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:
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.
Details and usage information about the Dataflow object in the IDX API, used by the IdentitySync ETL service.