External data flow methods

External data flows can be run, monitored, and managed through a rule-based API. Data-Decision-EDF-RunOptions and Pega-DM-EDF-Work are the container classes for the API rules, and provide the properties required to programmatically configure external data flow runs.

The following methods support the use of data flows in activities:

• Creating and start an external data flow run
• Starting an external data flow run
• Stopping an external data flow run
• Deleting an external data flow run
• Restarting an external data flow run
• Retrieving the status of an external data flow run

• Creating and starting an external data flow run

  Use the Call instruction with the pxStartRun activity to create and start an external data flow run.

• Starting an external data flow run

  Use the Call instruction with the pxStartRunById activity to start an external data flow run that has already been created.

• Stopping an external data flow run

  Use the Call instruction with the pxStopRun or pxStopRunById activity to stop an external data flow run.

• Deleting an external data flow run

  Use the Call instruction with the pxDeleteRunById activity to delete an external data flow run that is in the New, Completed, Failed, or Stopped state.

• Restarting an external data flow run

  Use the Call instruction with the pxRestartRun or pxRestartRunById activity to restart an external data flow run that is in the Completed, Failed, or Stopped state.

• Retrieving the status of an external data flow run

  Use the Call instruction with the pxLoadStatus activity to retrieve the status of an external data flow run to check it state. You can check if the data flow run is completed or it failed for some reason.