Skip Headers
Oracle® Warehouse Builder OMB*Plus Command Reference
11g Release 2 (11.2)

Part Number E14406-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
 

OMBALTER CT

Purpose

To alter a Code Template.

Prerequisites

In the context of an CT module.

Syntax

alterCTCommand =  OMBALTER CT "QUOTED_STRING" ( "renameClause" { 
          "kmAlterOptionsOptionsClause" } | "kmAlterOptionsOptionsClause"+ )
     renameClause =  RENAME TO "QUOTED_STRING"
     kmAlterOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET 
          "unsetReferenceIconSetClause" | SET "setPropertiesClause" | ADD ( 
          "addParameterClause" | "addVariableClause" | "addCTTaskClause" | 
          "addNestedCTTaskClause" | "addTransitionClause" ) | MODIFY ( 
          "modifyParameterClause" | "modifyVariableClause" | 
          "modifyCTTaskClause" | "modifyTransitionClause" ) | DELETE ( 
          "deleteParameterClause" | "deleteVariableClause" | "deleteTaskClause" 
          | "deleteTransitionClause" )
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     addParameterClause =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
           [ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
     addVariableClause =  VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
     addCTTaskClause =  "TASK_TYPE" TASK "QUOTED_STRING" { 
          "kmTaskAddOptionsOptionsClause" }
     addNestedCTTaskClause =  NESTED_CT TASK "QUOTED_STRING" SET [ 
          "collectPropertiesClause" SET ] ( REF | REFERENCE ) CT "QUOTED_STRING"
           [ SET "setReferenceIconSetClause" ]
     addTransitionClause =  TRANSITION "QUOTED_STRING" FROM TASK "QUOTED_STRING"
           TO "QUOTED_STRING" [ SET "setPropertiesClause" ]
     modifyParameterClause =  "parameterLocator" ( "renameClause" [ SET 
          "setPropertiesClause" ] [ "parameterBindingClause" ] | SET 
          "setPropertiesClause" [ "parameterBindingClause" ] | 
          "parameterBindingClause" )
     modifyVariableClause =  "variableLocator" ( "renameClause" [ SET 
          "setPropertiesClause" ] | SET "setPropertiesClause" )
     modifyCTTaskClause =  TASK "QUOTED_STRING" ( ( "renameClause" { 
          "kmTaskAlterOptionsOptionsClause" } ) | 
          "kmTaskAlterOptionsOptionsClause"+ )
     modifyTransitionClause =  TRANSITION "QUOTED_STRING" ( "renameClause" [ SET
           "setPropertiesClause" ] | SET "setPropertiesClause" )
     deleteParameterClause =  "parameterLocator"
     deleteVariableClause =  "variableLocator"
     deleteTaskClause =  TASK "QUOTED_STRING"
     deleteTransitionClause =  TRANSITION "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     parameterBindingClause =  UNBIND | BIND TO ( "parameterLocator" | 
          "variableLocator" )
     kmTaskAddOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET 
          "unsetReferenceIconSetClause" | SET "setPropertiesClause"
     collectPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     parameterLocator =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
     variableLocator =  VARIABLE "QUOTED_STRING"
     kmTaskAlterOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET 
          "unsetReferenceIconSetClause" | SET "setPropertiesClause"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

alterCTCommand

Alter the definition of a CT. The following lists all the default ct parameters:

{0}

renameClause

Rename the CT.

setReferenceIconSetClause

Set icon set for the expert module.

unsetReferenceIconSetClause

Unset icon set for a CT.

setPropertiesClause

This clause sets properties for the corresponding object.

setPropertiesClause

Basic properties for Code Template: 

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

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

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.

addParameterClause

Add a parameter to the expert or one of it's tasks.

addVariableClause

Add a variable to the expert.

addTransitionClause

Add a transition to the expert.

modifyParameterClause

Modify the definition of a parameter.

modifyVariableClause

Modify the definition of a variable.

modifyTransitionClause

Modify the definition of a transition.

deleteParameterClause

Delete a parameter.

deleteVariableClause

Delete a variable.

deleteTaskClause

Delete a task.

deleteTransitionClause

Delete a transition.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

parameterBindingClause

Bind or unbind two parameters. Note that this is setting the binding attribute of the parameter object and is not necessarily the same as the direction of data flow. The parameter to be set should be the one whose binding attribute is modified via the Object Inspector in the expert editor.

collectPropertiesClause

This clause sets properties for the corresponding object.

parameterLocator

Specify a parameter, either one of the expert or of a task.

variableLocator

Specify a variable in the expert.

propertyValue

Value of a property.

CT Object

Table 2-1 CT Object

Property Type Choices Min Max Default Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.