Invoke Pipeline

Summary

Use the INVOKE PIPELINE command to interactively execute a pipeline.

Syntax

invoke [synchronous] pipeline <pipeline_name>
[(variables variable_name1=value_override1, variable_name3=value_override2..n)];

Parameters

Parameter	Description
`[synchronous]`	(Optional) By default, pipeline invocations run asynchronously on the Connect server cluster. Use this parameter to cause the `INVOKE PIPELINE` command to run synchronously, i.e. to return control to the calling program only upon completion. Otherwise, control returns immediately, as the pipeline runs asynchronously in the background on the Connect cluster. Refer to `SHOW INVOCATIONS` to monitor pipeline status.
`<pipeline_name>`	(Required) The name of the pipeline domain object to run. Refer to `SHOW PIPELINES` for a list of all pipeline domain objects that exist in your business’ environment.
`[variables (variable_name1=value_override1,` `variable_name3=value_override2..n)]`	(Optional) Connect variables are global in scope. A pipeline invocation will use the global values unless the pipeline variable overrides parameters are used. The variable override parameters allow the caller to set a variable’s value scoped for the given pipeline invocation only. Other processes may use the same global variable name, but will see the global value, not the override. Refer to `SET` to learn more about variables.

Parameter

Description

[synchronous] (Optional) By default, pipeline invocations run asynchronously on the Connect server cluster. Use this parameter to cause the INVOKE PIPELINE command to run synchronously, i.e. to return control to the calling program only upon completion. Otherwise, control returns immediately, as the pipeline runs asynchronously in the background on the Connect cluster. Refer to SHOW INVOCATIONS to monitor pipeline status.

<pipeline_name> (Required) The name of the pipeline domain object to run. Refer to SHOW PIPELINES for a list of all pipeline domain objects that exist in your business’ environment.

[variables (variable_name1=value_override1,

variable_name3=value_override2..n)]

(Optional) Connect variables are global in scope. A pipeline invocation will use the global values unless the pipeline variable overrides parameters are used. The variable override parameters allow the caller to set a variable’s value scoped for the given pipeline invocation only. Other processes may use the same global variable name, but will see the global value, not the override. Refer to SET to learn more about variables.

Details

A pipeline can contain an ordered collection of steps and sub-pipeline members. Each pipeline member runs in sequential order. Use the SHOW INVOCATIONS and SHOW INVOCATION DETAILS commands to track the progress of the pipeline and its individual members. Abort a pipeline invocation with the ABORT INVOCATION command.

Pipelines may be invoked automatically via a Connect schedule. Refer to CREATE SCHEDULE. Lastly, compensation administrators may invoke pipelines as an “External Process” from the “Process Group” features found in the Incent UI.

The invoke command returns a status result set with the following columns:

Column Name	Data Type	Description
status_code	string	‘0’ indicates success, ‘1’ failure
status_message	string	‘ok’ indicates success, otherwise an error message
name	string	The name of the invoked pipeline if invoked asynchronously. Otherwise null.
command	string	‘invoke pipeline’ if invoked asynchronously. Otherwise null.
count	integer	Default value for this command is ‘1’.
value	string	The invocation_id of the invocation. Use with the `SHOW INVOCATIONS` and `SHOW INVOCATION DETAILS` command result sets to track invocation status.
exception_message	string	A more detailed message if an error occurred.