Syntax
retrieveProcessFlowCommand = OMBRETRIEVE PROCESS_FLOW "QUOTED_STRING" (
"retrieveProcessFlowClause" | "retrieveActivityClause" |
"retrieveTransitionClause" | "retrieveProcessParameterClause" |
"retrieveProcessVariableClause" )
retrieveProcessFlowClause = "getPropertiesClause" |
"getReferenceIconSetClause" | GET "getProcessFlowSCOClause"
retrieveActivityClause = ACTIVITY "QUOTED_STRING" ( "getPropertiesClause"
| "getReferenceIconSetClause" | "getActivityBoundObject" |
"getActivityTransitionClause" | "getActivityParameterClause" |
"getActivityParameterPropertiesClause" )
retrieveTransitionClause = TRANSITION "QUOTED_STRING" (
"getPropertiesClause" | GET "getTransitionActivityClause" )
retrieveProcessParameterClause = PARAMETER "QUOTED_STRING"
"getPropertiesClause"
retrieveProcessVariableClause = VARIABLE "QUOTED_STRING"
"getPropertiesClause"
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
getProcessFlowSCOClause = ACTIVITIES | ( ( "UNQUOTED_STRING" |
DATA_AUDITOR | USER_DEFINED | SUBPROCESS | MAPPING | TRANSFORMATION )
ACTIVITIES ) | TRANSITIONS | PARAMETERS | VARIABLES
getActivityBoundObject = GET ( REFERENCE | REF )
getActivityTransitionClause = GET ( INCOMING_TRANSITIONS |
OUTGOING_TRANSITIONS )
getActivityParameterClause = ( GET PARAMETERS )
getActivityParameterPropertiesClause = PARAMETER "QUOTED_STRING"
"getPropertiesClause"
getTransitionActivityClause = ( SOURCE_ACTIVITY | DESTINATION_ACTIVITY )
propertyNameList = ( "UNQUOTED_STRING" | BINDING ) { "," (
"UNQUOTED_STRING" | BINDING ) }
Parameters
retrieveProcessFlowCommand
Retrieve the details of an existing process flow.
retrieveProcessFlowClause
This clause retrieve the Process Flow.
retrieveActivityClause
This clause retrieves the Activity of a Process Flow.
retrieveTransitionClause
This clause retrieves the Transition of a Process Flow.
retrieveProcessParameterClause
This clause retrieves the Parameter of a Process Flow.
retrieveProcessVariableClause
Retrieve definition of a variable.
getPropertiesClause
Used to get properties (core, user-defined) for process flow. Valid properties are shown below:
getPropertiesClause
Base properties for Process Flow, Activity, Transition and Parameter:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of a Process Flow
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of a Process Flow
Basic properties for Transition:
Name: TRANSITION_CONDITION
Type: STRING
Valid Values: '', SUCCESS, ERROR, WARNING
Default: Empty string i.e. Unconditional
Gets the Transition Condition of a Transition
Basic properties for Activity Parameter :
Name: SIMPLE_CONDITION
Type: STRING
Valid Values: '', SUCCESS, ERROR, WARNING
Default: Empty string i.e. Unconditional
Sets the Simple Condition of a Transition
Name: COMPLEX_CONDITION
Type: STRING
Sets the Complex Condition of a Transition
Name: DATATYPE
Type: STRING
Valid Values: INTEGER, FLOAT, DATE, STRING, BOOLEAN
Default: STRING
Gets the datatype of a Activity Parameter
Name: DIRECTION
Type: STRING
Valid Values: IN
Default: IN
Gets the direction of a Activity Parameter
Name: ISLITERALVALUE
Type: STRING
Valid Values: TRUE FALSE
Default: TRUE
Whether the value stored is a literal value or an interpreted value, valid for PARAMETERS and VARIABLES.
Name: VALUE
Type: STRING
Valid Values: Examples '123', '123.456', 'Jan-08-2003', 'I am String', 'true'
Default: Empty string
Gets the value of a Activity Parameter
Name: BINDING
Type: STRING
Valid Values: Examples 'PROCESS_PARAM1', 'PROCESS_PARAM2'
Default: Empty string
Get the name of the process parameter that this parameter is bound to, empty if not bound.
Name: BOUND_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The name of the object which a process flow activity represents, for example, a mapping.
Name: DEPLOYED_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: USE_DEFAULT_LOCATION
The locaion to which the process flow is deployed.
Name: EXECUTION_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: NATIVE_EXECUTION
The location which is used to execute the process flow, which may differ from the deployment location.
Name: REMOTE_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: USE_DEFAULT_LOCATION
The File location which is remote from the Working Location, used by FTP to connect to the remote FTP server and set the remote working directory.
Name: USE_RETURN_AS_STATUS
Type: BOOLEAN
Valid Values: true, false
Default: false
When TRUE, the returned result will directly control the outcome of the activity/operator, 1=SUCCESS, 2=WARNINGS, 3=FAILURE.
getReferenceIconSetClause
Retrieve the icon set referenced by this process flow.
getProcessFlowSCOClause
For the current process flow, retrieve all activities or only activities of a specific type.
getActivityBoundObject
Retrieve the name of the object that the current activity refers to, pertinent to only MAPPING, SUBPROCESS and TRANSFORMATION activities.
getActivityTransitionClause
This clause retrieves all Activities of a Process Flow.
getActivityParameterClause
Retrieve the activity parameters for the current activity.
getActivityParameterPropertiesClause
Retrieve the details of an activity parameter.
getTransitionActivityClause
This clause retrieves all Transitions of a Process Flow.
propertyNameList
A comma delimited set of property names to set.
