Pipeline Executor

IMPORTANT: This documentation has been discontinued. Read the updated Pipeline Executor documentation on our new documentation portal.

Pipeline Executor makes synchronous or asynchronous calls to other pipelines that have already been deployed. When using the synchronous approach, you can obtain the result of the invoked pipeline.

Take a look at the configuration parameters of the component:

Operation: SYNC for synchronous calls to the pipeline; and ASYNC for asynchronous calls to the pipeline.

Pipeline Name: name of the pipeline to be invoked.

Version Major: Major Version of the pipeline to be invoked.

Payload: payload to be sent when invoking the pipeline.

Timeout: maximum time of the pipeline execution.

Expiration: time the message remains in the queue when trying to execute the pipeline (in milliseconds).

Fail On Error: if the option is enabled, the execution of the pipeline with error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property.

Messages flow

Input

No specific payload is expected in this component input. The input will be dynamically configured in the “Payload” field according to the need of the pipeline to be invoked.

Output

{
"operation": "SYNC",
"pipelineName": "pipeline-example",
"versionMajor": 1,
"success": true,
"payload": {},
"pipelineResponse": {}
}

operation: the selected operation, SYNC or ASYNC
pipelineName: name of the invoked pipeline
versionMajor: major version of the invoked pipeline
success: if the call was successful
payload: payload used to invoke the configured pipeline
pipelineResponse: response of the executed pipeline. This property is returned only in the SYNC operation.

Pipeline Executor in Action

See below how the component behaves in a particular situation and its respective configuration.

Making an asynchronous call

Operation: ASYNC

Pipeline Name: name of the pipeline to be invoked

Version Major: 1

Payload: {}

Timeout: 20000

Expiration: 30000

Fail On Error: false

In the scenario above, an asynchronous call to the configured pipeline will be made and the current flow will continue normally without waiting for the invoked pipeline response. You'll be able to see the execution and the call logs of this pipeline in the Platform logs screen.

Output

{
"operation": "ASYNC",
"pipelineName": "name of the pipeline to be invoked",
"versionMajor": 1,
"success": true,
"payload": {}
}

Making a synchronous call

Operation: SYNC