Data Orchestrator Functions
DataOrchestratorExecuteFlow
Declaration
DataOrchestratorFlowResult DataOrchestratorExecuteFlow(string flowName)Description
Executes a Data Orchestrator flow.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
flowName |
Name of the flow to be executed. |
Return Value
DataOrchestratorExecuteFlow
Declaration
DataOrchestratorFlowResult DataOrchestratorExecuteFlow(string flowName, string correlationId)Description
Executes a Data Orchestrator flow.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
flowName |
Name of the flow to be executed. |
correlationId |
Correlation id. |
Return Value
DataOrchestratorExecuteFlow
Declaration
DataOrchestratorFlowResult DataOrchestratorExecuteFlow(string flowName, VariantDictionary parameters)Description
Executes a Data Orchestrator flow.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
flowName |
Name of the flow to be executed. |
parameters |
Parameter names and values. |
Return Value
Instance of DataOrchestratorFlowResult.
DataOrchestratorExecuteFlow
Declaration
DataOrchestratorFlowResult DataOrchestratorExecuteFlow(string flowName, string correlationId, VariantDictionary parameters)Description
Executes a Data Orchestrator flow.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
flowName |
Name of the flow to be executed. |
correlationId |
Correlation id. |
parameters |
Parameter names and values. |
Return Value
Instance of DataOrchestratorFlowResult.
DataOrchestratorFlowResultGetMessage
Declaration
string DataOrchestratorFlowResultGetMessage(DataOrchestratorFlowResult result)Description
Gets the message from the result.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
result |
Instance of DataOrchestratorFlowResult. |
Return Value
Message.
DataOrchestratorFlowResultIsError
Declaration
bool DataOrchestratorFlowResultIsError(DataOrchestratorFlowResult result)Description
Check if the result is error.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
result |
Instance of DataOrchestratorFlowResult. |
Return Value
True or false.
DataOrchestratorFlowResultIsSuccess
Declaration
bool DataOrchestratorFlowResultIsSuccess(DataOrchestratorFlowResult result)Description
Check if the result is success.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
result |
Instance of DataOrchestratorFlowResult. |
Return Value
True or false.
DataOrchestratorFlowResultIsWarning
Declaration
bool DataOrchestratorFlowResultIsWarning(DataOrchestratorFlowResult result)Description
Check if the result is warning.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
result |
Instance of DataOrchestratorFlowResult. |
Return Value
True or false.
DataOrchestratorGetFlowNames
Declaration
StringList DataOrchestratorGetFlowNames()Description
Gets names of defined flows.
Supported Runtime Versions
5.0
Parameters
The function has no parameters.
Return Value
List of names of defined flows.
DataOrchestratorStartFlow
Declaration
string DataOrchestratorStartFlow(string flowName)Description
Starts a Data Orchestrator flow.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
flowName |
Name of the flow to be executed. |
Return Value
Identifier of asynchronously running job.
DataOrchestratorStartFlow
Declaration
string DataOrchestratorStartFlow(string flowName, VariantDictionary parameters)Description
Starts a Data Orchestrator flow.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
flowName |
Name of the flow to be executed. |
parameters |
Parameter names and values. |
Return Value
Identifier of asynchronously running job.
DataOrchestratorStartFlow
Declaration
string DataOrchestratorStartFlow(string flowName, string correlationId)Description
Starts a Data Orchestrator flow.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
flowName |
Name of the flow to be executed. |
correlationId |
Correlation id. |
Return Value
Identifier of asynchronously running job.
DataOrchestratorStartFlow
Declaration
string DataOrchestratorStartFlow(string flowName, string correlationId, VariantDictionary parameters)Description
Starts a Data Orchestrator flow.
Supported Runtime Versions
5.0
Parameters |
Description |
|---|---|
flowName |
Name of the flow to be executed. |
correlationId |
Correlation id. |
parameters |
Parameter names and values. |
Return Value
Identifier of asynchronously running job.