TRIGGER ORCHESTRATION

Description

The TRIGGER ORCHESTRATION processor is designed to initiate an orchestration process during the consolidation phase of data processing. This processor is particularly useful for automating complex workflows or processes that involve multiple steps or dependencies between different data feeds or systems. It supports all data types, including BLOBs, making it versatile for various data processing needs.

Config Location

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

Supported Data Types

BLOB
Json
String
Boolean
Double
Decimal
Integer

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:

<dataPoint name="NAME" dataType="STRING">
    <consDPProcessors>
        <consDPProcessor name="TRIGGER_ORCH_FROM_DP" entity="TRIGGER_ORCHESTRATION">
            <config>
                <![CDATA[
                    {
                        "orchestrationName" : "BACKEND_TRANSFORM",
                        "inheritMetaData" : true,
                        "orchestrationConfig" : {
                            "symbol":"#GRV{ CTX['symbol'] }",
                            "schemaId":"#GRV{ CTX.schemaId }"
                        }
                    }
                ]]>
            </config>
        </consDPProcessor>
    </consDPProcessors>
</dataPoint>

Example Result

Upon successful configuration and execution, the TRIGGER ORCHESTRATION processor will initiate the specified orchestration process ("BACKEND_TRANSFORM" in this example), allowing for the automation of complex workflows or processes.

Config Parameters

name	acceptable values	comment
orchestrationName	A string representing the name of the orchestration to be triggered.	This defines the orchestration that will be triggered.
inheritMetaData	A boolean value indicating whether to inherit metadata from the current context.	If set to true, metadata will be inherited.
orchestrationConfig	A JSON object specifying the configuration for the orchestration.	This includes any specific configurations required for the orchestration.
symbol	A string representing the symbol to be passed to the orchestration.	This is used for passing the symbol to the orchestration.
schemaId	A string representing the schema ID to be passed to the orchestration.	This is used for passing the schema ID to the orchestration.

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 configuration parameters within the <config> tag are correctly written and match the expected format and values.
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.