| Oracle® Warehouse Builder API and Scripting Reference 11g Release 1 (11.1) Part Number B31279-01 |
|
|
View PDF |
| Oracle® Warehouse Builder API and Scripting Reference 11g Release 1 (11.1) Part Number B31279-01 |
|
|
View PDF |
This chapter lists commands associated with OMBALTER in alphabetical order, concluding with the command OMBALTER QUEUE_TABLE. Subsequent commands associated with OMBALTER are contained in the next chapter.
Purpose
To alter an expert.
Prerequisites
In the context of an expert module.
Syntax
alterExpertCommand = OMBALTER EXPERT "QUOTED_STRING" ( "renameClause" [
"alterPropertiesOrIconSetClause" ] { "alterExpertDetailClauses" } |
"alterPropertiesOrIconSetClause" { "alterExpertDetailClauses" } |
"alterExpertDetailClauses"+ )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
alterExpertDetailClauses = ( ADD ( "addParameterClause" |
"addVariableClause" | "addNestedExpertClause" | "addTaskClause" |
"addTransitionClause" ) | MODIFY ( "modifyParameterClause" |
"modifyVariableClause" | "modifyTaskClause" | "modifyTransitionClause"
) | DELETE ( "deleteParameterClause" | "deleteVariableClause" |
"deleteTaskClause" | "deleteTransitionClause" ) )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
addParameterClause = PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
[ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
addVariableClause = VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
addNestedExpertClause = NESTED_EXPERT TASK "QUOTED_STRING" SET [
"collectPropertiesClause" SET ] ( REF | REFERENCE ) EXPERT
"QUOTED_STRING" [ SET "setReferenceIconSetClause" ]
addTaskClause = "TASK_TYPE" TASK "QUOTED_STRING" [ SET (
"setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
"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" )
modifyTaskClause = TASK "QUOTED_STRING" ( "renameClause" [
"alterPropertiesOrIconSetClause" ] | "alterPropertiesOrIconSetClause"
)
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" )
collectPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
parameterLocator = PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
variableLocator = VARIABLE "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterExpertCommand
Alter the definition of an expert. The following lists all the default
expert parameters:
1) EXP_LAUNCH_CONTEXT, type: STRING, direction: IN
The console context in which this expert is being launched.
2) EXP_LAUNCH_CONTEXT_TYPE, type: STRING, direction: IN
The type of the console context in which this expert is being launched.
3) EXP_OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) EXP_TYPE_TO_CREATE, type: STRING, direction: IN
The object type selected to be created when this expert is launched.
renameClause
Rename the expert.
alterPropertiesOrIconSetClause
Alter existing expert module properties and/or Icon Set.
alterExpertDetailClauses
Alter child objects of an expert.
setPropertiesClause
This clause sets properties for the corresponding object.
Basic properties for EXPERT:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the expert
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the expert
Basic properties for TASK:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the task
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the task. This is equivalent to the Goal of task in the
expert editor.
Name: INSTRUCTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
The instruction for the task
Name: PREPROCESSING
Type: STRING
Valid Values: N/A
Default: N/A
The pre-processing script for the task
Name: MAIN
Type: STRING
Valid Values: N/A
Default: N/A
The main script for the task
Name: POSTPROCESSING
Type: STRING
Valid Values: N/A
Default: N/A
The post-processing script for the task
Basic propeties for START TASK:
Name: PROC_DECL
Type: STRING(4000)
Valid Values: N/A
Default: ''
The procedure declaration for the expert.
Basic properties for TRANSITION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the transition
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the transition
Name: TRANSITION_CONDITION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Condition of the transition
Name: TRANSITION_ORDER
Type: NUMBER
Valid Values: N/A
Default: N/A
Order of the transition
Basic properties for PARAMETER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the parameter
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
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
Name: VALUE
Type: Same as datatype of the parameter
Valid Values: N/A
Default: N/A
The static value of the parameter
Basic properties for VARIABLE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the variable
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
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: N/A
Default: N/A
The static value of the variable
Properties for EXPERT:
Name: CLOSE_ASSISTANT_ON_COMPLETION
Type: BOOLEAN
Valid Values: true, false
Default: true
Sets whether the task assistant should be automatically closed after the
expert has been run.
Name: CLOSE_WINDOWS_ON_EXECUTION
Type: BOOLEAN
Valid Values: true, false
Default: true
Close all open windows when this expert is run.
Name: FINISH_DIALOG_ON_COMPLETION
Type: BOOLEAN
Valid Values: true, false
Default: true
Shows the finish dialog upon completion of expert.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: LOGGING
Type: BOOLEAN
Valid Values: true, false
Default: false
Log output to file when this expert is being run. A log file will be
created in <shiphome>/owb/log directory whenever this expert is run.
Name: MENU_ITEM_DISPLAY_STRING
Type: STRING
Valid Values: N/A
Default: ''
The display string when this expert is added as a menu item.
Name: ONLY_RUN_FROM_MENU
Type: BOOLEAN
Valid Values: true, false
Default: false
Only allow this expert to be run when it is attached to a menu item.
Name: REVERT_TO_SAVED_ON_ERROR
Type: BOOLEAN
Valid Values: true, false
Default: false
Revert to saved metadata if error occurs when the expert is run.
Name: RUN_STANDALONE
Type: BOOLEAN
Valid Values: true, false
Default: true
Sets whether the expert should be run as a standalone in expert assistant
mode or not.
Name: SAVE_ALL_BEFORE_START
Type: BOOLEAN
Valid Values: true, false
Default: false
Save all metadata before running the expert.
Name: SHOW_BUSY_DIALOG
Type: BOOLEAN
Valid Values: true, false
Default: true
Sets whether busy dialog should be shown when OMB or Java tasks are
executed in non-standalone mode.
Name: SHOW_LOG_WINDOW
Type: BOOLEAN
Valid Values: true, false
Default: false
Sets whether the log window should be shown when running the expert.
Name: SHOW_PROGRESS_GRAPH
Type: BOOLEAN
Valid Values: true, false
Default: true
Sets whether the progress graph dialog should be shown when running the
expert.
Name: SHOW_TASK_ASSISTANT
Type: BOOLEAN
Valid Values: true, false
Default: true
Sets whether the task assistant should be shown when running the expert.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceIconSetClause
Set icon set for the expert module.
addParameterClause
Add a parameter to the expert or one of it's tasks.
addVariableClause
Add a variable to the expert.
addNestedExpertClause
Add a nested expert to the expert. The nested expert is added by
reference.
addTaskClause
Add a task to the expert. Valid task types include: ADVANCED_QUEUE,
ALTERNATIVE_SORT_ORDER, ANALYZE_IMPACT, ANALYZE_LINEAGE, BUSINESS_AREA,
CHANGE_MANAGER, COMMIT, CONTROLCENTERJOBS, CUBE, CUSTOM_DIALOG,
DATA_AUDITOR, DATA_PROFILE, DATA_RULE, DATA_VIEWER, DEPLOY, DERIVATION,
DIMENSION, DRILL_PATH, DRILL_TO_DETAIL, END, EXTERNAL_TABLE, FLAT_FILE,
FUNCTION, GENERATION, ITEM_FOLDER, JAVA, LIST_OF_VALUES, MAPPING,
MATERIALIZED_VIEW, NESTED_EXPERT, OBJECT_SELECTOR, OMB, PLUGGABLE_MAPPING,
PRESENTATION_TEMPLATE, PROCEDURE, PROCESS_FLOW, REGISTERED_FUNCTION,
SELECT_SOURCE, SELECT_TARGET, SEQUENCE, SOURCE_IMPORT, START, STARTJOB,
TABLE, VALIDATION, VIEW.
Definition of each task is as follow:
Task type : ADVANCED_QUEUE
Group : MML
Description: A task to create or alter an advanced queue.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : ALTERNATIVE_SORT_ORDER
Group : MML
Description: A task to create or alter an alternative sort order.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : ANALYZE_IMPACT
Group : Service
Description: A task to analyze impact of an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object for analyzing impact.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object whose impact will be analyzed.
Task type : ANALYZE_LINEAGE
Group : Service
Description: A task to analyze lineage of an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object for analyzing lineage.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object whose lineage will be analyzed.
Task type : BUSINESS_AREA
Group : MML
Description: A task to create or alter a business area.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : CHANGE_MANAGER
Group : Service
Description: A task to invoke the change manager.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : COMMIT
Group : Service
Description: A task to perform commit in the design repository.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
Task type : CONTROLCENTERJOBS
Group : Service
Description: A task to launch the Control Center Job Monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) CONTROL_CENTER_NAME, type: STRING, direction: IN
The Control Center to use.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : CUBE
Group : MML
Description: A task to create or alter a cube.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : CUSTOM_DIALOG
Group : UI
Description: A task to show a custom dialog for user interaction.
Built-in parameters:
1) GUI_RETURN_VALUE, type: ARRAY, direction: OUT
The return value of type ARRAY that stores the name and return value pair
for each UI component.
2) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
3) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
Task type : DATA_AUDITOR
Group : MML
Description: A task to create or alter a data auditor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : DATA_PROFILE
Group : MML
Description: A task to create or alter a data profile.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : DATA_RULE
Group : MML
Description: A task to create or alter a data rule.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : DATA_VIEWER
Group : Service
Description: A task to launch the data viewer.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of the OWB FCO, such as TABLE.
4) OBJECT_NAME, type: STRING, direction: IN
The name of the OWB FCO.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : DEPLOY
Group : Service
Description: A task to launch the Control Center deployment monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) ACTION_PLAN_NAME, type: STRING, direction: IN
The deployment action plan to use.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : DERIVATION
Group : Service
Description: A task to run derivation service.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to derive.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be derived.
Task type : DIMENSION
Group : MML
Description: A task to create or alter a dimension.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : DRILL_PATH
Group : MML
Description: A task to create or alter a drill path.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : DRILL_TO_DETAIL
Group : MML
Description: A task to create or alter a drill to detail.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : END
Group : FlowControl
Description: A task that marks the end of the flow.
Built-in parameters:
Task type : EXTERNAL_TABLE
Group : MML
Description: A task to create or alter an external table.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : FLAT_FILE
Group : MML
Description: A task to create or alter a file.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : FUNCTION
Group : MML
Description: A task to create or alter a function.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : GENERATION
Group : Service
Description: A task to invoke the generation dialog.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to generate.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be generated.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : ITEM_FOLDER
Group : MML
Description: A task to create or alter an item folder.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : JAVA
Group : Integration
Description: A task to execute a Java program.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) CLASS_URL, type: STRING, direction: IN
The URL specification of the Jar file. An example for a local jar file
xyz.jar can be specified as file:/xyz.jar
4) CLASS_NAME, type: STRING, direction: IN
The class to load. This includes the package as well in dotted notation.
For example, oracle.owb.Test
5) METHOD_NAME, type: STRING, direction: IN
The static method to execute.
6) ARGUMENT_LIST, type: STRING, direction: IN
The argument list to be passed into the static method.
Task type : LIST_OF_VALUES
Group : MML
Description: A task to create or alter a list of values.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : MAPPING
Group : MML
Description: A task to create or alter a mapping.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : MATERIALIZED_VIEW
Group : MML
Description: A task to create or alter a materialized view.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : NESTED_EXPERT
Group : FlowControl
Description: A task that references another expert.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
Task type : OBJECT_SELECTOR
Group : UI
Description: A task that shows a dialog for user to select an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) OBJECT_TYPE, type: STRING, direction: IN
The type of object for selection.
Task type : OMB
Group : Integration
Description: A task to launch a generic OMB script.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
Task type : PLUGGABLE_MAPPING
Group : MML
Description: A task to create or alter a pluggable mapping.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : PRESENTATION_TEMPLATE
Group : MML
Description: A task to create or alter a presentation template.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : PROCEDURE
Group : MML
Description: A task to create or alter a procedure.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : PROCESS_FLOW
Group : MML
Description: A task to create or alter a process flow.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : REGISTERED_FUNCTION
Group : MML
Description: A task to create or alter a registered function.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : SELECT_SOURCE
Group : UI
Description: A task that allows users to pick a metadata source.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) MODULE_NAME, type: STRING, direction: OUT
The name of the module.
5) LOCATION_NAME, type: STRING, direction: OUT
The name of the location.
6) OBJECT_TYPE, type: STRING, direction: OUT
The type of object selected as the source.
7) SOURCE_TYPE, type: STRING, direction: INOUT
The type of the source, e.g. file or database.
Task type : SELECT_TARGET
Group : UI
Description: A task that allows users to pick a target.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) MODULE_NAME, type: STRING, direction: OUT
The name of the module.
5) LOCATION_NAME, type: STRING, direction: OUT
The name of the location.
6) OBJECT_TYPE, type: STRING, direction: OUT
The type of object selected as the target.
7) SOURCE_TYPE, type: STRING, direction: INOUT
The type of the source, e.g. file or database.
Task type : SEQUENCE
Group : MML
Description: A task to create or alter a sequence.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : SOURCE_IMPORT
Group : Service
Description: A task to invoke the import wizard.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) OBJECT_TYPE, type: STRING, direction: IN
The type of object to import.
5) IMPORT_MODE, type: STRING, direction: IN
The mode for import. Select FULL_MODE for importing multiple objects, or
MINIMAL_MODE for single import.
Task type : START
Group : FlowControl
Description: A task that marks the beginning of the flow.
Built-in parameters:
Task type : STARTJOB
Group : Service
Description: A task to launch the start job monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to be started.
4) OBJECT_PATH, type: STRING, direction: IN
The context path of the object to be started.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : TABLE
Group : MML
Description: A task to create or alter a table.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : VALIDATION
Group : Service
Description: A task to invoke the validation dialog.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to validate.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be validated.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : VIEW
Group : MML
Description: A task to create or alter a view.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
addTransitionClause
Add a transition to the expert.
modifyParameterClause
Modify the definition of a parameter.
modifyVariableClause
Modify the definition of a variable.
modifyTaskClause
Modify the definition of a task.
modifyTransitionClause
Modify the definition of a transition.
deleteParameterClause
Delete a parameter.
deleteVariableClause
Delete a variable.
deleteTaskClause
Delete a task expert.
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.
See Also
OMBALTER, OMBCREATE EXPERT, OMBRETRIEVE EXPERT, OMBDROP EXPERT
Purpose
To alter an expert module.
Prerequisites
In the context of a project.
Syntax
alterExpertModuleCommand = OMBALTER ( EXPERT_MODULE "QUOTED_STRING" (
"renameClause" [ "alterPropertiesOrIconSetClause" ] |
"alterPropertiesOrIconSetClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterExpertModuleCommand
Alter the definition of an expert module.
renameClause
Rename the expert module.
alterPropertiesOrIconSetClause
Alter existing expert module properties and/or Icon Set.
setPropertiesClause
Set properties for the expert module.
Basic properties for EXPERT_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the expert module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the expert module
propertyNameList
The list of properties to set.
propertyValueList
The list of property values to set.
propertyValue
The value of the property.
See Also
OMBALTER, OMBCREATE EXPERT_MODULE, OMBDROP EXPERT_MODULE
Purpose
Alter the external table by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of an Oracle Module.
Syntax
alterExternalTableCommand = OMBALTER ( EXTERNAL_TABLE "QUOTED_STRING" (
"renameClause" [ "alterExternalTablePropertiesAndReferencesClause" ] [
"alterExternalTableObjectClauses" ] |
"alterExternalTablePropertiesAndReferencesClause" [
"alterExternalTableObjectClauses" ] |
"alterExternalTableObjectClauses" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterExternalTablePropertiesAndReferencesClause = SET (
"setPropertiesClause" [ SET ( REF | REFERENCE )
"alterReferencesToRecordAndLocationClauses" | UNSET ( REF | REFERENCE
) "unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
"alterReferencesToRecordAndLocationClauses" ) | UNSET ( REF |
REFERENCE ) "unsetReferenceIconSetClause"
alterExternalTableObjectClauses = ADD ( "addExternalTableObjectClause" [
"alterExternalTableObjectClauses" ] | "addDataRuleUsageClause" {
"alterDataRuleUsageClauses" } ) | MODIFY (
"modifyExternalTableObjectClause" [ "alterExternalTableObjectClauses"
] | "addDataRuleUsageClause" { "alterDataRuleUsageClauses" } ) |
DELETE ( "deleteExternalTableObjectClause" [
"alterExternalTableObjectClauses" ] | "deleteDataRuleUsageClause" {
"alterDataRuleUsageClauses" } )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
alterReferencesToRecordAndLocationClauses =
"setReferencesToRecordFileModuleClause" [
"setReferencesToLocationClause" ] [ SET ( REF | REFERENCE )
"setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause" ] | "setReferencesToFileAndModuleClause"
[ "setReferencesToLocationClause" ] [ SET ( REF | REFERENCE )
"setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause" ] | "setReferencesToLocationClause" [
SET ( REF | REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF |
REFERENCE ) "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause"
unsetReferenceIconSetClause = ICONSET
addExternalTableObjectClause = COLUMN "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setPropertiesAndReferencesToFieldClauses" ]
| "addExternalTableDatafileClause"
addDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING" SET REF DATA_RULE
"QUOTED_STRING" ( GROUP "QUOTED_STRING" SET REF ( TABLE | VIEW |
MATERIALIZED_VIEW | EXTERNAL_TABLE ) "QUOTED_STRING" ( ATTRIBUTE
"QUOTED_STRING" SET REF COLUMN "QUOTED_STRING" )+ )+ [ SET
"setPropertiesClause" ]
alterDataRuleUsageClauses = ADD "addDataRuleUsageClause" | MODIFY
"modifyDataRuleUsageClause" | DELETE "deleteDataRuleUsageClause"
modifyExternalTableObjectClause = COLUMN "QUOTED_STRING" ( "renameClause"
[ "moveExternalTableColumnToClause" ] [ SET
"setPropertiesAndReferencesToFieldClauses" ] |
"moveExternalTableColumnToClause" [ SET
"setPropertiesAndReferencesToFieldClauses" ] | SET
"setPropertiesAndReferencesToFieldClauses" ) | DATA_FILE
"QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" )
deleteExternalTableObjectClause = COLUMN "QUOTED_STRING" | DATA_FILE
"QUOTED_STRING"
deleteDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferencesToRecordFileModuleClause = RECORD "QUOTED_STRING" OF
FLAT_FILE "QUOTED_STRING"
setReferencesToLocationClause = DEFAULT_LOCATION "QUOTED_STRING"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
setReferencesToFileAndModuleClause = FLAT_FILE "QUOTED_STRING"
setPropertiesAndReferencesToFieldClauses = "setPropertiesClause" [ SET (
REF | REFERENCE ) "setReferencesToFieldClause" ] | ( REF | REFERENCE )
"setReferencesToFieldClause"
addExternalTableDatafileClause = DATA_FILE "QUOTED_STRING" [ SET
"setPropertiesClause" ]
modifyDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" )
moveExternalTableColumnToClause = MOVE TO POSITION "INTEGER_LITERAL"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setReferencesToFieldClause = FIELD "QUOTED_STRING"
Keywords And Parameters
alterExternalTableCommand
Alter the existing external table.
QUOTED_STRING
The name of the external table to alter.
renameClause
Rename the external table to the value of the following quoted string.
alterExternalTableObjectClauses
Add, modify, or delete columns or data files.
setPropertiesClause
Set specified properties of the external table.
addExternalTableObjectClause
Add a column to the external table. The name of the new column will be the
quoted string.
addDataRuleUsageClause
Add a data rule usage to the relation.
alterDataRuleUsageClauses
Add, modify, or delete data rule usages.
modifyExternalTableObjectClause
Modify the properties of a column or data file or move a column to a new
position.
deleteExternalTableObjectClause
Delete a column or data file.
deleteDataRuleUsageClause
Delete a data rule usage.
propertyNameList
The names of the properties whose values you want to set.
Basic properties for COLUMN:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the column
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the column
Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE,
TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2
Default: NUMBER
The datatype of a column
Name: LENGTH
Type: NUMBER
Valid Values:
Default: 1
The length of a number
Name: PRECISION
Type: NUMBER
Valid Values: 0 - 38
Default: 1
The precision of a number. Use 0 to specify floating-point numbers.
Name: SCALE
Type: NUMBER
Valid Values: -84 - 127
Default: 1
The scale of a number.
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.
Properties for EXTERNAL_TABLE:
Name: BAD_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: USE_DEFAULT_LOCATION
Description not available.
Name: BAD_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Description not available.
Name: DISCARD_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: USE_DEFAULT_LOCATION
Description not available.
Name: DISCARD_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: ENDIAN
Type: STRING
Valid Values: BIG, LITTLE, PLATFORM
Default: PLATFORM
Description not available.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: LOAD_NULLS_WHEN_MISSING_VALUES
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: LOG_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: USE_DEFAULT_LOCATION
Description not available.
Name: LOG_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: NLS_CHARACTERSET
Type: STRING
Valid Values: N/A
Default: ''
NLS Characterset of the file. When the Access Parameters property is
specified for the External Table, this configuration parameter is ignored.
Name: NUMBER_OF_REJECTS_ALLOWED
Type: NUMBER
Valid Values: 0 - 2147483647
Default: 0
Description not available.
Name: PARALLEL_ACCESS_DRIVERS
Type: NUMBER
Valid Values: 1 - 63999
Default: 1
Description not available.
Name: PARALLEL_ACCESS_MODE
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: REJECTS_ARE_UNLIMITED
Type: BOOLEAN
Valid Values: true, false
Default: true
Description not available.
Name: SHADOW_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Description not available.
Name: SHADOW_TABLE_NAME
Type: STRING(30)
Valid Values: N/A
Default: ''
Description not available.
Name: STRING_SIZES_IN
Type: STRING
Valid Values: BYTES, CHARACTERS
Default: BYTES
Description not available.
Name: TRIM
Type: STRING
Valid Values: BOTH, LEFT, NONE, RIGHT, SQL*LOADER
Default: NONE
Description not available.
Properties for DATA_FILE:
Name: DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: USE_DEFAULT_LOCATION
The location of this data file for the external table.
Name: DATA_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of this data file.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValueList
The values for the named properties.
setReferencesToRecordFileModuleClause
Specify the record and full path to the flat file for the external table to
reference.
setReferencesToLocationClause
Specify the default location for the external table.
setReferencesToFileAndModuleClause
Specify the full path to the flat file for the external table to reference.
setPropertiesAndReferencesToFieldClauses
Set the properties and/or field reference of the external table column.
addExternalTableDatafileClause
Add a new data file to the external table. The name of the new data file
will be the quoted string. You may also set the properties of the new data
file.
modifyDataRuleUsageClause
Rename or modify the properties of a data rule usage.
moveExternalTableColumnToClause
Move a column of the external table.
propertyValue
A property value.
setReferencesToFieldClause
Set the name of the field which the external table column references.
See Also
OMBALTER, OMBCREATE EXTERNAL_TABLE, OMBDROP EXTERNAL_TABLE, OMBRETRIEVE EXTERNAL_TABLE
Purpose
Alter the flat file by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of a flat file module.
Syntax
alterFlatFileCommand = OMBALTER ( FLAT_FILE "QUOTED_STRING" (
"renameClause" [ "alterPropertiesOrIconSetClause" ] {
"alterRecordClauses" } | "alterPropertiesOrIconSetClause" {
"alterRecordClauses" } | "alterRecordClauses" { "alterRecordClauses" }
) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
alterRecordClauses = ADD "addRecordClauseForAlter" | MODIFY
"modifyRecordClause" | DELETE "deleteRecordClause"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
addRecordClauseForAlter = RECORD "QUOTED_STRING" [ SET
"setPropertiesClause" ] { ADD "addFieldClauseForAlter" }
modifyRecordClause = RECORD "QUOTED_STRING" ( "renameClause" [ SET
"setPropertiesClause" ] { "alterFieldClauses" } | SET
"setPropertiesClause" { "alterFieldClauses" } | "alterFieldClauses" {
"alterFieldClauses" } )
deleteRecordClause = RECORD "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addFieldClauseForAlter = FIELD "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
alterFieldClauses = ADD "addFieldClauseForAlter" | MODIFY
"modifyFieldClause" | DELETE "deleteFieldClause"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
modifyFieldClause = FIELD "QUOTED_STRING" ( "renameClause" [
"moveFieldToClause" ] [ SET "setPropertiesClause" ] |
"moveFieldToClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" )
deleteFieldClause = FIELD "QUOTED_STRING"
moveFieldToClause = MOVE TO POSITION "INTEGER_LITERAL"
Keywords And Parameters
alterFlatFileCommand
Alter a flat file.
QUOTED_STRING
The name of the flat file to alter.
renameClause
Rename the flat file to the following quoted string.
alterRecordClauses
Add, modify, or drop a record of the flat file.
setPropertiesClause
Set the properties of the flat file, record, or field.
addRecordClauseForAlter
Add a record named by the following quoted string.
modifyRecordClause
Modify a record specified by the following quoted string.
deleteRecordClause
Delete a record specified by the following quoted string.
propertyNameList
The names of the properties whose values you want to set.
Properties for FLAT_FILE:
Name: DATA_FILE_NAME
Type: STRING
Valid Values: N/A
Default ''
The name of the "sampled" file. Also the default data file value used in
SQL*Loader maps and External Tables.
Name: IS_DELIMITED
Type: BOOLEAN
Valid Values: true, false, 1, 0
Default: true
True indicates that this flat file is delimited. False indicates that its
fields are defined by fixed lengths
Name: CHARACTERSET
Type: STRING
Valid Values:
AL24UTFFSS,AR8ARABICMAC,AR8ARABICMACS,AR8ISO8859P6,AR8MSAWIN,AR8MSWIN1256,BLT8CP921,BLT8EBCDIC1112,BLT8MSWIN1257,BLT8PC775,CDN8PC863,CL8EBCDIC1025,CL8EBCDIC1025X,CL8ISO8859P5,CL8KOI8R,CL8MACCYRILLIC,CL8MACCYRILLICS,CL8MSWIN1251,D8EBCDIC273,DK8EBCDIC277,EE8EBCDIC870,EE8ISO8859P2,EE8MACCE,EE8MACCES,EE8MACCROATIAN,EE8MACCROATIANS,EE8MSWIN1250,EE8PC852,EL8EBCDIC875,EL8ISO8859P7,EL8MACGREEK,EL8MACGREEKS,EL8MSWIN1253,EL8PC437S,EL8PC737,EL8PC869,F8EBCDIC297,I8EBCDIC280,IS8MACICELANDIC,IS8MACICELANDICS,IS8PC861,IW8EBCDIC424,IW8ISO8859P8,IW8MACHEBREW,IW8MACHEBREWS,IW8MSWIN1255,JA16EBCDIC930,JA16EUC,JA16EUCYEN,JA16MACSJIS,JA16SJIS,JA16SJISYEN,JA16VMS,KO16KSC5601,LT8MSWIN921,N8PC865,NEE8ISO8859P4,RU8PC855,RU8PC866,S8EBCDIC278,SE8ISO8859P3,TH8MACTHAI,TH8MACTHAIS,TH8TISASCII,TR8EBCDIC1026,TR8MACTURKISH,TR8MACTURKISHS,TR8MSWIN1254,TR8PC857,US7ASCII,US8PC437,UTF8,WE8EBCDIC284,WE8EBCDIC285,WE8EBCDIC37,WE8EBCDIC37C,WE8EBCDIC500,WE8EBCDIC500C,WE8EBCDIC871,WE8ISO8859P1,WE8ISO8859P9,WE8MACROMAN8,WE8MACROMAN8S,WE8MSWIN1252,WE8PC850,WE8PC860,ZHS16CGB231280,ZHS16GBK,ZHS16MACCGB231280,ZHT16BIG5,ZHT16MSWIN950,ZHT32EUC
Default: WE8MSWIN1252
The character set of the data file.
Name: RECORD_DELIMITER
Type: STRING
Valid Values: N/A
Default: ''
The character(s) which denote the end of a physical record in a data file.
A hex value may be entered by entering embedded single quotes twice as:
'x''0f''' (all are single quotes). The outside single quote indicates a
quoted string and the inside single quotes single-quote x single-quote
single-quote 0F single-quote single-quote single-quote. (Please note
that this is not the FIELD_DELIMITER.
Name: RECORD_LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0 (Records are delimited by default)
The length (in characters) of the records in the data file.
Name: RECORD_TYPE_COLUMN_NUMBER
Type: NUMBER
Valid Values: 0+
Default: 0
The column which contains the record type values for a delimited,
multi-record type file.
Name: RECORD_TYPE_START_POSITION
Type: NUMBER
Valid Values: 0+
Default: 0
The starting position of the field (relative to 0) which contains the
record type values for a fixed-length, multi-record type file.
Name: RECORD_TYPE_END_POSITION
Type: NUMBER
Valid Values: 0+
Default: 0
The ending position of the field (relative to 0) which contains the record
type values for a fixed-length, multi-record type file.
Name: NUMBER_OF_RECORDS_TO_SKIP
Type: NUMBER
Valid Values: 0 - 1000
Default: 0
The default number of records to skip when loading this file.
Name: FIELD_DELIMITER
Type: STRING
Valid Values: Any single character
Default: ',' (Comma)
The character to divide the fields in a delimited file.
Name: FIELD_LEFT_ENCLOSURE
Type: STRING
Valid Values: Any single character
Default: None
A character to enclose fields which may contain the field delimiter.
Name: FIELD_RIGHT_ENCLOSURE
Type: STRING
Valid Values: Any single character
Default: None
A character to enclose fields which may contain the field delimiter.
Name: NUMBER_OF_PHYSICAL_RECORDS_PER_LOGICAL
Type: Number
Valid Values: 0+
Default: 0
Set this value if you wish to concatenate a fixed number of physical
records to form a single logical record.
Name: CONTINUE_IF_ENDS_WITH
Type: STRING
Valid Values: Any single character
Default: None
Set this value if you wish to concatenate a variable number of physical
records to form a single logical record, determined by records ending with
this character.
Name: CONTINUE_IF_STARTS_WITH
Type: STRING
Valid Values: N/A
Default: None
Set this value if you wish to concatenate a variable number of physical
records to form a single logical record, determined by records beginning
with this character.
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the record
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the record
Properties for RECORD:
Name: RECORD_TYPE_VALUE
Type: STRING
Valid Values: N/A
Default: None
This is a mandatory property for each record of a multi-record type file.
It is the string which will identify this record type in the data file.
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the record
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the record
Properties for FIELD:
Name: DATATYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE,
FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER
EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH,
LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH
LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARRAW,
VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
This is the SQL*Loader data type for the field.
Name: MAXIMUM_LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0
This is the maximum length of the field.
Name: LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0
Depreciated. This is the length of the field in a fixed length file. This
is the max length of the field in a delimited file.
Name: PRECISION
Type: NUMBER
Valid Values: Depends on data type
Default: 0
Precision of the field.
Name SCALE
Type: NUMBER
Valid Values: Depends on data type
Default: 0
Scale of the field
Name: START_POSITION
Type: NUMBER
Valid Values: 1+
Default: 1
The starting position of a field for a fixed length file.
Name: END_POSITION
Type: NUMBER
Valid Values: 1+
Default: 1
The ending position of a field for a fixed length file.
Name: SQL_DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE,
TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: DEFAULT. This will derive the SQL_DATATYPE from the value of
DATATYPE.
The data type which the field will be treated as in mapping and for
External Tables.
Name: SQL_LENGTH
Type: NUMBER
Valid Values: 1 - 4000
Default: 0
Name: SQL_PRECISION
Type: NUMBER
Valid Values: 1 - 38
Default: 1
Name: SQL_SCALE
Type: NUMBER
Valid Values: -84 - 127
Default: 0
Name: MASK
Type: STRING
Valid Values: N/A
Default: None
This is the mask used to define the format of DATE fields in the data file.
Name: NULL_IF
Type: STRING
Valid Values: Either = or != followed by either 'BLANKS', a single quoted
string, or a hexadecimal string
Default: None
If this condition is true for a field, the value loaded will be NULL.
Name: DEFAULT_IF
Type: STRING
Valid Values: Either = or != followed by either 'BLANKS', a single quoted
string, or a hexadecimal string
Default: None
If this condition is true for a field, the value loaded will be either NULL
or 0, dependent on data type.
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the field
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the field
propertyValueList
The values for the named properties.
addFieldClauseForAlter
Add a field to the record.
alterFieldClauses
Add, modify, or drop a field.
propertyValue
A property value.
modifyFieldClause
Modify the properties of a field specified by the following quoted string.
deleteFieldClause
Delete a field specified by the following quoted string.
moveFieldToClause
Move a field to a new position in the record.
See Also
OMBALTER, OMBCREATE FLAT_FILE, OMBDROP FLAT_FILE
Purpose
Alter the flat file module by renaming it, and/or reseting its properties.
Prerequisites
Should be in the context of a project.
Syntax
alterFlatFileModuleCommand = OMBALTER ( FLAT_FILE_MODULE "QUOTED_STRING" (
"renameClause" [
"alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
"alterPropertiesOrReferenceClauseForDataMetadataModule" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrReferenceClauseForDataMetadataModule = ( ( SET ( (
"alterPropertiesClause" [ ( SET
"setReferenceClauseForDataMetadataModule" [ UNSET
"unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
"unsetReferenceClauseForDataMetadataModule" [ SET
"setReferenceClauseForDataMetadataModule" ] ) ] ) | (
"setReferenceClauseForDataMetadataModule" [ UNSET
"unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
"unsetReferenceClauseForDataMetadataModule" [ SET
"setReferenceClauseForDataMetadataModule" ] ) ) [
"addOrRemoveOrModifyModuleReferenceLocationClause" ]
alterPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataMetadataModule = ( "setReferenceLocationClause" [
SET "setReferenceMetadataLocationOrIconSetClause" ] |
"setReferenceMetadataLocationOrIconSetClause" )
unsetReferenceClauseForDataMetadataModule = (
"unsetReferenceLocationClause" [ UNSET
"unsetReferenceMetadataLocationOrIconSetClause" ] |
"unsetReferenceMetadataLocationOrIconSetClause" )
addOrRemoveOrModifyModuleReferenceLocationClause = (
"addReferenceLocationClause" | "removeReferenceLocationClause" |
"modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
"removeReferenceLocationClause" | "modifyReferenceLocationClause" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceMetadataLocationOrIconSetClause = (
"setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
] | "setReferenceIconSetClause" )
unsetReferenceLocationClause = ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
unsetReferenceMetadataLocationOrIconSetClause = (
"unsetReferenceMetadataLocationClause" [ UNSET
"unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
addReferenceLocationClause = ADD ( REFERENCE | REF ) LOCATION
"QUOTED_STRING" [ SET AS DEFAULT ]
removeReferenceLocationClause = REMOVE ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
modifyReferenceLocationClause = MODIFY ( REFERENCE | REF ) LOCATION
"QUOTED_STRING" SET AS DEFAULT
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setReferenceMetadataLocationClause = ( REFERENCE | REF ) METADATA_LOCATION
"QUOTED_STRING"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceMetadataLocationClause = ( REFERENCE | REF )
METADATA_LOCATION "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
Keywords And Parameters
alterFlatFileModuleCommand
Alter a flat file module.
QUOTED_STRING
The name of the flat file module to alter.
renameClause
Rename the flat file module.
QUOTED_STRING
The new name for the flat file module.
setReferenceClauseForDataMetadataModule
Set location and/or icon set for the flat file module.
unsetReferenceClauseForDataMetadataModule
Unset location and/or icon set for the flat file module.
addOrRemoveOrModifyModuleReferenceLocationClause
Add/remove/modify runtime location for the flat file module.
propertyNameList
The names of the properties whose values you want to set.
Basic properties for FLAT_FILE_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of the flat file module.
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the flat file module.
propertyValueList
The values for the named properties.
setReferenceLocationClause
Set a location to the existing flat file module.
setReferenceMetadataLocationOrIconSetClause
Set metadata location and/or icon set for the flat file module.
unsetReferenceLocationClause
Unset a location to the existing flat file module.
unsetReferenceMetadataLocationOrIconSetClause
Unset metadata location and/or icon set for the flat file module.
addReferenceLocationClause
Add a runtime location to the flat file module.
removeReferenceLocationClause
Remove a runtime location from the flat file module.
modifyReferenceLocationClause
Modify a runtime location of the flat file module.
propertyValue
A property value.
setReferenceMetadataLocationClause
Set metadata location for the flat file module.
setReferenceIconSetClause
Set icon set for the flat file module.
unsetReferenceMetadataLocationClause
Unset metadata location for the flat file module.
unsetReferenceIconSetClause
Unset icon set for the flat file module.
See Also
OMBALTER, OMBCREATE FLAT_FILE_MODULE, OMBDROP FLAT_FILE_MODULE
Purpose
Alter the Function by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of a Oracle Module or Package or Transformation
Module.
A Transformation Module may be WB_CUSTOM_TRANS for Public Transformations.
WB_CUSTOM_TRANS may by modified by an administrator.
WB_CUSTOM_TRANS is not dependent on any project.
Syntax
alterFunctionCommand = OMBALTER ( FUNCTION "QUOTED_STRING" (
"renameClause" [ "alterPropertiesOrIconSetClause" ] [
"alterFuncProcParameterSCOClause" ] | "alterPropertiesOrIconSetClause"
[ "alterFuncProcParameterSCOClause" ] |
"alterFuncProcParameterSCOClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
alterFuncProcParameterSCOClause = ( ADD ( "alterFuncProcParameterClause" |
"addRelationalDependentClause" ) | MODIFY
"modifyFuncProcParameterClause" | DELETE (
"deleteFuncProcParameterClause" | "deleteRelationalDependentClause" )
) [ "alterFuncProcParameterSCOClause" ]
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterFuncProcParameterClause = PARAMETER "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
addRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
"QUOTED_STRING"
modifyFuncProcParameterClause = ( PARAMETER "QUOTED_STRING" (
"renameClause" | "moveToClause" | [ SET "setPropertiesClause" ] ) )
deleteFuncProcParameterClause = ( PARAMETER "QUOTED_STRING" )
deleteRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
"QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
moveToClause = MOVE TO POSITION "INTEGER_LITERAL"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterFunctionCommand
This command modifies an existing Function.
QUOTED_STRING
Name of the existing Function in single quotes.
renameClause
Rename a Function.
alterFuncProcParameterSCOClause
Modify, delete or add a Parameter for Function/Procedure, or add or delete
dependencies to some other relational objects.
setPropertiesClause
Used to set properties (core, user-defined) for function. Valid properties
are shown below:
Basic properties for FUNCTION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Function
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Function
Name: RETURN_TYPE
Type: STRING
Valid Values: PLS_INTEGER, BINARY_INTEGER, BOOLEAN, NUMBER, FLOAT, CHAR,
VARCHAR, VARCHAR2, DATE
Default: NUMBER
Set the Return Type for Function
Name: IMPLEMENTATION
Type: STRING
Valid Values: N/A
Default: ''
Set the code for Function which is included global variable declaration and
code between BEGIN and END.
Name: IS_DETERMINISTIC
Type: BOOLEAN
Valid Values: true, false
Default: false
This setting helps the optimizer avoid redundant function calls.
Name: IS_PARALLEL_ENABLE
Type: BOOLEAN
Valid Values: true, false
Default: false
This option sets flag to a stored function can be used safely in the slave
sessions of parallel DML evaluations.
Basic properties for PARAMETER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Parameter
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Parameter
Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BINARY_INTEGER, BLOB, BOOLEAN,
CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO
MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, PLS_INTEGER, RAW, TIMESTAMP,
TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR,
VARCHAR2, XMLTYPE
Default: NUMBER
Set the data type for Parameter
Name: IN_OUT
Type: STRING
Valid Values: IN, OUT, INOUT
Default: 'IN'
Set the parameter mode for Parameter
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Set the default value for Parameter
Properties for FUNCTION:
Name: AUTHID
Type: STRING
Valid Values: Current_User, Definer, None
Default: None
Generate the transformation with selected AUTHID option. Function will be
executed with the permissions defined by the AUTHID clause rather than the
function owner's permissions.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
alterFuncProcParameterClause
This clause alters Parameter of a Function.
addRelationalDependentClause
This clause adds referential dependencies to other relational objects.
modifyFuncProcParameterClause
Modify one or more Parameters to this Function/Procedure.
deleteFuncProcParameterClause
Delete one or more Parameters to this Function/Procedure.
deleteRelationalDependentClause
This clause deletes referential dependencies to other relational objects.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
moveToClause
Move a Parameters of this Function/Procedure.
propertyValue
Value of a property.
See Also
OMBALTER, OMBCREATE FUNCTION, OMBDROP FUNCTION
Purpose
Alter the Gateway module by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of project.
Syntax
alterGatewayModuleCommand = OMBALTER ( GATEWAY_MODULE "QUOTED_STRING" (
"renameClause" [
"alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
"alterPropertiesOrReferenceClauseForDataMetadataModule" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrReferenceClauseForDataMetadataModule = ( ( SET ( (
"alterPropertiesClause" [ ( SET
"setReferenceClauseForDataMetadataModule" [ UNSET
"unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
"unsetReferenceClauseForDataMetadataModule" [ SET
"setReferenceClauseForDataMetadataModule" ] ) ] ) | (
"setReferenceClauseForDataMetadataModule" [ UNSET
"unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
"unsetReferenceClauseForDataMetadataModule" [ SET
"setReferenceClauseForDataMetadataModule" ] ) ) [
"addOrRemoveOrModifyModuleReferenceLocationClause" ]
alterPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataMetadataModule = ( "setReferenceLocationClause" [
SET "setReferenceMetadataLocationOrIconSetClause" ] |
"setReferenceMetadataLocationOrIconSetClause" )
unsetReferenceClauseForDataMetadataModule = (
"unsetReferenceLocationClause" [ UNSET
"unsetReferenceMetadataLocationOrIconSetClause" ] |
"unsetReferenceMetadataLocationOrIconSetClause" )
addOrRemoveOrModifyModuleReferenceLocationClause = (
"addReferenceLocationClause" | "removeReferenceLocationClause" |
"modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
"removeReferenceLocationClause" | "modifyReferenceLocationClause" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceMetadataLocationOrIconSetClause = (
"setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
] | "setReferenceIconSetClause" )
unsetReferenceLocationClause = ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
unsetReferenceMetadataLocationOrIconSetClause = (
"unsetReferenceMetadataLocationClause" [ UNSET
"unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
addReferenceLocationClause = ADD ( REFERENCE | REF ) LOCATION
"QUOTED_STRING" [ SET AS DEFAULT ]
removeReferenceLocationClause = REMOVE ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
modifyReferenceLocationClause = MODIFY ( REFERENCE | REF ) LOCATION
"QUOTED_STRING" SET AS DEFAULT
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setReferenceMetadataLocationClause = ( REFERENCE | REF ) METADATA_LOCATION
"QUOTED_STRING"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceMetadataLocationClause = ( REFERENCE | REF )
METADATA_LOCATION "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
Keywords And Parameters
alterGatewayModuleCommand
This command modifies an existing Gateway module.
QUOTED_STRING
Name of the existing Gateway module in single quotes.
renameClause
Rename the Gateway module.
alterPropertiesOrReferenceClauseForDataMetadataModule
Alter existing Gateway module's properties and/or locations and/or icon
sets.
setReferenceClauseForDataMetadataModule
Set location and/or icon set for the gateway module.
addOrRemoveOrModifyModuleReferenceLocationClause
Add/remove/modify runtime location for the Gateway module.
setReferenceLocationClause
Set a location to the existing Gateway module.
setReferenceMetadataLocationOrIconSetClause
Set metadata location and/or icon set for the gateway module.
unsetReferenceLocationClause
Unset a location to the existing Gateway module.
unsetReferenceMetadataLocationOrIconSetClause
Unset metadata location and/or icon set for the gateway module.
addReferenceLocationClause
Add a runtime location to the gateway module.
removeReferenceLocationClause
Remove a runtime location from the gateway module.
setReferenceMetadataLocationClause
Set metadata location for the gateway module.
setReferenceIconSetClause
Set icon set for the gateway module.
unsetReferenceMetadataLocationClause
Unset metadata location for the gateway module.
unsetReferenceIconSetClause
Unset icon set for the gateway module.
See Also
OMBALTER, OMBCREATE GATEWAY_MODULE, OMBDROP GATEWAY_MODULE
Purpose
To modify one or more properties of an iconset, including renaming it.
Prerequisites
Any context.
Syntax
alterIconSetCommand = OMBALTER ( ICONSET "QUOTED_STRING" ( "renameClause"
[ SET "setPropertiesClause" ] | SET "setPropertiesClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterIconSetCommand
This command alters the properties of an iconset.
QUOTED_STRING
The name of the iconset to alter.
renameClause
Renames an iconset to a different name.
QUOTED_STRING
New name to set for the iconset.
setPropertiesClause
This clause sets a list properties to the specified values.
Basic properties for ICONSET:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the iconset
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the iconset
Name: BELONGS_TO_GROUP
Type: STRING
Valid Values: N/A
Default: ''
Name of the Group to which the iconset belongs
Name: CANVAS_ICON
Type: STRING
Valid Values: N/A
Default: ''
URL of the canvas icon (36x36)
Name: PALETTE_ICON
Type: STRING
Valid Values: N/A
Default: ''
URL of the palette icon (18x18)
Name: TREE_ICON
Type: STRING
Valid Values: N/A
Default: ''
URL of the tree icon (16x16)
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
A property value.
See Also
OMBALTER, OMBCREATE ICONSET, OMBDROP ICONSET
Purpose
To modify a transient import action plan.
Prerequisites
In the context of a project.
Syntax
alterImportActionPlanCommand = ( OMBALTER ( IMPORT_ACTION_PLAN )
"QUOTED_STRING" ( "alterActionPlanClause" { "alterActionPlanClause" }
) )
alterActionPlanClause = "renameActionPlanClause" | "addActionClause" |
"deleteActionClause" | "modifyActionClause"
renameActionPlanClause = RENAME TO "QUOTED_STRING"
addActionClause = ADD ACTION "QUOTED_STRING" ( "setPropertiesClause" [
"setRefSourceAndTargetClause" ] | "setRefSourceAndTargetClause" )
deleteActionClause = DELETE ACTION "QUOTED_STRING"
modifyActionClause = MODIFY ACTION "QUOTED_STRING" "modifyActionOperation"
{ "modifyActionOperation" }
setPropertiesClause = SET PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setRefSourceAndTargetClause = SET ( REF | REFERENCE ) "sourcesClause" SET
( REF | REFERENCE ) "targetClause"
modifyActionOperation = "renameActionClause" | "setPropertiesClause" |
"setRefSourceClause" | "setRefTargetClause" | "deleteSourceClause" |
"unsetTargetReferenceClause"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
sourcesClause = SOURCE "ObjType" "QUOTED_STRING" [ SET ( REF | REFERENCE )
"sourcesClause" ]
targetClause = TARGET "ObjType" "QUOTED_STRING"
renameActionClause = RENAME TO "QUOTED_STRING"
setRefSourceClause = SET ( REF | REFERENCE ) "sourcesClause"
setRefTargetClause = SET ( REF | REFERENCE ) "targetClause"
deleteSourceClause = UNSET ( REF | REFERENCE ) SOURCE "ObjType"
"QUOTED_STRING"
unsetTargetReferenceClause = UNSET ( REF | REFERENCE ) TARGET
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterImportActionPlanCommand
This command is for changing the details of an existing import action plan.
QUOTED_STRING
The name of the transient import action plan to be altered.
alterActionPlanClause
One modification to the import action plan.
renameActionPlanClause
For renaming the action plan.
QUOTED_STRING
The new name for the import action plan.
addActionClause
For adding an action to the import action plan.
QUOTED_STRING
The name of the action to be added.
deleteActionClause
For deleting an existing action.
QUOTED_STRING
The name of the action to be deleted.
modifyActionClause
For changing details of an existing action in the import action plan.
setPropertiesClause
For setting any properties for the import action. For the current release,
there are no predefined property for import actions.
setRefSourceAndTargetClause
For specifying source and target objects for the import action. The source
objects are to be imported into target.
modifyActionOperation
The clause for modifying details of an action.
renameActionClause
For renaming the action.
QUOTED_STRING
The new name for the action.
deleteSourceClause
For deleting a source item from the list of source items of this action.
QUOTED_STRING
The name of the source object. Note that the name of the source object must
be qualified with schema name, such as 'SCOTT.EMP'.
unsetTargetReferenceClause
For removing the pointer to target object from the import action.
See Also
OMBCREATE IMPORT_ACTION_PLAN, OMBIMPORT
Purpose
Alters an item folder.
Prerequisites
Should be in the context of a Business Definition Module or use the full
path.
Syntax
alterItemFolderCommand = ( OMBALTER ITEM_FOLDER "QUOTED_STRING" ( (
"renameClause" [ SET "setpropertiesClauseDelayed" ] [ SET
"setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
{ "alterItemFolderSCOClauses" } ) | ( SET "setpropertiesClauseDelayed"
[ SET "setReferenceIconSetClause" ] [ UNSET
"unsetReferenceIconSetClause" ] { "alterItemFolderSCOClauses" } ) | (
SET "setReferenceIconSetClause" [ UNSET "unsetReferenceIconSetClause"
] { "alterItemFolderSCOClauses" } ) | ( UNSET
"unsetReferenceIconSetClause" { "alterItemFolderSCOClauses" } ) | (
"alterItemFolderSCOClauses" { "alterItemFolderSCOClauses" } ) ) )
renameClause = RENAME TO "QUOTED_STRING"
setpropertiesClauseDelayed = PROPERTIES "(" "propertyNameListVector" ")"
VALUES "(" "propertyValueListVector" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterItemFolderSCOClauses = ADD ( "addItemClauseForAlter" |
"addConditionClauseForAlter" | "addJoinClause" ) | MODIFY (
"modifyItemClause" | "modifyConditionClause" | "modifyJoinClause" ) |
DELETE ( "deleteItemClause" | "deleteConditionClause" |
"deleteJoinClause" ) | UNSET "unsetJoinUsageClause"
propertyNameListVector = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueListVector = "propertyValue" { "," "propertyValue" }
addItemClauseForAlter = ITEM "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setPropertiesClause" ] [ SET ( REF |
REFERENCE ) ( "ItemItemReferencesClause" |
"ItemListOfValuesReferencesClause" |
"ItemDrillToDetailReferencesClause" |
"ItemAlternativeSortOrderReferencesClause" |
"ItemColumnReferencesClause" ) ]
addConditionClauseForAlter = CONDITION "QUOTED_STRING" [ SET
"setPropertiesClause" ]
addJoinClause = JOIN "QUOTED_STRING" [ SET "setPropertiesClause" ] [ SET (
REF | REFERENCE ) "JoinForeignKeyReferencesClause" ] {
"joinComponentClause" }
modifyItemClause = ITEM "QUOTED_STRING" [ "renameClause" ] [
"moveItemToClause" ] [ SET "setPropertiesClause" ] [ UNSET ( REF |
REFERENCE ) ( COLUMN | LIST_OF_VALUES | DRILL_TO_DETAIL |
ALTERNATIVE_SORT_ORDER ) ] [ SET ( REF | REFERENCE ) (
"ItemItemReferencesClause" | "ItemListOfValuesReferencesClause" |
"ItemDrillToDetailReferencesClause" |
"ItemAlternativeSortOrderReferencesClause" |
"ItemColumnReferencesClause" ) ]
modifyConditionClause = CONDITION "QUOTED_STRING" ( [ "renameClause" ] [
SET "setPropertiesClause" ] )
modifyJoinClause = JOIN "QUOTED_STRING" ( [ "renameClause" ] [ SET
"setPropertiesClause" ] [ UNSET ( REF | REFERENCE ) FOREIGN_KEY ] {
"alterJoinComponentSCOClauses" } )
deleteItemClause = ITEM "QUOTED_STRING"
deleteConditionClause = CONDITION "QUOTED_STRING"
deleteJoinClause = JOIN "QUOTED_STRING"
unsetJoinUsageClause = ( REF | REFERENCE ) USING JOIN "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
ItemItemReferencesClause = ITEM "QUOTED_STRING" OF ITEM_FOLDER
"QUOTED_STRING" "itemJoinUsages"
ItemListOfValuesReferencesClause = LIST_OF_VALUES "QUOTED_STRING"
ItemDrillToDetailReferencesClause = DRILL_TO_DETAIL "QUOTED_STRING"
ItemAlternativeSortOrderReferencesClause = ALTERNATIVE_SORT_ORDER
"QUOTED_STRING"
ItemColumnReferencesClause = COLUMN "QUOTED_STRING" OF ( TABLE | (
EXTERNAL_TABLE | VIEW ) ) "QUOTED_STRING"
JoinForeignKeyReferencesClause = FOREIGN_KEY "QUOTED_STRING" OF ( TABLE |
VIEW ) "QUOTED_STRING"
joinComponentClause = ADD JOIN_COMPONENT "QUOTED_STRING" [ SET
"setPropertiesClause" ] { SET ( REF | REFERENCE )
"setJoinComponentClauseDetails" }
moveItemToClause = MOVE TO POSITION "INTEGER_LITERAL"
alterJoinComponentSCOClauses = ADD "joinComponentClauseforAlter" | MODIFY
"modifyJoinComponentClause" | DELETE "deleteJoinComponentClause"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
itemJoinUsages = { SET ( REF | REFERENCE ) USING JOIN "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING" }
setJoinComponentClauseDetails = LOCAL ITEM "QUOTED_STRING" | REMOTE ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
joinComponentClauseforAlter = JOIN_COMPONENT "QUOTED_STRING" [ SET
"setPropertiesClause" ] { SET ( REF | REFERENCE )
"setJoinComponentClauseDetails" }
modifyJoinComponentClause = JOIN_COMPONENT "QUOTED_STRING" [
"renameClause" ] [ SET "setPropertiesClause" ] [ SET ( REF | REFERENCE
) "setJoinComponentClauseDetails" ] [ UNSET ( REF | REFERENCE )
"unsetJoinComponentClauseDetails" ]
deleteJoinComponentClause = JOIN_COMPONENT "QUOTED_STRING"
unsetJoinComponentClauseDetails = LOCAL ITEM | REMOTE ITEM
Keywords And Parameters
alterItemFolderCommand
This clause alters an item folder.
QUOTED_STRING
name of the item folder.
renameClause
Renames an item folder with a different name.
setpropertiesClauseDelayed
This clause sets the properties.
setReferenceIconSetClause
Set specified Icon Set.
unsetReferenceIconSetClause
Unset specified Icon Set.
alterItemFolderSCOClauses
This clause modifies the contents of the item folder.
propertyNameListVector
This clause holds the names of the properties.
propertyValueListVector
This clause holds the values of the properties.
addItemClauseForAlter
This clause adds an item to an item folder.
QUOTED_STRING
name of the item.
addConditionClauseForAlter
This clause adds a condition to an item folder.
QUOTED_STRING
name of the condition.
addJoinClause
This clause adds a join to an item folder.
QUOTED_STRING
name of the join.
modifyItemClause
This clause modifies an item in an item folder.
QUOTED_STRING
name of the item.
modifyConditionClause
This clause modifies a condition in an item folder.
QUOTED_STRING
name of the condition.
modifyJoinClause
This clause modifies a join in an item folder.
QUOTED_STRING
name of the join.
deleteItemClause
This clause deletes an item from an item folder.
QUOTED_STRING
name of the item.
deleteConditionClause
This clause deletes a condition from an item folder.
QUOTED_STRING
name of the condition.
deleteJoinClause
This clause deletes a join from an item folder.
QUOTED_STRING
name of the join.
unsetJoinUsageClause
removes a join usage.
propertyValue
This is a property value.
setPropertiesClause
This clause sets the properties of the object.
Basic properties for ITEM_FOLDER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the item folder
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the item folder
Name: EXTERNAL_TABLE_NAME
Type: STRING(255)
Valid Values: N/A
Default: ''
The physical name for the corresponding table or view. This is
automatically set if the Folder is associated with a Table
Name: VISIBLE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the item folder should be visible to the user
Name: FOLDER_TYPE
Type: STRING(40)
Valid Values: SIMPLE, COMPLEX
Default: ''
The type of item folder
Basic properties for ITEM:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the item
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the item
Name: ALIGNMENT
Type: STRING(40)
Valid Values: GENERAL, LEFT, CENTER, RIGHT
Default: 'GENERAL'
The default alignment for displaying the item
Name: DISPLAY_CASE
Type: STRING(40)
Valid Values: GENERAL, LOWER, UPPER, INITCAPPED
Default: 'GENERAL'
How alphabetic characters should be displayed
Name: CASE_STORAGE
Type: STRING(40)
Valid Values: GENERAL, LOWER, UPPER, MIXED
Default: 'GENERAL'
How alphabetic characters are stored
Name: CONTENT_TYPE
Type: STRING(40)
Valid Values: No Value or FILE. For datatypes such as BLOB, it may contain
a file extension such as DOC, AVI, WAV, JPG
Default: ''
Details on whether the Item contains a file name or should be processed by
an external application
Name: DEFAULT_AGGREGATE
Type: STRING(255)
Valid Values: Detail, AVG, COUNT, MAX, MIN, SUM
Default: 'SUM' when the datatype is Numeric, 'Detail' otherwise
Name of the default rollup function for the item
Name: DEFAULT_POSITION
Type: STRING(40)
Valid Values: MEASURE, TOP OR SIDE, TOP, SIDE, PAGE
Default: 'MEASURE' when the datatype is NUMBER or FLOAT, 'TOP OR SIDE'
otherwise
Default position for the item
Name: REPLACE_NULL_WITH
Type: STRING(255)
Valid Values: N/A
Default: ''
The value to be displayed for null values
Name: FORMULA
Type: STRING
Valid Values: N/A
Default: ''
The text of the derivation expression for a derived item
Name: EXTERNAL_COLUMN_NAME
Type: STRING(255)
Valid Values: N/A
Default: ''
The external name of the corresponding column. This is automatically set
if the Item is is associated with a Column
Name: FORMAT_MASK
Type: STRING(255)
Valid Values: N/A
Default: ''
The display format mask for the item
Name: HEADING
Type: STRING(255)
Valid Values: N/A
Default: ''
The displayed heading text for the item
Name: DATATYPE
Type: STRING(40)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH
NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.ROW_LCR, TIMESTAMP,
TIMESTAMP WITH LOCAL TIME ZONE
TIMESTAMP WITH TIME ZONE, UNSPECIFIED, VARCHAR, VARCHAR2, XMLTYPE,
SYS.XMLFORMAT, BLAST_ALIGN_PLSQLRECORDTYPE
SYS.LCR$_ROW_RECORD, BLAST_SQL_TABLE_OF_NUMBERS, SYS.XMLSEQUENCETYPE,
SYS_REFCURSOR, BLAST_MATCH_PLSQLRECORDTYPE
Default: 'VARCHAR2'
The datatype for the item
Name: VISIBLE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the item should be visible to the user
Name: MAX_CHAR_FETCHED
Type: Number
Valid Values: N/A
Default: ''
The maximum number of characters fetched for an item
Name: DEFAULT_WIDTH
Type: Number
Valid Values: N/A
Default: ''
The default number of characters to display
Name: WORD_WRAP
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether wordwrap is allowed in the display
Basic properties for JOIN:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the join
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the join
Name: OUTER_JOIN_ON_MASTER
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether detail rows with no related master row should be included in the
join
Name: OUTER_JOIN_ON_DETAIL
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether master rows with no related detail rows should be included in the
join
Name: EXTERNAL_KEY_NAME
Type: STRING(255)
Valid Values: N/A
Default: ''
The external name of the corresponding foreign key. This is automatically
set if the Join is is associated with a Foreign Key
Name: DETAIL_ALWAYS_HAS_MASTER
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether every detail row must reference a unique master row
Name: ONE_TO_ONE
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether a master row only ever has a single detail row
Basic properties for JOIN_COMPONENT:
Name: JOIN_OPERATOR
Type: STRING(200)
Valid Values: =, <>, <, <=, > or >=
Default: ''
Business name of the join
Basic properties for CONDITION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the condition
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the condition
Name: MATCH_CASE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the case of alphabetic characters must match exactly
Name: FORMULA
Type: STRING
Valid Values: N/A
Default: ''
The expression for the condition
Name: MANDATORY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the Condition is optional or mandatory
Properties for ITEM_FOLDER:
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
Location for the referenced database object
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts
to create an object only for those objects marked as Deployable = true
Name: OPTIMIZER_HINT
Type: STRING
Valid Values: N/A
Default: ''
Optimizer Hint to be added when this Item Folder is used in a query
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
ItemItemReferencesClause
This clause is used to reference another item.
QUOTED_STRING
name of the referenced item.
ItemListOfValuesReferencesClause
This clause is used to reference a list of values.
QUOTED_STRING
name of the list of values.
ItemDrillToDetailReferencesClause
This clause is used to reference a drill to detail.
QUOTED_STRING
name of the drill to detail.
ItemAlternativeSortOrderReferencesClause
This clause is used to reference an alternative sort order.
QUOTED_STRING
name of the alternative sort order.
ItemColumnReferencesClause
This clause is used to reference a column.
QUOTED_STRING
name of the referenced column.
JoinForeignKeyReferencesClause
The foreign key reference.
joinComponentClause
The join components.
moveItemToClause
This clause is for positioning an item in an item folder.
alterJoinComponentSCOClauses
This clause alters the structure of the join component.
propertyNameList
This is the list of property names.
propertyValueList
This is the list of property values.
itemJoinUsages
The specific joins to be used.
setJoinComponentClauseDetails
The structure of the join component.
joinComponentClauseforAlter
This clause adds a join component.
modifyJoinComponentClause
This clause modifies a join component for a join.
deleteJoinComponentClause
This clause deletes a join component.
unsetJoinComponentClauseDetails
This clause updates the join component details.
See Also
OMBCREATE ITEM_FOLDER, OMBRETRIEVE ITEM_FOLDER
Purpose
Alters a list of values.
Prerequisites
Should be in the context of a business definition module or use the full
path.
Syntax
alterListOfValuesCommand = ( OMBALTER LIST_OF_VALUES "QUOTED_STRING" ( (
"renameClause" [ SET "setPropertiesClauseforLOVandD2D" ] [ SET
"setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
{ "alterListOfValuesClauses" } ) | ( SET
"setPropertiesClauseforLOVandD2D" [ SET "setReferenceIconSetClause" ]
[ UNSET "unsetReferenceIconSetClause" ] { "alterListOfValuesClauses" }
) | ( SET "setReferenceIconSetClause" [ UNSET
"unsetReferenceIconSetClause" ] { "alterListOfValuesClauses" } ) | (
UNSET "unsetReferenceIconSetClause" { "alterListOfValuesClauses" } ) |
( "alterListOfValuesClauses" { "alterListOfValuesClauses" } ) ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClauseforLOVandD2D = PROPERTIES "("
"propertyNameListforLOVandD2D" ")" VALUES "(" "propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterListOfValuesClauses = SET ( REF | REFERENCE ) DEFINING ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING" | UNSET ( REF |
REFERENCE ) "deleteListOfValuesClauses" |
"addListOfValuesReferenceClause"
propertyNameListforLOVandD2D = ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
"," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }
propertyValueList = "propertyValue" { "," "propertyValue" }
deleteListOfValuesClauses = ( DEFINING ITEM ) | ( ITEM "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING" )
addListOfValuesReferenceClause = SET ( REF | REFERENCE ) ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterListOfValuesCommand
This clause alters a list of values.
QUOTED_STRING
name of the list of values.
renameClause
Renames a list of values with a different name.
setPropertiesClauseforLOVandD2D
This clause sets the properties of the object.
Basic properties for LIST_OF_VALUES:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the list of values
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the list of values
Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the list of values enables drilling between the item folders
containing the items that use the list of values
Name: RETRIEVE_VALUES_GROUP_SIZE
Type: Number
Valid Values: N/A
Default: '100'
The number of rows to be fetched from the database at a time
Name: CACHE_VALUES
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the list of values should be cached in memory
Name: REQUIRE_SEARCH
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether search criteria should be requested
Name: SHOW_IN_NAVIGATOR
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be shown in the item navigator
Name: SORTED_DISTINCT
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be displayed sorted with duplicates hidden
Properties for LIST_OF_VALUES:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts
to create an object only for those objects marked as Deployable = true
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceIconSetClause
Set specified Icon Set.
unsetReferenceIconSetClause
Unset specified Icon Set.
alterListOfValuesClauses
This clause modifies a list of values.
DEFINING
This sets the defining item for the list of values.
propertyNameListforLOVandD2D
This is the list of property names.
propertyValueList
This is the list of property values.
deleteListOfValuesClauses
This deletes a reference to an item from a list of values.
addListOfValuesReferenceClause
This adds a reference to an item to a list of values.
propertyValue
This is a property value.
See Also
OMBCREATE LIST_OF_VALUES, OMBRETRIEVE LIST_OF_VALUES
Purpose
Alter the location by renaming it, and/or reset its properties.
Prerequisites
Can be in any context.
Syntax
alterLocationCommand = OMBALTER ( LOCATION "QUOTED_STRING" (
"renameClause" [ "setPropertiesForModifyClause" [ "alterIconSetClause"
] ] | "setPropertiesForModifyClause" [ "alterIconSetClause" ] |
"alterIconSetClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesForModifyClause = SET PROPERTIES "(" "propertyNameList" ")"
VALUES "(" "propertyValueList" ")"
alterIconSetClause = SET "setReferenceIconSetClause" [ UNSET
"unsetReferenceIconSetClause" ] | UNSET "unsetReferenceIconSetClause"
[ SET "setReferenceIconSetClause" ]
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterLocationCommand
Alter the location specified by the quoted string.
renameClause
Rename the location to the value of the following quoted string.
setPropertiesForModifyClause
Set or alter specified properties of the location.
alterIconSetClause
Set or unset the Icon Set of the location.
propertyNameList
The names of the properties whose values you want to set.
Properties for LOCATION:
Basic properties:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the location.
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the location.
Name: TYPE
Type: STRING
Valid Values:
'CONCURRENT_MANAGER'
'AUTOSYS_AGENT'
'AUTOSYS_INSTANCE'
'BIBEANS'
'DISCOVERER'
'FILE_SYSTEM'
'ORACLE_DATABASE'
'ORACLE_GATEWAY'
'ORACLE_WORKFLOW'
'SAP'
'TRANSPORTABLE_MODULE_SOURCE'
'TRANSPORTABLE_MODULE_TARGET'
Default: N/A
The type of system the location represents.
Name: VERSION
Type: STRING
Valid Values:
for 'CONCURRENT_MANAGER' : '11i'
for 'AUTOSYS_AGENT' : '0'
for 'AUTOSYS_INSTANCE' : '0'
for 'BIBEANS' : '10.1'
for 'DISCOVERER' : '10.1'
for 'FILE_SYSTEM' : do not set version
for 'ORACLE_DATABASE' : '8.1','9.0','9.2','10.1','10.2', '11.1'
for 'ORACLE_GATEWAY' : do not set version
for 'ORACLE_WORKFLOW' : '2.6.2','2.6.3','2.6.4','11i'
for 'SAP' : '4.x','3.x'
for 'TRANSPORTABLE_MODULE_SOURCE' : '8.1','9.0','9.2','10.1','10.2', '11.1'
for 'TRANSPORTABLE_MODULE_TARGET' : '8.1','9.0','9.2','10.1','10.2', '11.1'
Default: N/A
The version of the system(s) the location represents.
Lists of available properties for different types of LOCATION:
for 'CONCURRENT_MANAGER' :
TYPE,PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME,SCHEMA,VERSION,APPLICATION,APPLICATION_USER,RESPONSIBILITY
for 'AUTOSYS_AGENT':
TYPE,VERSION,PASSWORD,HOST
for 'AUTOSYS_INSTANCE':'
TYPE,VERSION,USER (or USER_NAME),PASSWORD,INSTANCE
for 'BIBEANS':
TYPE,VERSION,USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME
for 'DISCOVERER':
TYPE,VERSION,USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME
for 'FILE_SYSTEM':
TYPE,USER (or USER_NAME),PASSWORD,HOST,ROOTPATH
for 'ORACLE_DATABASE':
TYPE,VERSION,CONNECT_AS_USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME,DATABASE_NAME,SCHEMA
for 'ORACLE_GATEWAY':
TYPE,CONNECT_AS_USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME,SCHEMA
for 'ORACLE_WORKFLOW':
TYPE,VERSION,PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME,SCHEMA
for 'SAP':
TYPE, VERSION, USER (or USER_NAME), PASSWORD, APPLICATION_SERVER,
SYSTEM_NUMBER, CLIENT, LANGUAGE, HOST_LOGIN_USER, HOST_LOGIN_PASSWORD,
FTP_DIRECTORY, EXECUTION_FM
for 'TRANSPORTABLE_MODULE_SOURCE':
TYPE, VERSION,CONNECT_AS_USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,FTP_USER,FTP_PASSWORD
for 'TRANSPORTABLE_MODULE_TARGET':
TYPE, VERSION,CONNECT_AS_USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME
Some other properties for LOCATIONs:
Name: CONNECTION_TYPE
Type: STRING
Valid Values: 'HOST_PORT_SERVICE', 'SQL_NET_CONNECTION', 'DATABASE_LINK'
Default: 'HOST_PORT_SERVICE'
The location connection details format.
Name: HOST
Type: STRING
Valid Values: N/A
Default: N/A
The machine name.
Name: PORT
Type: NUMBER
Valid Values: 1 - 65535
Default: 1521
The port number of a database listener.
Name: SERVICE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The database service name.
Name: NET_SERVICE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The database netservice name.
Name: SCHEMA
Type: STRING
Valid Values: N/A
Default: N/A
The database schema name.
Name: PASSWORD
Type: STRING
Valid Values: N/A
Default: N/A
The password.
Name: USER
Type: STRING
Valid Values: N/A
Default: N/A
The user name.
Name: CONNECT_AS_USER
Synonym: USER_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The user name.
Name: ROOTPATH
Type: STRING
Valid Values: N/A
Default: N/A
The file system directory.
Name: APPLICATION
Type: STRING
Valid Values: N/A
Default: N/A
The Application name.
Name: APPLICATION_USER
Type: STRING
Valid Values: N/A
Default: N/A
The user name.
Name: DATABASE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The Data Base name.
Name: RESPONSIBILITY
Type: STRING
Valid Values: N/A
Default: N/A
The resposibility role.
Name: APPLICATION_SERVER
Type: STRING
Valid Values: N/A
Default: N/A
The application server.
Name: SYSTEM_NUMBER
Type: STRING
Valid Values: N/A
Default: N/A
The number of SAP system.
Name: CLIENT
Type: STRING
Valid Values: N/A
Default: N/A
The client.
Name: LANGUAGE
Type: STRING
Valid Values: N/A
Default: N/A
The languge of SAP.
Name: HOST_LOGIN_USER
Type: STRING
Valid Values: N/A
Default: N/A
The user.
Name: HOST_LOGIN_PASSWORD
Type: STRING
Valid Values: N/A
Default: N/A
The password.
Name: EXECUTION_FM
Type: STRING
Valid Values: N/A
Default: N/A
RFC Function Module for remote ABAP report execution
Name: FTP_USER
Type: STRING
Valid Values: N/A
Default: N/A
The user name used for creating ftp connection.
Name: FTP_PASSWORD
Type: STRING
Valid Values: N/A
Default: N/A
The ftp password.
Name: FTP_DIRECTORY
Type: STRING
Valid Values: N/A
Default: N/A
The directory used in a ftp session
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValueList
The values for the named properties.
propertyValue
A property value.
See Also
OMBALTER, OMBCREATE LOCATION, OMBDROP LOCATION
Purpose
Alter the content of a mapping.
Prerequisites
1. The current context of scripting must be an Oracle Module
2. No concurrent user should be modifying the mapping
Syntax
alterMappingCommand = OMBALTER MAPPING "mappingName"
"alterMapDetailClause"
mappingName = "QUOTED_STRING"
alterMapDetailClause = "renameClause" [ "alterPropertiesOrIconSetClause" ]
[ "alterOperatorOwnerDescendantsClause"+ ] |
"alterPropertiesOrIconSetClause" [
"alterOperatorOwnerDescendantsClause"+ ] |
"alterOperatorOwnerDescendantsClause"+
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = ( SET ( ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] )
| "setReferenceIconSetClause" ) ) | UNSET
"unsetReferenceIconSetClause"
alterOperatorOwnerDescendantsClause = ADD ( "addOperatorClause" |
"addGroupClause" | "addAttributeClause" | "addChildClause" |
"addConnectionClause" ) | MODIFY ( "modifyOperatorClause" |
"modifyGroupClause" | "modifyAttributeClause" | "modifyChildClause" )
| DELETE ( "operatorBottomUpLocator" | "groupBottomUpLocator" |
"attributeBottomUpLocator" | "childBottomUpLocator" |
"deleteConnectionLocator" )
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
addOperatorClause = "operatorType" OPERATOR "operatorName" [
"pluggableMapBottomUpLocator" ] [ SET "setPropertiesClause" ] [
"setBindingClause" ]
addGroupClause = "groupDirection" GROUP "groupName" OF
"operatorBottomUpLocator" [ SET "setPropertiesClause" ]
addAttributeClause = ATTRIBUTE "attributeName" OF "groupBottomUpLocator" [
SET "setPropertiesClause" ]
addChildClause = "childType" "childName" "childOwnerBottomUpLocator" [ SET
"setPropertiesClause" ]
addConnectionClause = CONNECTION FROM ( "groupBottomUpLocator" TO
"groupBottomUpLocator" [ "groupToGroupConnectType" ] |
"attributeBottomUpLocator" TO ( "attributeBottomUpLocator" |
"attributesBottomUpLocator" | "groupBottomUpLocator" ) |
"attributesBottomUpLocator" TO ( "attributesBottomUpLocator" |
"groupBottomUpLocator" ) )
modifyOperatorClause = "operatorBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
modifyGroupClause = "groupBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
modifyAttributeClause = "attributeBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
modifyChildClause = "childBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
operatorBottomUpLocator = OPERATOR "operatorName" [
"pluggableMapBottomUpLocator" ]
groupBottomUpLocator = GROUP "groupName" OF "operatorBottomUpLocator"
attributeBottomUpLocator = ATTRIBUTE "attributeName" OF
"groupBottomUpLocator"
childBottomUpLocator = "childType" "childName" { OF "childType"
"childName" } [ OF "mappableBottomUpLocator" ]
deleteConnectionLocator = CONNECTION ( FROM "mappableBottomUpLocator" [ TO
"mappableBottomUpLocator" ] | TO "mappableBottomUpLocator" )
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
operatorType = PLUGGABLE_MAPPING | "UNQUOTED_STRING"
operatorName = "QUOTED_STRING"
pluggableMapBottomUpLocator = ( OF PLUGGABLE_MAPPING "pluggableMapName" [
"pluggableMapBottomUpLocator" ] )
setBindingClause = BOUND TO "bindableLocator"
groupDirection = INPUT | OUTPUT | INPUT_OUTPUT
groupName = "QUOTED_STRING"
attributeName = "QUOTED_STRING"
childType = "UNQUOTED_STRING"
childName = "QUOTED_STRING"
childOwnerBottomUpLocator = { OF "childType" "childName" } [ OF
"mappableBottomUpLocator" ]
groupToGroupConnectType = COPY ALL | BY ( NAME [ IGNORE ( SPECIAL_CHARS
"QUOTED_STRING" | SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX
"QUOTED_STRING" | TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX
"QUOTED_STRING" ) { "," IGNORE ( SPECIAL_CHARS "QUOTED_STRING" |
SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX "QUOTED_STRING" |
TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX "QUOTED_STRING" ) } ] |
POSITION )
attributesBottomUpLocator = ATTRIBUTES "attributeNameList" OF
"groupBottomUpLocator"
mappableBottomUpLocator = "operatorBottomUpLocator" |
"groupBottomUpLocator" | "attributeBottomUpLocator"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
pluggableMapName = "QUOTED_STRING"
bindableLocator = "bindableType" "bindableName" [ OF "bindableType"
"bindableName" ]
attributeNameList = "(" "attributeName" { "," "attributeName" } ")"
bindableType = PLUGGABLE_MAPPING | OBJECT_TYPE | "UNQUOTED_STRING"
bindableName = "QUOTED_STRING"
Keywords And Parameters
alterMappingCommand
Alter the content of a mapping.
mappingName
Name of the mapping.
alterMapDetailClause
Alter the detail of the mapping.
renameClause
Rename a mapping, mapping operator, mapping group, or mapping attribute.
alterOperatorOwnerDescendantsClause
Alter the desired child objects applicable to a mapping or a pluggable
mapping.
setPropertiesClause
Describe the keys of properties for the map or objects in the map.
addOperatorClause
Adds a mapping operator to a map. When you add an operator, Warehouse
Builder creates default groups and parameters for the operator. Please see
the appendix section of the Scripting Reference.
The following is an example for creating an operator:
OMBALTER MAPPING 'M1' ADD TABLE OPERATOR 'T1'
addGroupClause
Add a mapping group to a mapping operator.
addAttributeClause
Add a mapping attribute to a mapping group.
addChildClause
Add a child to a mapping, mapping operator, mapping group or mapping
attribute.
The following is an example for creating a child object under a mapping
OMBALTER MAPPING 'M1' ADD SOURCE_DATA_FILE 'FILE1'
Note: Key word "OPERATOR" "GROUP" "ATTRIBUTE" are important for their
respective ADD clauses. Without the key words, OMBPlus will interpret the
ADD clause as an addChildClause. Here is an example:
OMB+> OMBALTER MAPPING 'M1' ADD TABLE 'T1'
OMB02932: Error getting child objects of type TABLE in M1
OMBPLUS interprets the ADD clause as one for creating a non-operator child
object under the mapping object. Therefore, it tries to find type
definition for non-operator child object "TABLE" and cannot find it.
addConnectionClause
Add connections between mapping groups or mapping attributes.
modifyOperatorClause
Modify a mapping operator.
modifyGroupClause
Modify a mapping group.
modifyAttributeClause
Modify a mapping attribute.
modifyChildClause
Modify a child that belongs to a mapping, mapping operator, mapping group
or mapping attribute.
operatorBottomUpLocator
Location of a mapping operator.
groupBottomUpLocator
Location of a mapping group.
attributeBottomUpLocator
Location of a mapping attribute.
childBottomUpLocator
Location of the child that belongs to a map, mapping operator, mapping
group or mapping attribute.
deleteConnectionLocator
Delete connections between mapping operators, mapping groups or mapping
attributes.
propertyKeyList
The list of property keys.
propertyValueList
A list of property values.
operatorType
Type of a mapping operator. The following operator types are available:
ADVANCED_QUEUE, AGGREGATOR, ANYDATA_CAST, CONSTANT, CONSTRUCT_OBJECT, CUBE,
DATA_GENERATOR, DEDUPLICATOR, DIMENSION, EXPAND_OBJECT, EXPRESSION,
EXTERNAL_TABLE, FILTER, FLAT_FILE, INPUT_PARAMETER, INPUT_SIGNATURE,
ITERATOROPERATOR, JOINER, KEY_LOOKUP, LCRCAST, LCRSPLITTER, MATCHMERGE,
MATERIALIZED_VIEW, NAME_AND_ADDRESS, OUTPUT_PARAMETER, OUTPUT_SIGNATURE,
PIVOT, PLUGGABLE_MAPPING, POSTMAPPING_PROCESS, PREMAPPING_PROCESS,
SEQUENCE, SET_OPERATION, SORTER, SPLITTER, TABLE, TABLE_FUNCTION,
TRANSFORMATION, UNPIVOT, VIEW.
operatorName
Name of a mapping operator.
pluggableMapBottomUpLocator
Location of a child pluggable mapping within a mapping or another pluggable
mapping.
setBindingClause
Set the binding during the creation of a mapping operator or mapping
attribute.
groupDirection
Direction of a mapping group.
groupName
Name of a mapping group.
attributeName
Name of a mapping attribute.
childType
Type of a child that belongs to map, mapping operator, mapping group or
mapping attribute.
childName
Name of a child that belongs to map, mapping operator, mapping group or
mapping attribute.
childOwnerBottomUpLocator
Location of a child owner. A child owner can be a map, mapping operator,
mapping group, mapping attribute or a child.
groupToGroupConnectType
Connecting from a mapping group in one mapping operator to a mapping group
in another mapping operator.
attributesBottomUpLocator
Location of a list of mapping attributes.
mappableBottomUpLocator
Location of the object to be bound to a mapping mapping operator or mapping
attribute.
propertyKey
A property key for an object.
Basic properties for MAPPING:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the mapping
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the mapping
Basic properties for OPERATOR:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the operator
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the operator
Basic properties for GROUP:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the group
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the group
Basic properties for ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the attribute
Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE,
TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: ''
Datatype of the Attribute
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Length of the attribute.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Precision of the attribute.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Scale of the attribute.
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.
Properties for MAPPING:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
True if the map is deployable to a physical implementation
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: GENERATION_LANGUAGE
Type: STRING
Valid Values: ABAP, PLSQL, SQLLOADER, UNDEFINED
Default: UNDEFINED
The language used when generating code for the mapping.
Name: REFERRED_CALENDAR
Type: STRING
Valid Values: N/A
Default: ''
Enter the Schedule to associate with this object.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Properties for GROUP:
Name: COMMANDTYPE
Type: STRING
Valid Values: ALL_COMMAND_TYPES, DELETE, INSERT, UPDATE
Default: ALL_COMMAND_TYPES
The operation causing the change described by the LCR
Name: DEFAULT_EXPIRATION_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: NULL
A date value to be served as the expiration time of a newly created open
record.
Name: DIMENSION_KEY
Type: STRING(32)
Valid Values: N/A
Default: ''
The column in which dimension key value is to be stored when this is a
target of star schema.
Name: EXPRESSION_INOUT
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: EXPRESSION_OUT
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: EXTRACTING_TYPE
Type: STRING
Valid Values: FROM_ALL, FROM_CURRENT
Default: FROM_CURRENT
The extracting operation to be performed when this is a source. If Extract
Current Only (Type 2 Only) is specified, only current records will be
extracted. If Extract All is specified, all records will be extracted.
Name: GROUP_TYPE
Type: STRING
Valid Values: REF_CURSOR, SCALAR
Default: SCALAR
This property specifies whether the input parameter is a scalar or a ref
cursor type
Name: INTERNAL_TABLE
Type: STRING
Valid Values: N/A
Default: ''
Internal staging table for this operator group
Name: LEVEL_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of this level.
Name: MODULENAME
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parameter group
Name: RECORD_TYPE_VALUES
Type: STRING
Valid Values: N/A
Default: ''
Record Type Values.
Name: RETURN_TABLE_OF_SCALAR
Type: BOOLEAN
Valid Values: true, false
Default: false
This property specifies whether the return of the table function is a TABLE
of SCALAR or not.
Name: ROW_LOCATOR
Type: STRING
Valid Values: N/A
Default: ''
An expression indicating which attribute within the input group is the row
locator.
Name: ROW_LOCATOR_VALUES
Type: STRING
Valid Values: N/A
Default: NULL, NULL
A comma-separated expressions that gives the possible values of the row
locator within a unpivot group.
Name: SLOWLY_CHANGING_TYPE
Type: STRING
Valid Values: TYPE1, TYPE2, TYPE3
Default: TYPE2
The slowly changing type of this target.
Name: SPLIT_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
Condition that defines when to perform the attribute maps for the
attributes in this group.
Name: TABLENAME
Type: STRING
Valid Values: N/A
Default: ''
The source table corresponding to the LCR
Name: TARGET_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The table name bound to this target.
Properties for ATTRIBUTE:
Name: ADDRESS_TYPE
Type: STRING
Valid Values: NA_ADDRTYPE_DUAL, NA_ADDRTYPE_NORMAL
Default: NA_ADDRTYPE_NORMAL
You can designate an address type as Normal or Dual. For example, a dual
address occurs when a record contains both a street address and a P.O. Box;
this is common with business data. A normal address contains only one type
of address.
Name: ATTRIBUTE_ROLE
Type: STRING
Valid Values: END_DATE, LOOKUP_ACTIVE_DATE, MEASURE, NATURAL_KEY, NONE,
PARENT_NATURAL_KEY, PARENT_REF_KEY, PARENT_SURROGATE_KEY, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: BINDING_COLUMN_NAME
Type: STRING
Valid Values: N/A
Default: ''
The binding column name for this attribute
Name: DATA_TYPE
Type: STRING
Valid Values: N/A
Default: ''
The data type of the attribute
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The Default Value for the function input parameter
Name: DIMENSION_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The dimension attribute referenced to by this level attribute.
Name: EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
The output expression for the attribute
Name: FIELD_DATA_TYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE,
FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER
EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH,
LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH
LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARGRAPHIC,
VARRAW, VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
SQL Data Type of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Field Length of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Field Precision of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Field Scale of the field in the file to which this operator is bound.
Name: FIELD_DEFAULTIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is blank or zero,
based on the datatype.
Name: FIELD_END_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The ending position of the field in the file
Name: FIELD_MASK
Type: STRING
Valid Values: N/A
Default: ''
The mask for the field
Name: FIELD_NULLIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is null
Name: FIELD_START_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The starting position of the field in the file
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data fractional seconds precision value of the attribute
Name: FUNCTION_RETURN
Type: BOOLEAN
Valid Values: true, false
Default: false
Specifies whether this output is the return value of this function
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this input attribute is a part of the
unpivot group key.
Name: INPUT_ROLE
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_CITY, NA_COUNTRYCODE,
NA_COUNTRYNAME, NA_FIRMNAME, NA_FIRSTNAME, NA_FIRSTPARTNAME, NA_LASTLINE,
NA_LASTLINE_2, NA_LASTNAME, NA_LASTPARTNAME, NA_LINE1, NA_LINE10, NA_LINE2,
NA_LINE3, NA_LINE4, NA_LINE5, NA_LINE6, NA_LINE7, NA_LINE8, NA_LINE9,
NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_NEIGHBORHOOD, NA_NONE,
NA_PASSTHRU, NA_PERSON, NA_PERSON2, NA_PERSON3, NA_POSTALCODE, NA_POSTNAME,
NA_PRENAME, NA_PRIMARYADDRESS, NA_SECONDARYADDRESS, NA_STATE
Default: NA_NONE
Assigns a name-address input role to the selected input attribute
Name: INSTANCE
Type: STRING
Valid Values: NA_INSTANCE_FIFTH, NA_INSTANCE_FIRST, NA_INSTANCE_FOURTH,
NA_INSTANCE_SECOND, NA_INSTANCE_SIXTH, NA_INSTANCE_THIRD
Default: NA_INSTANCE_FIRST
The instance option is used when an address contains multiple names, you
can specify which name in the group should be used. In addition, you can
use this option to assign an address type to a miscellaneous address
component.
Name: IS_CAST_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: IS_OPTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the input is not required to be connected
Name: IS_PREDEFINED_CONSTANT
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
The data length value of the attribute
Name: LEVEL_ATTRIBUTE_COLNAME_NAME
Type: STRING
Valid Values: N/A
Default: ''
Column name in the AW staging table and source view for this attribute.
Name: LEVEL_ATTRIBUTE_LEVEL_INDICATOR_COLNAME
Type: STRING
Valid Values: N/A
Default: ''
Level indicating columns name. This level will contain the name of the name
of the level this parent reference belongs to. This is relavant only for
skip level hierarchies.
Name: LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Level Attribute.
Name: LEVEL_RELATIONSHIP_NAME
Type: STRING
Valid Values: N/A
Default: ''
The level relationship name associated to this attribute.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
update load operation.
Name: LOOKUP_ATTRIBUTE_ROLE
Type: STRING
Valid Values: DIMENSION_KEY, END_DATE, NATURAL_KEY, NONE, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: MATCHING_ROW
Type: NUMBER
Valid Values: 1 - 1000
Default: 1
An positive integer to indicate from which row within the unpivot group
this output attribute obtains its data.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the update load operation.
Name: MERGE_ATTR
Type: STRING
Valid Values: N/A
Default: ''
Related merge attribute
Name: OUTPUT_COMPONENT
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_ADDRESSCORRECTED, NA_ADDRESSTYPE,
NA_AUTO_ZONE_IND, NA_BOXNAME, NA_BOXNUMBER, NA_BUILDINGNAME, NA_CART,
NA_CBSA_CODE, NA_CBSA_DESC, NA_CENSUSID, NA_CHECKDIGIT, NA_CITY,
NA_CITYCORRECTED, NA_CITYMATCH, NA_CITYWARNING, NA_CITY_ABBREV,
NA_CITY_ABBREV_2, NA_CITY_ALTERNATE, NA_COMPLEX, NA_COUNTRYCODE,
NA_COUNTRYCODE3, NA_COUNTRYNAME, NA_COUNTYNAME, NA_DELIVERYBEATCODE,
NA_DELIVERYOFFICECODE, NA_DELIVERYPOINT, NA_EMAIL, NA_EXTRA_1, NA_EXTRA_10,
NA_EXTRA_11, NA_EXTRA_12, NA_EXTRA_13, NA_EXTRA_14, NA_EXTRA_15,
NA_EXTRA_16, NA_EXTRA_17, NA_EXTRA_18, NA_EXTRA_19, NA_EXTRA_2,
NA_EXTRA_20, NA_EXTRA_3, NA_EXTRA_4, NA_EXTRA_5, NA_EXTRA_6, NA_EXTRA_7,
NA_EXTRA_8, NA_EXTRA_9, NA_FIPS, NA_FIPSCOUNTY, NA_FIPS_PLACE_CODE,
NA_FIRMCOUNT, NA_FIRMNAME, NA_FIRM_LOC, NA_FIRSTNAME, NA_FIRSTNAMESTD,
NA_GENDER, NA_GEO_MATCH_PREC, NA_INSTALLATIONNAME, NA_INSTALLATIONTYPE,
NA_ISADDRESSVERIFIABLE, NA_ISFOUND, NA_ISGOODADDRESS, NA_ISGOODGROUP,
NA_ISGOODNAME, NA_ISPARSED, NA_LACS, NA_LASTLINE, NA_LASTLINE_2,
NA_LASTNAME, NA_LATITUDE, NA_LOCALITYCODE, NA_LOCALITYNAME, NA_LOCALITY_2,
NA_LOCALITY_3, NA_LOCALITY_4, NA_LONGITUDE, NA_LOT, NA_LOT_ORDER, NA_MCD,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME2STD, NA_MIDDLENAME3,
NA_MIDDLENAME3STD, NA_MIDDLENAMESTD, NA_MISCADDRESS, NA_MSA,
NA_NAMEDESIGNATOR, NA_NAMEWARNING, NA_NAME_FIRM_EXTRA, NA_NEIGHBORHOOD,
NA_NONAMBIGUOUSMATCH, NA_NONE, NA_NP_SEC_ADDR, NA_NP_UNIT_DESIG,
NA_NP_UNIT_NBR, NA_OTHERPOSTNAME, NA_PARSESTATUS, NA_PARSESTATUSDESC,
NA_PARSINGCOUNTRY, NA_PASSTHRU, NA_PERSON, NA_PERSONCOUNT, NA_PHONE,
NA_POSTALCODE, NA_POSTALCODECORRECTED, NA_POSTALCODEFORMATTED,
NA_POSTDIRECTIONAL, NA_POSTNAME, NA_PREDIRECTIONAL, NA_PRENAME,
NA_PRIMARYADDRESS, NA_PRIM_NAME_2, NA_RELATIONSHIP, NA_ROUTENAME,
NA_ROUTENUMBER, NA_SECONDARYADDRESS, NA_SSN, NA_STATE,
NA_STREETCOMPCORRECTED, NA_STREETCOMPMATCH, NA_STREETCORRECTED,
NA_STREETNAME, NA_STREETNAMEMATCH, NA_STREETNUMBER, NA_STREETNUMBERMATCH,
NA_STREETTYPE, NA_STREETWARNING, NA_TITLE, NA_UNITDESIGNATOR,
NA_UNITNUMBER, NA_URBANIZATIONNAME, NA_URBAN_IND, NA_ZIP4, NA_ZIP5
Default: NA_NONE
Assigns a Name and Address output component to the selected output
attribute.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parmater
Name: PIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
A comma-separated expression that gives the input attribute to be used for
each output row in the pivot group.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data precision value of the attribute
Name: REFERENCED_LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level attribute associated to this attribute.
Name: REFERENCED_LEVEL_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level group associated to this attribute.
Name: REFERENCING_TYPE
Type: STRING
Valid Values: LOOKUP_KEY, NONE, REFERENCE_KEY_ALL, REFERENCE_KEY_ONLY
Default: NONE
The type of reference to indicate how this attribute participates in
resolving existing level relationships and level implementations. If Lookup
Reference Attribute is specified, this attribute will be used as lookup
attribute upon parent level to resolve level implementations during
loading. If Level Relationship Attribute (Snowflake) is specified, this
attribute will be directly used as level relationship attribute and no
lookup upon parent level would be performed during loading. If Level
Relationship Attribute (Star) is specified, this attribute will be directly
used as level relationship attribute, as well as lookup attribute upon
parent level to resolve level implementations during loading. If none is
specified, this attribute does not participate in any level relationship.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
The data scale value of the attribute
Name: SKIP_LEVEL_DIMENSION
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether this level has a skip level parent.
Name: TYPE_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the field of the PLS Record or attribute of the Object Type or
column of the ROWTYPE that corresponds to this attribute. This property is
not applicable if the return type is TABLE of SCALAR.
Name: UNPIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: NULL
An expression that gives the input attribute to be used as the output of
this attribute.
Name: UPDATE_OPERATION
Type: STRING(3)
Valid Values: +=, -=, =, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data
and the existing data on the target during the update load operation.
Name: VALUETYPE
Type: STRING
Valid Values: NEW, NEW_OLD, OLD
Default: NEW_OLD
Specifies the value type of this attribute
Properties for AGGREGATOR_OPERATOR:
Name: GROUP_BY_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Group By clause for the aggregation
Name: HAVING_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Having clause for the aggregation
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for CONSTRUCT_OBJECT_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for CUBE_OPERATOR:
Name: ALLOW_PARALLEL_SOLVE
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, allow parallel solve when solving the cube.
Name: AW_STAGED_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the set-based AW load data is staged into a temporary table before
loading into the AW.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: CUBE_STORAGE_ISAW
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether the storage for this cube in AW.
Name: DIMENSION_AWNAME
Type: STRING
Valid Values: N/A
Default: ''
AW Name which contains this Dimension.
Name: INCREMENTAL_AGGREGATION
Type: BOOLEAN
Valid Values: true, false
Default: true
Indicates whether incremental aggregation should be done or full
aggregation.
Name: LOADING_TYPE
Type: STRING
Valid Values: LOAD, REMOVE
Default: LOAD
The loading operation to be performed when this is a target. If LOAD is
specified, OWB will try to insert all input data into target. If REMOVE is
specified, OWB will try to match between the input data and target data to
compute existing data; it will then remove existing data from target.
Name: MAX_JOB_QUEUES_ALLOCATED
Type: NUMBER
Valid Values: 1 - 1000
Default: 0
The maximum number of job queues allocated when solving the cube.
Name: RUN_AGGREGATION
Type: STRING
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether to solve the cube or not . Specify YES
and cube data will be precomputed for the levels specified in the
definition of cube
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRUNCATE_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
The truncate flag to indicate whether all existing dimension values should
be truncated before load begins (AW only).
Properties for DEDUPLICATOR_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for DIMENSION_OPERATOR:
Name: AW_LOAD_MODEL
Type: STRING
Valid Values: OTHER, SNOWFLAKE, STAR
Default: SNOWFLAKE
The loading model for the AW dimension - star, snowflake, or other.
Name: AW_STAGED_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the set-based AW load data is staged into a temporary table before
loading into the AW.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DEFAULT_EFFECTIVE_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: SYSDATE
A date value to be served as the effective time of a newly created open
record. The same date value is also served as the expiration time to close
an existing open record.
Name: DEFAULT_EXPIRATION_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: NULL
A date value to be served as the expiration time of a newly created open
record.
Name: DIMENSION_AWNAME
Type: STRING
Valid Values: N/A
Default: ''
AW Name which contains this Dimension.
Name: DIMENSION_ISAW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Flag to indicate whether storage is AW.
Name: LOADING_TYPE
Type: STRING
Valid Values: LOAD, REMOVE
Default: LOAD
The loading operation to be performed when this is a target. If LOAD is
specified, OWB will try to match between the input data and target data to
compute new data and existing data; it will then create new data, as well
as modify existing data onto target. If REMOVE is specified, OWB will try
to match between the input data and target data to compute existing data;
it will then remove existing data from target.
Name: SLOWLY_CHANGING_TYPE
Type: STRING
Valid Values: TYPE1, TYPE2, TYPE3
Default: TYPE2
The slowly changing type of this target.
Name: SURROGATE_IDENTIFIER_LOADING_POLICY
Type: STRING
Valid Values: N/A
Default: ''
The name of the sequence used to generate surrogate key values when loading
the dimension.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRUNCATE_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
The truncate flag to indicate whether all existing dimension values should
be truncated before load begins (AW only).
Name: TYPE2_MATCH_CURRENT_ONLY
Type: STRING
Valid Values: NO, YES
Default: YES
If set to YES, only the current record will be used when performing the
selected operation (remove or extract) for type 2 dimension.
Name: TYPE2_RECORD_GAP_INTERVAL
Type: NUMBER
Valid Values: N/A
Default: 1
A numeric value indicating the number of units (see
TYPE2_RECORD_GAP_INTERVAL_UNITS property below) that will be added to the
expiration date of the previous closed record, to create the effective date
of a new open record.
Name: TYPE2_RECORD_GAP_INTERVAL_UNITS
Type: STRING
Valid Values: DAYS, HOURS, MINUTES, SECONDS, WEEKS
Default: SECONDS
A value indicating the units used for the gap that will be added to the
expiration date of the previous closed record, to create the effective date
of a new open record.
Properties for EXPAND_OBJECT_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for EXTERNAL_TABLE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DATA_COLLECTION_FREQUENCY
Type: STRING(16)
Valid Values: DAY, HOUR, MINUTE, MONTH, QUARTER, UNKNOWN, YEAR
Default: UNKNOWN
New Data Granularity
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: DIRECT
Type: BOOLEAN
Valid Values: true, false
Default: false
Directly swap source into target as a partition without first creating a
staging table.
Name: ENABLE_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable Constraints
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EVALUATE_CHECK_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: false
Evaluate check constraints
Name: EXCEPTIONS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Exceptions Table Name
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PEL_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
PEL Enabled
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: REPLACE_DATA
Type: BOOLEAN
Valid Values: true, false
Default: false
Replace existing data in target partition if there is any.
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Properties for FILTER_OPERATOR:
Name: FILTER_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
The boolean filtering condition that identifies what data is to be
processed. Any row with a false condition will be ignored.
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for FLAT_FILE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by reconciliation for this item. Unlike other
operators, it is not needed for generation. By default it is the same name
as the item.
Name: CONCATENATE_RECORDS
Type: NUMBER
Valid Values: N/A
Default: 0
Number of Physical Records per Logical Record.
Name: CONTINUATION_CHARACTER
Type: STRING
Valid Values: N/A
Default: ''
Character that indicates the record is continued on the next line.
Name: CONTINUATION_CHARACTER_ON_NEXT_LINE
Type: BOOLEAN
Valid Values: true, false
Default: FALSE
If there is a continuation character, is it at the start of the line.
Name: FIELD_ENCLOSURE_CHARACTERS
Type: STRING
Valid Values: N/A
Default: ''
Characters that wrap fields. Example ' or ".
Name: FIELD_NAMES_IN_THE_FIRST_ROW
Type: BOOLEAN
Valid Values: true, false
Default: FALSE
Indicates whether file contains a header row.
Name: FIELD_TERMINATION_CHARACTER
Type: STRING
Valid Values: N/A
Default: ,
Character that separates the fields of a delimited file.
Name: FILE_FORMAT
Type: STRING
Valid Values: DELIMITED, FIXED
Default: DELIMITED
File Format (Fixed or Delimited).
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: INSERT, NONE, UPDATE
Default: INSERT
The loading operation to be performed
Name: OUTPUT_AS_XML
Type: BOOLEAN
Valid Values: true, false
Default: false
Output data to file in XML format.
Name: RECORD_DELIMITER
Type: STRING
Valid Values: N/A
Default: ''
Character that indicates the end of the record.
Name: RECORD_SIZE
Type: NUMBER
Valid Values: N/A
Default: 0
Size of a fixed length record.
Name: RECORD_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
If this is a multi record file, this will indicate the length of the data
that identifies the type of record. It is used with the Record Type
Position.
Name: RECORD_TYPE_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
If this is a multi record file, this will indicate the position of the
field that identifies the type of record.
Name: SAMPLED_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The default name of the physical file to be used by sqlloader. If the file
was sampled, the default was set from sampled file name.
Name: SOURCE_DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The Location of the File Module of this Flat File at the time of
reconciliation. Stored as UOID.
Name: TARGET_DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access referenced entity.
Name: TARGET_DATA_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the target data file, including extension (file type). This name
should not include the file path. To specify where the target data file
will be created/appended, set the Target Data File Location.
Properties for ITERATOR_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for JOINER_OPERATOR:
Name: JOIN_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
The Join Condition for the join operator
Properties for KEY_LOOKUP_OPERATOR:
Name: BOUND_LEVEL
Type: STRING
Valid Values: N/A
Default: ''
The level name of the bound level, if this is a dimension lookup.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: CREATE_NO_MATCH_ROW
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, a row is created and the user-defined default values are used, in
the case where no lookup match is found. If false, no row is produced.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOOKUP_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
Key lookup condition based on the source inputs. This condition is used to
lookup a value in the bound table. If the condition is not met, the
default value expression will be returned. If a default expression is not
defined, null is used.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TYPE2_HISTORY_LOOKUP_DATE
Type: STRING
Valid Values: N/A
Default: ''
A date expression used when doing a lookup on a type 2 dimension level, to
specify the historical date for which to retrieve data. If blank, the most
current record is used.
Properties for LCRCAST_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for MATCHMERGE_OPERATOR:
Name: MATCH_KEYS
Type: STRING
Valid Values: N/A
Default: ''
Ordered list of attributes that control the set of records to be matched at
any at any particular time.
Name: MATCH_NEW_RECORDS
Type: BOOLEAN
Valid Values: true, false
Default: false
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"MATCHMERGE.GENERAL.MATCH_NEW_RECORDS:DESCRIPTION"
Name: MATCH_NEW_RECORD_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"MATCHMERGE.GENERAL.MATCH_NEW_RECORD_CONDITION:DESCRIPTION"
Name: MERGED_PREFIX
Type: STRING
Valid Values: N/A
Default: ''
Set the prefix used for the merged attributes in the cross-reference group.
Properties for MATERIALIZED_VIEW_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT,
INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Properties for NAME_AND_ADDRESS_OPERATOR:
Name: ADDRESS_LINE_1
Type: STRING
Valid Values: N/A
Default: ''
Address line 1
Name: ADDRESS_LINE_2
Type: STRING
Valid Values: N/A
Default: ''
Address line 2
Name: ADDRESS_LINE_3
Type: STRING
Valid Values: N/A
Default: ''
Address line 3
Name: ADDRESS_LINE_4
Type: STRING
Valid Values: N/A
Default: ''
Address line 4
Name: DUAL_ADDRESS_ASSIGNMENT
Type: STRING
Valid Values: NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX,
NA_DUALADDR_STREET
Default: NA_DUALADDR_STREET
A dual address refers to two address lines for the same destination. For
example, a record contains both a street address and a P.O. Box; this is
common with business data. Select which of the two address lines should be
assigned in these cases.
Name: GENERATE_CASS_REPORT
Type: STRING
Valid Values: NA_NO, NA_YES
Default: NA_NO
Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS
report is a text file specified by the United States Postal Service. The
report is written to the [nas/bin/admin/reports] folder under the home
folder of the name/address server.
Name: LIST_NAME
Type: STRING
Valid Values: N/A
Default: ''
The list name is optional and provides a reference for tracking multiple
CASS reports.
Name: PARSING_TYPE
Type: STRING
Valid Values: NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY
Default: NA_NAMEANDADDRESS
Select a name-address parsing type to be performed on the input data
Name: PRIMARY_COUNTRY
Type: STRING
Valid Values: NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD,
NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE,
NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST,
NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND,
NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM,
NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR,
NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP,
NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF
Default: NA_USA
Select the primary parsing country which best represents the input data.
Input addresses having the same country as the primary parsing country will
only need to be parsed once. Input addresses having a different country
than the primary parsing country may be reparsed by a different parser. For
performance reasons, it is best to minimize the percentage of 2-pass parses
by selecting the optimal parser.
Name: PROCESSOR_NAME
Type: STRING
Valid Values: N/A
Default: ''
The processor name is the name of the organization submitting the CASS
report.
Properties for PIVOT_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: PIVOT_GROUP_SIZE
Type: NUMBER
Valid Values: 1 - 1000
Default: 2
A number specifying the pivot group size for the pivot operation. Pivot
group size determines the number of output rows that are produced from each
input row.
Properties for PLUGGABLE_MAPPING_OPERATOR:
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Properties for POSTMAPPING_PROCESS_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: POSTMAPPING_PROCESS_RUN_CONDITION
Type: STRING(10)
Valid Values: ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING
Default: ON_SUCCESS
Indicates under what condition of the mapping the post-mapping process will
be run.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for PREMAPPING_PROCESS_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: MAPPING_RUN_CONDITION
Type: STRING(10)
Valid Values: ALWAYS, ON_ERROR, ON_SUCCESS
Default: ON_SUCCESS
Indicates under what condition of the pre-mapping process the mapping will
be run.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for QUEUE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: REAL_TIME_DATA_FORMAT
Type: STRING
Valid Values: LOGICAL_CHANGE_RECORD, MESSAGE
Default: LOGICAL_CHANGE_RECORD
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"ADVANCEDQUEUE.DEFAULT.REALTIMEFORMAT:DESCRIPTION"
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Properties for SEQUENCE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for SET_OPERATION_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: SET_OPERATION
Type: STRING
Valid Values: INTERSECT, MINUS, UNION, UNIONALL
Default: UNION
Specifies the set operation that is to be performed by this operator.
Properties for SORTER_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: ORDER_BY_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Order By Clause
Properties for SPLITTER_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for TABLE_FUNCTION_OPERATOR:
Name: TABLE_FUNCTION_IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: TABLE_FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Table Function
Properties for TABLE_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: CONFLICT_RESOLUTION
Type: BOOLEAN
Valid Values: true, false
Default: true
Detect and resolve any conflicts that may arise during DML using the LCR
APIs
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DATA_COLLECTION_FREQUENCY
Type: STRING(16)
Valid Values: DAY, HOUR, MINUTE, MONTH, QUARTER, UNKNOWN, YEAR
Default: UNKNOWN
New Data Granularity
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: DIRECT
Type: BOOLEAN
Valid Values: true, false
Default: false
Directly swap source into target as a partition without first creating a
staging table.
Name: ENABLE_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable Constraints
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EVALUATE_CHECK_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: false
Evaluate check constraints
Name: EXCEPTIONS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Exceptions Table Name
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: JOINRANK
Type: FLOAT
Valid Values: N/A
Default: 0
Join Rank
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT,
INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PEL_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
PEL Enabled
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: REPLACE_DATA
Type: BOOLEAN
Valid Values: true, false
Default: false
Replace existing data in target partition if there is any.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Name: USE_LCR_API
Type: BOOLEAN
Valid Values: true, false
Default: true
Use LCR APIs if possible to perform the DML
Properties for TRANSFORMATION_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, then the function is a target
Name: RETURN_TYPE
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for UNPIVOT_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for VIEW_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT,
INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValue
A single property value. It can be a number, float, boolean or
single-quoted string.
pluggableMapName
Name of the pluggable map.
bindableLocator
Location of the object to be bound to a mapping operator or mapping
attribute.
attributeNameList
A list of attribute names.
bindableType
Type of object bound to a mapping operator or mapping attribute.
bindableName
Name of the object bound to a mapping operator or mapping attribute.
See Also
OMBALTER, OMBCREATE MAPPING, OMBRETRIEVE MAPPING, OMBDROP MAPPING
Purpose
To alter properties and definition of a materialized view.
Prerequisites
In the context of an Oracle Module.
Syntax
alterMaterializedViewCommand = OMBALTER ( MATERIALIZED_VIEW
"QUOTED_STRING" ( "renameClause" [ "alterPropertiesOrIconSetClause" ]
[ "alterMaterializedViewSCOandDependentClauses" ] |
"alterPropertiesOrIconSetClause" [
"alterMaterializedViewSCOandDependentClauses" ] |
"alterMaterializedViewSCOandDependentClauses" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET ( REF |
REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause"
alterMaterializedViewSCOandDependentClauses = ADD (
"addColumnClauseForAlter" [
"alterMaterializedViewSCOandDependentClauses" ] |
"addViewConstraintClause" { "alterViewConstraintClauses" } |
"addSCOClause" { "alterMaterializedViewSCOClauses" } |
"addDataRuleUsageClause" { "alterDataRuleUsageClauses" } |
"addRelationalDependentClause" [
"alterMaterializedViewSCOandDependentClauses" ] ) | MODIFY (
"modifyColumnClause" [ "alterMaterializedViewSCOandDependentClauses" ]
| "modifyViewConstraintClause" { "alterViewConstraintClauses" } |
"modifySCOClause" { "alterMaterializedViewSCOClauses" } |
"modifyDataRuleUsageClause" { "alterDataRuleUsageClauses" } ) | DELETE
( "deleteColumnClause" [
"alterMaterializedViewSCOandDependentClauses" ] |
"deleteViewConstraintClause" { "alterViewConstraintClauses" } |
"deleteSCOClause" { "alterMaterializedViewSCOClauses" } |
"deleteDataRuleUsageClause" { "alterDataRuleUsageClauses" } |
"deleteRelationalDependentClause" [
"alterMaterializedViewSCOandDependentClauses" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ICONSET
addColumnClauseForAlter = COLUMN "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
addViewConstraintClause = "addUkPkClause" | "addFkClause"
alterViewConstraintClauses = ADD "addViewConstraintClause" | MODIFY
"modifyViewConstraintClause" | DELETE "deleteViewConstraintClause"
addSCOClause = "addIndexClause" | "addIndexPartitionClause" |
"addIndexPartitionKeyClause" | "addPartitionClause" |
"addPartitionKeyClause" | "addSubpartitionClause" |
"addaddMaterializedViewSCOandDependentClauseClause" |
"addSubPartitionKeyClause" | "addIndexColumnClause"
alterMaterializedViewSCOClauses = ADD "addSCOClause" | MODIFY
"modifySCOClause" | DELETE "deleteSCOClause"
addDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING" SET REF DATA_RULE
"QUOTED_STRING" ( GROUP "QUOTED_STRING" SET REF ( TABLE | VIEW |
MATERIALIZED_VIEW | EXTERNAL_TABLE ) "QUOTED_STRING" ( ATTRIBUTE
"QUOTED_STRING" SET REF COLUMN "QUOTED_STRING" )+ )+ [ SET
"setPropertiesClause" ]
alterDataRuleUsageClauses = ADD "addDataRuleUsageClause" | MODIFY
"modifyDataRuleUsageClause" | DELETE "deleteDataRuleUsageClause"
addRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW ) "QUOTED_STRING"
modifyColumnClause = COLUMN "QUOTED_STRING" ( "renameClause" [
"moveToClause" ] [ SET "setPropertiesClause" ] | "moveToClause" [ SET
"setPropertiesClause" ] | SET "setPropertiesClause" )
modifyViewConstraintClause = "modifyUkPkClause" | "modifyFkClause"
modifySCOClause = "modifyIndexClause" | "modifyIndexPartitionClause" |
"modifyIndexPartitionKeyClause" | "modifyPartitionClause" |
"modifyPartitionKeyClause" |
"modifyaddMaterializedViewSCOandDependentClauseClause" |
"modifySubPartitionClause" | "modifySubPartitionKeyClause" |
"modifyIndexColumnClause"
modifyDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" )
deleteColumnClause = COLUMN "QUOTED_STRING"
deleteViewConstraintClause = UNIQUE_KEY "QUOTED_STRING" | PRIMARY_KEY
"QUOTED_STRING" | FOREIGN_KEY "QUOTED_STRING"
deleteSCOClause = INDEX "QUOTED_STRING" | PARTITION "QUOTED_STRING" |
PARTITION_KEY "QUOTED_STRING" | TEMPLATE_SUBPARTITION "QUOTED_STRING"
| SUBPARTITION_KEY "QUOTED_STRING" | INDEX_COLUMN "QUOTED_STRING" OF
INDEX "QUOTED_STRING" | INDEX_PARTITION "QUOTED_STRING" OF INDEX
"QUOTED_STRING" | INDEX_PARTITION_KEY "QUOTED_STRING" OF INDEX
"QUOTED_STRING" | SUBPARTITION "QUOTED_STRING" OF PARTITION
"QUOTED_STRING"
deleteDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING"
deleteRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW ) "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ SET
"setUkPkPropertiesAndReferencesColumnsClauses" ]
addFkClause = FOREIGN_KEY "QUOTED_STRING" [ SET "setFkSubClauses" ]
addIndexClause = INDEX "QUOTED_STRING" [ SET
"setSCOConfigurationPropertiesClauses" ]
addIndexPartitionClause = INDEX_PARTITION "QUOTED_STRING" OF INDEX
"QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] (
"renameSCOConfigurationClause" [ SET
"setSCOConfigurationPropertiesClauses" ] | [ SET
"setSCOConfigurationPropertiesClauses" ] )
addIndexPartitionKeyClause = INDEX_PARTITION_KEY "QUOTED_STRING" OF INDEX
"QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ]
addPartitionClause = PARTITION "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setSCOConfigurationPropertiesClauses" ]
addPartitionKeyClause = PARTITION_KEY "QUOTED_STRING" [ SET
"setSCOConfigurationPropertiesClauses" ]
addSubpartitionClause = SUBPARTITION "QUOTED_STRING" OF PARTITION
"QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET
"setSCOConfigurationPropertiesClauses" ]
addaddMaterializedViewSCOandDependentClauseClause = TEMPLATE_SUBPARTITION
"QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET
"setSCOConfigurationPropertiesClauses" ]
addSubPartitionKeyClause = SUBPARTITION_KEY "QUOTED_STRING" [ SET
"setSCOConfigurationPropertiesClauses" ]
addIndexColumnClause = INDEX_COLUMN "QUOTED_STRING" OF INDEX
"QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ]
moveToClause = MOVE TO POSITION "INTEGER_LITERAL"
modifyUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" (
"renameClause" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ]
| SET "setUkPkPropertiesAndReferencesColumnsClauses" )
modifyFkClause = FOREIGN_KEY "QUOTED_STRING" ( "renameClause" [ SET
"setFkSubClauses" ] | SET "setFkSubClauses" )
modifyIndexClause = INDEX "QUOTED_STRING" ( "renameSCOConfigurationClause"
[ SET "setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifyIndexPartitionClause = INDEX_PARTITION "QUOTED_STRING" OF INDEX
"QUOTED_STRING" ( "renameSCOConfigurationClause" [
"moveToClauseIndexPartition" ] [ SET
"setSCOConfigurationPropertiesClauses" ] |
"moveToClauseIndexPartition" [ SET
"setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifyIndexPartitionKeyClause = INDEX_PARTITION_KEY "QUOTED_STRING" OF
INDEX "QUOTED_STRING" ( SET "setSCOConfigurationPropertiesClauses" )
modifyPartitionClause = PARTITION "QUOTED_STRING" (
"renameSCOConfigurationClause" [ "moveToClausePartition" ] [ SET
"setSCOConfigurationPropertiesClauses" ] | "moveToClausePartition" [
SET "setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifyPartitionKeyClause = PARTITION_KEY "QUOTED_STRING" (
"renameSCOConfigurationClause" [ SET
"setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifyaddMaterializedViewSCOandDependentClauseClause =
TEMPLATE_SUBPARTITION "QUOTED_STRING" ( "renameSCOConfigurationClause"
[ "moveToClauseTemplateSubPartition" ] [ SET
"setSCOConfigurationPropertiesClauses" ] |
"moveToClauseTemplateSubPartition" [ SET
"setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifySubPartitionClause = SUBPARTITION "QUOTED_STRING" OF PARTITION
"QUOTED_STRING" ( "renameSCOConfigurationClause" [
"moveToClauseSubPartition" ] [ SET
"setSCOConfigurationPropertiesClauses" ] | "moveToClauseSubPartition"
[ SET "setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifySubPartitionKeyClause = SUBPARTITION_KEY "QUOTED_STRING" (
"renameSCOConfigurationClause" [ SET
"setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
modifyIndexColumnClause = INDEX_COLUMN "QUOTED_STRING" OF INDEX
"QUOTED_STRING" ( "renameSCOConfigurationClause" [
"moveToClauseForIndexColumn" ] [ SET
"setSCOConfigurationPropertiesClauses" ] |
"moveToClauseForIndexColumn" [ SET
"setSCOConfigurationPropertiesClauses" ] | SET
"setSCOConfigurationPropertiesClauses" )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setUkPkPropertiesAndReferencesColumnsClauses = "setPropertiesClause" [ SET
( REF | REFERENCE ) "constraintColumnReferencesClause" ] | ( REF |
REFERENCE ) "constraintColumnReferencesClause"
setFkSubClauses = "setPropertiesClause" [ SET ( REF | REFERENCE )
"setFkReferencesClauses" ] | ( REF | REFERENCE )
"setFkReferencesClauses"
setSCOConfigurationPropertiesClauses = PROPERTIES "(" "propertyNameList"
")" VALUES "(" "propertyValueList" ")"
renameSCOConfigurationClause = RENAME TO "QUOTED_STRING"
moveToClauseIndexPartition = MOVE TO POSITION "INTEGER_LITERAL"
moveToClausePartition = MOVE TO POSITION "INTEGER_LITERAL"
moveToClauseTemplateSubPartition = MOVE TO POSITION "INTEGER_LITERAL"
moveToClauseSubPartition = MOVE TO POSITION "INTEGER_LITERAL"
moveToClauseForIndexColumn = MOVE TO POSITION "INTEGER_LITERAL"
constraintColumnReferencesClause = COLUMNS "(" "quotedNameList" ")"
setFkReferencesClauses = "constraintColumnReferencesClause" [ SET ( REF |
REFERENCE ) "constraintUkReferencesClause" ] |
"constraintUkReferencesClause" [ SET ( REF | REFERENCE )
"constraintColumnReferencesClause" ]
quotedNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
constraintUkReferencesClause = ( UNIQUE_KEY | PRIMARY_KEY )
"QUOTED_STRING" [ OF ( TABLE | VIEW ) "QUOTED_STRING" ]
Keywords And Parameters
alterMaterializedViewCommand
This clause alters a materialized view.
QUOTED_STRING
name of the materialized view.
renameClause
renames a table with a different name.
setPropertiesClause
Used to set properties (core, logical, physical, user-defined) for
materialized views (including partitions and subpartitions) and their
columns, indexes (including index partitions), unique keys, foreign keys,
and primary keys.
Note:
Constraints can be specified but will not be generated for either View or
Materialized View in this release.
Basic properties for VIEW, MATERIALIZED_VIEW:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the View, MaterializedView
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the View, MaterializedView
Name: VIEW_QUERY
Type: STRING(4000)
Valid Values: N/A
Default: ''
Sets the query definition in View and MaterializedView.
Basic properties for COLUMN:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the column
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the column
Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, SYS.XMLFORMAT,
TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE,
VARHCAR, VARCHAR2, XMLTYPE
Default: NUMBER
The datatype of a column
Name: LENGTH
Type: NUMBER
Valid Values:
Default: 1
The length of a number
Name: PRECISION
Type: NUMBER
Valid Values: 0 - 38
Default: 1
The precision of a number. Use 0 to specify floating-point numbers.
Name: SCALE
Type: NUMBER
Valid Values: -84 - 127
Default: 1
The scale of a number.
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Default value of the column
Name: NOT_NULL
Type: BOOLEAN
Valid Values: true, false
Default: false
Specify "true" to enforce Not Null restriction on a column.
Basic properties for PARTITION_KEY:
Name: TYPE
Type: STRING
Valid Values: RANGE, LIST, HASH, HASH BY QUANTITY
Default: (No default, must be one of the choices above)
Ask Oracle to partition the table rows according to a Hash Algorithm, lists
of values, or specified ranges.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH partitions the database should create on HASH BY
QUANTITY partitioning. For optimal load balancing you should specify a
number of partitions that is a power of 2. If you have multiple Partition
Keys, you only have to specify once.
Basic properties for PARTITION:
Name: VALUES_LESS_THAN
Type: STRING
Valid Values: N/A
Default: ''
Specify the noninclusive upper bound for the current RANGE partition. The
value list is a comma-delimited, ordered list of literal values
corresponding to the index partitioning column list. Always specify
MAXVALUE(s) as the value(s) of the last partition, and make sure you have
specified PARTITION_KEY(s) before you specify any PARTITION.
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
Specify a list of literal values for the current LIST partition. The value
list is a comma-delimited, ordered list of literal values corresponding to
the index partitioning column. Commas can be escaped using "" (e.g.
'1,2,3'). Always specify DEFAULT as the value of the last partition, and
make sure you have specified PARTITION_KEY(s) before you specify any
PARTITION.. Each LIST partition must have at least one value. No value,
including NULL, can appear in more than one partition.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH customized subpartitions the database should create
for a particular main RANGE partition (RANGE-HASH BY QUANTITY
partitioning). For optimal load balancing you should specify a number of
subpartitions that is a power of 2. If you have multiple Subpartition Keys,
you only have to specify once. Set it to 0 to reverse to the use of generic
template HASH_QUANTITY specified in SUBPARTITION_KEY.
Basic properties for SUBPARTITION_KEY:
Name: TYPE
Type: STRING
Valid Values: LIST, HASH, HASH BY QUANTITY
Default: (No default, must be one of the choices above)
For partition-level partitioning according to a Hash Algorithm or lists of
values. Each partition is further sorted into subpartitions.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH subpartitions the database should create on HASH BY
QUANTITY partitioning. For optimal load balancing you should specify a
number of subpartitions that is a power of 2. If you have multiple
Subpartition Keys, you only have to specify once.
Basic properties for SUBPARTITION:
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
Specify a list of literal values for the current LIST subpartition. The
value list is a comma-delimited, ordered list of literal values
corresponding to the index partitioning column. Always specify DEFAULT as
the value of the last subpartition, and make sure you have specified
SUBPARTITION_KEY(s) before you specify any SUBPARTITION. Each LIST
subpartition must have at least one value. No value, including NULL, can
appear in more than one subpartition.
Basic properties for TEMPLATE_SUBPARTITION:
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
In composite partitioning, template subpartitions are automatically applied
to those partitions without their subpartitions specified. Here for LIST
subpartitions only, specify a comma-delimited, ordered list of literal
values corresponding to the LIST subpartitioning column. Always specify
DEFAULT as the value of the last template LIST subpartition, and and make
sure you have specified SUBPARTITION_KEY(s) before you specify any
TEMPLATE_SUBPARTITION. Each LIST template subpartition must have at least
one value. No value, including NULL, can appear in more than one template
subpartition.
Basic properties for INDEX:
Name: INDEX_TYPE
Type: STRING
Valid Values: UNIQUE, NON-UNIQUE, BITMAP, FUNCTION-BASED
Default: (No default, must be one of the choices above)
Specify the type of an index. NORMAL can be used in place of NON-UNIQUE.
Name: LOCAL_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Specify if an index is Global or Local. The default is Global.
Specify Local so that the index is partitioned on the same columns, with
the same number of partitions and the same partition bounds as table.
Oracle Database automatically maintains local index partitioning as the
underlying table is repartitioned.
Name: COLUMN_EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
Specify an expression built from columns of table, constants, SQL
functions, and user-defined functions to create a FUNCTION-BASED index.
Basic properties for INDEX_PARTITION_KEY:
Name: TYPE
Type: STRING
Valid Values: RANGE, HASH, HASH BY QUANTITY
Default: (No default, must be one of the choices above)
Ask Oracle to partition the index rows according to a Hash Algorithm, lists
of values, or specified ranges. Hash index partitioning is supported
starting with Oracle 10g version.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH index partitions the database should create based on
HASH BY QUANTITY partitioning. For optimal load balancing you should
specify a number of index partitions that is a power of 2. If you have
multiple index Partition Keys, you only have to specify once.
Basic properties for INDEX_PARTITION:
Name: VALUES_LESS_THAN
Type: STRING
Valid Values: N/A
Default: ''
Specify the noninclusive upper bound for the current RANGE partition in a
global index. The value list is a comma-delimited, ordered list of literal
values corresponding to the index partitioning column list. Always specify
MAXVALUE(s) as the value(s) of the last partition. No need to specify
VALUES_LESS_THAN for Local index.
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
Specify a list of literal values for the current LIST partition in a global
index. The value list is a comma-delimited, ordered list of literal values
corresponding to the index partitioning column. Always specify DEFAULT as
the value of the last partition. Each LIST partition must have at least one
value. No value, including NULL, can appear in more than one partition. No
need to specify VALUES_EQUAL_TO for Local index.
Basic properties for CHECK_CONSTRAINTS:
Name: CHECK_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
Specify a condition that each row in the table must satisfy.
Properties for MATERIALIZED_VIEW:
Name: BASE_TABLES
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: BUFFER_POOL
Type: STRING
Valid Values: , DEFAULT, KEEP, RECYCLE
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.BUFFERPOOL:DESCRIPTION"
Name: BUILD
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE, PREBUILT
Default: ''
Description not available.
Name: CONSTRAINTS
Type: STRING
Valid Values: , ENFORCED, TRUSTED
Default: ''
Description not available.
Name: DEFAULTINDEXBUFFERPOOL
Type: STRING
Valid Values: , DEFAULT, KEEP, RECYCLE
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.DEFAULTINDEXBUFFERPOOL:DESCRIPTION"
Name: DEFAULTINDEXFREELISTGROUPS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.DEFAULTINDEXFREELISTGROUPS:DESCRIPTION"
Name: DEFAULTINDEXFREELISTS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.DEFAULTINDEXFREELISTS:DESCRIPTION"
Name: DEFAULTINDEXINITIAL
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.DEFAULTINDEXINITIAL:DESCRIPTION"
Name: DEFAULTINDEXINITRANS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.DEFAULTINDEXINITRANS:DESCRIPTION"
Name: DEFAULTINDEXMAXEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.DEFAULTINDEXMAXEXTENTS:DESCRIPTION"
Name: DEFAULTINDEXMAXTRANS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.DEFAULTINDEXMAXTRANS:DESCRIPTION"
Name: DEFAULTINDEXMINEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.DEFAULTINDEXMINEXTENTS:DESCRIPTION"
Name: DEFAULTINDEXNEXT
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.DEFAULTINDEXNEXT:DESCRIPTION"
Name: DEFAULTINDEXPCTINCREASE
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.DEFAULTINDEXPCTINCREASE:DESCRIPTION"
Name: DEFAULT_INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.DEFAULTINDEXSTOREIN:DESCRIPTION"
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Description not available.
Name: FOR_UPDATE
Type: STRING
Valid Values: , NO, YES
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.FORUPDATE:DESCRIPTION"
Name: FREELISTGROUPS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.FREELISTGROUPS:DESCRIPTION"
Name: FREELISTS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.FREELISTS:DESCRIPTION"
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: HASH_PARTITION_TABLESPACE_LIST
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: INITIAL
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.INITIAL:DESCRIPTION"
Name: INITRANS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.INITRANS:DESCRIPTION"
Name: LOGGING_MODE
Type: STRING
Valid Values: , LOGGING, NOLOGGING
Default: ''
Description not available.
Name: MAXEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.MAXEXTENTS:DESCRIPTION"
Name: MAXTRANS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.MAXTRANS:DESCRIPTION"
Name: MINEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.MINEXTENTS:DESCRIPTION"
Name: NEXT
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: NEXTDATE
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.NEXTDATE:DESCRIPTION"
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: , NOPARALLEL, PARALLEL
Default: ''
Description not available.
Name: PARALLEL_DEGREE
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.PARALLELDEGREE:DESCRIPTION"
Name: PCTFREE
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.PCTFREE:DESCRIPTION"
Name: PCTINCREASE
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.PCTINCREASE:DESCRIPTION"
Name: PCTUSED
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.PCTUSED:DESCRIPTION"
Name: QUERY_REWRITE
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.QUERY REWRITE:DESCRIPTION"
Name: REFRESH
Type: STRING
Valid Values: , COMPLETE, FAST, FORCE, NEVER
Default: ''
Description not available.
Name: REFRESH_ON
Type: STRING
Valid Values: , COMMIT, DEMAND
Default: ''
Description not available.
Name: ROLLBACK
Type: STRING
Valid Values: , DEFAULT, DEFAULT LOCAL, DEFAULT MASTER, NONE
Default: DEFAULT LOCAL
Description not available.
Name: ROLLBACKSEGMENTLOCAL
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: ROLLBACKSEGMENTMASTER
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: SHADOW_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.SHADOWTABLE.TABLESPACE:DESCRIPTION"
Name: SHADOW_TABLE_NAME
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.MATERIALIZEDVIEWS.SHADOWTABLE.TABLENAME:DESCRIPTION"
Name: STARTWITH
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Description not available.
Name: USING_INDEX_MODE
Type: STRING
Valid Values: , USING_INDEX, USING_NO_INDEX
Default: ''
Description not available.
Name: WITH
Type: STRING
Valid Values: , PRIMARY_KEY, ROWID
Default: ''
Description not available.
Properties for UNIQUE_KEY:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.TABLE.CONSTRAINT.INDEXTABLESPACE:DESCRIPTION"
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.TABLE.CONSTRAINT.USINGINDEX:DESCRIPTION"
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Properties for FOREIGN_KEY:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: ONDELETE
Type: STRING
Valid Values: , CASCADE, SET NULL
Default: ''
Specify CASCADE if you want Oracle to remove dependent foreign key values.
Specify SET NULL if you want Oracle to convert dependent foreign key values
to NULL.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Properties for CHECK_CONSTRAINT:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Properties for INDEX:
Name: BUFFER_POOL
Type: STRING
Valid Values: , DEFAULT, KEEP, RECYCLE
Default: ''
Specify a default buffer pool (cache) for table or partition object. The
default is DEFAULT.
Name: COMPUTESTATISTICS
Type: STRING
Valid Values: , NO, YES
Default: ''
Specify YES to collect statistics at relatively little cost during the
creation of an index.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: FREELISTGROUPS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of groups of free lists for the database object you are
creating. The default is 1.
Name: FREELISTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of free lists for each of the free list groups for the
table, partition, cluster, or index. The default is 1.
Name: INDEXORDER
Type: STRING
Valid Values: , ASC, DESC
Default: ''
Use ASC or DESC to indicate whether the index should be created in
ascending or descending order. The Oracle default is ASC.
Name: INITIAL
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the first extent. Use K or M to specify size
in kilobytes or megabytes.
Name: INITRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the initial number (2-255) of concurrent transaction entries
allocated within each data block allocated to the database object. The
default is 2 for Index.
Name: KEYCOMPRESS
Type: STRING
Valid Values: , COMPRESS, NOCOMPRESS
Default: ''
Specify COMPRESS to enable key compression.
Name: KEYCOMPRESSPREFIXLENGTH
Type: STRING
Valid Values: N/A
Default: ''
Specify the prefix length (number of prefix columns to compress). For
unique indexes, the valid range of prefix length values is from 1 to the
number of key columns minus 1. The default prefix length is the number of
key columns minus 1. For nonunique indexes, the valid range of prefix
length values is from 1 to the number of key columns. The default prefix
length is the number of key columns. Oracle compresses only nonpartitioned
indexes that are nonunique or unique indexes of at least two columns. You
cannot specify COMPRESS for a bitmap index.
Name: LOGGING_MODE
Type: STRING
Valid Values: , LOGGING, NOLOGGING
Default: ''
Specify whether the creation of the table and of any indexes required
because of constraints, partition, or LOB storage characteristics will be
logged in the redo log file (LOGGING) or not (NOLOGGING). The default is
LOGGING.
Name: MAXEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents, including the first, that Oracle can
allocate for the object.
Name: MAXTRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the maximum number (2-255) of concurrent transactions that can
update a data block allocated to the database object.
Name: MINEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents to allocate when the object is created.
Name: NEXT
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the next extent to be allocated. Use K or M to
specify size in kilobytes or megabytes.
Name: ONLINE
Type: STRING
Valid Values: , NO, YES
Default: ''
Specify YES to indicate that DML operations on the table will be allowed
during creation of the index.
Name: OPTIMAL
Type: STRING
Valid Values: N/A
Default: ''
Specifies an optimal size in bytes for a rollback segment. Use K or M to
specify this size in kilobytes or megabytes. Specify NULL for no optimal
size for the rollback segment. The default is NULL.
Name: OVERFLOW
Type: STRING
Valid Values: N/A
Default: ''
Enter a comma separated list of Index tablespaces for overflow data. For
simple-partitoned object, it is used for HASH BY QUANTITY partition
overflow Index tablespaces. The number of Index tablespaces does not have
to equal the number of partitions. If the number of partitions is greater
than the number of Index tablespaces, then Oracle cycles through the names
of the Index tablespaces.
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: , NOPARALLEL, PARALLEL
Default: ''
Enables or disables parallel processing when the table is created. Also
enables or disables parallel processing or access. The default is PARALLEL.
Name: PARALLEL_DEGREE
Type: STRING
Valid Values: N/A
Default: ''
Enter degree of parallelism, which is the number of parallel threads used
in the parallel operation.
Name: PARTITION_TABLESPACE_LIST
Type: STRING
Valid Values: N/A
Default: ''
Enter a comma separated list of tablespaces for a locally partitioned
index. For simple-partitoned object, it is used for HASH BY QUANTITY
partition tablespaces. If specified, then individual local Hash index
partitions specified will be ignored for Local Hash or Range-Hash Index
partitioning.
Name: PCTFREE
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the percentage (0-99) of space in each
data block of the database object reserved for future updates to the rows
of the object. The default is 10.
Name: PCTINCREASE
Type: STRING
Valid Values: N/A
Default: ''
Specify the percent by which the third and subsequent extents grow over the
preceding extent. The default is 50.
Name: SORT
Type: STRING
Valid Values: , NOSORT, REVERSE, SORT
Default: ''
Specify NOSORT to indicate to Oracle that the rows are already stored in
the database in ascending order. Specify REVERSE to store the bytes of the
index block in reverse order, excluding the rowid.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Properties for PARTITION:
Name: BUFFER_POOL
Type: STRING
Valid Values: , DEFAULT, KEEP, RECYCLE
Default: ''
Specify a default buffer pool (cache) for table or partition object. The
default is DEFAULT.
Name: DATA_SEGMENT_COMPRESSION
Type: STRING
Valid Values: , COMPRESS, NOCOMPRESS
Default: ''
Use this clause to instruct Oracle whether to compress data segments to
reduce disk use. The default is NOCOMPRESS.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: FREELISTGROUPS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of groups of free lists for the database object you are
creating. The default is 1.
Name: FREELISTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of free lists for each of the free list groups for the
table, partition, cluster, or index.
Name: INITIAL
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the first extent. Use K or M to specify size
in kilobytes or megabytes.
Name: INITRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the initial number (1-255) of concurrent transaction entries
allocated within each data block allocated to the database object. The
default is 1 for Table and 2 for Index.
Name: LOGGING_MODE
Type: STRING
Valid Values: , LOGGING, NOLOGGING
Default: ''
Specify whether the creation of the table and of any indexes required
because of constraints, partition, or LOB storage characteristics will be
logged in the redo log file (LOGGING) or not (NOLOGGING). The default is
LOGGING.
Name: MAXEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents, including the first, that Oracle can
allocate for the object.
Name: MAXTRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the maximum number (1-255) of concurrent transactions that can
update a data block allocated to the database object.
Name: MINEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents to allocate when the object is created.
Name: NEXT
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the next extent to be allocated. Use K or M to
specify size in kilobytes or megabytes.
Name: OPTIMAL
Type: STRING
Valid Values: N/A
Default: ''
Specifies an optimal size in bytes for a rollback segment. Use K or M to
specify this size in kilobytes or megabytes. Specify NULL for no optimal
size for the rollback segment. The default is NULL.
Name: PCTFREE
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the percentage (0-99) of space in each
data block of the database object reserved for future updates to the rows
of the object. The default is 10.
Name: PCTINCREASE
Type: STRING
Valid Values: N/A
Default: ''
Specify the percent by which the third and subsequent extents grow over the
preceding extent. The default is 50.
Name: PCTUSED
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the minimum percentage (0-99) of used
space that Oracle maintains for each data block of the database object. The
default is 40.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
addColumnClauseForAlter
This clause adds a column at a particular position.
When you alter a table and add columns to it, the position you specify for
a new column must be less than or equal to the number of columns added up
to that point in the OMBALTER command.
For example, a table TEMP_TAB contains three columns. You use the following
OMBALTER TABLE command to add three more columns:
OMBALTER TABLE 'TEMP_TAB' \
ADD COLUMN 'C4' AT POSITION 4 \
SET PROPERTIES(DATATYPE,PRECISION) VALUES('NUMBER',7) \
ADD COLUMN 'C5' AT POSITION 6 \
SET PROPERTIES(DATATYPE) VALUES('VARCHAR2') \
ADD COLUMN 'C6' AT POSITION 5 \
SET PROPERTIES(DATATYPE,PRECISION) VALUES('NUMBER',10);
This command does not execute successfully because at the point when you
specify the position of the column C5 as 6, the table is contains only 5
columns.
QUOTED_STRING
The column name.
addViewConstraintClause
This clause adds the view's configuration clause.
alterViewConstraintClauses
This clause alters the view's constraint clause.
addSCOClause
This clause will add SCOs.
addDataRuleUsageClause
Add a data rule usage to the relation.
alterDataRuleUsageClauses
Add, modify, or delete data rule usages.
addRelationalDependentClause
This clause adds referential dependencies to other relational objects.
modifyColumnClause
This clause renames, set properties, and move columns.
modifyViewConstraintClause
This clause modifies the view's constraint clause.
modifySCOClause
This clause will modify SCOs.
modifyDataRuleUsageClause
Rename or modify the properties of a data rule usage.
deleteColumnClause
This clause deletes a column.
deleteViewConstraintClause
This clause deletes the view's constraint.
deleteSCOClause
This clause deletes a SCO.
QUOTED_STRING
Either index, partition, partition_key, or index column name.
deleteDataRuleUsageClause
Delete a data rule usage.
deleteRelationalDependentClause
This clause deletes referential dependencies to other relational objects.
propertyNameList
The list of properties.
propertyValueList
The list of property values.
addUkPkClause
This clause adds the adds unique key and primary keys.
QUOTED_STRING
name of the unique key or primary key.
addFkClause
This clause adds foreign key.
QUOTED_STRING
Name of the foreign key.
addIndexClause
This clause adds an index.
QUOTED_STRING
Name of the index.
addPartitionClause
This clause adds a partition.
QUOTED_STRING
Name of the partition.
addPartitionKeyClause
This clause adds a partition key.
QUOTED_STRING
Name of the partition key. This should be a column identifier.
addIndexColumnClause
This clause will add index column to a specified index.
QUOTED_STRING
This should be a column identifier of owning object (such as a table) of
the index.
moveToClause
This clause will move the column to given position.
modifyUkPkClause
It modifies unique or primary key.
modifyFkClause
This clause modifies the foreign key.
modifyIndexClause
This clause modifies the Index.
QUOTED_STRING
Name of the index.
modifyPartitionClause
This clause modifies a partition.
QUOTED_STRING
Name of the partition.
modifyPartitionKeyClause
This clause modifies a partition key.
QUOTED_STRING
Name of the partition key.
modifyIndexColumnClause
Modifies the Index Column. The first quoted_string in this clause denotes
index column name, and the latter denotes index.
propertyValue
This clause adds the property values.
setUkPkPropertiesAndReferencesColumnsClauses
This clause adds properties and references to columns.
setFkSubClauses
This clause set references to a foreign key.
setSCOConfigurationPropertiesClauses
Set the configuration properties for the following:
- Partition, Subpartition, and Template Subpartition: All refer to
configuration properties of Partition.
- Index, and Index Partition: For Index Partition, refer to configuration
properties of Partition.
renameSCOConfigurationClause
This clause renames configuration objects.
constraintColumnReferencesClause
This clause provides names of all columns.
setFkReferencesClauses
This clause sets foreign key references.
quotedNameList
This clause gives column names.
constraintUkReferencesClause
The first QUOTED_STRING denotes the UniqueKey or Primay key name, and the
latter denotes the table's or view's name.
See Also
OMBALTER, OMBCREATE MATERIALIZED_VIEW, OMBDROP MATERIALIZED_VIEW, OMBRETRIEVE MATERIALIZED_VIEW
Purpose
Modify an existing metadata loader action plan.
Prerequisites
Connection must be established to the repository.
Syntax
alterMDLActionPlanCommand = ( OMBALTER ( MDL_ACTION_PLAN ) "QUOTED_STRING"
( "alterActionPlanClause" { "alterActionPlanClause" } ) )
alterActionPlanClause = "renameActionPlanClause" | "addActionClause" |
"deleteActionClause" | "modifyActionClause"
renameActionPlanClause = RENAME TO "QUOTED_STRING"
addActionClause = ADD ACTION "QUOTED_STRING" "setReferenceClause"
deleteActionClause = DELETE ACTION "QUOTED_STRING"
modifyActionClause = MODIFY ACTION "QUOTED_STRING" "modifyActionOperation"
{ "modifyActionOperation" }
setReferenceClause = SET ( REF | REFERENCE ) ( "referenceValueClause" )
modifyActionOperation = "renameActionClause" | "setReferenceClause" |
"deleteReferenceClause"
referenceValueClause = "objectTypeValue" "QUOTED_STRING" [ SET ( REF |
REFERENCE ) "referenceValueClause" ]
renameActionClause = RENAME TO "QUOTED_STRING"
deleteReferenceClause = DELETE REFERENCE "objectTypeValue" "QUOTED_STRING"
objectTypeValue = ( PROJECT | ORACLE_MODULE | TABLE | VIEW | SEQUENCE |
MATERIALIZED_VIEW | FUNCTION | PROCEDURE | PACKAGE | DIMENSION | CUBE
| ADVANCED_QUEUE | STREAMS_QUEUE | MAPPING | REAL_TIME_MAPPING |
PROCESS_FLOW_MODULE | PROCESS_FLOW_PACKAGE | PROCESS_FLOW | SAP_MODULE
| CMI_MODULE | GATEWAY_MODULE | EXTERNAL_TABLE | FLAT_FILE_MODULE |
FLAT_FILE | BUSINESS_DEFINITION_MODULE | ITEM_FOLDER | LIST_OF_VALUES
| DRILL_TO_DETAIL | ALTERNATIVE_SORT_ORDER | DRILL_PATH |
BUSINESS_AREA | LOCATION | CONNECTOR | CONTROL_CENTER | CONFIGURATION
| COLLECTION | SNAPSHOT | ROLE | USER | ICONSET |
TRANSFORMATION_MODULE | CALENDAR_MODULE | CALENDAR_FOLDER | CALENDAR |
EXPERT_MODULE | EXPERT | DATA_RULE_MODULE | DATA_RULE | DATA_AUDITOR
| STREAMS_CAPTURE_PROCESS | QUEUE_TABLE | QUEUE_PROPAGATION |
OBJECT_TYPE | NESTED_TABLE | VARYING_ARRAY | DEPLOYMENT | DATA_PROFILE
| PROFILE_REFERENCE | PLSQL_TABLE_TYPE | PLSQL_RECORD_TYPE |
PLSQL_REF_CURSOR_TYPE | PLUGGABLE_MAPPING | PLUGGABLE_MAPPING_FOLDER |
CMI_DEFINITION | ACTIVITY_TEMPLATE | ACTIVITY_TEMPLATE_FOLDER |
TRANSPORTABLE_MODULE )
Keywords And Parameters
alterMDLActionPlanCommand
Modify an existing metadata loader action plan.
alterActionPlanClause
The type of altering that can be performed on the action plan.
renameActionPlanClause
Rename an action plan.
addActionClause
Add an action to an action plan.
deleteActionClause
Removes an action from an action plan.
modifyActionClause
Modify an action of an action plan.
setReferenceClause
Specify the object type and the absolute path name of an object.
modifyActionOperation
The type of operations that can be performed on an action.
referenceValueClause
Specify a first-class object type and the absolute pathname of an object.
QUOTED_STRING
Absolute path name of an object (e.g. '/MY_PROJECT/MODULE_X/TABLE_Y').
renameActionClause
Rename an action of an action plan.
deleteReferenceClause
Remove a reference object from an action plan.
objectTypeValue
The first-class object type that is allowed to be specified in the
referenceValueClause.
See Also
OMBCREATE MDL_ACTION_PLAN, OMBDROP MDL_ACTION_PLAN, OMBRETRIEVE MDL_ACTION_PLAN, OMUEXPORT MDL_FILE
Purpose
Alter the Nested Table by resetting its properties.
Prerequisites
Should be in the context of an Oracle Module.
Syntax
alterNestedTableCommand = OMBALTER ( NESTED_TABLE "QUOTED_STRING" (
"renameClause" [ "alterPropertiesOrIconSetClause" ] |
"alterPropertiesOrIconSetClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET ( REF |
REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
renameClause
renames a table with a different name.
setPropertiesClause
Basic properties for NESTED_TABLE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Nested Table
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Nested Table
Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, SYS.XMLFORMAT,
TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE,
VARHCAR, VARCHAR2, XMLTYPE
Default: ''
Datatype of the Base Element of the Nested Table
Properties for NESTED_TABLE:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
OMBALTER, OMBCREATE NESTED_TABLE, OMBDROP NESTED_TABLE
Purpose
Alter the Object Type by resetting its properties or adding/removing its attributes.
Prerequisites
Should be in the context of an Oracle Module.
Syntax
alterObjectTypeCommand = OMBALTER ( OBJECT_TYPE "QUOTED_STRING" (
"renameClause" [ "alterPropertiesOrIconSetClause" ] [
"alterAttributesClause" ] | "alterPropertiesOrIconSetClause" [
"alterAttributesClause" ] | "alterAttributesClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET ( REF |
REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause"
alterAttributesClause = ( "addAttributeClause" | "deleteAttributeClause" |
"modifyAttributeClause" )+
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ICONSET
addAttributeClause = ADD OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING" [ AT
POSITION "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
deleteAttributeClause = DELETE OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING"
modifyAttributeClause = MODIFY OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING" (
"renameClause" [ "moveToAttributeClause" ] [ SET "setPropertiesClause"
] | "moveToAttributeClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
moveToAttributeClause = MOVE TO POSITION "INTEGER_LITERAL"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterObjectTypeCommand
Alters an Object Type of the given name by either renaming it, or by
setting it's properties or by modifying one or more of its Attributes or a
combination of these.
renameClause
renames a table with a different name.
alterAttributesClause
Adds, deletes or modifies one or more Attributes of this Object Type.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for Object Type or
its Attributes.
Basic properties for OBJECT_TYPE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Object Type
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Object Type
Basic properties for OBJECT_TYPE_ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Attribute
Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, SYS.XMLFORMAT,
TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE,
VARHCAR, VARCHAR2, XMLTYPE
Default: ''
Datatype of the Attribute
Properties for OBJECT_TYPE:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
addAttributeClause
Adds an Attribute with the given name and properties.
deleteAttributeClause
Deletes an Attribute with the given name.
modifyAttributeClause
Modifies an Attribute with the given name by either renaming it or changing
its properties or both.
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
OMBALTER, OMBRETRIEVE OBJECT_TYPE, OMBCREATE OBJECT_TYPE, OMBDROP OBJECT_TYPE
Purpose
Alter the Oracle module by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of project.
Syntax
alterOracleModuleCommand = OMBALTER ( ORACLE_MODULE "QUOTED_STRING" (
"renameClause" [
"alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
"alterPropertiesOrReferenceClauseForDataMetadataModule" |
"addOrRemoveOrModifyModuleReferenceLocationClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrReferenceClauseForDataMetadataModule = ( ( SET ( (
"alterPropertiesClause" [ ( SET
"setReferenceClauseForDataMetadataModule" [ UNSET
"unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
"unsetReferenceClauseForDataMetadataModule" [ SET
"setReferenceClauseForDataMetadataModule" ] ) ] ) | (
"setReferenceClauseForDataMetadataModule" [ UNSET
"unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
"unsetReferenceClauseForDataMetadataModule" [ SET
"setReferenceClauseForDataMetadataModule" ] ) ) [
"addOrRemoveOrModifyModuleReferenceLocationClause" ]
addOrRemoveOrModifyModuleReferenceLocationClause = (
"addReferenceLocationClause" | "removeReferenceLocationClause" |
"modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
"removeReferenceLocationClause" | "modifyReferenceLocationClause" }
alterPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataMetadataModule = ( "setReferenceLocationClause" [
SET "setReferenceMetadataLocationOrIconSetClause" ] |
"setReferenceMetadataLocationOrIconSetClause" )
unsetReferenceClauseForDataMetadataModule = (
"unsetReferenceLocationClause" [ UNSET
"unsetReferenceMetadataLocationOrIconSetClause" ] |
"unsetReferenceMetadataLocationOrIconSetClause" )
addReferenceLocationClause = ADD ( REFERENCE | REF ) LOCATION
"QUOTED_STRING" [ SET AS DEFAULT ]
removeReferenceLocationClause = REMOVE ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
modifyReferenceLocationClause = MODIFY ( REFERENCE | REF ) LOCATION
"QUOTED_STRING" SET AS DEFAULT
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceMetadataLocationOrIconSetClause = (
"setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
] | "setReferenceIconSetClause" )
unsetReferenceLocationClause = ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
unsetReferenceMetadataLocationOrIconSetClause = (
"unsetReferenceMetadataLocationClause" [ UNSET
"unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setReferenceMetadataLocationClause = ( REFERENCE | REF ) METADATA_LOCATION
"QUOTED_STRING"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceMetadataLocationClause = ( REFERENCE | REF )
METADATA_LOCATION "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
Keywords And Parameters
alterOracleModuleCommand
This command modifies an existing Oracle module.
QUOTED_STRING
Name of the existing Oracle module in single quotes.
renameClause
Rename an Oracle module.
alterPropertiesOrReferenceClauseForDataMetadataModule
Alter existing Oracle module's properties and/or locations and/or icon
sets.
addOrRemoveOrModifyModuleReferenceLocationClause
Add/remove/modify runtime location for the Oracle module.
setReferenceClauseForDataMetadataModule
Set location and/or icon set for the Oracle module.
unsetReferenceClauseForDataMetadataModule
Unset location and/or icon set for the Oracle module.
addReferenceLocationClause
Add a runtime location to the Oracle module.
removeReferenceLocationClause
Remove a runtime location from the Oracle module.
modifyReferenceLocationClause
Modify a runtime location of the Oracle module.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
setReferenceLocationClause
Set a location to the existing Oracle module.
setReferenceMetadataLocationOrIconSetClause
Set metadata location and/or icon set for the Oracle module.
unsetReferenceLocationClause
Unset a location to the existing Oracle module.
unsetReferenceMetadataLocationOrIconSetClause
Unset metadata location and/or icon set for the Oracle module.
propertyValue
Value of a property.
setReferenceMetadataLocationClause
Set metadata location for the Oracle module.
setReferenceIconSetClause
Set icon set for the Oracle module.
unsetReferenceMetadataLocationClause
Unset metadata location for the Oracle module.
unsetReferenceIconSetClause
Unset icon set for the Oracle module.
See Also
OMBALTER, OMBCREATE ORACLE_MODULE, OMBDROP ORACLE_MODULE
Purpose
Alter the Package by renaming it, and/or reset its properties, and/or adding/deleting/modifying the user types.
Prerequisites
Should be in the context of a Oracle Module or Transformation Module.
A Transformation Module may be WB_CUSTOM_TRANS for Public Transformations.
WB_CUSTOM_TRANS may by modified by an administrator.
WB_CUSTOM_TRANS is not dependent on any project.
Syntax
alterPackageCommand = OMBALTER ( PACKAGE "QUOTED_STRING" ( "renameClause"
[ "alterPropertiesOrIconSetClause" ] [
"alterRelationalDependentsClause" ] | "alterPropertiesOrIconSetClause"
[ "alterRelationalDependentsClause" ] |
"alterRelationalDependentsClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
alterRelationalDependentsClause = ( ADD "addRelationalDependentClause" |
DELETE "deleteRelationalDependentClause" ) [
"alterRelationalDependentsClause" ]
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
addRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
"QUOTED_STRING"
deleteRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
"QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterPackageCommand
This command modifies an existing Package.
QUOTED_STRING
Name of the existing Package in single quotes.
renameClause
Rename a Package.
alterRelationalDependentsClause
This clause adds or deletes referential dependencies to other relational
objects.
setPropertiesClause
Used to set properties (core, user-defined) for packages. Valid properties
are shown below:
Basic properties for PACKAGE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the package
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the package
Name: PACKAGE_BODY
Type: STRING
Valid Values: N/A
Default: ''
Sets the Package Body for a Imported Package
Properties for PACKAGE:
Name: AUTHID
Type: STRING
Valid Values: Current_User, Definer, None
Default: None
Generate the package with selected AUTHID option. Function will be executed
with the permissions defined by the AUTHID clause rather than the function
owner's permissions.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
addRelationalDependentClause
This clause adds referential dependencies to other relational objects.
deleteRelationalDependentClause
This clause deletes referential dependencies to other relational objects.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
propertyValue
Value of a property.
See Also
OMBALTER, OMBCREATE PACKAGE, OMBDROP PACKAGE
Purpose
Alter the PLSQL Record Type by resetting its properties or adding/removing its attributes.
Prerequisites
Should be in the context of a Package
Syntax
alterPlSqlRecordTypeCommand = OMBALTER ( PLSQL_RECORD_TYPE "QUOTED_STRING"
( "renameClause" [ "alterPropertiesOrIconSetClause" ] [
"alterRecordTypeAttributeClause" ] | "alterPropertiesOrIconSetClause"
[ "alterRecordTypeAttributeClause" ] |
"alterRecordTypeAttributeClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET ( REF |
REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
"unsetReferenceIconSetClause"
alterRecordTypeAttributeClause = ( "addRecordTypeAttributeClause" |
"deleteRecordTypeAttributeClause" | "modifyRecordTypeAttributeClause"
)+
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ICONSET
addRecordTypeAttributeClause = ADD ATTRIBUTE "QUOTED_STRING" [ SET
"setPropertiesClause" ]
deleteRecordTypeAttributeClause = DELETE ATTRIBUTE "QUOTED_STRING"
modifyRecordTypeAttributeClause = MODIFY ATTRIBUTE "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterPlSqlRecordTypeCommand
Alters an PLSQL Record Type of the given name by either renaming it, or by
setting it's properties or by modifying one or more of its Attributes or a
combination of these.
renameClause
renames a table with a different name.
alterRecordTypeAttributeClause
Adds, deletes or modifies one or more Attributes of this PLSQL Record Type.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for PLSQL Record
Type or its Attributes.
Basic properties for PLSQL_RECORD_TYPE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the PLSQL Record Type
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the PLSQL Record Type
Basic properties for ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Attribute
Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, SYS.XMLFORMAT,
TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE,
VARHCAR, VARCHAR2, XMLTYPE
Default: ''
Datatype of the Attribute
Properties for PLSQL_RECORD_TYPE:
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Properties for ATTRIBUTE:
Name: ADDRESS_TYPE
Type: STRING
Valid Values: NA_ADDRTYPE_DUAL, NA_ADDRTYPE_NORMAL
Default: NA_ADDRTYPE_NORMAL
You can designate an address type as Normal or Dual. For example, a dual
address occurs when a record contains both a street address and a P.O. Box;
this is common with business data. A normal address contains only one type
of address.
Name: ATTRIBUTE_ROLE
Type: STRING
Valid Values: END_DATE, LOOKUP_ACTIVE_DATE, MEASURE, NATURAL_KEY, NONE,
PARENT_NATURAL_KEY, PARENT_REF_KEY, PARENT_SURROGATE_KEY, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: BINDING_COLUMN_NAME
Type: STRING
Valid Values: N/A
Default: ''
The binding column name for this attribute
Name: DATA_TYPE
Type: STRING
Valid Values: N/A
Default: ''
The data type of the attribute
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The Default Value for the function input parameter
Name: DIMENSION_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The dimension attribute referenced to by this level attribute.
Name: EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
The output expression for the attribute
Name: FIELD_DATA_TYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE,
FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER
EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH,
LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH
LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARGRAPHIC,
VARRAW, VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
SQL Data Type of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Field Length of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Field Precision of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Field Scale of the field in the file to which this operator is bound.
Name: FIELD_DEFAULTIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is blank or zero,
based on the datatype.
Name: FIELD_END_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The ending position of the field in the file
Name: FIELD_MASK
Type: STRING
Valid Values: N/A
Default: ''
The mask for the field
Name: FIELD_NULLIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is null
Name: FIELD_START_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The starting position of the field in the file
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data fractional seconds precision value of the attribute
Name: FUNCTION_RETURN
Type: BOOLEAN
Valid Values: true, false
Default: false
Specifies whether this output is the return value of this function
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this input attribute is a part of the
unpivot group key.
Name: INPUT_ROLE
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_CITY, NA_COUNTRYCODE,
NA_COUNTRYNAME, NA_FIRMNAME, NA_FIRSTNAME, NA_FIRSTPARTNAME, NA_LASTLINE,
NA_LASTLINE_2, NA_LASTNAME, NA_LASTPARTNAME, NA_LINE1, NA_LINE10, NA_LINE2,
NA_LINE3, NA_LINE4, NA_LINE5, NA_LINE6, NA_LINE7, NA_LINE8, NA_LINE9,
NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_NEIGHBORHOOD, NA_NONE,
NA_PASSTHRU, NA_PERSON, NA_PERSON2, NA_PERSON3, NA_POSTALCODE, NA_POSTNAME,
NA_PRENAME, NA_PRIMARYADDRESS, NA_SECONDARYADDRESS, NA_STATE
Default: NA_NONE
Assigns a name-address input role to the selected input attribute
Name: INSTANCE
Type: STRING
Valid Values: NA_INSTANCE_FIFTH, NA_INSTANCE_FIRST, NA_INSTANCE_FOURTH,
NA_INSTANCE_SECOND, NA_INSTANCE_SIXTH, NA_INSTANCE_THIRD
Default: NA_INSTANCE_FIRST
The instance option is used when an address contains multiple names, you
can specify which name in the group should be used. In addition, you can
use this option to assign an address type to a miscellaneous address
component.
Name: IS_CAST_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: IS_OPTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the input is not required to be connected
Name: IS_PREDEFINED_CONSTANT
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
The data length value of the attribute
Name: LEVEL_ATTRIBUTE_COLNAME_NAME
Type: STRING
Valid Values: N/A
Default: ''
Column name in the AW staging table and source view for this attribute.
Name: LEVEL_ATTRIBUTE_LEVEL_INDICATOR_COLNAME
Type: STRING
Valid Values: N/A
Default: ''
Level indicating columns name. This level will contain the name of the name
of the level this parent reference belongs to. This is relavant only for
skip level hierarchies.
Name: LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Level Attribute.
Name: LEVEL_RELATIONSHIP_NAME
Type: STRING
Valid Values: N/A
Default: ''
The level relationship name associated to this attribute.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
update load operation.
Name: LOOKUP_ATTRIBUTE_ROLE
Type: STRING
Valid Values: DIMENSION_KEY, END_DATE, NATURAL_KEY, NONE, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: MATCHING_ROW
Type: NUMBER
Valid Values: 1 - 1000
Default: 1
An positive integer to indicate from which row within the unpivot group
this output attribute obtains its data.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the update load operation.
Name: MERGE_ATTR
Type: STRING
Valid Values: N/A
Default: ''
Related merge attribute
Name: OUTPUT_COMPONENT
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_ADDRESSCORRECTED, NA_ADDRESSTYPE,
NA_AUTO_ZONE_IND, NA_BOXNAME, NA_BOXNUMBER, NA_BUILDINGNAME, NA_CART,
NA_CBSA_CODE, NA_CBSA_DESC, NA_CENSUSID, NA_CHECKDIGIT, NA_CITY,
NA_CITYCORRECTED, NA_CITYMATCH, NA_CITYWARNING, NA_CITY_ABBREV,
NA_CITY_ABBREV_2, NA_CITY_ALTERNATE, NA_COMPLEX, NA_COUNTRYCODE,
NA_COUNTRYCODE3, NA_COUNTRYNAME, NA_COUNTYNAME, NA_DELIVERYBEATCODE,
NA_DELIVERYOFFICECODE, NA_DELIVERYPOINT, NA_EMAIL, NA_EXTRA_1, NA_EXTRA_10,
NA_EXTRA_11, NA_EXTRA_12, NA_EXTRA_13, NA_EXTRA_14, NA_EXTRA_15,
NA_EXTRA_16, NA_EXTRA_17, NA_EXTRA_18, NA_EXTRA_19, NA_EXTRA_2,
NA_EXTRA_20, NA_EXTRA_3, NA_EXTRA_4, NA_EXTRA_5, NA_EXTRA_6, NA_EXTRA_7,
NA_EXTRA_8, NA_EXTRA_9, NA_FIPS, NA_FIPSCOUNTY, NA_FIPS_PLACE_CODE,
NA_FIRMCOUNT, NA_FIRMNAME, NA_FIRM_LOC, NA_FIRSTNAME, NA_FIRSTNAMESTD,
NA_GENDER, NA_GEO_MATCH_PREC, NA_INSTALLATIONNAME, NA_INSTALLATIONTYPE,
NA_ISADDRESSVERIFIABLE, NA_ISFOUND, NA_ISGOODADDRESS, NA_ISGOODGROUP,
NA_ISGOODNAME, NA_ISPARSED, NA_LACS, NA_LASTLINE, NA_LASTLINE_2,
NA_LASTNAME, NA_LATITUDE, NA_LOCALITYCODE, NA_LOCALITYNAME, NA_LOCALITY_2,
NA_LOCALITY_3, NA_LOCALITY_4, NA_LONGITUDE, NA_LOT, NA_LOT_ORDER, NA_MCD,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME2STD, NA_MIDDLENAME3,
NA_MIDDLENAME3STD, NA_MIDDLENAMESTD, NA_MISCADDRESS, NA_MSA,
NA_NAMEDESIGNATOR, NA_NAMEWARNING, NA_NAME_FIRM_EXTRA, NA_NEIGHBORHOOD,
NA_NONAMBIGUOUSMATCH, NA_NONE, NA_NP_SEC_ADDR, NA_NP_UNIT_DESIG,
NA_NP_UNIT_NBR, NA_OTHERPOSTNAME, NA_PARSESTATUS, NA_PARSESTATUSDESC,
NA_PARSINGCOUNTRY, NA_PASSTHRU, NA_PERSON, NA_PERSONCOUNT, NA_PHONE,
NA_POSTALCODE, NA_POSTALCODECORRECTED, NA_POSTALCODEFORMATTED,
NA_POSTDIRECTIONAL, NA_POSTNAME, NA_PREDIRECTIONAL, NA_PRENAME,
NA_PRIMARYADDRESS, NA_PRIM_NAME_2, NA_RELATIONSHIP, NA_ROUTENAME,
NA_ROUTENUMBER, NA_SECONDARYADDRESS, NA_SSN, NA_STATE,
NA_STREETCOMPCORRECTED, NA_STREETCOMPMATCH, NA_STREETCORRECTED,
NA_STREETNAME, NA_STREETNAMEMATCH, NA_STREETNUMBER, NA_STREETNUMBERMATCH,
NA_STREETTYPE, NA_STREETWARNING, NA_TITLE, NA_UNITDESIGNATOR,
NA_UNITNUMBER, NA_URBANIZATIONNAME, NA_URBAN_IND, NA_ZIP4, NA_ZIP5
Default: NA_NONE
Assigns a Name and Address output component to the selected output
attribute.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parmater
Name: PIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
A comma-separated expression that gives the input attribute to be used for
each output row in the pivot group.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data precision value of the attribute
Name: REFERENCED_LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level attribute associated to this attribute.
Name: REFERENCED_LEVEL_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level group associated to this attribute.
Name: REFERENCING_TYPE
Type: STRING
Valid Values: LOOKUP_KEY, NONE, REFERENCE_KEY_ALL, REFERENCE_KEY_ONLY
Default: NONE
The type of reference to indicate how this attribute participates in
resolving existing level relationships and level implementations. If Lookup
Reference Attribute is specified, this attribute will be used as lookup
attribute upon parent level to resolve level implementations during
loading. If Level Relationship Attribute (Snowflake) is specified, this
attribute will be directly used as level relationship attribute and no
lookup upon parent level would be performed during loading. If Level
Relationship Attribute (Star) is specified, this attribute will be directly
used as level relationship attribute, as well as lookup attribute upon
parent level to resolve level implementations during loading. If none is
specified, this attribute does not participate in any level relationship.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
The data scale value of the attribute
Name: SKIP_LEVEL_DIMENSION
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether this level has a skip level parent.
Name: TYPE_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the field of the PLS Record or attribute of the Object Type or
column of the ROWTYPE that corresponds to this attribute. This property is
not applicable if the return type is TABLE of SCALAR.
Name: UNPIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: NULL
An expression that gives the input attribute to be used as the output of
this attribute.
Name: UPDATE_OPERATION
Type: STRING(3)
Valid Values: +=, -=, =, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data
and the existing data on the target during the update load operation.
Name: VALUETYPE
Type: STRING
Valid Values: NEW, NEW_OLD, OLD
Default: NEW_OLD
Specifies the value type of this attribute
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
addRecordTypeAttributeClause
Adds an Attribute with the given name and properties.
deleteRecordTypeAttributeClause
Deletes an Attribute with the given name.
modifyRecordTypeAttributeClause
Modifies an Attribute with the given name by either renaming it or changing
its properties or both.
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
ALTER, OMBRETRIEVE PLSQL_RECORD_TYPE, OMBCREATE PLSQL_RECORD_TYPE, OMBDROP PLSQL_RECORD_TYPE
Purpose
Alter the Ref-Cursor Type by resetting its properties.
Prerequisites
Should be in the context of a Package.
Syntax
alterPlSqlRefCursorTypeCommand = OMBALTER ( PLSQL_REF_CURSOR_TYPE
"QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterPlSqlRefCursorTypeCommand
Alters a PL/SQL Ref-cursor Type of the given name by setting it's
properties.
renameClause
renames a table with a different name.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for Ref-cursor
Type.
Basic properties for PLSQL_REF_CURSOR_TYPE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Ref-Cursor Type
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Ref-Cursor Type
Name: RETURN_TYPE
Type: STRING(20)
Valid Values: N/A
Default: ''
Return type of the Ref-Cursor Type. This should be a PLSQL Record Type.
Properties for PLSQL_REF_CURSOR_TYPE:
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Properties for ATTRIBUTE:
Name: ADDRESS_TYPE
Type: STRING
Valid Values: NA_ADDRTYPE_DUAL, NA_ADDRTYPE_NORMAL
Default: NA_ADDRTYPE_NORMAL
You can designate an address type as Normal or Dual. For example, a dual
address occurs when a record contains both a street address and a P.O. Box;
this is common with business data. A normal address contains only one type
of address.
Name: ATTRIBUTE_ROLE
Type: STRING
Valid Values: END_DATE, LOOKUP_ACTIVE_DATE, MEASURE, NATURAL_KEY, NONE,
PARENT_NATURAL_KEY, PARENT_REF_KEY, PARENT_SURROGATE_KEY, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: BINDING_COLUMN_NAME
Type: STRING
Valid Values: N/A
Default: ''
The binding column name for this attribute
Name: DATA_TYPE
Type: STRING
Valid Values: N/A
Default: ''
The data type of the attribute
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The Default Value for the function input parameter
Name: DIMENSION_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The dimension attribute referenced to by this level attribute.
Name: EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
The output expression for the attribute
Name: FIELD_DATA_TYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE,
FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER
EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH,
LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH
LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARGRAPHIC,
VARRAW, VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
SQL Data Type of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Field Length of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Field Precision of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Field Scale of the field in the file to which this operator is bound.
Name: FIELD_DEFAULTIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is blank or zero,
based on the datatype.
Name: FIELD_END_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The ending position of the field in the file
Name: FIELD_MASK
Type: STRING
Valid Values: N/A
Default: ''
The mask for the field
Name: FIELD_NULLIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is null
Name: FIELD_START_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The starting position of the field in the file
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data fractional seconds precision value of the attribute
Name: FUNCTION_RETURN
Type: BOOLEAN
Valid Values: true, false
Default: false
Specifies whether this output is the return value of this function
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this input attribute is a part of the
unpivot group key.
Name: INPUT_ROLE
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_CITY, NA_COUNTRYCODE,
NA_COUNTRYNAME, NA_FIRMNAME, NA_FIRSTNAME, NA_FIRSTPARTNAME, NA_LASTLINE,
NA_LASTLINE_2, NA_LASTNAME, NA_LASTPARTNAME, NA_LINE1, NA_LINE10, NA_LINE2,
NA_LINE3, NA_LINE4, NA_LINE5, NA_LINE6, NA_LINE7, NA_LINE8, NA_LINE9,
NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_NEIGHBORHOOD, NA_NONE,
NA_PASSTHRU, NA_PERSON, NA_PERSON2, NA_PERSON3, NA_POSTALCODE, NA_POSTNAME,
NA_PRENAME, NA_PRIMARYADDRESS, NA_SECONDARYADDRESS, NA_STATE
Default: NA_NONE
Assigns a name-address input role to the selected input attribute
Name: INSTANCE
Type: STRING
Valid Values: NA_INSTANCE_FIFTH, NA_INSTANCE_FIRST, NA_INSTANCE_FOURTH,
NA_INSTANCE_SECOND, NA_INSTANCE_SIXTH, NA_INSTANCE_THIRD
Default: NA_INSTANCE_FIRST
The instance option is used when an address contains multiple names, you
can specify which name in the group should be used. In addition, you can
use this option to assign an address type to a miscellaneous address
component.
Name: IS_CAST_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: IS_OPTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the input is not required to be connected
Name: IS_PREDEFINED_CONSTANT
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
The data length value of the attribute
Name: LEVEL_ATTRIBUTE_COLNAME_NAME
Type: STRING
Valid Values: N/A
Default: ''
Column name in the AW staging table and source view for this attribute.
Name: LEVEL_ATTRIBUTE_LEVEL_INDICATOR_COLNAME
Type: STRING
Valid Values: N/A
Default: ''
Level indicating columns name. This level will contain the name of the name
of the level this parent reference belongs to. This is relavant only for
skip level hierarchies.
Name: LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Level Attribute.
Name: LEVEL_RELATIONSHIP_NAME
Type: STRING
Valid Values: N/A
Default: ''
The level relationship name associated to this attribute.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
update load operation.
Name: LOOKUP_ATTRIBUTE_ROLE
Type: STRING
Valid Values: DIMENSION_KEY, END_DATE, NATURAL_KEY, NONE, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: MATCHING_ROW
Type: NUMBER
Valid Values: 1 - 1000
Default: 1
An positive integer to indicate from which row within the unpivot group
this output attribute obtains its data.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the update load operation.
Name: MERGE_ATTR
Type: STRING
Valid Values: N/A
Default: ''
Related merge attribute
Name: OUTPUT_COMPONENT
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_ADDRESSCORRECTED, NA_ADDRESSTYPE,
NA_AUTO_ZONE_IND, NA_BOXNAME, NA_BOXNUMBER, NA_BUILDINGNAME, NA_CART,
NA_CBSA_CODE, NA_CBSA_DESC, NA_CENSUSID, NA_CHECKDIGIT, NA_CITY,
NA_CITYCORRECTED, NA_CITYMATCH, NA_CITYWARNING, NA_CITY_ABBREV,
NA_CITY_ABBREV_2, NA_CITY_ALTERNATE, NA_COMPLEX, NA_COUNTRYCODE,
NA_COUNTRYCODE3, NA_COUNTRYNAME, NA_COUNTYNAME, NA_DELIVERYBEATCODE,
NA_DELIVERYOFFICECODE, NA_DELIVERYPOINT, NA_EMAIL, NA_EXTRA_1, NA_EXTRA_10,
NA_EXTRA_11, NA_EXTRA_12, NA_EXTRA_13, NA_EXTRA_14, NA_EXTRA_15,
NA_EXTRA_16, NA_EXTRA_17, NA_EXTRA_18, NA_EXTRA_19, NA_EXTRA_2,
NA_EXTRA_20, NA_EXTRA_3, NA_EXTRA_4, NA_EXTRA_5, NA_EXTRA_6, NA_EXTRA_7,
NA_EXTRA_8, NA_EXTRA_9, NA_FIPS, NA_FIPSCOUNTY, NA_FIPS_PLACE_CODE,
NA_FIRMCOUNT, NA_FIRMNAME, NA_FIRM_LOC, NA_FIRSTNAME, NA_FIRSTNAMESTD,
NA_GENDER, NA_GEO_MATCH_PREC, NA_INSTALLATIONNAME, NA_INSTALLATIONTYPE,
NA_ISADDRESSVERIFIABLE, NA_ISFOUND, NA_ISGOODADDRESS, NA_ISGOODGROUP,
NA_ISGOODNAME, NA_ISPARSED, NA_LACS, NA_LASTLINE, NA_LASTLINE_2,
NA_LASTNAME, NA_LATITUDE, NA_LOCALITYCODE, NA_LOCALITYNAME, NA_LOCALITY_2,
NA_LOCALITY_3, NA_LOCALITY_4, NA_LONGITUDE, NA_LOT, NA_LOT_ORDER, NA_MCD,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME2STD, NA_MIDDLENAME3,
NA_MIDDLENAME3STD, NA_MIDDLENAMESTD, NA_MISCADDRESS, NA_MSA,
NA_NAMEDESIGNATOR, NA_NAMEWARNING, NA_NAME_FIRM_EXTRA, NA_NEIGHBORHOOD,
NA_NONAMBIGUOUSMATCH, NA_NONE, NA_NP_SEC_ADDR, NA_NP_UNIT_DESIG,
NA_NP_UNIT_NBR, NA_OTHERPOSTNAME, NA_PARSESTATUS, NA_PARSESTATUSDESC,
NA_PARSINGCOUNTRY, NA_PASSTHRU, NA_PERSON, NA_PERSONCOUNT, NA_PHONE,
NA_POSTALCODE, NA_POSTALCODECORRECTED, NA_POSTALCODEFORMATTED,
NA_POSTDIRECTIONAL, NA_POSTNAME, NA_PREDIRECTIONAL, NA_PRENAME,
NA_PRIMARYADDRESS, NA_PRIM_NAME_2, NA_RELATIONSHIP, NA_ROUTENAME,
NA_ROUTENUMBER, NA_SECONDARYADDRESS, NA_SSN, NA_STATE,
NA_STREETCOMPCORRECTED, NA_STREETCOMPMATCH, NA_STREETCORRECTED,
NA_STREETNAME, NA_STREETNAMEMATCH, NA_STREETNUMBER, NA_STREETNUMBERMATCH,
NA_STREETTYPE, NA_STREETWARNING, NA_TITLE, NA_UNITDESIGNATOR,
NA_UNITNUMBER, NA_URBANIZATIONNAME, NA_URBAN_IND, NA_ZIP4, NA_ZIP5
Default: NA_NONE
Assigns a Name and Address output component to the selected output
attribute.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parmater
Name: PIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
A comma-separated expression that gives the input attribute to be used for
each output row in the pivot group.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data precision value of the attribute
Name: REFERENCED_LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level attribute associated to this attribute.
Name: REFERENCED_LEVEL_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level group associated to this attribute.
Name: REFERENCING_TYPE
Type: STRING
Valid Values: LOOKUP_KEY, NONE, REFERENCE_KEY_ALL, REFERENCE_KEY_ONLY
Default: NONE
The type of reference to indicate how this attribute participates in
resolving existing level relationships and level implementations. If Lookup
Reference Attribute is specified, this attribute will be used as lookup
attribute upon parent level to resolve level implementations during
loading. If Level Relationship Attribute (Snowflake) is specified, this
attribute will be directly used as level relationship attribute and no
lookup upon parent level would be performed during loading. If Level
Relationship Attribute (Star) is specified, this attribute will be directly
used as level relationship attribute, as well as lookup attribute upon
parent level to resolve level implementations during loading. If none is
specified, this attribute does not participate in any level relationship.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
The data scale value of the attribute
Name: SKIP_LEVEL_DIMENSION
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether this level has a skip level parent.
Name: TYPE_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the field of the PLS Record or attribute of the Object Type or
column of the ROWTYPE that corresponds to this attribute. This property is
not applicable if the return type is TABLE of SCALAR.
Name: UNPIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: NULL
An expression that gives the input attribute to be used as the output of
this attribute.
Name: UPDATE_OPERATION
Type: STRING(3)
Valid Values: +=, -=, =, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data
and the existing data on the target during the update load operation.
Name: VALUETYPE
Type: STRING
Valid Values: NEW, NEW_OLD, OLD
Default: NEW_OLD
Specifies the value type of this attribute
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
ALTER, OMBRETRIEVE PLSQL_REF_CURSOR_TYPE, OMBCREATE PLSQL_REF_CURSOR_TYPE, OMBDROP PLSQL_REF_CURSOR_TYPE
Purpose
Alter the Table Type by resetting its properties.
Prerequisites
Should be in the context of a Package.
Syntax
alterPlSqlTableTypeCommand = OMBALTER ( PLSQL_TABLE_TYPE "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterPlSqlTableTypeCommand
Alters a PL/SQL Table Type of the given name by setting it's properties.
renameClause
renames a table with a different name.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for Table Type.
Basic properties for PLSQL_TABLE_TYPE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Table Type
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Table Type
Name: RETURN_TYPE
Type: STRING(20)
Valid Values: NUMBER, VARCHAR2, VARCHAR, DATE, FLOAT
Default: ''
Return type of the Table Type. This can be a scalar type or a PLSQL Record
Type.
Properties for PLSQL_TABLE_TYPE:
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Properties for ATTRIBUTE:
Name: ADDRESS_TYPE
Type: STRING
Valid Values: NA_ADDRTYPE_DUAL, NA_ADDRTYPE_NORMAL
Default: NA_ADDRTYPE_NORMAL
You can designate an address type as Normal or Dual. For example, a dual
address occurs when a record contains both a street address and a P.O. Box;
this is common with business data. A normal address contains only one type
of address.
Name: ATTRIBUTE_ROLE
Type: STRING
Valid Values: END_DATE, LOOKUP_ACTIVE_DATE, MEASURE, NATURAL_KEY, NONE,
PARENT_NATURAL_KEY, PARENT_REF_KEY, PARENT_SURROGATE_KEY, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: BINDING_COLUMN_NAME
Type: STRING
Valid Values: N/A
Default: ''
The binding column name for this attribute
Name: DATA_TYPE
Type: STRING
Valid Values: N/A
Default: ''
The data type of the attribute
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The Default Value for the function input parameter
Name: DIMENSION_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The dimension attribute referenced to by this level attribute.
Name: EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
The output expression for the attribute
Name: FIELD_DATA_TYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE,
FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER
EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH,
LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH
LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARGRAPHIC,
VARRAW, VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
SQL Data Type of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Field Length of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Field Precision of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Field Scale of the field in the file to which this operator is bound.
Name: FIELD_DEFAULTIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is blank or zero,
based on the datatype.
Name: FIELD_END_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The ending position of the field in the file
Name: FIELD_MASK
Type: STRING
Valid Values: N/A
Default: ''
The mask for the field
Name: FIELD_NULLIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is null
Name: FIELD_START_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The starting position of the field in the file
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data fractional seconds precision value of the attribute
Name: FUNCTION_RETURN
Type: BOOLEAN
Valid Values: true, false
Default: false
Specifies whether this output is the return value of this function
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this input attribute is a part of the
unpivot group key.
Name: INPUT_ROLE
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_CITY, NA_COUNTRYCODE,
NA_COUNTRYNAME, NA_FIRMNAME, NA_FIRSTNAME, NA_FIRSTPARTNAME, NA_LASTLINE,
NA_LASTLINE_2, NA_LASTNAME, NA_LASTPARTNAME, NA_LINE1, NA_LINE10, NA_LINE2,
NA_LINE3, NA_LINE4, NA_LINE5, NA_LINE6, NA_LINE7, NA_LINE8, NA_LINE9,
NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_NEIGHBORHOOD, NA_NONE,
NA_PASSTHRU, NA_PERSON, NA_PERSON2, NA_PERSON3, NA_POSTALCODE, NA_POSTNAME,
NA_PRENAME, NA_PRIMARYADDRESS, NA_SECONDARYADDRESS, NA_STATE
Default: NA_NONE
Assigns a name-address input role to the selected input attribute
Name: INSTANCE
Type: STRING
Valid Values: NA_INSTANCE_FIFTH, NA_INSTANCE_FIRST, NA_INSTANCE_FOURTH,
NA_INSTANCE_SECOND, NA_INSTANCE_SIXTH, NA_INSTANCE_THIRD
Default: NA_INSTANCE_FIRST
The instance option is used when an address contains multiple names, you
can specify which name in the group should be used. In addition, you can
use this option to assign an address type to a miscellaneous address
component.
Name: IS_CAST_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: IS_OPTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the input is not required to be connected
Name: IS_PREDEFINED_CONSTANT
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
The data length value of the attribute
Name: LEVEL_ATTRIBUTE_COLNAME_NAME
Type: STRING
Valid Values: N/A
Default: ''
Column name in the AW staging table and source view for this attribute.
Name: LEVEL_ATTRIBUTE_LEVEL_INDICATOR_COLNAME
Type: STRING
Valid Values: N/A
Default: ''
Level indicating columns name. This level will contain the name of the name
of the level this parent reference belongs to. This is relavant only for
skip level hierarchies.
Name: LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Level Attribute.
Name: LEVEL_RELATIONSHIP_NAME
Type: STRING
Valid Values: N/A
Default: ''
The level relationship name associated to this attribute.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
update load operation.
Name: LOOKUP_ATTRIBUTE_ROLE
Type: STRING
Valid Values: DIMENSION_KEY, END_DATE, NATURAL_KEY, NONE, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: MATCHING_ROW
Type: NUMBER
Valid Values: 1 - 1000
Default: 1
An positive integer to indicate from which row within the unpivot group
this output attribute obtains its data.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the update load operation.
Name: MERGE_ATTR
Type: STRING
Valid Values: N/A
Default: ''
Related merge attribute
Name: OUTPUT_COMPONENT
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_ADDRESSCORRECTED, NA_ADDRESSTYPE,
NA_AUTO_ZONE_IND, NA_BOXNAME, NA_BOXNUMBER, NA_BUILDINGNAME, NA_CART,
NA_CBSA_CODE, NA_CBSA_DESC, NA_CENSUSID, NA_CHECKDIGIT, NA_CITY,
NA_CITYCORRECTED, NA_CITYMATCH, NA_CITYWARNING, NA_CITY_ABBREV,
NA_CITY_ABBREV_2, NA_CITY_ALTERNATE, NA_COMPLEX, NA_COUNTRYCODE,
NA_COUNTRYCODE3, NA_COUNTRYNAME, NA_COUNTYNAME, NA_DELIVERYBEATCODE,
NA_DELIVERYOFFICECODE, NA_DELIVERYPOINT, NA_EMAIL, NA_EXTRA_1, NA_EXTRA_10,
NA_EXTRA_11, NA_EXTRA_12, NA_EXTRA_13, NA_EXTRA_14, NA_EXTRA_15,
NA_EXTRA_16, NA_EXTRA_17, NA_EXTRA_18, NA_EXTRA_19, NA_EXTRA_2,
NA_EXTRA_20, NA_EXTRA_3, NA_EXTRA_4, NA_EXTRA_5, NA_EXTRA_6, NA_EXTRA_7,
NA_EXTRA_8, NA_EXTRA_9, NA_FIPS, NA_FIPSCOUNTY, NA_FIPS_PLACE_CODE,
NA_FIRMCOUNT, NA_FIRMNAME, NA_FIRM_LOC, NA_FIRSTNAME, NA_FIRSTNAMESTD,
NA_GENDER, NA_GEO_MATCH_PREC, NA_INSTALLATIONNAME, NA_INSTALLATIONTYPE,
NA_ISADDRESSVERIFIABLE, NA_ISFOUND, NA_ISGOODADDRESS, NA_ISGOODGROUP,
NA_ISGOODNAME, NA_ISPARSED, NA_LACS, NA_LASTLINE, NA_LASTLINE_2,
NA_LASTNAME, NA_LATITUDE, NA_LOCALITYCODE, NA_LOCALITYNAME, NA_LOCALITY_2,
NA_LOCALITY_3, NA_LOCALITY_4, NA_LONGITUDE, NA_LOT, NA_LOT_ORDER, NA_MCD,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME2STD, NA_MIDDLENAME3,
NA_MIDDLENAME3STD, NA_MIDDLENAMESTD, NA_MISCADDRESS, NA_MSA,
NA_NAMEDESIGNATOR, NA_NAMEWARNING, NA_NAME_FIRM_EXTRA, NA_NEIGHBORHOOD,
NA_NONAMBIGUOUSMATCH, NA_NONE, NA_NP_SEC_ADDR, NA_NP_UNIT_DESIG,
NA_NP_UNIT_NBR, NA_OTHERPOSTNAME, NA_PARSESTATUS, NA_PARSESTATUSDESC,
NA_PARSINGCOUNTRY, NA_PASSTHRU, NA_PERSON, NA_PERSONCOUNT, NA_PHONE,
NA_POSTALCODE, NA_POSTALCODECORRECTED, NA_POSTALCODEFORMATTED,
NA_POSTDIRECTIONAL, NA_POSTNAME, NA_PREDIRECTIONAL, NA_PRENAME,
NA_PRIMARYADDRESS, NA_PRIM_NAME_2, NA_RELATIONSHIP, NA_ROUTENAME,
NA_ROUTENUMBER, NA_SECONDARYADDRESS, NA_SSN, NA_STATE,
NA_STREETCOMPCORRECTED, NA_STREETCOMPMATCH, NA_STREETCORRECTED,
NA_STREETNAME, NA_STREETNAMEMATCH, NA_STREETNUMBER, NA_STREETNUMBERMATCH,
NA_STREETTYPE, NA_STREETWARNING, NA_TITLE, NA_UNITDESIGNATOR,
NA_UNITNUMBER, NA_URBANIZATIONNAME, NA_URBAN_IND, NA_ZIP4, NA_ZIP5
Default: NA_NONE
Assigns a Name and Address output component to the selected output
attribute.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parmater
Name: PIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
A comma-separated expression that gives the input attribute to be used for
each output row in the pivot group.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data precision value of the attribute
Name: REFERENCED_LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level attribute associated to this attribute.
Name: REFERENCED_LEVEL_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level group associated to this attribute.
Name: REFERENCING_TYPE
Type: STRING
Valid Values: LOOKUP_KEY, NONE, REFERENCE_KEY_ALL, REFERENCE_KEY_ONLY
Default: NONE
The type of reference to indicate how this attribute participates in
resolving existing level relationships and level implementations. If Lookup
Reference Attribute is specified, this attribute will be used as lookup
attribute upon parent level to resolve level implementations during
loading. If Level Relationship Attribute (Snowflake) is specified, this
attribute will be directly used as level relationship attribute and no
lookup upon parent level would be performed during loading. If Level
Relationship Attribute (Star) is specified, this attribute will be directly
used as level relationship attribute, as well as lookup attribute upon
parent level to resolve level implementations during loading. If none is
specified, this attribute does not participate in any level relationship.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
The data scale value of the attribute
Name: SKIP_LEVEL_DIMENSION
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether this level has a skip level parent.
Name: TYPE_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the field of the PLS Record or attribute of the Object Type or
column of the ROWTYPE that corresponds to this attribute. This property is
not applicable if the return type is TABLE of SCALAR.
Name: UNPIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: NULL
An expression that gives the input attribute to be used as the output of
this attribute.
Name: UPDATE_OPERATION
Type: STRING(3)
Valid Values: +=, -=, =, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data
and the existing data on the target during the update load operation.
Name: VALUETYPE
Type: STRING
Valid Values: NEW, NEW_OLD, OLD
Default: NEW_OLD
Specifies the value type of this attribute
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
ALTER, OMBRETRIEVE PLSQL_TABLE_TYPE, OMBCREATE PLSQL_TABLE_TYPE, OMBDROP PLSQL_TABLE_TYPE
Purpose
Alter the content of a pluggable map folder.
Prerequisites
1. The current context of scripting must be a project.
2. No concurrent user should be modifying the pluggable map folder.
Syntax
alterPluggableMappingFolderCommand = ( OMBALTER PLUGGABLE_MAPPING_FOLDER
"pluggableMapFolderName" ( ( "renameClause" [
"alterPropertiesOrIconSetClause" ] ) |
"alterPropertiesOrIconSetClause" ) )
pluggableMapFolderName = "QUOTED_STRING"
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = ( SET ( ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] )
| "setReferenceIconSetClause" ) ) | UNSET
"unsetReferenceIconSetClause"
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterPluggableMappingFolderCommand
Alter the content of a pluggable map folder.
pluggableMapFolderName
Name of the pluggable map folder.
renameClause
Rename a mapping, mapping operator, mapping group, or mapping attribute.
setPropertiesClause
Describe the keys of properties for the map or objects in the map.
propertyKeyList
The list of property keys.
propertyValueList
A list of property values.
propertyKey
A property key for an object.
Basic properties for MAPPING:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the mapping
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValue
A single property value. It can be a number, float, boolean or
single-quoted string.
See Also
OMBALTER
Purpose
Alter the content of a pluggable mapping.
Prerequisites
1. The current context of scripting must be a project or pluggable map
folder.
2. No concurrent user should be modifying the pluggable mapping.
Syntax
alterPluggableMappingCommand = OMBALTER PLUGGABLE_MAPPING
"pluggableMapName" "alterOperatorOwnerDetailClause"
pluggableMapName = "QUOTED_STRING"
alterOperatorOwnerDetailClause = "renameClause" [
"alterPropertiesOrIconSetClause" ] [
"alterOperatorOwnerDescendantsClause"+ ] |
"alterPropertiesOrIconSetClause" [
"alterOperatorOwnerDescendantsClause"+ ] |
"alterOperatorOwnerDescendantsClause"+
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = ( SET ( ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] )
| "setReferenceIconSetClause" ) ) | UNSET
"unsetReferenceIconSetClause"
alterOperatorOwnerDescendantsClause = ADD ( "addOperatorClause" |
"addGroupClause" | "addAttributeClause" | "addChildClause" |
"addConnectionClause" ) | MODIFY ( "modifyOperatorClause" |
"modifyGroupClause" | "modifyAttributeClause" | "modifyChildClause" )
| DELETE ( "operatorBottomUpLocator" | "groupBottomUpLocator" |
"attributeBottomUpLocator" | "childBottomUpLocator" |
"deleteConnectionLocator" )
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
addOperatorClause = "operatorType" OPERATOR "operatorName" [
"pluggableMapBottomUpLocator" ] [ SET "setPropertiesClause" ] [
"setBindingClause" ]
addGroupClause = "groupDirection" GROUP "groupName" OF
"operatorBottomUpLocator" [ SET "setPropertiesClause" ]
addAttributeClause = ATTRIBUTE "attributeName" OF "groupBottomUpLocator" [
SET "setPropertiesClause" ]
addChildClause = "childType" "childName" "childOwnerBottomUpLocator" [ SET
"setPropertiesClause" ]
addConnectionClause = CONNECTION FROM ( "groupBottomUpLocator" TO
"groupBottomUpLocator" [ "groupToGroupConnectType" ] |
"attributeBottomUpLocator" TO ( "attributeBottomUpLocator" |
"attributesBottomUpLocator" | "groupBottomUpLocator" ) |
"attributesBottomUpLocator" TO ( "attributesBottomUpLocator" |
"groupBottomUpLocator" ) )
modifyOperatorClause = "operatorBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
modifyGroupClause = "groupBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
modifyAttributeClause = "attributeBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
modifyChildClause = "childBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
operatorBottomUpLocator = OPERATOR "operatorName" [
"pluggableMapBottomUpLocator" ]
groupBottomUpLocator = GROUP "groupName" OF "operatorBottomUpLocator"
attributeBottomUpLocator = ATTRIBUTE "attributeName" OF
"groupBottomUpLocator"
childBottomUpLocator = "childType" "childName" { OF "childType"
"childName" } [ OF "mappableBottomUpLocator" ]
deleteConnectionLocator = CONNECTION ( FROM "mappableBottomUpLocator" [ TO
"mappableBottomUpLocator" ] | TO "mappableBottomUpLocator" )
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
operatorType = PLUGGABLE_MAPPING | "UNQUOTED_STRING"
operatorName = "QUOTED_STRING"
pluggableMapBottomUpLocator = ( OF PLUGGABLE_MAPPING "pluggableMapName" [
"pluggableMapBottomUpLocator" ] )
setBindingClause = BOUND TO "bindableLocator"
groupDirection = INPUT | OUTPUT | INPUT_OUTPUT
groupName = "QUOTED_STRING"
attributeName = "QUOTED_STRING"
childType = "UNQUOTED_STRING"
childName = "QUOTED_STRING"
childOwnerBottomUpLocator = { OF "childType" "childName" } [ OF
"mappableBottomUpLocator" ]
groupToGroupConnectType = COPY ALL | BY ( NAME [ IGNORE ( SPECIAL_CHARS
"QUOTED_STRING" | SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX
"QUOTED_STRING" | TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX
"QUOTED_STRING" ) { "," IGNORE ( SPECIAL_CHARS "QUOTED_STRING" |
SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX "QUOTED_STRING" |
TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX "QUOTED_STRING" ) } ] |
POSITION )
attributesBottomUpLocator = ATTRIBUTES "attributeNameList" OF
"groupBottomUpLocator"
mappableBottomUpLocator = "operatorBottomUpLocator" |
"groupBottomUpLocator" | "attributeBottomUpLocator"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
bindableLocator = "bindableType" "bindableName" [ OF "bindableType"
"bindableName" ]
attributeNameList = "(" "attributeName" { "," "attributeName" } ")"
bindableType = PLUGGABLE_MAPPING | OBJECT_TYPE | "UNQUOTED_STRING"
bindableName = "QUOTED_STRING"
Keywords And Parameters
alterPluggableMappingCommand
Alter the content of a pluggable mapping.
pluggableMapName
Name of the pluggable map.
alterOperatorOwnerDetailClause
Alter the detail of the pluggable mapping.
renameClause
Rename a mapping, mapping operator, mapping group, or mapping attribute.
alterOperatorOwnerDescendantsClause
Alter the desired child objects applicable to a mapping or a pluggable
mapping.
setPropertiesClause
Describe the keys of properties for the map or objects in the map.
addOperatorClause
Adds a mapping operator to a map. When you add an operator, Warehouse
Builder creates default groups and parameters for the operator. Please see
the appendix section of the Scripting Reference.
The following is an example for creating an operator:
OMBALTER MAPPING 'M1' ADD TABLE OPERATOR 'T1'
addGroupClause
Add a mapping group to a mapping operator.
addAttributeClause
Add a mapping attribute to a mapping group.
addChildClause
Add a child to a mapping, mapping operator, mapping group or mapping
attribute.
The following is an example for creating a child object under a mapping
OMBALTER MAPPING 'M1' ADD SOURCE_DATA_FILE 'FILE1'
Note: Key word "OPERATOR" "GROUP" "ATTRIBUTE" are important for their
respective ADD clauses. Without the key words, OMBPlus will interpret the
ADD clause as an addChildClause. Here is an example:
OMB+> OMBALTER MAPPING 'M1' ADD TABLE 'T1'
OMB02932: Error getting child objects of type TABLE in M1
OMBPLUS interprets the ADD clause as one for creating a non-operator child
object under the mapping object. Therefore, it tries to find type
definition for non-operator child object "TABLE" and cannot find it.
addConnectionClause
Add connections between mapping groups or mapping attributes.
modifyOperatorClause
Modify a mapping operator.
modifyGroupClause
Modify a mapping group.
modifyAttributeClause
Modify a mapping attribute.
modifyChildClause
Modify a child that belongs to a mapping, mapping operator, mapping group
or mapping attribute.
operatorBottomUpLocator
Location of a mapping operator.
groupBottomUpLocator
Location of a mapping group.
attributeBottomUpLocator
Location of a mapping attribute.
childBottomUpLocator
Location of the child that belongs to a map, mapping operator, mapping
group or mapping attribute.
deleteConnectionLocator
Delete connections between mapping operators, mapping groups or mapping
attributes.
propertyKeyList
The list of property keys.
propertyValueList
A list of property values.
operatorType
Type of a mapping operator. The following operator types are available:
ADVANCED_QUEUE, AGGREGATOR, ANYDATA_CAST, CONSTANT, CONSTRUCT_OBJECT, CUBE,
DATA_GENERATOR, DEDUPLICATOR, DIMENSION, EXPAND_OBJECT, EXPRESSION,
EXTERNAL_TABLE, FILTER, FLAT_FILE, INPUT_PARAMETER, INPUT_SIGNATURE,
ITERATOROPERATOR, JOINER, KEY_LOOKUP, LCRCAST, LCRSPLITTER, MATCHMERGE,
MATERIALIZED_VIEW, NAME_AND_ADDRESS, OUTPUT_PARAMETER, OUTPUT_SIGNATURE,
PIVOT, PLUGGABLE_MAPPING, POSTMAPPING_PROCESS, PREMAPPING_PROCESS,
SEQUENCE, SET_OPERATION, SORTER, SPLITTER, TABLE, TABLE_FUNCTION,
TRANSFORMATION, UNPIVOT, VIEW.
operatorName
Name of a mapping operator.
pluggableMapBottomUpLocator
Location of a child pluggable mapping within a mapping or another pluggable
mapping.
setBindingClause
Set the binding during the creation of a mapping operator or mapping
attribute.
groupDirection
Direction of a mapping group.
groupName
Name of a mapping group.
attributeName
Name of a mapping attribute.
childType
Type of a child that belongs to map, mapping operator, mapping group or
mapping attribute.
childName
Name of a child that belongs to map, mapping operator, mapping group or
mapping attribute.
childOwnerBottomUpLocator
Location of a child owner. A child owner can be a map, mapping operator,
mapping group, mapping attribute or a child.
groupToGroupConnectType
Connecting from a mapping group in one mapping operator to a mapping group
in another mapping operator.
attributesBottomUpLocator
Location of a list of mapping attributes.
mappableBottomUpLocator
Location of the object to be bound to a mapping mapping operator or mapping
attribute.
propertyKey
A property key for an object.
Basic properties for MAPPING:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the mapping
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the mapping
Basic properties for OPERATOR:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the operator
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the operator
Basic properties for GROUP:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the group
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the group
Basic properties for ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the attribute
Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE,
TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: ''
Datatype of the Attribute
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Length of the attribute.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Precision of the attribute.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Scale of the attribute.
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.
Properties for PLUGGABLE_MAPPING:
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Properties for GROUP:
Name: COMMANDTYPE
Type: STRING
Valid Values: ALL_COMMAND_TYPES, DELETE, INSERT, UPDATE
Default: ALL_COMMAND_TYPES
The operation causing the change described by the LCR
Name: DEFAULT_EXPIRATION_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: NULL
A date value to be served as the expiration time of a newly created open
record.
Name: DIMENSION_KEY
Type: STRING(32)
Valid Values: N/A
Default: ''
The column in which dimension key value is to be stored when this is a
target of star schema.
Name: EXPRESSION_INOUT
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: EXPRESSION_OUT
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: EXTRACTING_TYPE
Type: STRING
Valid Values: FROM_ALL, FROM_CURRENT
Default: FROM_CURRENT
The extracting operation to be performed when this is a source. If Extract
Current Only (Type 2 Only) is specified, only current records will be
extracted. If Extract All is specified, all records will be extracted.
Name: GROUP_TYPE
Type: STRING
Valid Values: REF_CURSOR, SCALAR
Default: SCALAR
This property specifies whether the input parameter is a scalar or a ref
cursor type
Name: INTERNAL_TABLE
Type: STRING
Valid Values: N/A
Default: ''
Internal staging table for this operator group
Name: LEVEL_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of this level.
Name: MODULENAME
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parameter group
Name: RECORD_TYPE_VALUES
Type: STRING
Valid Values: N/A
Default: ''
Record Type Values.
Name: RETURN_TABLE_OF_SCALAR
Type: BOOLEAN
Valid Values: true, false
Default: false
This property specifies whether the return of the table function is a TABLE
of SCALAR or not.
Name: ROW_LOCATOR
Type: STRING
Valid Values: N/A
Default: ''
An expression indicating which attribute within the input group is the row
locator.
Name: ROW_LOCATOR_VALUES
Type: STRING
Valid Values: N/A
Default: NULL, NULL
A comma-separated expressions that gives the possible values of the row
locator within a unpivot group.
Name: SLOWLY_CHANGING_TYPE
Type: STRING
Valid Values: TYPE1, TYPE2, TYPE3
Default: TYPE2
The slowly changing type of this target.
Name: SPLIT_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
Condition that defines when to perform the attribute maps for the
attributes in this group.
Name: TABLENAME
Type: STRING
Valid Values: N/A
Default: ''
The source table corresponding to the LCR
Name: TARGET_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The table name bound to this target.
Properties for ATTRIBUTE:
Name: ADDRESS_TYPE
Type: STRING
Valid Values: NA_ADDRTYPE_DUAL, NA_ADDRTYPE_NORMAL
Default: NA_ADDRTYPE_NORMAL
You can designate an address type as Normal or Dual. For example, a dual
address occurs when a record contains both a street address and a P.O. Box;
this is common with business data. A normal address contains only one type
of address.
Name: ATTRIBUTE_ROLE
Type: STRING
Valid Values: END_DATE, LOOKUP_ACTIVE_DATE, MEASURE, NATURAL_KEY, NONE,
PARENT_NATURAL_KEY, PARENT_REF_KEY, PARENT_SURROGATE_KEY, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: BINDING_COLUMN_NAME
Type: STRING
Valid Values: N/A
Default: ''
The binding column name for this attribute
Name: DATA_TYPE
Type: STRING
Valid Values: N/A
Default: ''
The data type of the attribute
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The Default Value for the function input parameter
Name: DIMENSION_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The dimension attribute referenced to by this level attribute.
Name: EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
The output expression for the attribute
Name: FIELD_DATA_TYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE,
FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER
EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH,
LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH
LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARGRAPHIC,
VARRAW, VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
SQL Data Type of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Field Length of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Field Precision of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Field Scale of the field in the file to which this operator is bound.
Name: FIELD_DEFAULTIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is blank or zero,
based on the datatype.
Name: FIELD_END_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The ending position of the field in the file
Name: FIELD_MASK
Type: STRING
Valid Values: N/A
Default: ''
The mask for the field
Name: FIELD_NULLIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is null
Name: FIELD_START_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The starting position of the field in the file
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data fractional seconds precision value of the attribute
Name: FUNCTION_RETURN
Type: BOOLEAN
Valid Values: true, false
Default: false
Specifies whether this output is the return value of this function
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this input attribute is a part of the
unpivot group key.
Name: INPUT_ROLE
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_CITY, NA_COUNTRYCODE,
NA_COUNTRYNAME, NA_FIRMNAME, NA_FIRSTNAME, NA_FIRSTPARTNAME, NA_LASTLINE,
NA_LASTLINE_2, NA_LASTNAME, NA_LASTPARTNAME, NA_LINE1, NA_LINE10, NA_LINE2,
NA_LINE3, NA_LINE4, NA_LINE5, NA_LINE6, NA_LINE7, NA_LINE8, NA_LINE9,
NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_NEIGHBORHOOD, NA_NONE,
NA_PASSTHRU, NA_PERSON, NA_PERSON2, NA_PERSON3, NA_POSTALCODE, NA_POSTNAME,
NA_PRENAME, NA_PRIMARYADDRESS, NA_SECONDARYADDRESS, NA_STATE
Default: NA_NONE
Assigns a name-address input role to the selected input attribute
Name: INSTANCE
Type: STRING
Valid Values: NA_INSTANCE_FIFTH, NA_INSTANCE_FIRST, NA_INSTANCE_FOURTH,
NA_INSTANCE_SECOND, NA_INSTANCE_SIXTH, NA_INSTANCE_THIRD
Default: NA_INSTANCE_FIRST
The instance option is used when an address contains multiple names, you
can specify which name in the group should be used. In addition, you can
use this option to assign an address type to a miscellaneous address
component.
Name: IS_CAST_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: IS_OPTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the input is not required to be connected
Name: IS_PREDEFINED_CONSTANT
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
The data length value of the attribute
Name: LEVEL_ATTRIBUTE_COLNAME_NAME
Type: STRING
Valid Values: N/A
Default: ''
Column name in the AW staging table and source view for this attribute.
Name: LEVEL_ATTRIBUTE_LEVEL_INDICATOR_COLNAME
Type: STRING
Valid Values: N/A
Default: ''
Level indicating columns name. This level will contain the name of the name
of the level this parent reference belongs to. This is relavant only for
skip level hierarchies.
Name: LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Level Attribute.
Name: LEVEL_RELATIONSHIP_NAME
Type: STRING
Valid Values: N/A
Default: ''
The level relationship name associated to this attribute.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
update load operation.
Name: LOOKUP_ATTRIBUTE_ROLE
Type: STRING
Valid Values: DIMENSION_KEY, END_DATE, NATURAL_KEY, NONE, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: MATCHING_ROW
Type: NUMBER
Valid Values: 1 - 1000
Default: 1
An positive integer to indicate from which row within the unpivot group
this output attribute obtains its data.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the update load operation.
Name: MERGE_ATTR
Type: STRING
Valid Values: N/A
Default: ''
Related merge attribute
Name: OUTPUT_COMPONENT
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_ADDRESSCORRECTED, NA_ADDRESSTYPE,
NA_AUTO_ZONE_IND, NA_BOXNAME, NA_BOXNUMBER, NA_BUILDINGNAME, NA_CART,
NA_CBSA_CODE, NA_CBSA_DESC, NA_CENSUSID, NA_CHECKDIGIT, NA_CITY,
NA_CITYCORRECTED, NA_CITYMATCH, NA_CITYWARNING, NA_CITY_ABBREV,
NA_CITY_ABBREV_2, NA_CITY_ALTERNATE, NA_COMPLEX, NA_COUNTRYCODE,
NA_COUNTRYCODE3, NA_COUNTRYNAME, NA_COUNTYNAME, NA_DELIVERYBEATCODE,
NA_DELIVERYOFFICECODE, NA_DELIVERYPOINT, NA_EMAIL, NA_EXTRA_1, NA_EXTRA_10,
NA_EXTRA_11, NA_EXTRA_12, NA_EXTRA_13, NA_EXTRA_14, NA_EXTRA_15,
NA_EXTRA_16, NA_EXTRA_17, NA_EXTRA_18, NA_EXTRA_19, NA_EXTRA_2,
NA_EXTRA_20, NA_EXTRA_3, NA_EXTRA_4, NA_EXTRA_5, NA_EXTRA_6, NA_EXTRA_7,
NA_EXTRA_8, NA_EXTRA_9, NA_FIPS, NA_FIPSCOUNTY, NA_FIPS_PLACE_CODE,
NA_FIRMCOUNT, NA_FIRMNAME, NA_FIRM_LOC, NA_FIRSTNAME, NA_FIRSTNAMESTD,
NA_GENDER, NA_GEO_MATCH_PREC, NA_INSTALLATIONNAME, NA_INSTALLATIONTYPE,
NA_ISADDRESSVERIFIABLE, NA_ISFOUND, NA_ISGOODADDRESS, NA_ISGOODGROUP,
NA_ISGOODNAME, NA_ISPARSED, NA_LACS, NA_LASTLINE, NA_LASTLINE_2,
NA_LASTNAME, NA_LATITUDE, NA_LOCALITYCODE, NA_LOCALITYNAME, NA_LOCALITY_2,
NA_LOCALITY_3, NA_LOCALITY_4, NA_LONGITUDE, NA_LOT, NA_LOT_ORDER, NA_MCD,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME2STD, NA_MIDDLENAME3,
NA_MIDDLENAME3STD, NA_MIDDLENAMESTD, NA_MISCADDRESS, NA_MSA,
NA_NAMEDESIGNATOR, NA_NAMEWARNING, NA_NAME_FIRM_EXTRA, NA_NEIGHBORHOOD,
NA_NONAMBIGUOUSMATCH, NA_NONE, NA_NP_SEC_ADDR, NA_NP_UNIT_DESIG,
NA_NP_UNIT_NBR, NA_OTHERPOSTNAME, NA_PARSESTATUS, NA_PARSESTATUSDESC,
NA_PARSINGCOUNTRY, NA_PASSTHRU, NA_PERSON, NA_PERSONCOUNT, NA_PHONE,
NA_POSTALCODE, NA_POSTALCODECORRECTED, NA_POSTALCODEFORMATTED,
NA_POSTDIRECTIONAL, NA_POSTNAME, NA_PREDIRECTIONAL, NA_PRENAME,
NA_PRIMARYADDRESS, NA_PRIM_NAME_2, NA_RELATIONSHIP, NA_ROUTENAME,
NA_ROUTENUMBER, NA_SECONDARYADDRESS, NA_SSN, NA_STATE,
NA_STREETCOMPCORRECTED, NA_STREETCOMPMATCH, NA_STREETCORRECTED,
NA_STREETNAME, NA_STREETNAMEMATCH, NA_STREETNUMBER, NA_STREETNUMBERMATCH,
NA_STREETTYPE, NA_STREETWARNING, NA_TITLE, NA_UNITDESIGNATOR,
NA_UNITNUMBER, NA_URBANIZATIONNAME, NA_URBAN_IND, NA_ZIP4, NA_ZIP5
Default: NA_NONE
Assigns a Name and Address output component to the selected output
attribute.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parmater
Name: PIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
A comma-separated expression that gives the input attribute to be used for
each output row in the pivot group.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data precision value of the attribute
Name: REFERENCED_LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level attribute associated to this attribute.
Name: REFERENCED_LEVEL_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level group associated to this attribute.
Name: REFERENCING_TYPE
Type: STRING
Valid Values: LOOKUP_KEY, NONE, REFERENCE_KEY_ALL, REFERENCE_KEY_ONLY
Default: NONE
The type of reference to indicate how this attribute participates in
resolving existing level relationships and level implementations. If Lookup
Reference Attribute is specified, this attribute will be used as lookup
attribute upon parent level to resolve level implementations during
loading. If Level Relationship Attribute (Snowflake) is specified, this
attribute will be directly used as level relationship attribute and no
lookup upon parent level would be performed during loading. If Level
Relationship Attribute (Star) is specified, this attribute will be directly
used as level relationship attribute, as well as lookup attribute upon
parent level to resolve level implementations during loading. If none is
specified, this attribute does not participate in any level relationship.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
The data scale value of the attribute
Name: SKIP_LEVEL_DIMENSION
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether this level has a skip level parent.
Name: TYPE_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the field of the PLS Record or attribute of the Object Type or
column of the ROWTYPE that corresponds to this attribute. This property is
not applicable if the return type is TABLE of SCALAR.
Name: UNPIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: NULL
An expression that gives the input attribute to be used as the output of
this attribute.
Name: UPDATE_OPERATION
Type: STRING(3)
Valid Values: +=, -=, =, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data
and the existing data on the target during the update load operation.
Name: VALUETYPE
Type: STRING
Valid Values: NEW, NEW_OLD, OLD
Default: NEW_OLD
Specifies the value type of this attribute
Properties for AGGREGATOR_OPERATOR:
Name: GROUP_BY_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Group By clause for the aggregation
Name: HAVING_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Having clause for the aggregation
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for CONSTRUCT_OBJECT_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for CUBE_OPERATOR:
Name: ALLOW_PARALLEL_SOLVE
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, allow parallel solve when solving the cube.
Name: AW_STAGED_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the set-based AW load data is staged into a temporary table before
loading into the AW.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: CUBE_STORAGE_ISAW
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether the storage for this cube in AW.
Name: DIMENSION_AWNAME
Type: STRING
Valid Values: N/A
Default: ''
AW Name which contains this Dimension.
Name: INCREMENTAL_AGGREGATION
Type: BOOLEAN
Valid Values: true, false
Default: true
Indicates whether incremental aggregation should be done or full
aggregation.
Name: LOADING_TYPE
Type: STRING
Valid Values: LOAD, REMOVE
Default: LOAD
The loading operation to be performed when this is a target. If LOAD is
specified, OWB will try to insert all input data into target. If REMOVE is
specified, OWB will try to match between the input data and target data to
compute existing data; it will then remove existing data from target.
Name: MAX_JOB_QUEUES_ALLOCATED
Type: NUMBER
Valid Values: 1 - 1000
Default: 0
The maximum number of job queues allocated when solving the cube.
Name: RUN_AGGREGATION
Type: STRING
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether to solve the cube or not . Specify YES
and cube data will be precomputed for the levels specified in the
definition of cube
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRUNCATE_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
The truncate flag to indicate whether all existing dimension values should
be truncated before load begins (AW only).
Properties for DEDUPLICATOR_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for DIMENSION_OPERATOR:
Name: AW_LOAD_MODEL
Type: STRING
Valid Values: OTHER, SNOWFLAKE, STAR
Default: SNOWFLAKE
The loading model for the AW dimension - star, snowflake, or other.
Name: AW_STAGED_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the set-based AW load data is staged into a temporary table before
loading into the AW.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DEFAULT_EFFECTIVE_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: SYSDATE
A date value to be served as the effective time of a newly created open
record. The same date value is also served as the expiration time to close
an existing open record.
Name: DEFAULT_EXPIRATION_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: NULL
A date value to be served as the expiration time of a newly created open
record.
Name: DIMENSION_AWNAME
Type: STRING
Valid Values: N/A
Default: ''
AW Name which contains this Dimension.
Name: DIMENSION_ISAW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Flag to indicate whether storage is AW.
Name: LOADING_TYPE
Type: STRING
Valid Values: LOAD, REMOVE
Default: LOAD
The loading operation to be performed when this is a target. If LOAD is
specified, OWB will try to match between the input data and target data to
compute new data and existing data; it will then create new data, as well
as modify existing data onto target. If REMOVE is specified, OWB will try
to match between the input data and target data to compute existing data;
it will then remove existing data from target.
Name: SLOWLY_CHANGING_TYPE
Type: STRING
Valid Values: TYPE1, TYPE2, TYPE3
Default: TYPE2
The slowly changing type of this target.
Name: SURROGATE_IDENTIFIER_LOADING_POLICY
Type: STRING
Valid Values: N/A
Default: ''
The name of the sequence used to generate surrogate key values when loading
the dimension.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRUNCATE_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
The truncate flag to indicate whether all existing dimension values should
be truncated before load begins (AW only).
Name: TYPE2_MATCH_CURRENT_ONLY
Type: STRING
Valid Values: NO, YES
Default: YES
If set to YES, only the current record will be used when performing the
selected operation (remove or extract) for type 2 dimension.
Name: TYPE2_RECORD_GAP_INTERVAL
Type: NUMBER
Valid Values: N/A
Default: 1
A numeric value indicating the number of units (see
TYPE2_RECORD_GAP_INTERVAL_UNITS property below) that will be added to the
expiration date of the previous closed record, to create the effective date
of a new open record.
Name: TYPE2_RECORD_GAP_INTERVAL_UNITS
Type: STRING
Valid Values: DAYS, HOURS, MINUTES, SECONDS, WEEKS
Default: SECONDS
A value indicating the units used for the gap that will be added to the
expiration date of the previous closed record, to create the effective date
of a new open record.
Properties for EXPAND_OBJECT_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for EXTERNAL_TABLE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DATA_COLLECTION_FREQUENCY
Type: STRING(16)
Valid Values: DAY, HOUR, MINUTE, MONTH, QUARTER, UNKNOWN, YEAR
Default: UNKNOWN
New Data Granularity
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: DIRECT
Type: BOOLEAN
Valid Values: true, false
Default: false
Directly swap source into target as a partition without first creating a
staging table.
Name: ENABLE_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable Constraints
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EVALUATE_CHECK_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: false
Evaluate check constraints
Name: EXCEPTIONS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Exceptions Table Name
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PEL_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
PEL Enabled
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: REPLACE_DATA
Type: BOOLEAN
Valid Values: true, false
Default: false
Replace existing data in target partition if there is any.
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Properties for FILTER_OPERATOR:
Name: FILTER_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
The boolean filtering condition that identifies what data is to be
processed. Any row with a false condition will be ignored.
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for FLAT_FILE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by reconciliation for this item. Unlike other
operators, it is not needed for generation. By default it is the same name
as the item.
Name: CONCATENATE_RECORDS
Type: NUMBER
Valid Values: N/A
Default: 0
Number of Physical Records per Logical Record.
Name: CONTINUATION_CHARACTER
Type: STRING
Valid Values: N/A
Default: ''
Character that indicates the record is continued on the next line.
Name: CONTINUATION_CHARACTER_ON_NEXT_LINE
Type: BOOLEAN
Valid Values: true, false
Default: FALSE
If there is a continuation character, is it at the start of the line.
Name: FIELD_ENCLOSURE_CHARACTERS
Type: STRING
Valid Values: N/A
Default: ''
Characters that wrap fields. Example ' or ".
Name: FIELD_NAMES_IN_THE_FIRST_ROW
Type: BOOLEAN
Valid Values: true, false
Default: FALSE
Indicates whether file contains a header row.
Name: FIELD_TERMINATION_CHARACTER
Type: STRING
Valid Values: N/A
Default: ,
Character that separates the fields of a delimited file.
Name: FILE_FORMAT
Type: STRING
Valid Values: DELIMITED, FIXED
Default: DELIMITED
File Format (Fixed or Delimited).
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: INSERT, NONE, UPDATE
Default: INSERT
The loading operation to be performed
Name: OUTPUT_AS_XML
Type: BOOLEAN
Valid Values: true, false
Default: false
Output data to file in XML format.
Name: RECORD_DELIMITER
Type: STRING
Valid Values: N/A
Default: ''
Character that indicates the end of the record.
Name: RECORD_SIZE
Type: NUMBER
Valid Values: N/A
Default: 0
Size of a fixed length record.
Name: RECORD_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
If this is a multi record file, this will indicate the length of the data
that identifies the type of record. It is used with the Record Type
Position.
Name: RECORD_TYPE_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
If this is a multi record file, this will indicate the position of the
field that identifies the type of record.
Name: SAMPLED_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The default name of the physical file to be used by sqlloader. If the file
was sampled, the default was set from sampled file name.
Name: SOURCE_DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The Location of the File Module of this Flat File at the time of
reconciliation. Stored as UOID.
Name: TARGET_DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access referenced entity.
Name: TARGET_DATA_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the target data file, including extension (file type). This name
should not include the file path. To specify where the target data file
will be created/appended, set the Target Data File Location.
Properties for ITERATOR_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for JOINER_OPERATOR:
Name: JOIN_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
The Join Condition for the join operator
Properties for KEY_LOOKUP_OPERATOR:
Name: BOUND_LEVEL
Type: STRING
Valid Values: N/A
Default: ''
The level name of the bound level, if this is a dimension lookup.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: CREATE_NO_MATCH_ROW
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, a row is created and the user-defined default values are used, in
the case where no lookup match is found. If false, no row is produced.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOOKUP_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
Key lookup condition based on the source inputs. This condition is used to
lookup a value in the bound table. If the condition is not met, the
default value expression will be returned. If a default expression is not
defined, null is used.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TYPE2_HISTORY_LOOKUP_DATE
Type: STRING
Valid Values: N/A
Default: ''
A date expression used when doing a lookup on a type 2 dimension level, to
specify the historical date for which to retrieve data. If blank, the most
current record is used.
Properties for LCRCAST_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for MATCHMERGE_OPERATOR:
Name: MATCH_KEYS
Type: STRING
Valid Values: N/A
Default: ''
Ordered list of attributes that control the set of records to be matched at
any at any particular time.
Name: MATCH_NEW_RECORDS
Type: BOOLEAN
Valid Values: true, false
Default: false
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"MATCHMERGE.GENERAL.MATCH_NEW_RECORDS:DESCRIPTION"
Name: MATCH_NEW_RECORD_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"MATCHMERGE.GENERAL.MATCH_NEW_RECORD_CONDITION:DESCRIPTION"
Name: MERGED_PREFIX
Type: STRING
Valid Values: N/A
Default: ''
Set the prefix used for the merged attributes in the cross-reference group.
Properties for MATERIALIZED_VIEW_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT,
INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Properties for NAME_AND_ADDRESS_OPERATOR:
Name: ADDRESS_LINE_1
Type: STRING
Valid Values: N/A
Default: ''
Address line 1
Name: ADDRESS_LINE_2
Type: STRING
Valid Values: N/A
Default: ''
Address line 2
Name: ADDRESS_LINE_3
Type: STRING
Valid Values: N/A
Default: ''
Address line 3
Name: ADDRESS_LINE_4
Type: STRING
Valid Values: N/A
Default: ''
Address line 4
Name: DUAL_ADDRESS_ASSIGNMENT
Type: STRING
Valid Values: NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX,
NA_DUALADDR_STREET
Default: NA_DUALADDR_STREET
A dual address refers to two address lines for the same destination. For
example, a record contains both a street address and a P.O. Box; this is
common with business data. Select which of the two address lines should be
assigned in these cases.
Name: GENERATE_CASS_REPORT
Type: STRING
Valid Values: NA_NO, NA_YES
Default: NA_NO
Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS
report is a text file specified by the United States Postal Service. The
report is written to the [nas/bin/admin/reports] folder under the home
folder of the name/address server.
Name: LIST_NAME
Type: STRING
Valid Values: N/A
Default: ''
The list name is optional and provides a reference for tracking multiple
CASS reports.
Name: PARSING_TYPE
Type: STRING
Valid Values: NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY
Default: NA_NAMEANDADDRESS
Select a name-address parsing type to be performed on the input data
Name: PRIMARY_COUNTRY
Type: STRING
Valid Values: NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD,
NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE,
NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST,
NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND,
NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM,
NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR,
NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP,
NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF
Default: NA_USA
Select the primary parsing country which best represents the input data.
Input addresses having the same country as the primary parsing country will
only need to be parsed once. Input addresses having a different country
than the primary parsing country may be reparsed by a different parser. For
performance reasons, it is best to minimize the percentage of 2-pass parses
by selecting the optimal parser.
Name: PROCESSOR_NAME
Type: STRING
Valid Values: N/A
Default: ''
The processor name is the name of the organization submitting the CASS
report.
Properties for PIVOT_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: PIVOT_GROUP_SIZE
Type: NUMBER
Valid Values: 1 - 1000
Default: 2
A number specifying the pivot group size for the pivot operation. Pivot
group size determines the number of output rows that are produced from each
input row.
Properties for PLUGGABLE_MAPPING_OPERATOR:
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Properties for POSTMAPPING_PROCESS_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: POSTMAPPING_PROCESS_RUN_CONDITION
Type: STRING(10)
Valid Values: ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING
Default: ON_SUCCESS
Indicates under what condition of the mapping the post-mapping process will
be run.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for PREMAPPING_PROCESS_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: MAPPING_RUN_CONDITION
Type: STRING(10)
Valid Values: ALWAYS, ON_ERROR, ON_SUCCESS
Default: ON_SUCCESS
Indicates under what condition of the pre-mapping process the mapping will
be run.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for QUEUE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: REAL_TIME_DATA_FORMAT
Type: STRING
Valid Values: LOGICAL_CHANGE_RECORD, MESSAGE
Default: LOGICAL_CHANGE_RECORD
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"ADVANCEDQUEUE.DEFAULT.REALTIMEFORMAT:DESCRIPTION"
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Properties for SEQUENCE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for SET_OPERATION_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: SET_OPERATION
Type: STRING
Valid Values: INTERSECT, MINUS, UNION, UNIONALL
Default: UNION
Specifies the set operation that is to be performed by this operator.
Properties for SORTER_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: ORDER_BY_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Order By Clause
Properties for SPLITTER_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for TABLE_FUNCTION_OPERATOR:
Name: TABLE_FUNCTION_IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: TABLE_FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Table Function
Properties for TABLE_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: CONFLICT_RESOLUTION
Type: BOOLEAN
Valid Values: true, false
Default: true
Detect and resolve any conflicts that may arise during DML using the LCR
APIs
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DATA_COLLECTION_FREQUENCY
Type: STRING(16)
Valid Values: DAY, HOUR, MINUTE, MONTH, QUARTER, UNKNOWN, YEAR
Default: UNKNOWN
New Data Granularity
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: DIRECT
Type: BOOLEAN
Valid Values: true, false
Default: false
Directly swap source into target as a partition without first creating a
staging table.
Name: ENABLE_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable Constraints
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EVALUATE_CHECK_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: false
Evaluate check constraints
Name: EXCEPTIONS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Exceptions Table Name
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: JOINRANK
Type: FLOAT
Valid Values: N/A
Default: 0
Join Rank
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT,
INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PEL_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
PEL Enabled
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: REPLACE_DATA
Type: BOOLEAN
Valid Values: true, false
Default: false
Replace existing data in target partition if there is any.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Name: USE_LCR_API
Type: BOOLEAN
Valid Values: true, false
Default: true
Use LCR APIs if possible to perform the DML
Properties for TRANSFORMATION_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, then the function is a target
Name: RETURN_TYPE
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for UNPIVOT_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for VIEW_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT,
INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property allows you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValue
A single property value. It can be a number, float, boolean or
single-quoted string.
bindableLocator
Location of the object to be bound to a mapping operator or mapping
attribute.
attributeNameList
A list of attribute names.
bindableType
Type of object bound to a mapping operator or mapping attribute.
bindableName
Name of the object bound to a mapping operator or mapping attribute.
See Also
OMBALTER, OMBCREATE PLUGGABLE_MAPPING, OMBRETRIEVE PLUGGABLE_MAPPING, OMBDROP PLUGGABLE_MAPPING
Purpose
Alters a presentation template.
Prerequisites
Should be in the context of a business presentation module or use the full
path.
Syntax
alterReportCommand = ( OMBALTER PRESENTATION_TEMPLATE "QUOTED_STRING" ( (
"renameClause" [ SET "setpropertiesClauseDelayed" ] [ SET
"setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
{ "alterReportClauses" } ) | ( SET "setpropertiesClauseDelayed" [ SET
"setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
{ "alterReportClauses" } ) | ( SET "setReferenceIconSetClause" [ UNSET
"unsetReferenceIconSetClause" ] { "alterReportClauses" } ) | ( UNSET
"unsetReferenceIconSetClause" { "alterReportClauses" } ) | (
"alterReportClauses" { "alterReportClauses" } ) ) )
renameClause = RENAME TO "QUOTED_STRING"
setpropertiesClauseDelayed = PROPERTIES "(" "propertyNameListVector" ")"
VALUES "(" "propertyValueListVector" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterReportClauses = ADD "addReportItemClauseForAlter" | MODIFY
"modifyReportItemClause" | DELETE "deleteReportItemClause"
propertyNameListVector = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueListVector = "propertyValue" { "," "propertyValue" }
addReportItemClauseForAlter = ( DATA_ITEM "QUOTED_STRING" [ SET
"setPropertiesClause" ] [ SET ( REF | REFERENCE )
"ReportMeasureReferencesClause" ] ) | ( EDGE_ITEM "QUOTED_STRING" [
SET "setPropertiesClause" ] [ SET ( REF | REFERENCE )
"ReportEdgeReferencesClause" ] )
modifyReportItemClause = ( DATA_ITEM "QUOTED_STRING" [ "renameClause" ] [
SET "setPropertiesClause" ] [ SET ( REF | REFERENCE )
"ReportMeasureReferencesClause" ] [ UNSET ( REF | REFERENCE )
"unsetReportMeasureReferencesClause" ] ) | ( EDGE_ITEM "QUOTED_STRING"
[ "renameClause" ] [ SET "setPropertiesClause" ] [ SET ( REF |
REFERENCE ) "ReportEdgeReferencesClause" ] [ UNSET ( REF | REFERENCE )
"unsetReportEdgeReferencesClause" ] )
deleteReportItemClause = DATA_ITEM "QUOTED_STRING" | EDGE_ITEM
"QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
ReportMeasureReferencesClause = MEASURE "QUOTED_STRING" OF CUBE
"QUOTED_STRING"
ReportEdgeReferencesClause = [ ROLE "QUOTED_STRING" OF ] DIMENSION
"QUOTED_STRING"
unsetReportMeasureReferencesClause = MEASURE
unsetReportEdgeReferencesClause = ROLE | DIMENSION
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
Keywords And Parameters
alterReportCommand
This clause alters a presentation template.
QUOTED_STRING
name of the presentation template.
renameClause
Renames a presentation template with a different name.
setpropertiesClauseDelayed
This clause sets the properties.
setReferenceIconSetClause
Set specified Icon Set.
unsetReferenceIconSetClause
Unset specified Icon Set.
alterReportClauses
This clause modifies a presentation template.
propertyNameListVector
This clause holds the names of the properties.
propertyValueListVector
This clause holds the values of the properties.
addReportItemClauseForAlter
This adds an item reference to a presentation template.
QUOTED_STRING
name of the item.
modifyReportItemClause
This modifies an item reference in a presentation template.
DATA_ITEM
This modifies a data item in a presentation template.
QUOTED_STRING
name of the item.
EDGE_ITEM
This modifies an edge item in a presentation template.
deleteReportItemClause
This removes an item reference from a presentation template.
DATA_ITEM
This deletes a data item from a presentation template.
QUOTED_STRING
name of the item.
EDGE_ITEM
This deletes an edge item from a presentation template.
propertyValue
This is a property value.
setPropertiesClause
This clause sets the properties of the object.
Basic properties for presentation template:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the presentation template
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the presentation template
Name: PRESENTATION_TYPE
Type: STRING(40)
Valid Values: CROSSTAB, TABLE or a subtype of graph
Default: ''
The type of the presentation template
Basic properties for EDGE_ITEM:
Name: PLACEMENT
Type: STRING(40)
Valid Values: TOP OR SIDE, TOP, SIDE, PAGE
Default: ''
The placement of the edge item in the presentation template
Properties for PRESENTATION_TEMPLATE:
Name: CATALOG_FOLDER
Type: STRING
Valid Values: N/A
Default: ''
Catalog Folder for deployed BI Beans presentation
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
Location for referenced database objects
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to
create an object only for those objects marked as Deployable = true
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
ReportMeasureReferencesClause
This clause references a measure from the item.
ReportEdgeReferencesClause
This clause references dimension or roles from the item.
unsetReportMeasureReferencesClause
This clause will remove a reference to a measure.
unsetReportEdgeReferencesClause
This clause will remove a reference to an edge item.
propertyNameList
This is the list of property names.
propertyValueList
This is the list of property values.
See Also
OMBCREATE PRESENTATION_TEMPLATE, OMBRETRIEVE PRESENTATION_TEMPLATE
Purpose
Alter the Procedure by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of a Oracle Module or Package or Transformation
Module.
A Transformation Module may be WB_CUSTOM_TRANS for Public Transformations.
WB_CUSTOM_TRANS may by modified by an administrator.
WB_CUSTOM_TRANS is not dependent on any project.
Syntax
alterProcedureCommand = OMBALTER ( PROCEDURE "QUOTED_STRING" (
"renameClause" [ "alterPropertiesOrIconSetClause" ] [
"alterFuncProcParameterSCOClause" ] | "alterPropertiesOrIconSetClause"
[ "alterFuncProcParameterSCOClause" ] |
"alterFuncProcParameterSCOClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
alterFuncProcParameterSCOClause = ( ADD ( "alterFuncProcParameterClause" |
"addRelationalDependentClause" ) | MODIFY
"modifyFuncProcParameterClause" | DELETE (
"deleteFuncProcParameterClause" | "deleteRelationalDependentClause" )
) [ "alterFuncProcParameterSCOClause" ]
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterFuncProcParameterClause = PARAMETER "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
addRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
"QUOTED_STRING"
modifyFuncProcParameterClause = ( PARAMETER "QUOTED_STRING" (
"renameClause" | "moveToClause" | [ SET "setPropertiesClause" ] ) )
deleteFuncProcParameterClause = ( PARAMETER "QUOTED_STRING" )
deleteRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
"QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
moveToClause = MOVE TO POSITION "INTEGER_LITERAL"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterProcedureCommand
This command modifies an existing Procedure.
QUOTED_STRING
Name of the existing Procedure in single quotes.
renameClause
Rename a Procedure.
alterFuncProcParameterSCOClause
Modify, delete or add a Parameter for Function/Procedure, or add or delete
dependencies to some other relational objects.
setPropertiesClause
Used to set properties (core, user-defined) for procedure. Valid properties
are shown below:
Basic properties for PROCEDURE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Procedure
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Procedure
Name: IMPLEMENTATION
Type: STRING
Valid Values: N/A
Default: ''
Set the code for Procedure which is included global variable declaration
and code between BEGIN and END.
Basic properties for PARAMETER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Parameter
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Parameter
Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BINARY_INTEGER, BLOB, BOOLEAN,
CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO
MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, PLS_INTEGER, RAW, TIMESTAMP,
TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR,
VARCHAR2, XMLTYPE
Default: NUMBER
Set the data type for Parameter
Name: IN_OUT
Type: STRING
Valid Values: IN, OUT, INOUT
Default: 'IN'
Set the parameter mode for Parameter
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Set the default value for Parameter
Properties for PROCEDURE:
Name: AUTHID
Type: STRING
Valid Values: Current_User, Definer, None
Default: None
Generate the transformation with selected AUTHID option. Function will be
executed with the permissions defined by the AUTHID clause rather than the
function owner's permissions.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
alterFuncProcParameterClause
This clause alters Parameter of a Procedure.
addRelationalDependentClause
This clause adds referential dependencies to other relational objects.
modifyFuncProcParameterClause
Modify one or more Parameters to this Function/Procedure.
deleteFuncProcParameterClause
Delete one or more Parameters to this Function/Procedure.
deleteRelationalDependentClause
This clause deletes referential dependencies to other relational objects.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
moveToClause
Move a Parameters of this Function/Procedure.
propertyValue
Value of a property.
See Also
OMBALTER, OMBCREATE PROCEDURE, OMBDROP PROCEDURE
Purpose
Alter the Process Flow by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of a Process Flow Package.
Syntax
alterProcessFlowCommand = OMBALTER PROCESS_FLOW "QUOTED_STRING" ( (
"renameClause" [ "alterPropertiesOrIconSetClause" ] [
"alterProcessFlowSCOClauses" ] ) | ( "alterPropertiesOrIconSetClause"
[ "alterProcessFlowSCOClauses" ] ) | "alterProcessFlowSCOClauses" )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
alterProcessFlowSCOClauses = ADD ( "addProcessParameterClause" [
"alterProcessFlowSCOClauses" ] | "addProcessVariableClause" [
"alterProcessFlowSCOClauses" ] | "addActivityClause" [
"alterProcessFlowSCOClauses" ] | "addTransitionClause" [
"alterProcessFlowSCOClauses" ] ) | MODIFY (
"modifyProcessParameterClause" [ "alterProcessFlowSCOClauses" ] |
"modifyProcessVariableClause" [ "alterProcessFlowSCOClauses" ] |
"modifyActivityClause" [ "alterProcessFlowSCOClauses" ] |
"modifyUserDefinedActivityClause" [ "alterProcessFlowSCOClauses" ] |
"modifyTransitionClause" [ "alterProcessFlowSCOClauses" ] ) | DELETE (
"deleteProcessParameterClause" [ "alterProcessFlowSCOClauses" ] |
"deleteProcessVariableClause" [ "alterProcessFlowSCOClauses" ] |
"deleteActivityClause" [ "alterProcessFlowSCOClauses" ] |
"deleteTransitionClause" [ "alterProcessFlowSCOClauses" ] |
"deleteUserDefinedParameterClause" [ "alterProcessFlowSCOClauses" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
addProcessParameterClause = ( PARAMETER "QUOTED_STRING" ) [ SET
"setPropertiesClause" ]
addProcessVariableClause = ( VARIABLE "QUOTED_STRING" ) [ SET
"setPropertiesClause" ]
addActivityClause = ( "addStandardActivityClause" | "addMapActivityClause"
| "addTemplateActivityClause" | "addDataAuditorActivityClause" |
"addFunctionActivityClause" | "addSubProcessActivityClause" )
addTransitionClause = ( TRANSITION "QUOTED_STRING" ( FROM ACTIVITY
"QUOTED_STRING" ) ( TO "QUOTED_STRING" ) ) [ SET "setPropertiesClause"
]
modifyProcessParameterClause = PARAMETER "QUOTED_STRING" ( "renameClause"
[ SET "setPropertiesClause" ] | SET "setPropertiesClause" )
modifyProcessVariableClause = VARIABLE "QUOTED_STRING" ( "renameClause" [
SET "setPropertiesClause" ] | SET "setPropertiesClause" )
modifyActivityClause = ACTIVITY "QUOTED_STRING" ( ( "renameClause" [
"alterPropertiesOrIconSetClause" ] [ "modifyActivityParameterClause" ]
) | ( "alterPropertiesOrIconSetClause" [
"modifyActivityParameterClause" ] ) | "modifyActivityParameterClause"
)
modifyUserDefinedActivityClause = ( USER_DEFINED | TRANSFORMATION |
MAPPING ) ACTIVITY "QUOTED_STRING" ( "renameClause" [
"alterPropertiesOrIconSetClause" ] [ "modifyUDActivityParameterClause"
] | "alterPropertiesOrIconSetClause" [
"modifyUDActivityParameterClause" ] |
"modifyUDActivityParameterClause" )
modifyTransitionClause = TRANSITION "QUOTED_STRING" ( "renameClause" [ SET
"setPropertiesClause" ] | SET "setPropertiesClause" )
deleteProcessParameterClause = PARAMETER "QUOTED_STRING"
deleteProcessVariableClause = VARIABLE "QUOTED_STRING"
deleteActivityClause = ACTIVITY "QUOTED_STRING"
deleteTransitionClause = TRANSITION "QUOTED_STRING"
deleteUserDefinedParameterClause = PARAMETER "QUOTED_STRING" OF
USER_DEFINED ACTIVITY "QUOTED_STRING"
propertyNameList = ( "UNQUOTED_STRING" | BINDING ) { "," (
"UNQUOTED_STRING" | BINDING ) }
propertyValueList = "propertyValue" { "," "propertyValue" }
addStandardActivityClause = ( "UNQUOTED_STRING" | USER_DEFINED ) ACTIVITY
"QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ]
addMapActivityClause = ( MAPPING ACTIVITY "QUOTED_STRING" [ SET (
PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF | REFERENCE )
"setPropertiesAndReferencesMapClauses" ] [ "setReferenceIconSetClause"
] ) ] | ( REF | REFERENCE ) "setPropertiesAndReferencesMapClauses" [
SET "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
addTemplateActivityClause = ( ACTIVITY_TEMPLATE ACTIVITY "QUOTED_STRING" [
SET ( PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF |
REFERENCE ) "setPropertiesAndReferencesTemplateClause" ] [
"setReferenceIconSetClause" ] ) ] | ( REF | REFERENCE )
"setPropertiesAndReferencesTemplateClause" [ SET
"setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
addDataAuditorActivityClause = ( DATA_AUDITOR ACTIVITY "QUOTED_STRING" [
SET ( PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF | REFERENCE
) "setPropertiesAndReferencesDataAuditorClauses" ] [
"setReferenceIconSetClause" ] ) ] | ( REF | REFERENCE )
"setPropertiesAndReferencesDataAuditorClauses" [ SET
"setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
addFunctionActivityClause = ( TRANSFORMATION ACTIVITY "QUOTED_STRING" [
SET ( PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF | REFERENCE
) "setPropertiesAndReferencesFunctionClauses" ] [
"setReferenceIconSetClause" ] ) ] | ( REF | REFERENCE )
"setPropertiesAndReferencesFunctionClauses" [ SET
"setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
addSubProcessActivityClause = ( SUBPROCESS ACTIVITY "QUOTED_STRING" SET (
PROPERTIES "collectPropertiesClause" SET ( REF | REFERENCE )
"setPropertiesAndReferencesSubProcessClauses" [ SET
"setReferenceIconSetClause" ] | ( REF | REFERENCE )
"setPropertiesAndReferencesSubProcessClauses" [ SET
"setReferenceIconSetClause" ] ) )
modifyActivityParameterClause = MODIFY "modifyActivityParameter" [
"modifyActivityParameterClause" ]
modifyUDActivityParameterClause = ADD ( "addUDActivityParameterClause" [
"modifyUDActivityParameterClause" ] ) | MODIFY (
"alterUDActivityParameterClause" [ "modifyUDActivityParameterClause" ]
) | DELETE ( "deleteUDActivityParameterClause" [
"modifyUDActivityParameterClause" ] )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
collectPropertiesClause = "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setPropertiesAndReferencesMapClauses = ( MAPPING "QUOTED_STRING" )
setPropertiesAndReferencesTemplateClause = ( ACTIVITY_TEMPLATE
"QUOTED_STRING" )
setPropertiesAndReferencesDataAuditorClauses = ( DATA_AUDITOR
"QUOTED_STRING" )
setPropertiesAndReferencesFunctionClauses = ( TRANSFORMATION
"QUOTED_STRING" )
setPropertiesAndReferencesSubProcessClauses = ( PROCESS_FLOW
"QUOTED_STRING" )
modifyActivityParameter = PARAMETER "QUOTED_STRING" SET
"setPropertiesClause"
addUDActivityParameterClause = PARAMETER "QUOTED_STRING" [ SET
"setPropertiesClause" ]
alterUDActivityParameterClause = PARAMETER "QUOTED_STRING" ( (
"renameClause" [ SET "setPropertiesClause" ] ) | ( SET
"setPropertiesClause" ) )
deleteUDActivityParameterClause = PARAMETER "QUOTED_STRING"
Keywords And Parameters
alterProcessFlowCommand
Alter process flow.
renameClause
Rename process flow/ activity, depending on current context.
alterProcessFlowSCOClauses
This clause is wrapper clause to add, modify or delete Process Flow's
second class objects.
setPropertiesClause
Used to set properties (core, user-defined) for process flow. Note: For
MAPPING, TRANSFORMATION and SUBPROCESS
activities the setPropertiesAndReferencesMapClauses,
setPropertiesAndReferencesFunctionClauses and
setPropertiesAndReferencesSubProcessClauses respectively,
are mandatory.
For MAPPING or TRANSFORMATION activities and the REFERENCE property has to
be set to a
valid MAP or TRANSFORMATION within the current project.
For SUBPROCESS activities the REFERENCE property has to be set
to a SUBPROCESS within the same PROCESS_FLOW_PACKAGE.
Valid properties are shown below:
Base properties for PROCESS_FLOW:
Basic properties for Process Flow, Activity, Transition and Parameter:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Process Flow
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Process Flow Core properties for Transition :
Name: TRANSITION_CONDITION
Type: STRING
Valid Values: '', SUCCESS, ERROR, WARNING
Default: '' i.e. Unconditional
Sets the Transition Condition of a Transition
Description of the Process Flow Core properties for Activity Parameter :
Name: DATATYPE
Type: STRING
Valid Values: INTEGER, FLOAT, DATE, STRING, BOOLEAN
Default: STRING
Sets the datatype of a Activity Parameter
Name: DIRECTION
Type: STRING
Valid Values: IN
Default: IN
Sets the direction of a Activity Parameter
Name: VALUE
Type: STRING
Valid Values: Examples '123', '123.456', 'Jan-08-2003', 'I am String',
'true'
Default: ''
For Mapping activities representing PLSQL maps, the allowed value for the
parameters:
OPERATING_MODE:'SET_BASED' 'ROW_BASED' 'ROW_BASED_TARGET_ONLY'
'SET_BASED_FAIL_OVER_TO_ROW_BASED'
'SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY'
AUDIT_LEVEL:'NONE' 'STATISTICS' 'ERROR_DETAILS' 'COMPLETE'
Sets the value of a Activity Parameter
Name: BINDING
Type: STRING
Valid Values: Examples 'PARAM_1', 'PARAM_2'
Default: ''
Represents the parameter on the process flow that this parameter is bound
to.
When setting users can specify the name of any PROCESS PARAMETER of same
datatype.
This feature allows for parameterizing the process flow. If the parameter
is bound
the VALUE property is ignored when generating the process flow.
To unbind a parameter, use an empty quoted string ie. '', and the parameter
will be unbound.
Properties for PROCESS_FLOW:
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: REFERRED_CALENDAR
Type: STRING
Valid Values: N/A
Default: ''
Enter the Schedule to associate with this object.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
addProcessParameterClause
This clause adds the Parameters for a Process Flow.
addActivityClause
This clause adds the Activities for a Process Flow.
addTransitionClause
This clause adds the Transitions for a Process Flow.
modifyProcessParameterClause
This clause modifies the Parameters of a Process Flow.
modifyActivityClause
This clause modifies the Activities of a Process Flow.
modifyUserDefinedActivityClause
Alter the properties of the specified user defined activity.
modifyTransitionClause
This clause modifies the Transitions of a Process Flow.
deleteProcessParameterClause
This clause deletes the Parameters of a Process Flow.
deleteActivityClause
This clause deletes the Activities of a Process Flow.
deleteTransitionClause
This clause deletes the Transitions of a Process Flow.
deleteUserDefinedParameterClause
This clause deletes the Parametrers of a User Defined Activity of a Process
Flow.
propertyNameList
A comma delimited set of property names to set.
propertyValueList
A comma delimited set of property values to set.
addStandardActivityClause
This clause adds standard activity types AND, EMAIL, END_ERROR,
END_WARNING, END_SUCCESS, FILE_EXISTS, FORK, FTP, OR, ASSIGN, END_LOOP,
FOR_LOOP, MANUAL, NOTIFICATION, ROUTE, SET_STATUS, SQLPLUS, WAIT,
WHILE_LOOP OR USER_DEFINED to a Process Flow.
addMapActivityClause
This clause adds the MAP activity to a Process Flow.
addTemplateActivityClause
This clause adds an ACTIVITY_TEMPLATE as an activity to a Process Flow.
addDataAuditorActivityClause
This clause adds a DATA_AUDITOR activity to a Process Flow.
addFunctionActivityClause
This clause adds the Function or Procedure activity to a Process Flow.
addSubProcessActivityClause
This clause adds a Process as an activity to a Process Flow.
modifyActivityParameterClause
Alter the properties of activity parameters.
modifyUDActivityParameterClause
Alter user defined activity by adding new parameters or modifying existing
parameter.
propertyValue
Integer value, float value or quoted string literal.
collectPropertiesClause
This clause collects core properties of Map, Function/Procedure and
Subprocess activity.
setPropertiesAndReferencesMapClauses
This clause sets reference to the existing Map.
setPropertiesAndReferencesFunctionClauses
This clause sets a reference to existing Function or Procedure.
setPropertiesAndReferencesSubProcessClauses
This clause sets a reference to existing Process Flow.
modifyActivityParameter
Alter the properties of the parameter.
addUDActivityParameterClause
Add more activity parameters to the user defined activity.
alterUDActivityParameterClause
In the current user defined activity, alter the properties of the activity
parameter eg. rename, set DATATYPE or set VALUE.
deleteUDActivityParameterClause
For the current user defined activity, delete the activity parameter.
See Also
OMBALTER, OMBCREATE PROCESS_FLOW, OMBDROP PROCESS_FLOW
Purpose
Alter the Process Flow Module by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of a project.
Syntax
alterProcessFlowModuleCommand = OMBALTER ( PROCESS_FLOW_MODULE
"QUOTED_STRING" ( "renameClause" [ "alterPropertiesOrReferenceClause"
] | "alterPropertiesOrReferenceClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrReferenceClause = SET ( "setPropertiesClause" [ SET
"setReferenceClause" [ UNSET "unsetReferenceClause" ] | UNSET
"unsetReferenceClause" [ SET "setReferenceClause" ] ] |
"setReferenceClause" [ UNSET "unsetReferenceClause" ] ) | UNSET
"unsetReferenceClause" [ SET "setReferenceClause" ]
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = ( "setReferenceLocationClause" [ SET
"setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
unsetReferenceClause = ( "unsetReferenceLocationClause" [ UNSET
"unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceLocationClause = ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterProcessFlowModuleCommand
This command modifies an existing process flow module.
renameClause
Rename an existing process flow module.
setPropertiesClause
Set values of properties of a process flow module.
Base properties for PROCESS_FLOW_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of a Process Flow Module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of a Process Flow Module
propertyNameList
Comma-separated list of property names. Property names are not in
quotation marks.
propertyValueList
Comma separated list of property values.
setReferenceLocationClause
Set a location to a supported workflow engine.
unsetReferenceLocationClause
Unset the location of the process flow module.
propertyValue
Value of a property.
See Also
OMBALTER, OMBCREATE PROCESS_FLOW_MODULE, OMBDROP PROCESS_FLOW_MODULE
Purpose
Alter the Process Flow Package by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of a Process Flow Module.
Syntax
alterProcessFlowPackageCommand = OMBALTER ( PROCESS_FLOW_PACKAGE
"QUOTED_STRING" ( "renameClause" [ "alterPropertiesOrIconSetClause" ]
| "alterPropertiesOrIconSetClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
propertyNameList = ( "UNQUOTED_STRING" | BINDING ) { "," (
"UNQUOTED_STRING" | BINDING ) }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterProcessFlowPackageCommand
Alter process flow package.
renameClause
Rename the process flow package.
setPropertiesClause
Set the properties of the process flow package.
Basic properties for PROCESS_FLOW_PACKAGE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Process Flow Package
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Process Flow Package
Properties for PROCESS_FLOW_PACKAGE:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"OWF.PACKAGES.DEPLOYABLE:DESCRIPTION"
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
A comma delimited set of property names to set.
propertyValueList
A comma delimited set of property values to set.
propertyValue
Integer value, float value or quoted string literal.
See Also
OMBALTER, OMBCREATE PROCESS_FLOW_PACKAGE, OMBDROP PROCESS_FLOW_PACKAGE
Purpose
To alter a profile reference, such as to add or delete a data rule usage, or set properties on a profile attribute.
Prerequisites
Must be done in the context of a Data Profile.
Syntax
alterProfileReferenceCommand = OMBALTER ( PROFILE_REFERENCE
"QUOTED_STRING" ( [ SET "setPropertiesClause" ] { ADD
"addDataRuleUsageClause" | DELETE "deleteDataRuleUsageClause" | MODIFY
( "modifyDataRuleUsageClause" | "modifyProfileAttributeClause" ) } )
)
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
addDataRuleUsageClause = DATA_RULE_USAGE ( [ "QUOTED_STRING" ] [ SET REF
DATA_RULE "QUOTED_STRING" ] ( DERIVE FROM ( (
"getProfileAttributeDerivationClause" |
"getProfileForeignKeyDerivationClause" |
"getProfileUniqueKeyDerivationClause" |
"getFunctionalDependencyDerivationClause" |
"getRowRelationshipDerivationClause" ) [ CREATE IN DATA_RULE_MODULE
"QUOTED_STRING" ] ) | ( GROUP "QUOTED_STRING" SET REF TABLE
"QUOTED_STRING" ( ATTRIBUTE "QUOTED_STRING" SET REF COLUMN
"QUOTED_STRING" )+ )+ [ SET "setPropertiesClause" ] ) )
deleteDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING"
modifyDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" ] | SET
"setPropertiesClause" )
modifyProfileAttributeClause = PROFILE_ATTRIBUTE "QUOTED_STRING" SET
"setPropertiesClause"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
getProfileAttributeDerivationClause = PROFILE_ATTRIBUTE "QUOTED_STRING"
PROFILE_TYPE "QUOTED_STRING"
getProfileForeignKeyDerivationClause = PROFILE_FOREIGN_KEY "QUOTED_STRING"
getProfileUniqueKeyDerivationClause = PROFILE_UNIQUE_KEY "QUOTED_STRING"
getFunctionalDependencyDerivationClause = FUNCTIONAL_DEPENDENCY
"QUOTED_STRING"
getRowRelationshipDerivationClause = ROW_RELATIONSHIP "QUOTED_STRING"
renameClause = RENAME TO "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterProfileReferenceCommand
This clause alters the profile reference.
QUOTED_STRING
This is the name of the source pointed to by the profile reference.
setPropertiesClause
Configuration properties for PROFILE_REFERENCE that affect loading:
Name: COPY_DATA
Type: BOOLEAN
Valid Values: true | false
Default: true
Setting this to true will enable copying of data from source to profile
workspace.
Name: CALCULATE_DATATYPES
Type: BOOLEAN
Valid Values: true | false
Default: false
Setting this to true will enable data type discovery for the selected
table.
Name: CALCULATE_COMMON_FORMATS
Type: BOOLEAN
Valid Values: true | false
Default: false
Setting this to true will enable common format discovery for the selected
table.
Name: NULL_VALUE
Type: STRING
Valid Values: any string value
Default: null
This value will be considered as the null value when profiling. Please
enclose the value in single quotes. An unqouted null (the current default
value) will be considered a database null.
Name: SAMPLE_RATE
Type: 100
Valid Values: 1-100
Default: 100
This value will be the percent of total rows that will be randomly selected
during loading.
Configuration properties for PROFILE_REFERENCE that affect profiling:
Name: CALCULATE_DOMAINS
Type: BOOLEAN
Valid Values: true | false
Default: true
Setting this to true will enable domain discovery.
Name: DOMAIN_MAX_COUNT
Type: NUMBER
Valid Values: 1-any number
Default: true
The maximum number of distinct values in a column in order for that column
to be discovered as possibly being defined by a domain. Domain Discovery
of a column occurs if the number of distinct values in that column is at or
below the Max Distinct Values Count property, AND, the number of distinct
values as a percentage of total rows is at or below the Max Distinct Values
Percent property.
Name: DOMAIN_MAX_PERCENT
Type: NUMBER
Valid Values: 1-100
Default: true
The maximum number of distinct values in a column, expressed as a
percentage of the total number of rows in the table, in order for that
column to be discovered as possibly being defined by a domain. Domain
Discovery of a column occurs if the number of distinct values in that
column is at or below the Max Distinct Values Count property, AND, the
number of distinct values as a percentage of total rows is at or below the
Max Distinct Values Percent property.
Name: DOMAIN_MIN_COUNT
Type: NUMBER
Valid Values: 1-any number
Default: true
The minimum number of rows for the given distinct value in order for that
distinct value to be considered as compliant with the domain. Domain Value
Compliance for a value occurs if the number of rows with that value is at
or above the Min Rows Count property, AND, the number of rows with that
value as a percentage of total rows is at or above the Min Rows Percent
property.
Name: DOMAIN_MIN_PERCENT
Type: NUMBER
Valid Values: 1-100
Default: true
The minimum number of rows, expressed as a percentage of the total number
of rows, for the given distinct value in order for that distinct value to
be considered as compliant with the domain. Domain Value Compliance for a
value occurs if the number of rows with that value is at or above the Min
Rows Count property, AND, the number of rows with that value as a
percentage of total rows is at or above the Min Rows Percent property.
Name: CALCULATE_UK
Type: BOOLEAN
Valid Values: true | false
Default: true
Setting this to true will enable unique key discovery.
Name: UK_MIN_PERCENT
Type: NUMBER
Valid Values: 1-100
Default: 75
This is the minimum percentage of rows that need to satisfy a unique key
relationship.
Name: CALCULATE_FD
Type: BOOLEAN
Valid Values: true | false
Default: true
Setting this to true will enable functional dependency discovery.
Name: FD_MIN_PERCENT
Type: NUMBER
Valid Values: 1-100
Default: 75
This is the minimum percentage of rows that need to satisfy a functional
dependency relationship.
Name: FD_UK_LHS_COUNT
Type: NUMBER
Valid Values: 1-number of attributes of source less 1
Default: 1
This is the maximum number of attributes for unique key and functional
dependency profiling.
Name: CALCULATE_FK
Type: BOOLEAN
Valid Values: true | false
Default: true
Setting this to true will enable foreign key discovery.
Name: FK_MIN_PERCENT
Type: NUMBER
Valid Values: 1-100
Default: 75
This is the minimum percentage of rows that need to satisfy a foreign key
relationship.
Name: CALCULATE_REDUNDANT_COLUMNS
Type: BOOLEAN
Valid Values: true | false
Default: false
Setting this to true will enable redundant column discovery with respect to
a foreign key-unique key pair.
Name: REDUNDANT_MIN_PERCENT
Type: NUMBER
Valid Values: 1-100
Default: 75
This is the minimum percentage of rows that are redundant.
Name: CALCULATE_DATA_RULES
Type: BOOLEAN
Valid Values: true | false
Default: false
Setting this to true will enable data rule profiling for the selected
table.
Configuration properties for PROFILE_ATTRIBUTE that affect loading:
Name: USE_IN_LOADING
Type: BOOLEAN
Valid Values: true | false
Default: true
This tells the profiler if the data for this column is to be copied from
the source schema to the profile workspace schema.
Name: CALCULATE_PATTERNS
Type: BOOLEAN
Valid Values: true | false
Default: false
Setting this to true will enable pattern discovery.
Name: MAX_NUM_PATTERNS
Type: NUMBER
Valid Values: any number less than the number of rows of the source
Default: 10
This tells the profiler to get the top-N patterns for the attribute.
Configuration properties for PROFILE_ATTRIBUTE that affect loading:
Name: USE_IN_FK
Type: BOOLEAN
Valid Values: true | false
Default: true
This tells the profiler if this column is to be part of the determinant in
functional dependency discovery.By default, all non-numeric columns set
this property to false
Name: USE_IN_LOADING
Type: BOOLEAN
Valid Values: true | false
Default: true
Setting this to true will include this column in profiling.
Name: CALCULATE_DATATYPES
Type: BOOLEAN
Valid Values: true | false
Default: false
Setting this to true will enable data type discovery for the selected
table.
Name: CALCULATE_COMMON_FORMATS
Type: BOOLEAN
Valid Values: true | false
Default: false
Setting this to true will enable common format discovery for the selected
table.
Name: NULL_VALUE
Type: STRING
Valid Values: any string value
Default: null
This value will be considered as the null value when profiling. Please
enclose the value in single quotes. An unqouted null (the current default
value) will be considered a database null.
Configuration properties for PROFILE_ATTRIBUTE that affect profiling:
Name: USE_IN_DETERMINANT
Type: BOOLEAN
Valid Values: true | false
Default: true
This tells the profiler if this column is to be part of the determinant in
functional dependency discovery.By default, all non-numeric columns set
this property to false
Name: CALCULATE_DOMAINS
Type: BOOLEAN
Valid Values: true | false
Default: true
This tells the profiler if domain values are to be discovered for this
column.
Name: DOMAIN_MAX_COUNT
Type: NUMBER
Valid Values: 1-any number
Default: true
This tells the profiler the maximum number of distinct values this column
can have to be considered as domain attributes.
Name: DOMAIN_MAX_PERCENT
Type: NUMBER
Valid Values: 1-100
Default: true
This tells the profiler the maximum number of distinct values as a
percentage this column can have to be considered as domain attributes.
Name: DOMAIN_MIN_COUNT
Type: NUMBER
Valid Values: 1-any number
Default: true
This tells the profiler the minimum number of rows a particular value
should have in order to be considered a domain value.
Name: DOMAIN_MIN_PERCENT
Type: NUMBER
Valid Values: 1-100
Default: true
This tells the profiler the minimum number of rows as a percentage a
particular value should have in order to be considered a domain value.
addDataRuleUsageClause
Add a data rule usage to the profile table.
QUOTED_STRING
name of data rule usage.
deleteDataRuleUsageClause
Delete a data rule usage.
QUOTED_STRING
name of data rule usage.
modifyDataRuleUsageClause
Rename or modify the properties of a data rule usage.
QUOTED_STRING
name of data rule usage.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
renameClause
Renames an object.
propertyValue
Value of a property.
See Also
OMBALTER
Purpose
Alter the project by renaming it, and/or reset its properties.
Prerequisites
Should be in the top level context.
Syntax
alterProjectCommand = OMBALTER ( PROJECT "QUOTED_STRING" ( "renameClause"
[ "alterPropertiesOrIconSetClause" ] |
"alterPropertiesOrIconSetClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterProjectCommand
Modify an existing project.
QUOTED_STRING
Name of the existing project in quotes.
renameClause
Rename a project.
alterPropertiesOrIconSetClause
Alter existing Project properties and/or Icon Set.
setPropertiesClause
Associate a set of properties with a project.
Basic properties for PROJECT:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of a Project
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of a Project
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
propertyValue
Value of a property.
See Also
OMBALTER, OMBCREATE PROJECT, OMBDROP PROJECT
Purpose
Alter the Queue Propagation by resetting its properties.
Prerequisites
Should be in the context of an Advanced Queue. The target Queue should
exist in any Oracle Module.
Syntax
alterQPCommand = OMBALTER ( QUEUE_PROPAGATION "QUOTED_STRING" (
"renameClause" [ SET "setQPPropertiesClause" ] | SET
"setQPPropertiesClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
setQPPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterQPCommand
Alters the Queue Propagation with the given name by either renaming it or
by setting it's properties or both.
renameClause
Renames the Queue Propagation to the given name.
setQPPropertiesClause
Sets properties (core, logical, physical, user-defined) for Queue
Propagation. Valid properties are shown below:
Basic properties for QUEUE_PROPAGATION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Queue Propagation
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Queue Propagation
Name: TARGET_QUEUE
Type: STRING(4000)
Valid Values: N/A
Default: ''
Target Queue for the Queue Propagation. This has to be the name of a Queue
existing in any Oracle Module.
Properties for QUEUE_PROPAGATION:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those objects marked as Deployable = true.
Name: DURATION
Type: STRING
Valid Values: N/A
Default: ''
The duration of proagation to be done. The default value is null.Applicable
only for non-streams queue propagation.
Name: GENERATE_DBLINK
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate script for Database Link which is used for propagation
Name: GENERATE_QUEUE_PROPAGATION
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate script for Queue Propagation
Name: GENERATE_REPLICATION_RULE
Type: BOOLEAN
Valid Values: true, false
Default: false
Generate Ruleset and Rule for Replication purpose in Streams queue
propagation
Name: GENERATE_SCHEDULE_PROPAGATION
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate script for Scheduling propagation. Applicable only for non-streams
queue propagation.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: LATENCY
Type: STRING
Valid Values: N/A
Default: 60
The latency for the queue propagation. By default the value is
60.Applicable only for non-streams queue propagation.
Name: NEXT_TIME
Type: STRING
Valid Values: N/A
Default: ''
Next time when the propagation to be done. The default value is
null.Applicable only for non-streams queue propagation.
Name: NOT_PERMITTED_TAG_VALUES
Type: STRING
Valid Values: N/A
Default: ''
List of comma separated Tag values (in Hex numbers) which are not allowed
for propagation
Name: PERMITTED_TAG_VALUES
Type: STRING
Valid Values: N/A
Default: ''
List of comma separated Tag values (in Hex numbers) which are allowed for
propagation
Name: START_TIME
Type: STRING
Valid Values: N/A
Default: SYSDATE
The start time for the propagation to happen. The default value is
SYSDATE.Applicable only for non-streams queue propagation.
Name: SUBCRIBER_TRANSFORMATION
Type: STRING
Valid Values: N/A
Default: ''
A Transformation that will be applied before propagation to the target
queue. Applicable only for non-streams queue propagation.
Name: SUBSCRIBER_RULE_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
A Rule condition to check whether the message can be propagated to the
subscriber. Applicable only for non-streams queue propagation.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
OMBALTER, OMBCREATE QUEUE_PROPAGATION, OMBRETRIEVE QUEUE_PROPAGATION, OMBDROP QUEUE_PROPAGATION
Purpose
Alter the Queue Table by resetting its properties.
Prerequisites
Should be in the context of an Oracle Module. The target Queue should exist
in any Oracle Module.
Syntax
alterQTCommand = OMBALTER ( QUEUE_TABLE "QUOTED_STRING" ( "renameClause" [
SET "setQTPropertiesClause" ] | SET "setQTPropertiesClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
setQTPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterQTCommand
Alters the Queue Table with the given name by either renaming it or by
setting it's properties or both.
renameClause
Renames the Queue Table to the given name.
setQTPropertiesClause
Sets properties (core, logical, physical, user-defined) for Queue Table.
Valid properties are shown below:
Basic properties for QUEUE_TABLE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Queue Table
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Queue Table
Name: PAYLOAD_TYPE
Type: STRING(4000)
Valid Values: N/A
Default: ''
Object Type for the Queue Table. This has to be the name of an Object Type
(OBJECT_TYPE) existing in any Oracle Module.
Properties for QUEUE_TABLE:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.QUEUETABLES.DEFAULT.DEPLOYABLE:DESCRIPTION"
Name: GENERATE_QUEUE_TABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.QUEUETABLES.GENERATEQUEUETABLE:DESCRIPTION"
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.QUEUETABLES.TABLESPACE:DESCRIPTION"
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
OMBALTER, OMBCREATE QUEUE_TABLE, OMBRETRIEVE QUEUE_TABLE, OMBDROP QUEUE_TABLE
