Generated Record

The Start Pipelines origin creates an orchestration record that includes information about the pipelines that it starts.

The record includes the following fields:
Field Name Description
orchestratorTasks List Map field that contains task details for the orchestration pipeline.

Most orchestration stages add details about their completed tasks within this field.
<unique task name> List Map field within the orchestratorTasks field that contains the following fields:
  • pipelineIds - IDs of the pipelines that the stage is configured to start.
  • pipelineResults - List Map of pipeline run details for each pipeline.
  • success - Boolean field that indicates whether all pipelines completed successfully.

    Included only when the pipelines run in the foreground.
<pipeline ID> List Map field within the pipelineResults field that provides details about each pipeline. Contains the following fields:
  • pipelineId - ID of the pipeline.
  • pipelineTitle - Name of the pipeline.
  • startedSuccessfully - Boolean field that indicates whether a pipeline was started successfully.
  • finishedSuccessfully - Boolean field that indicates whether a pipeline completed successfully.

    Included only when the pipeline runs in the foreground.

  • pipelineMetrics - Map field that contains metrics for the pipeline and individual pipeline stages.

    Included only when the pipeline runs in the foreground.

  • pipelineStatus - Status of the pipeline. For more information, see Understanding Pipeline States.
  • pipelineStatusMessage - Status message for the pipeline.
  • committedOffsetsStr - Offset details for the pipeline.

    Included only when the pipeline runs in the foreground.

For example, the following preview shows information provided by a Start Pipelines origin with the Load_ADLS task name. The origin runs one pipeline in the background:

Note that the startedSuccessfully and pipelineStatus fields indicate that pipeline was started successfully. There is no finishedSuccessfully field because the pipeline has not yet completed.

For an example of an orchestration record, see Example.