In the IDX API used by IdentitySync, a dataflow object defines the complete flow of extracting, transforming, and transmitting data between Gigya and a partner platform in a specific direction.
A dataflow object contains an array of steps. Each step but the last executes a script from the Component Repository, then calls the next step. The last step executes the final script - usually writing the data to the destination platform.
Use the idx.createDataflow method to create a dataflow and save it in the system. After a dataflow has been created, you can execute it using idx.createScheduling.
|id||string||An automatically generated unique ID.|
|name||string||The title of the dataflow.|
|description||string||The description of the dataflow.|
An array of step objects.
Each step includes the following fields:
- id: the unique identifier of the step within a given dataflow. Each step has to have an ID so it can be called by other steps in the "next" attribute.
- type: the ID of the ETL script used in this step (see Script Repository).
- params (optional): an object defining parameters to use when calling the ETL script. The names of the parameters, their values, and whether they are required depends on the implementation.
- next: an array containing one or more IDs of the next step(s) to be carried out.
- A step to which no other step refers in the next attribute is automatically considered the entry point of the dataflow.
- Steps which do not have a next attribute are automatically considered end-points of the dataflow.
- Assign multiple values to a next attribute to split the dataflow. See example.
Automatically updated: the date and time of the last time the dataflow was executed.
For an example of a dataflow, see Dataflow Example and Dataflow Templates.