Skip to content

TRIGGER ORCHESTRATION

Description

The TRIGGER ORCHESTRATION processor is designed to initiate the execution of an orchestration workflow. This processor is particularly useful for scenarios where complex, multi-step processes need to be orchestrated, such as workflows involving multiple services.

Config Location

To configure the TRIGGER ORCHESTRATION processor, you need to define it within the schemaAppliedProcessors section of your schema configuration. This involves specifying the processor name and entity.

Supported Data Types

  • String
  • Double
  • Decimal
  • Integer
  • Json
  • BLOB
  • Boolean

Config Requirements

Config ({}) options are required for the TRIGGER ORCHESTRATION processor. If no configuration is provided or if the configuration is improperly set up, a block violation will be thrown. For more information on Apiro violations and their appearance in the Apiro UI or logs, refer to the violations section.

Example Config

Below is an example of how to configure the TRIGGER ORCHESTRATION processor in XML format:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
<schemaAppliedProcessors>
    <dataBlockProcessors>
        <dataBlockProcessor name="BLOCK_TRIGGER_ORCH" entity="TRIGGER_ORCHESTRATION">
            <config>
                <![CDATA[
                    {
                        "orchestrationName" : "BACKEND_TRANSFORM",
                        "inheritMetaData" : true,
                        "orchestrationConfig" : {
                            "symbol":"#GRV{ CTX['symbol'] }",
                            "schemaId":"#GRV{ CTX.schemaId }"
                        }
                    }
                ]]>
            </config>
        </dataBlockProcessor>
    </dataBlockProcessors>
</schemaAppliedProcessors>

Example Result

Upon successful configuration and execution, the TRIGGER ORCHESTRATION processor will initiate the specified orchestration workflow (BACKEND_TRANSFORM). The workflow will inherit metadata from the current context and will be configured with the provided parameters, such as symbol and schemaId.

Config Parameters

name acceptable values comment
orchestrationName A string representing the name of the orchestration workflow to be triggered
inheritMetaData A boolean indicating whether the orchestration should inherit metadata from the current context
orchestrationConfig A JSON object containing configuration details for the orchestration, such as specific parameters to be passed to the workflow

Common Mistakes

  • Ensure that the processor name and entity are correctly defined in the configuration to ensure that the processor is correctly identified and applied during the data processing pipeline.
  • Verify that the orchestrationName matches the name of an existing orchestration workflow.
  • Ensure that the orchestrationConfig contains the correct parameters required by the orchestration workflow.
  • Remember that the configuration for the TRIGGER ORCHESTRATION processor is required. If no configuration, or improper configuration is provided then a block violation will be thrown.