OMBRETRIEVE CT

Purpose

To retrieve metadata on a CT (Code Template).

Prerequisites

In the context of an CT module.

Syntax

retrieveCTCommand =  OMBRETRIEVE CT "QUOTED_STRING" ( "getCTClauses" | 
          "retrieveCTTaskClause" | "retrieveTransitionClause" | 
          "retrieveParameterClause" | "retrieveVariableClause" )
     getCTClauses =  GET ( "getPropertiesClause" | "getReferenceIconSetClause" |
           TASKS | "TASK_TYPE" TASKS | NESTED_CT TASKS | TRANSITIONS | 
          PARAMETERS | VARIABLES )
     retrieveCTTaskClause =  TASK "QUOTED_STRING" ( GET ( "getPropertiesClause" 
          | "getReferenceIconSetClause" | PARAMETERS | INCOMING TRANSITIONS | 
          OUTGOING TRANSITIONS ) | "retrieveParameterClause" )
     retrieveTransitionClause =  TRANSITION "QUOTED_STRING" GET ( 
          "getPropertiesClause" | SOURCE TASK | DESTINATION TASK )
     retrieveParameterClause =  PARAMETER "QUOTED_STRING" GET ( 
          "getPropertiesClause" | "getBindingClause" )
     retrieveVariableClause =  VARIABLE "QUOTED_STRING" GET 
          "getPropertiesClause"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getBindingClause =  BOUND ( VARIABLE | PARAMETER )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveCTCommand

Retrieve definition of the CT.

retrieveTransitionClause

Retrieve definition of a transition.

retrieveParameterClause

Retrieve definition of an code template or a task parameter.

retrieveVariableClause

Retrieve definition of a variable.

getPropertiesClause

Get the values of the specified properties.

getPropertiesClause

Basic properties for EXPERT: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the expert

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the expert

Basic properties for TASK: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the task

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the task.  This is equivalent to the Goal of task in the expert editor.

Name: INSTRUCTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The instruction for the task

Name: PREPROCESSING
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The pre-processing script for the task

Name: MAIN
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The main script for the task

Name: POSTPROCESSING
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The post-processing script for the task


Basic propeties for START TASK: 

Name: PROC_DECL
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The procedure declaration for the expert.


Basic properties for TRANSITION: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the transition

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the transition

Name: TRANSITION_CONDITION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Condition of the transition

Name: TRANSITION_ORDER
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: N/A
Order of the transition

Basic properties for PARAMETER: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the parameter

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the parameter

Name: DATATYPE
Type: STRING
Valid Values: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the parameter

Name: DIRECTION
Type: STRING
Valid Values: IN, OUT, INOUT
Default: IN
Direction of the parameter. 
Direction of custom expert parameter can only be IN or OUT. 
For some tasks, direction of custom parameter can be IN, OUT or INOUT. 

Name: VALUE
Type: Same as datatype of the parameter
Valid Values: Any valid character string in supported character set.
Default: N/A
The static value of the parameter


Basic properties for VARIABLE: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the variable

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the variable

Name: DATATYPE
Type: STRING
Valid Values: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the variable

Name: VALUE
Type: Same as datatype of the variable
Valid Values: Any valid character string in supported character set.
Default: N/A
The static value of the variable

getReferenceIconSetClause

Retrieve the icon set referenced by this CT module.

getBindingClause

Get the bound variable or parameter.

propertyNameList

The list of property names.

EXPERT Object

Table 18-5 EXPERT Object

Property	Type	Choices	Min	Max	Default	Description
CLOSE_ASSISTANT_ON_COMPLETION	BOOLEAN	true, false	none	none	true	Sets whether the task assistant should be automatically closed after the expert has been run.
CLOSE_WINDOWS_ON_EXECUTION	BOOLEAN	true, false	none	none	true	Close all open windows when this expert is run.
FINISH_DIALOG_ON_COMPLETION	BOOLEAN	true, false	none	none	true	Shows the finish dialog upon completion of expert.
GENERATION_COMMENTS	STRING	none	none	none	empty string	Enter additional comments for the generated code.
LOGGING	BOOLEAN	true, false	none	none	false
MENU_ITEM_DISPLAY_STRING	STRING	none	none	none	empty string	The display string when this expert is added as a menu item.
ONLY_RUN_FROM_MENU	BOOLEAN	true, false	none	none	false	Only allow this expert to be run when it is attached to a menu item.
REVERT_TO_SAVED_ON_ERROR	BOOLEAN	true, false	none	none	false	Revert to saved metadata if error occurs when the expert is run.
RUN_STANDALONE	BOOLEAN	true, false	none	none	true	Sets whether the expert should be run as a standalone in expert assistant mode or not.
SAVE_ALL_BEFORE_START	BOOLEAN	true, false	none	none	false	Save all metadata before running the expert.
SHOW_BUSY_DIALOG	BOOLEAN	true, false	none	none	true	Sets whether busy dialog should be shown when OMB or Java tasks are executed in non-standalone mode.
SHOW_LOG_WINDOW	BOOLEAN	true, false	none	none	false	Sets whether the log window should be shown when running the expert.
SHOW_PROGRESS_GRAPH	BOOLEAN	true, false	none	none	true	Sets whether the progress graph dialog should be shown when running the expert.
SHOW_TASK_ASSISTANT	BOOLEAN	true, false	none	none	true	Sets whether the task assistant should be shown when running the expert.

OMBRETRIEVE CT

Purpose

Prerequisites

Syntax

Parameters

retrieveCTCommand

retrieveTransitionClause

retrieveParameterClause

retrieveVariableClause

getPropertiesClause

getPropertiesClause

getReferenceIconSetClause

getBindingClause

propertyNameList

EXPERT Object

See Also