| 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 DRILL_TO_DETAIL. Subsequent commands associated with OMBALTER are contained in the next chapter.
Purpose
Alter metadata for a component.
Prerequisites
Should be in the parent context of the component to alter.
Syntax
alterCommand = OMBALTER "fco_type" "fco_name" "alterCommandSubClauses"
alterCommandSubClauses = ( "renameClause" [ "setPropertiesClause" ] {
"setReferenceClause" | "unsetReferenceClause" } {
"addSCOClauseForAlter" | "modifySCOClause" | "deleteSCOClause" } ) | (
"setPropertiesClause" { "setReferenceClause" | "unsetReferenceClause"
} { "addSCOClauseForAlter" | "modifySCOClause" | "deleteSCOClause" }
) | ( ( "setReferenceClause" | "unsetReferenceClause" )+ {
"addSCOClauseForAlter" | "modifySCOClause" | "deleteSCOClause" } ) | (
"addSCOClauseForAlter" | "modifySCOClause" | "deleteSCOClause" )+
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = SET PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = SET ( REF | REFERENCE ) [ "qualifier" ] "type"
"quotedNameList" [ { "parentSCOClause" } OF "fco_type" "fco_name" ]
unsetReferenceClause = UNSET ( REF | REFERENCE ) [ "qualifier" ] "type"
addSCOClauseForAlter = ADD "sco_type" "sco_name" { "parentSCOClause" } [
AT POSITION "pos" ] [ "setPropertiesClause" ] { "setReferenceClause" }
modifySCOClause = MODIFY "sco_type" "sco_name" { "parentSCOClause" }
"modifySCOSubClauses"
deleteSCOClause = DELETE "sco_type" "sco_name" { "parentSCOClause" }
propertyNameList = "propertyName" { "," "propertyName" }
propertyValueList = "propertyValue" { "," "propertyValue" }
quotedNameList = "QUOTED_STRING" | "(" "QUOTED_STRING" { ","
"QUOTED_STRING" } ")"
parentSCOClause = OF "sco_type" "sco_name"
modifySCOSubClauses = ( "renameClause" [ "moveToClause" ] [
"setPropertiesClause" ] { "setReferenceClause" } ) | ( "moveToClause"
[ "setPropertiesClause" ] { "setReferenceClause" } ) | (
"setPropertiesClause" { "setReferenceClause" } ) |
"setReferenceClause"+
propertyName = "UNQUOTED_STRING"
propertyValue = "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL"
moveToClause = MOVE TO POSITION "pos"
Keywords And Parameters
alterCommand
Specify the component to alter.
fco_type
The type of the component.
fco_name
The physical name of the component in single quotes.
alterCommandSubClauses
Use this clause to rename the component, reset its properties, or modify
the child objects of the component.
renameClause
Rename the component.
setPropertiesClause
Set object properties.
setReferenceClause
Specify reference objects.
qualifier
Specify which reference to set, if there are more than one pointing to the
same type.
unsetReferenceClause
Removes an existing reference.
qualifier
Specify which reference to set, if there are more than one pointing to the
same type.
addSCOClauseForAlter
Add child objects under the component.
modifySCOClause
Change definition of a child object.
deleteSCOClause
Delete a child object.
propertyNameList
A list of property names.
propertyValueList
A list of property values.
quotedNameList
A list of single-quoted physical names.
parentSCOClause
Used to specify the path from a child object to the component
modifySCOSubClauses
Use this clause to rename a child object, reset its properties or
references, or reorder it.
propertyName
An unquoted string representing the name of a property.
propertyValue
The value of a property.
moveToClause
Used to reorder child objects.
See Also
OMBCREATE, OMBDROP
Purpose
To alter activity template folder.
Prerequisites
Should be in the context of a Project.
Syntax
parseAlterTemplateFolder = "QUOTED_STRING" ( ( RENAME TO "QUOTED_STRING" [
"alterTemplateFolderPropertiesOrIconSetClause" ] ) |
"alterTemplateFolderPropertiesOrIconSetClause" )
alterTemplateFolderPropertiesOrIconSetClause = ( ( SET
"setPropertiesClause" ) | "setReferenceIconSetClause" |
"unsetReferenceIconSetClause" )+
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = SET ( REFERENCE | REF ) ICONSET
"QUOTED_STRING"
unsetReferenceIconSetClause = UNSET ( REFERENCE | REF ) ICONSET
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
setPropertiesClause
Basic properties for ACTIVITY_TEMPLATE_FOLDER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Activity Template Folder
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Activity Template Folder
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
See Also
OMBALTER, OMBCREATE ACTIVITY_TEMPLATE_FOLDER, OMBDROP ACTIVITY_TEMPLATE_FOLDER
Purpose
To alter activity template folder.
Prerequisites
Should be in the context of an Activity Template Folder.
Syntax
parseAlterTemplate = "QUOTED_STRING" ( ( "renameClause" [
"alterTemplatePropertiesOrIconSetClause" ] [ "modifyParametersClause"
] ) | ( "alterTemplatePropertiesOrIconSetClause" [
"modifyParametersClause" ] ) | "modifyParametersClause" )
renameClause = RENAME TO "QUOTED_STRING"
alterTemplatePropertiesOrIconSetClause = ( ( SET "setPropertiesClause" ) |
"setReferenceIconSetClause" | "unsetReferenceIconSetClause" )+
modifyParametersClause = ( "addParameterClause" | "modifyParameterClause"
| "deleteParameterClause" )+
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = SET ( REFERENCE | REF ) ICONSET
"QUOTED_STRING"
unsetReferenceIconSetClause = UNSET ( REFERENCE | REF ) ICONSET
addParameterClause = ( ADD PARAMETER "QUOTED_STRING" ) [ SET
"setPropertiesClause" ]
modifyParameterClause = MODIFY PARAMETER "QUOTED_STRING" ( (
"renameClause" [ SET "setPropertiesClause" ] ) | ( SET
"setPropertiesClause" ) )
deleteParameterClause = DELETE PARAMETER "QUOTED_STRING"
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
setPropertiesClause
Basic properties for ACTIVITY_TEMPLATE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Activity Template
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Activity Template
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
See Also
OMBALTER, OMBCREATE ACTIVITY_TEMPLATE, OMBDROP ACTIVITY_TEMPLATE
Purpose
Alter the Advanced Queue by resetting its properties.
Prerequisites
Should be in the context of an Oracle Module. The Queue Table should exist
in the same Oracle Module.
Syntax
alterAQCommand = OMBALTER ( ADVANCED_QUEUE "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
alterAQCommand
Alters the Advanced Queue with the given name by either renaming it or by
setting it's properties or both.
renameClause
Renames the Advanced Queue to the given name.
alterPropertiesOrIconSetClause
Set properties or change the Icon Set.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for Advanced Queue.
Valid properties are shown below:
Basic properties for ADVANCED_QUEUE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Advanced Queue
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Advanced Queue
Name: QTABLE
Type: STRING(4000)
Valid Values: N/A
Default: ''
Queue Table for the Advanced Queue. This has to be the name of a Queue
Table(QUEUE_TABLE) existing in the same Oracle Module.
Properties for ADVANCED_QUEUE:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.DEPLOYABLE:DESCRIPTION"
Name: DEQUEUE_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.DEQUEUEENABLED:DESCRIPTION"
Name: ENQUEUE_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.ENQUEUEENABLED:DESCRIPTION"
Name: GENERATE_ADVANCED_QUEUE
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.GENERATEAQ:DESCRIPTION"
Name: GENERATE_TEMPORARY_TABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.GENERATETEMPTABLE:DESCRIPTION"
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: MAX_RETRIES
Type: NUMBER
Valid Values: N/A
Default: 5
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.MAXRETRIES:DESCRIPTION"
Name: RETENTION_TIME
Type: NUMBER
Valid Values: N/A
Default: 0
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.RETENTIONTIME:DESCRIPTION"
Name: RETRY_DELAY
Type: NUMBER
Valid Values: N/A
Default: 0
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.ADVANCEDQUEUES.DEFAULT.RETRYDELAY:DESCRIPTION"
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceIconSetClause
Set the specified Icon Set.
unsetReferenceIconSetClause
Unset the Icon Set.
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
See Also
OMBALTER, OMBCREATE ADVANCED_QUEUE, OMBRETRIEVE ADVANCED_QUEUE, OMBDROP ADVANCED_QUEUE
Purpose
Alters an alternative sort order.
Prerequisites
Should be in the context of a business definition module or use the full
path.
Syntax
alterAlternativeSortOrderCommand = ( OMBALTER ALTERNATIVE_SORT_ORDER
"QUOTED_STRING" ( ( "renameClause" [ SET
"setPropertiesClauseforLOVandD2D" ] [ SET "setReferenceIconSetClause"
] [ UNSET "unsetReferenceIconSetClause" ] {
"alterAlternativeSortOrderClauses" } ) | ( SET
"setPropertiesClauseforLOVandD2D" [ SET "setReferenceIconSetClause" ]
[ UNSET "unsetReferenceIconSetClause" ] {
"alterAlternativeSortOrderClauses" } ) | ( SET
"setReferenceIconSetClause" [ UNSET "unsetReferenceIconSetClause" ] {
"alterAlternativeSortOrderClauses" } ) | ( UNSET
"unsetReferenceIconSetClause" { "alterAlternativeSortOrderClauses" } )
| ( "alterAlternativeSortOrderClauses" {
"alterAlternativeSortOrderClauses" } ) ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClauseforLOVandD2D = PROPERTIES "("
"propertyNameListforLOVandD2D" ")" VALUES "(" "propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterAlternativeSortOrderClauses = SET ( REF | REFERENCE )
"addAlternativeSortOrderClauseforAlter" | UNSET ( REF | REFERENCE )
"deleteAlternativeSortOrderClauses" |
"addAlternativeSortOrderReferenceClause"
propertyNameListforLOVandD2D = ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
"," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }
propertyValueList = "propertyValue" { "," "propertyValue" }
addAlternativeSortOrderClauseforAlter = ( DEFINING ITEM "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING" ) | ( ORDERED ITEM "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING" )
deleteAlternativeSortOrderClauses = ( DEFINING ITEM ) | ( ORDERED ITEM ) |
( ITEM "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING" )
addAlternativeSortOrderReferenceClause = SET ( REF | REFERENCE ) ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterAlternativeSortOrderCommand
This clause alters an alternative sort order.
QUOTED_STRING
name of the alternative sort order.
renameClause
Renames an alternative sort order with a different name.
setPropertiesClauseforLOVandD2D
This clause sets the properties of the object.
Basic properties for ALTERNATIVE_SORT_ORDER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the alternative sort order
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the alternative sort order
Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the alternative sort order enables drilling between the item
folders containing the items that use the alternative sort order
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 ALTERNATIVE_SORT_ORDER:
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.
alterAlternativeSortOrderClauses
This clause modifies an alternative sort order.
propertyNameListforLOVandD2D
This is the list of property names.
propertyValueList
This is the list of property values.
addAlternativeSortOrderClauseforAlter
This clause sets the defining item or ordering item for the alternative
sort order.
DEFINING
This sets the defining item for the alternative sort order.
ORDERED
This sets the ordered item for the alternative sort order.
deleteAlternativeSortOrderClauses
This deletes specific item references from an alternative sort order.
DEFINING
This deletes the defining item from an alternative sort order.
ITEM
This deletes a reference to an item from an alternative sort order.
ORDERED
This deletes the ordered item from an alternative sort order.
addAlternativeSortOrderReferenceClause
This adds a reference to an item to an alternative sort order.
propertyValue
This is a property value.
See Also
OMBCREATE ALTERNATIVE_SORT_ORDER, OMBRETRIEVE ALTERNATIVE_SORT_ORDER
Purpose
To alter an existing profile action plan.
Prerequisites
alterAnalyzeActionPlanPreTag??
Syntax
AlterActionPlanCommand = ( OMBALTER ( ( DEPLOYMENT_ACTION_PLAN |
ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" ( (
"renameActionPlanClause" { "addActionClause" | "modifyActionClause" |
"deleteActionClause" } ) | ( "addActionClause" { "addActionClause" |
"modifyActionClause" | "deleteActionClause" } ) | (
"modifyActionClause" { "addActionClause" | "modifyActionClause" |
"deleteActionClause" } ) | ( "deleteActionClause" { "addActionClause"
| "modifyActionClause" | "deleteActionClause" } ) ) )
renameActionPlanClause = RENAME TO "QUOTED_STRING"
addActionClause = ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
modifyActionClause = MODIFY ACTION "QUOTED_STRING" ( (
"renameActionClause" [ "setUnsetClause" ] ) | "setUnsetClause" )
deleteActionClause = DELETE ACTION "QUOTED_STRING"
setClause = ( "propertiesClause" [ SET "setReferenceClause" ] ) |
"setReferenceClause"
renameActionClause = RENAME TO "QUOTED_STRING"
setUnsetClause = ( ( SET "setClauseForAlter" ) | ( UNSET
"unsetReferenceClause" ) )
propertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
"useClause" }
setClauseForAlter = ( "propertiesClause" [ SET "setReferenceClause" |
UNSET "unsetReferenceClause" ] ) | "setReferenceClause"
unsetReferenceClause = ( REF | REFERENCE )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
useClause = USE DATA_RULE_USAGE "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
AlterActionPlanCommand
Alter an action plan.
QUOTED_STRING
Action plan name.
renameActionPlanClause
Rename an action plan.
addActionClause
Add an action to an action plan.
QUOTED_STRING
Action name.
modifyActionClause
Modify an action of an action plan.
QUOTED_STRING
Action name.
deleteActionClause
Delete an action of an action plan.
QUOTED_STRING
Action name.
setClause
Set the properties of an action and/or associate an object with an action.
renameActionClause
Rename an action of the action plan.
setUnsetClause
Set the properties and/or associate/disassociate an object with an action.
propertiesClause
Set the properties and/or associate/disassociate an object with an action.
setReferenceClause
Associate an object with an action.
ObjType
Object type. The only valid value is DATA_PROFILE_TABLE.
setClauseForAlter
Set the properties and/or associate/disassociate an object with an action.
unsetReferenceClause
Disassociate a previously associated object from an action.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
useClause
Currently used only in CORRECTION_SCHEMA_ACTION_PLAN.
propertyValue
Value of a property.
See Also
OMBCREATE ANALYZE_ACTION_PLAN, OMBPROFILE
Purpose
Alters a Business Area.
Prerequisites
Should be in the context of a Business Definition Module or use the full
path.
Syntax
alterBusinessAreaCommand = ( OMBALTER BUSINESS_AREA "QUOTED_STRING" ( (
"renameClause" [ SET "setPropertiesClause" ] [ SET
"setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
{ "alterBusinessAreaClauses" } ) | ( SET "setPropertiesClause" [ SET
"setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
{ "alterBusinessAreaClauses" } ) | ( SET "setReferenceIconSetClause" [
UNSET "unsetReferenceIconSetClause" ] { "alterBusinessAreaClauses" }
) | ( UNSET "unsetReferenceIconSetClause" { "alterBusinessAreaClauses"
} ) | ( "alterBusinessAreaClauses" { "alterBusinessAreaClauses" } ) )
)
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterBusinessAreaClauses = UNSET ( REF | REFERENCE ) "("
"unsetfolderNameList" ")" | SET ( REF | REFERENCE ) "("
"setfolderNameList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
unsetfolderNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
setfolderNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterBusinessAreaCommand
This clause alters a Business Area.
QUOTED_STRING
name of the Business Area.
renameClause
Renames a Business Area with a different name.
setPropertiesClause
This clause sets the properties of the object.
Basic properties for BUSINESS_AREA:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the business area
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the business area
Properties for BUSINESS_AREA:
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.
alterBusinessAreaClauses
This clause adds, modifies or deletes business area shortcuts.
propertyNameList
This is the list of property names.
propertyValueList
This is the list of property values.
unsetfolderNameList
Used to remove folder references for this business area.
setfolderNameList
Used to set item folder references for this business area.
propertyValue
This is a property value.
See Also
OMBCREATE BUSINESS_AREA, OMBRETRIEVE BUSINESS_AREA
Purpose
Alter a business definition module by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of project.
Syntax
alterEULModuleCommand = OMBALTER ( BUSINESS_DEFINITION_MODULE
"QUOTED_STRING" ( "renameClause" [
"alterPropertiesOrReferenceClauseForDataOnlyModule" ] |
"alterPropertiesOrReferenceClauseForDataOnlyModule" |
"addOrRemoveOrModifyModuleReferenceLocationClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrReferenceClauseForDataOnlyModule = ( ( SET ( (
"setPropertiesClause" [ ( SET "setReferenceClauseForDataOnlyModule" [
UNSET "unsetReferenceClauseForDataOnlyModule" ] ) | ( UNSET
"unsetReferenceClauseForDataOnlyModule" [ SET
"setReferenceClauseForDataOnlyModule" ] ) ] ) | (
"setReferenceClauseForDataOnlyModule" [ UNSET
"unsetReferenceClauseForDataOnlyModule" ] ) ) ) | ( UNSET
"unsetReferenceClauseForDataOnlyModule" [ SET
"setReferenceClauseForDataOnlyModule" ] ) ) [
"addOrRemoveOrModifyModuleReferenceLocationClause" ]
addOrRemoveOrModifyModuleReferenceLocationClause = (
"addReferenceLocationClause" | "removeReferenceLocationClause" |
"modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
"removeReferenceLocationClause" | "modifyReferenceLocationClause" }
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataOnlyModule = ( "setReferenceLocationClause" [ SET
"setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
unsetReferenceClauseForDataOnlyModule = ( "unsetReferenceLocationClause" [
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
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
alterEULModuleCommand
This command modifies an existing business definition module.
QUOTED_STRING
Name of the existing business definition module in single quotes.
renameClause
Rename a business definition module.
alterPropertiesOrReferenceClauseForDataOnlyModule
Alter existing business definition module's properties and/or locations
and/or icon sets.
addOrRemoveOrModifyModuleReferenceLocationClause
Add/remove/modify runtime location for the business definition module.
setPropertiesClause
Associate a set of properties with the existing business definition module.
Basic properties for BUSINESS_DEFINITION_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of a business definition module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of a business definition module
Properties for BUSINESS_DEFINITION_MODULE:
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
Discoverer Location for Business Definition Module
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: MLS_DEPLOYMENT_LANGUAGE
Type: STRING
Valid Values: N/A
Default: MLS_BASE_LANGUAGE
MLS Language to be used for deployment
Name: OBJECT_MATCHING
Type: STRING
Valid Values: BY_IDENTIFIER, BY_NAME
Default: BY_IDENTIFIER
Whether import should match up objects by identifier or by name
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceClauseForDataOnlyModule
Set location and/or icon set for the new business definition module.
unsetReferenceClauseForDataOnlyModule
Unset location and/or icon set for the business definition module.
addReferenceLocationClause
Add a runtime location to the new business definition module.
removeReferenceLocationClause
Remove a runtime location from the business definition module.
modifyReferenceLocationClause
Modify a runtime location of the business definition module.
propertyNameList
Comma-separated list of property names. Property names are not in quotes.
propertyValueList
Comma-separated list of property values.
setReferenceLocationClause
Set a location for the existing business definition module.
setReferenceIconSetClause
Set icon set for the new business definition module.
unsetReferenceLocationClause
Unset a location for the existing business definition module.
unsetReferenceIconSetClause
Unset icon set for the business definition module.
propertyValue
Value for a specified property.
See Also
OMBALTER, OMBCREATE BUSINESS_DEFINITION_MODULE, OMBDROP BUSINESS_DEFINITION_MODULE
Purpose
Alter the presentation module by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of project.
Syntax
alterReportModuleCommand = OMBALTER ( BUSINESS_PRESENTATION_MODULE
"QUOTED_STRING" ( "renameClause" [
"alterPropertiesOrReferenceClauseForDataOnlyModule" ] |
"alterPropertiesOrReferenceClauseForDataOnlyModule" |
"addOrRemoveOrModifyModuleReferenceLocationClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrReferenceClauseForDataOnlyModule = ( ( SET ( (
"setPropertiesClause" [ ( SET "setReferenceClauseForDataOnlyModule" [
UNSET "unsetReferenceClauseForDataOnlyModule" ] ) | ( UNSET
"unsetReferenceClauseForDataOnlyModule" [ SET
"setReferenceClauseForDataOnlyModule" ] ) ] ) | (
"setReferenceClauseForDataOnlyModule" [ UNSET
"unsetReferenceClauseForDataOnlyModule" ] ) ) ) | ( UNSET
"unsetReferenceClauseForDataOnlyModule" [ SET
"setReferenceClauseForDataOnlyModule" ] ) ) [
"addOrRemoveOrModifyModuleReferenceLocationClause" ]
addOrRemoveOrModifyModuleReferenceLocationClause = (
"addReferenceLocationClause" | "removeReferenceLocationClause" |
"modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
"removeReferenceLocationClause" | "modifyReferenceLocationClause" }
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataOnlyModule = ( "setReferenceLocationClause" [ SET
"setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
unsetReferenceClauseForDataOnlyModule = ( "unsetReferenceLocationClause" [
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
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
alterReportModuleCommand
This command modifies an existing presentation module.
QUOTED_STRING
Name of the existing presentation module in single quotes.
renameClause
Rename a presentation module.
alterPropertiesOrReferenceClauseForDataOnlyModule
Alter existing business presentation module's properties and/or locations
and/or icon sets.
addOrRemoveOrModifyModuleReferenceLocationClause
Add/remove/modify runtime location for the business presentation module.
setPropertiesClause
Associate a set of properties with the existing presentation module.
Basic properties for BUSINESS_PRESENTATION_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of a presentation module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of a presentation module
Properties for BUSINESS_PRESENTATION_MODULE:
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
BI Beans Location for Business Presentation Module
Name: DEFAULT_CATALOG_FOLDER
Type: STRING
Valid Values: N/A
Default: ''
Default Catalog Folder for deployed BI Beans presentations
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
setReferenceClauseForDataOnlyModule
Set location and/or icon set for the new business presentation module.
unsetReferenceClauseForDataOnlyModule
Unset location and/or icon set for the business presentation module.
addReferenceLocationClause
Add a runtime location to the new business presentation module.
removeReferenceLocationClause
Remove a runtime location from the business presentation module.
modifyReferenceLocationClause
Modify a runtime location of the business presentation module.
propertyNameList
Comma-separated list of property names. Property names are not in quotes.
propertyValueList
Comma-separated list of property values.
setReferenceLocationClause
Set a location for the existing presentation module.
setReferenceIconSetClause
Set icon set for the new business presentation module.
unsetReferenceLocationClause
Unset a location for the existing presentation module.
unsetReferenceIconSetClause
Unset icon set for the business presentation module.
propertyValue
Value for a specified property.
See Also
OMBALTER, OMBCREATE BUSINESS_PRESENTATION_MODULE, OMBDROP BUSINESS_PRESENTATION_MODULE
Purpose
To alter calendar.
Prerequisites
Should be in the context of a CalendarFolder.
Syntax
parseAlterCalendar = OMBALTER CALENDAR "QUOTED_STRING" ( ( "renameClause"
[ "alterCalendarPropertiesOrIconSetClause" ] [ "modifySchedulesClause"
] ) | ( "alterCalendarPropertiesOrIconSetClause" [
"modifySchedulesClause" ] ) | "modifySchedulesClause" )
renameClause = RENAME TO "QUOTED_STRING"
alterCalendarPropertiesOrIconSetClause = ( SET ( ( "setPropertiesClause" [
SET "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause"
] ) | "setReferenceIconSetClause" ) ) | UNSET
"unsetReferenceIconSetClause"
modifySchedulesClause = ( "addScheduleClause" | "modifyScheduleClause" )+
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
addScheduleClause = ADD SCHEDULE
modifyScheduleClause = MODIFY SCHEDULE "QUOTED_STRING" ( SET
"setPropertiesClause" )
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
setPropertiesClause
Basic properties for CALENDAR:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Calendar
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Calendar
Each calendar contains a single schedule with the name 'LOCALWINDOW'
which has the following properties which define the various aspects
of the schedule
Basic properties for SCHEDULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Schedule
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Schedule
Basic properties for the owned SCHEDULE OBJECT :
Name: START_TIME
Type: STRING(4000)
Valid Values: Start time in the format specified by property DATE_FORMAT.
The value NULL can also be passed if a schedule that takes on a start time
of ASAP ie. upon deployment.
Default: ''
Start time for the schedule
Name: END_TIME
Type: STRING(4000)
Valid Values: End time in the format specified by property DATE_FORMAT. The
value NULL can also be passed if a schedule that repeats forever is to be
created..
Default: ''
End time for the schedule
Name: TIMEZONE
Type: STRING(4000)
Valid Values: N/A
Default: ''
Time zone which times refer to.
Name: REPEAT_EXPRESSION
Type: STRING(4000)
Valid Values: N/A
Default: ''
iCal format of a repeat expression. If no REPEAT_EXPRESSION is supplied,
the scheduled activity is only performed once. The REPEAT_EXPRESSION
includes the following:
FREQ
This specifies the type of recurrence. It must be specified. The possible
predefined frequency values are YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY,
MINUTELY, and SECONDLY. Alternatively, specifies an existing schedule to
use as a user-defined frequency.
INTERVAL
This specifies a positive integer representing how often the recurrence
repeats. The default is 1, which means every second for secondly, every day
for daily, and so on. The maximum value is 999.
BYMONTH
This specifies which month or months you want the job to execute in. You
can use numbers such as 1 for January and 3 for March, as well as
three-letter abbreviations such as FEB for February and JUL for July.
BYWEEKNO
This specifies the week of the year as a number. byweekno is only valid for
YEARLY.
BYYEARDAY
This specifies the day of the year as a number. Valid values are 1 to 366.
An example is 69, which is March 10 (31 for January, 28 for February, and
10 for March). 69 evaluates to March 10 for non-leap years and March 9 in
leap years. -2 will always evaluate to December 30th independent of whether
it is a leap year.
BYMONTHDAY
This specifies the day of the month as a number. Valid values are 1 to 31.
An example is 10, which means the 10th day of the selected month. You can
use the minus sign (-) to count backward from the last day, so, for
example, BYMONTHDAY=-1 means the last day of the month and BYMONTHDAY=-2
means the next to last day of the month.
BYDAY
This specifies the day of the week from Monday to Sunday in the form MON,
TUE, and so on. Using numbers, you can specify the 26th Friday of the year,
if using a YEARLY frequency, or the 4th THU of the month, using a MONTHLY
frequency. Using the minus sign, you can say the second to last Friday of
the month. For example, -1 FRI is the last Friday of the month.
BYHOUR
This specifies the hour on which the job is to run. Valid values are 0 to
23. As an example, 10 means 10 a.m.
BYMINUTE
This specifies the minute on which the job is to run. Valid values are 0 to
59. As an example, 45 means 45 minutes past the chosen hour.
BYSECOND
This specifies the second on which the job is to run. Valid values are 0 to
59. As an example, 30 means 30 seconds past the chosen minute.
BYSETPOS (10gR2 only)
This selects one or more items by position in the list of timestamps that
result after the whole calendaring expression is evaluated. It is useful
for requirements such as running a job on the last workday of the month.
Rather than attempting to express this with the other BY clauses, you can
code the calendaring expression to evaluate to a list of every workday of
the month, and then add the BYSETPOS clause to select only the last item of
that list.
All of the above properties can be used in the SET PROPERTIES clause as
well.
The following properties are supported for the GET PROPERTIES clause only
Name: DATE_FORMAT
Type: STRING
Valid Values: N/A
Default: N//A
Region specific time format string, eg MMM/dd/yy:HH:mm:ss.
Name: AVAILABLE_TIMEZONES
Type: STRING ARRAY
Valid Values: N/A
Default: N//A
List of available time zone ids that can be used to set the TIMEZONE
property. This property is for information purposes only.
Name: PREVIEW_DATES
Type: STRING(4000)
Valid Values: N/A
Default: ''
Preview of dates that this schedule includes. This property is only valid
for OMBRETRIEVE.
Properties for CALENDAR:
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
See Also
OMBALTER, OMBCREATE CALENDAR, OMBDROP CALENDAR
Purpose
To alter a calendar module.
Prerequisites
Should be in the context of a Project.
Syntax
parseAlterModule = OMBALTER CALENDAR_MODULE "QUOTED_STRING" ( ( RENAME TO
"QUOTED_STRING" [ "alterModulePropertiesOrIconSetClause" ] ) |
"alterModulePropertiesOrIconSetClause" )
alterModulePropertiesOrIconSetClause = ( SET ( ( "setPropertiesClause" [ (
( SET ( "setReferenceLocationClause" [ ( SET
"setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
) ] ) ) | ( UNSET "unsetReferenceLocationClause" [ ( SET
"setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
) ] ) ) | ( ( SET "setReferenceIconSetClause" ) | ( UNSET
"unsetReferenceIconSetClause" ) ) ] ) | ( "setReferenceLocationClause"
[ ( SET "setReferenceIconSetClause" ) | ( UNSET
"unsetReferenceIconSetClause" ) ] ) | "setReferenceIconSetClause" ) )
| ( UNSET ( "unsetReferenceLocationClause" [ ( SET
"setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
) ] ) | "unsetReferenceIconSetClause" )
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
unsetReferenceLocationClause = ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
setPropertiesClause
Basic properties for CALENDAR_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Calendar Module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Calendar Module
Properties for CALENDAR_MODULE:
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location to which the schedule will be deployed.
Name: EVAL_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location in which the scheduled object will be evaluated.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
See Also
OMBALTER, OMBCREATE CALENDAR_MODULE, OMBDROP CALENDAR_MODULE
Purpose
This command is used to change the settings of a change data capture
Prerequisites
This command can only be executed in the context of a module and operates
only on already existing change data captures.
Syntax
alterChangeSetCommand = OMBALTER ( CHANGE_DATA_CAPTURE "QUOTED_STRING" [ (
CAPTURE CHANGES | USE CHANGES ) ] [ "renameClause" ] { SET
"setPropertiesClause" | "alterChangeSetSCOClauses" } )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
alterChangeSetSCOClauses = ( "addChangeSetSCOClauses" |
"modifyChangeSetSCOClauses" | "deleteChangeSetSCOClauses" )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addChangeSetSCOClauses = ( ( ADD CAPTURE ( TABLE | VIEW |
MATERIALIZED_VIEW ) "QUOTED_STRING" ) { "addCaptureSCOClauses" } [
"specialCaptureColumnsClause"+ ] )
modifyChangeSetSCOClauses = ( ( MODIFY CAPTURE ( TABLE | VIEW |
MATERIALIZED_VIEW ) "QUOTED_STRING" ) ( ( "addCaptureSCOClauses" |
"modifyCaptureSCOClauses" | "deleteCaptureSCOClauses" |
"specialCaptureColumnsClause" ) )+ )
deleteChangeSetSCOClauses = ( DELETE CAPTURE ( TABLE | VIEW |
MATERIALIZED_VIEW ) "QUOTED_STRING" )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
addCaptureSCOClauses = ( "addCaptureColumnsClause" | "addChangeSpecClause"
| "addRowIdentifierClause" | "addTxnIdentifierClause" )
specialCaptureColumnsClause = [ DONT ] CAPTURE ( OLD_VALUES | USER_NAME )
modifyCaptureSCOClauses = ( "modifyCaptureColumnsClause" |
"modifyChangeSpecClause" )
deleteCaptureSCOClauses = ( "deleteCaptureColumnsClause" |
"deleteChangeSpecClause" | "deleteRowIdentifierClause" |
"deleteTxnIdentifierClause" )
addCaptureColumnsClause = ( "addEachCaptureColumnClause" | (
CAPTURE_COLUMNS ( NULL | ( "(" "columnNameList" ")" ) ) ) )
addChangeSpecClause = ( IDENTIFY ( INSERT | UPDATE | DELETE ) BY
CHANGE_COLUMN "QUOTED_STRING" [ USING CHANGE_EXPRESSION
"QUOTED_STRING" ] )
addRowIdentifierClause = ( "addEachRowIdentifierColumnClause" | (
ROW_IDENTIFIER_COLUMNS ( NULL | ( "(" "columnNameList" ")" ) ) ) )
addTxnIdentifierClause = ( "addEachTxnIdentifierColumnClause" | (
TXN_IDENTIFIER_COLUMNS ( NULL | ( "(" "columnNameList" ")" ) ) ) )
modifyCaptureColumnsClause = ( MODIFY CAPTURE_COLUMN "QUOTED_STRING" SET
POSITION "INTEGER_LITERAL" )
modifyChangeSpecClause = ( SET ( INSERT | UPDATE | DELETE ) ( (
CHANGE_COLUMN "QUOTED_STRING" ) | ( CHANGE_EXPRESSION "QUOTED_STRING"
) ) )
deleteCaptureColumnsClause = ( DELETE CAPTURE_COLUMN "QUOTED_STRING" )
deleteChangeSpecClause = ( DONT IDENTIFY ( INSERT | UPDATE | DELETE ) )
deleteRowIdentifierClause = ( ( DELETE ROW_IDENTIFIER_COLUMN
"QUOTED_STRING" ) )
deleteTxnIdentifierClause = ( ( DELETE TXN_IDENTIFIER_COLUMN
"QUOTED_STRING" ) )
addEachCaptureColumnClause = ( ADD CAPTURE_COLUMN "QUOTED_STRING" AT
POSITION "INTEGER_LITERAL" )
columnNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
addEachRowIdentifierColumnClause = ( ( ADD ROW_IDENTIFIER_COLUMN
"QUOTED_STRING" ) )
addEachTxnIdentifierColumnClause = ( ( ADD TXN_IDENTIFIER_COLUMN
"QUOTED_STRING" ) )
Keywords And Parameters
setPropertiesClause
Basic properties for CHANGE_DATA_CAPTURE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Change Data Capture
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Change Data Capture
ombalter_changeset$alterChangeSetCommand = This clause alters a change data
capture.
Properties for CHANGE_DATA_CAPTURE:
Name: CAPTUREFROM
Type: STRING
Valid Values: ALL_AVAILABLE, FROM_START_DATE
Default: ALL_AVAILABLE
This property is used to specify whether the Change Data Capture object
will capture all available changes or changes that occured after a
specified date.
Name: CAPTUREFROMDATE
Type: STRING
Valid Values: N/A
Default: ''
This property is used to specify the date from which changes will be
captured by the Change Data Capture object.
Name: DBA_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
This property specifies the DBA location from which the Supplemental Log
scripts will need to be deployed. This property is used if the schema in
which the Change Data Capture will be deployed is not the owner of the
source table and is also not a DBA.
Name: DELETE_DANGLING_REF
Type: BOOLEAN
Valid Values: true, false
Default: false
This property specifies whether the dangling references to tables need to
be deleted during a reconcile operation on the Change Data Capture.
Name: DEPLOY_GET_TIME_FUNCTION
Type: BOOLEAN
Valid Values: true, false
Default: true
This property is used to indicate whether a function that returns the
system time on the Source system needs to be deployed. This is used if the
Change Data Capture object is used in a mapping that will be deployed on a
database instance different from the instance containing the source table.
Name: DEPLOY_SOURCE_SCRIPTS
Type: BOOLEAN
Valid Values: true, false
Default: true
This property specifies whether OWB should generate and deploy supplemental
log and instantiation script for the source tables.
Name: FIRSTSCN
Type: STRING
Valid Values: N/A
Default: ''
This value is needed if the Change Data Capture and the source table exist
on different database instances.
Name: GET_TIME_FUNCTION
Type: STRING(28)
Valid Values: N/A
Default: OWB$SYSDATE
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.CHANGELOGS.GETTIMEFUNC:DESCRIPTION"
Name: LONG_TRANSACTION_WAIT_TIME
Type: NUMBER
Valid Values: >= 0
Default: 0
This property specifies the number of seconds to wait for long running
active transactions to complete during change extraction.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
This property is used to specify the name of tablespace where all Change
Data Capture structures are to be created.
Name: TRANSACTION_WAIT_TIME
Type: NUMBER
Valid Values: >= 0
Default: 0
This property specifies the number of seconds to wait for active
transactions to complete during change extraction.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
See Also
OMBALTER, OMBCREATE CHANGE_DATA_CAPTURE, OMBRETRIEVE CHANGE_DATA_CAPTURE, OMBDROP CHANGE_DATA_CAPTURE
Purpose
Alter the CMI definition by renaming it, and/or reset its properties.
Prerequisites
Should be in the root context.
Syntax
alterMIVDefinitionCommand = OMBALTER ( CMI_DEFINITION "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" ] | ( SET
"setPropertiesClause" ) | ( USING DEFINITION_FILE "QUOTED_STRING" ) )
)
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
alterMIVDefinitionCommand
This command modifies an existing CMI definition.
QUOTED_STRING
Name of the existing CMI definition in single quotes.
renameClause
Rename an CMI definition.
setPropertiesClause
Associate a set of properties with the existing CMI definition.
Basic properties for CMI_DEFINITION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of an CMI Definition
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of an CMI Definition
Name: MIV_TYPE
Type: STRING(40)
Valid Values: Applications,Databases
Default: N/A
Type of an CMI Definition
Properties for CMI_DEFINITION:
Name: LOCATION_UOID
Type: STRING
Valid Values: N/A
Default: ''
Location Warehouse Builder should use to retrieve the data.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
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 CMI_DEFINITION, OMBDROP CMI_DEFINITION
Purpose
Alter the CMI module by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of project.
Syntax
alterMIVModuleCommand = OMBALTER ( CMI_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
alterMIVModuleCommand
This command modifies an existing CMI module.
QUOTED_STRING
Name of the existing CMI module in single quotes.
renameClause
Rename an CMI module.
alterPropertiesOrReferenceClauseForDataMetadataModule
Alter existing CMI module's properties and/or locations and/or icon sets.
setReferenceClauseForDataMetadataModule
Set location and/or icon set for the CMI module.
unsetReferenceClauseForDataMetadataModule
Unset location and/or icon set for the CMI module.
addOrRemoveOrModifyModuleReferenceLocationClause
Add/remove/modify runtime location for the CMI 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 CMI module.
setReferenceMetadataLocationOrIconSetClause
Set metadata location and/or icon set for the CMI module.
unsetReferenceLocationClause
Unset a location to the existing CMI module.
unsetReferenceMetadataLocationOrIconSetClause
Unset metadata location and/or icon set for the CMI module.
addReferenceLocationClause
Add a runtime location to the CMI module.
removeReferenceLocationClause
Remove a runtime location from the CMI module.
modifyReferenceLocationClause
Modify a runtime location of the CMI module.
propertyValue
Value of a property.
setReferenceMetadataLocationClause
Set metadata location for the CMI module.
setReferenceIconSetClause
Set icon set for the CMI module.
unsetReferenceMetadataLocationClause
Unset metadata location for the CMI module.
unsetReferenceIconSetClause
Unset icon set for the CMI module.
See Also
OMBALTER, OMBCREATE CMI_MODULE, OMBDROP CMI_MODULE
Purpose
Alter the collection by adding, removing or modifying shortcuts.
Prerequisites
Should be in the context of a project, before altering a collection.
Syntax
alterCollectionCommand = OMBALTER ( COLLECTION "QUOTED_STRING" ( [
"renameClause" ] [ SET "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
SET "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause"
] [ "alterCollectionReferences" ] ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterCollectionReferences = ( "addReferenceClause" |
"removeReferenceClause" | "reconcileReferenceClause" )+
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addReferenceClause = ADD REFERENCE TO "componentRefClause"
removeReferenceClause = REMOVE REFERENCE TO "componentRefClause"
reconcileReferenceClause = RECONCILE
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
componentRefClause = ( EXTERNAL_TABLE | TABLE | VIEW | MATERIALIZED_VIEW |
SEQUENCE | VARYING_ARRAY | OBJECT_TYPE | NESTED_TABLE | MAPPING |
DIMENSION | CUBE | ADVANCED_QUEUE | STREAMS_QUEUE | QUEUE_TABLE |
ORACLE_MODULE | TRANSFORMATION_MODULE | FLAT_FILE_MODULE | FLAT_FILE |
PROCESS_FLOW | PROCESS_FLOW_PACKAGE | PROCESS_FLOW_MODULE |
SAP_MODULE | CMI_MODULE | COLLECTION | FUNCTION | PROCEDURE | PACKAGE
| BUSINESS_DEFINITION_MODULE | ITEM_FOLDER | LIST_OF_VALUES |
DRILL_TO_DETAIL | ALTERNATIVE_SORT_ORDER | DRILL_PATH | BUSINESS_AREA
| GATEWAY_MODULE | CONFIGURATION | REGISTERED_FUNCTION |
PLUGGABLE_MAPPING | PLUGGABLE_MAPPING_FOLDER | DATA_AUDITOR |
TRANSPORTABLE_MODULE | EXPERT_MODULE | EXPERT | CALENDAR_MODULE |
CALENDAR | DATA_PROFILE | DATA_RULE_MODULE | DATA_RULE )
"QUOTED_STRING"
Keywords And Parameters
alterCollectionCommand
Alter a collection of objects.
QUOTED_STRING
Name of the existing collection in quotes.
renameClause
Rename a collection.
setPropertiesClause
Associate a set of properties with a collection.
Basic properties for COLLECTION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the collection
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the collection
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
alterCollectionReferences
Alter the collections references, includes adding, dropping and reconciling
the collection.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
addReferenceClause
Add a reference to the collection.
removeReferenceClause
Remove a reference from the collection.
reconcileReferenceClause
Reconcile the collection, deleting references which now refer to deleted
objects.
propertyValue
Value of a property.
componentRefClause
Specify the type of the object to reference.
See Also
OMBALTER, OMBCREATE COLLECTION
Purpose
Alter the Configuration by renaming it, and/or reset its properties and Icon Set.
Prerequisites
Should be in the context of a project.
Syntax
alterConfigurationCommand = OMBALTER ( CONFIGURATION "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
alterConfigurationCommand
This command modifies an existing Configuration.
renameClause
Rename Configuration.
alterPropertiesOrIconSetClause
Alter existing Configuration properties and/or Icon Set.
setPropertiesClause
Associate a set of properties with the existing Configuration.
Basic properties for CONFIGURATION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of a Configuration
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of a Configuration.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceIconSetClause
Set an Icon Set to the existing Configuration.
unsetReferenceIconSetClause
Unset an Icon Set from the existing Configuration.
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 CONFIGURATION
Purpose
Alter the connector by renaming it, and/or reset its referenced location or properties or icon set.
Prerequisites
Can be in any context; the name is a name of the connector's owning
location and a connector name separated by slash.
Syntax
alterConnectorCommand = OMBALTER ( CONNECTOR "QUOTED_STRING" (
"renameClause" [ "alterPropertiesOrReferenceClause" ] |
"alterPropertiesOrReferenceClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrReferenceClause = SET ( "setPropertiesClause" [ SET
"setReferenceClause" [ UNSET "unsetReferenceIconSetClause" ] | UNSET
"unsetReferenceIconSetClause" [ SET "setReferenceClause" ] ] |
"setReferenceClause" [ UNSET "unsetReferenceIconSetClause" ] ) | UNSET
"unsetReferenceIconSetClause" [ SET "setReferenceClause" ]
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = ( "setReferenceToLocationClause" [ SET
"setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceToLocationClause = ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterConnectorCommand
Alter the connector specified by the quoted string.
renameClause
Rename the connector.
setPropertiesClause
Set specified properties of the connector.
unsetReferenceIconSetClause
Unset specified Icon Set.
propertyNameList
The names of the properties whose values you want to set.
Properties for CONNECTOR:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the connector.
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the connector.
Name: DATABASE_LINK_NAME
Type: STRING(30)
Valid Values: N/A
Default: ''
Database Link name.
Properties for CONNECTOR:
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
propertyValueList
The values for the named properties.
setReferenceToLocationClause
Set the name of the location which the connector references.
setReferenceIconSetClause
Set specified Icon Set.
propertyValue
A property value.
See Also
OMBALTER, OMBCREATE CONNECTOR, OMBDROP CONNECTOR
Purpose
Alter the control center by renaming it, and/or reseting its properties, and/or adding/removing a referenced location,
and/or resetting properties of a referenced location.
Prerequisites
Can be in any context.
Syntax
alterControlCenterCommand = OMBALTER ( CONTROL_CENTER "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" [ "alterIconSetClause" ] {
"alterReferenceLocationClause" } ] | SET "setPropertiesClause" [
"alterIconSetClause" ] { "alterReferenceLocationClause" } |
"alterIconSetClause" { "alterReferenceLocationClause" } | {
"alterReferenceLocationClause" } ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
alterIconSetClause = SET "setReferenceIconSetClause" [ UNSET
"unsetReferenceIconSetClause" ] | UNSET "unsetReferenceIconSetClause"
[ SET "setReferenceIconSetClause" ]
alterReferenceLocationClause = "addReferenceLocationClause" |
"modifyReferenceLocationClause" | "deleteReferenceLocationClause"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
addReferenceLocationClause = ADD ( REF | REFERENCE ) LOCATION
"QUOTED_STRING" [ SET "setPropertiesClause" ]
modifyReferenceLocationClause = MODIFY ( REF | REFERENCE ) LOCATION
"QUOTED_STRING" SET "setPropertiesClause"
deleteReferenceLocationClause = DELETE ( REF | REFERENCE ) LOCATION
"QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterControlCenterCommand
Alter a control center.
renameClause
Rename the control center to the value of the following quoted string.
setPropertiesClause
Set the specified properties of the control center.
alterIconSetClause
Set or unset the Icon Set.
alterReferenceLocationClause
Alter the referenced location.
propertyNameList
The names of the properties whose values you want to set.
Properties for CONTROL_CENTER:
Name: HOST
Type: STRING
Valid Values: N/A
Default: N/A
The host machine the control center is installed on.
Name: PORT
Type: NUMBER
Valid Values: 1 - 65535
Default: 1521
The port number of the database in which the control center is installed.
Name: SERVICE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The service name of the database in which the control center is installed.
Name: USER
Synonym: USER_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name of the database user you wish to connect to the control center as.
Name: PASSWORD
Type: STRING
Valid Values: N/A
Default: N/A
The password.
Name: WORKSPACE
Type: STRING
Valid Values: N/A
Default: N/A
The name of the workspace to which to connect.
All of the preceding properties (except of PASSWORD) are mandatory for
OMBCREATE CONTROL_CENTER.
Basic properties for CONTROL_CENTER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the control center.
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the control center.
Properties for a referenced location of the control center:
Name: IS_SOURCE
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, then a refernced location is a source location.
Name: IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, then a refernced location is a target location.
Properties for CONTROL_CENTER:
Name: HOST
Type: STRING
Valid Values: N/A
Default: ''
Host of the location
Name: NET_SERVICE_NAME
Type: STRING(2000)
Valid Values: N/A
Default: ''
Net Service Name of the location
Name: PASSWORD
Type: STRING(30)
Valid Values: N/A
Default: ''
Password for the location
Name: PORT
Type: NUMBER
Valid Values: N/A
Default: 1521
Port of the location
Name: SCHEMA
Type: STRING
Valid Values: N/A
Default: ''
Workspace owner.name to use for deployment
Name: SERVICE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Service Name of the location
Name: USER
Type: STRING
Valid Values: N/A
Default: ''
User name for the location
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValueList
The values for the named properties.
setReferenceIconSetClause
Set the icon set.
unsetReferenceIconSetClause
Unset the icon set.
addReferenceLocationClause
Add a referenced location to the control center and/or set its properties.
modifyReferenceLocationClause
Set/reset properties of the referenced location.
deleteReferenceLocationClause
Delete a referenced location from the control center.
propertyValue
A property value.
See Also
OMBALTER, OMBCREATE CONTROL_CENTER, OMBDROP CONTROL_CENTER
Purpose
Alter an action plan for creating a correction map.
Prerequisites
In the context of a data profile.
Syntax
AlterActionPlanCommand = ( OMBALTER ( ( DEPLOYMENT_ACTION_PLAN |
ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" ( (
"renameActionPlanClause" { "addActionClause" | "modifyActionClause" |
"deleteActionClause" } ) | ( "addActionClause" { "addActionClause" |
"modifyActionClause" | "deleteActionClause" } ) | (
"modifyActionClause" { "addActionClause" | "modifyActionClause" |
"deleteActionClause" } ) | ( "deleteActionClause" { "addActionClause"
| "modifyActionClause" | "deleteActionClause" } ) ) )
renameActionPlanClause = RENAME TO "QUOTED_STRING"
addActionClause = ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
modifyActionClause = MODIFY ACTION "QUOTED_STRING" ( (
"renameActionClause" [ "setUnsetClause" ] ) | "setUnsetClause" )
deleteActionClause = DELETE ACTION "QUOTED_STRING"
setClause = ( "propertiesClause" [ SET "setReferenceClause" ] ) |
"setReferenceClause"
renameActionClause = RENAME TO "QUOTED_STRING"
setUnsetClause = ( ( SET "setClauseForAlter" ) | ( UNSET
"unsetReferenceClause" ) )
propertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
"useClause" }
setClauseForAlter = ( "propertiesClause" [ SET "setReferenceClause" |
UNSET "unsetReferenceClause" ] ) | "setReferenceClause"
unsetReferenceClause = ( REF | REFERENCE )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
useClause = USE DATA_RULE_USAGE "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
AlterActionPlanCommand
Alter an action plan.
QUOTED_STRING
Action plan name.
renameActionPlanClause
Rename an action plan.
QUOTED_STRING
Action plan name.
addActionClause
Add an action to an action plan.
QUOTED_STRING
Action name.
modifyActionClause
Modify an action of an action plan.
QUOTED_STRING
Action name.
deleteActionClause
Delete an action of an action plan.
QUOTED_STRING
Action name.
setClause
Set the properties of an action and/or associate an object with an action.
renameActionClause
Rename an action of an action plan.
setUnsetClause
Set the properties and/or associate/disassociate an object with an action.
propertiesClause
Set the properties and/or associate/disassociate an object with an action.
setReferenceClause
Associate an object with an action.
ObjType
Object type. The only valid value is DATA_PROFILE_TABLE.
setClauseForAlter
Set the properties and/or associate/disassociate an object with an action.
unsetReferenceClause
Disassociate a previously associated object from an action.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
useClause
Currently used only in CORRECTION_SCHEMA_ACTION_PLAN.
propertyValue
Value of a property.
See Also
OMBCREATE CORRECTION_MAPS_ACTION_PLAN, OMBPROFILE
Purpose
Alter an action plan for creating a correction schema, identifying the tables that will be mapped to that
schema.
Prerequisites
In the context of a data profile.
Syntax
AlterActionPlanCommand = ( OMBALTER ( ( DEPLOYMENT_ACTION_PLAN |
ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" ( (
"renameActionPlanClause" { "addActionClause" | "modifyActionClause" |
"deleteActionClause" } ) | ( "addActionClause" { "addActionClause" |
"modifyActionClause" | "deleteActionClause" } ) | (
"modifyActionClause" { "addActionClause" | "modifyActionClause" |
"deleteActionClause" } ) | ( "deleteActionClause" { "addActionClause"
| "modifyActionClause" | "deleteActionClause" } ) ) )
renameActionPlanClause = RENAME TO "QUOTED_STRING"
addActionClause = ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
modifyActionClause = MODIFY ACTION "QUOTED_STRING" ( (
"renameActionClause" [ "setUnsetClause" ] ) | "setUnsetClause" )
deleteActionClause = DELETE ACTION "QUOTED_STRING"
setClause = ( "propertiesClause" [ SET "setReferenceClause" ] ) |
"setReferenceClause"
renameActionClause = RENAME TO "QUOTED_STRING"
setUnsetClause = ( ( SET "setClauseForAlter" ) | ( UNSET
"unsetReferenceClause" ) )
propertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
"useClause" }
setClauseForAlter = ( "propertiesClause" [ SET "setReferenceClause" |
UNSET "unsetReferenceClause" ] ) | "setReferenceClause"
unsetReferenceClause = ( REF | REFERENCE )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
useClause = USE DATA_RULE_USAGE "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
AlterActionPlanCommand
Alter an action plan.
QUOTED_STRING
Action plan name.
renameActionPlanClause
Rename an action plan.
addActionClause
Add an action to an action plan.
QUOTED_STRING
Action name.
modifyActionClause
Modify an action of an action plan.
QUOTED_STRING
Action name.
deleteActionClause
Delete an action of an action plan.
QUOTED_STRING
Action name.
setClause
Set the properties of an action and/or associate an object with an action.
renameActionClause
Rename an action of the action plan.
setUnsetClause
Set the properties and/or associate/disassociate an object with an action.
propertiesClause
Set the properties and/or associate/disassociate an object with an action.
setReferenceClause
Associate an object with an action.
ObjType
Object type. The only valid value is DATA_PROFILE_TABLE.
setClauseForAlter
Set the properties and/or associate/disassociate an object with an action.
unsetReferenceClause
Disassociate a previously associated object from an action.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
useClause
Name of data rule usage.
propertyValue
Value of a property.
See Also
OMBCREATE CORRECTION_SCHEMA_ACTION_PLAN, OMBPROFILE
Purpose
This command alters a Cube.
Prerequisites
Should be in Oracle Module context.
Syntax
alterCubeCommand = OMBALTER CUBE "cubeName" ( ( "renameClause" [
"alterPropertiesOrIconSetClause" ] [ "setCubeAggFunctionClause" ] [
"alterCubeDescendentsClause" ] [ "cubeImplementationClause" ] ) |
"cubePartitionClause" | ( "alterPropertiesOrIconSetClause" [
"setCubeAggFunctionClause" ] [ "alterCubeDescendentsClause" ] [
"cubeImplementationClause" ] ) | ( "setCubeAggFunctionClause" [
"alterCubeDescendentsClause" ] [ "cubeImplementationClause" ] ) | (
"alterCubeDescendentsClause" [ "cubeImplementationClause" ] ) |
"cubeImplementationClause" | "alterCubeUnBindingClause" )
cubeName = "QUOTED_STRING"
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( ( "setPropertiesClause" [ ( SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ) ]
) | "setReferenceIconSetClause" ) | UNSET
"unsetReferenceIconSetClause"
setCubeAggFunctionClause = SET AGGREGATE_FUNCTION TO "aggFunctionName"
alterCubeDescendentsClause = ( ADD ( "addMeasureClause" |
"addDimensionUseClause" | "addCompositeDimensionClause" ) | MODIFY (
"modifyMeasureClause" | "modifyDimensionUseClause" |
"modifyCompositeDimensionClause" ) | DELETE ( "measureLocator" |
"compositeDimensionLocator" | "dimensionUseLocator" ) )+
cubeImplementationClause = IMPLEMENTED BY ( ( "cubeBindingClause" {
"measureBindingClause" | "dimensionUseBindingClause" } ) |
"cubeAutoBindingClause" )
cubePartitionClause = ( SET PARTITION LEVEL "levelName" OF HIERARCHY
"hierName" OF DIMENSION "dimensionName" )
alterCubeUnBindingClause = DELETE BINDING
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
aggFunctionName = "QUOTED_STRING"
addMeasureClause = MEASURE "measureName" [ SET "setPropertiesClause" ] [
"setAggFunctionClause" ] [ "setPreComputedLevelsClause" ] [
"setCalcExprClause" ]
addDimensionUseClause = DIMENSION_USE "dimensionUseName" [ SET
"setPropertiesClause" ] [ "setDimensionUseReferenceClause" ] [ AT
POSITION "INTEGER_LITERAL" ]
addCompositeDimensionClause = COMPOSITE_DIMENSION "compositeDimensionName"
[ SET "setPropertiesClause" ] [
"setCompositeDimensionReferenceClause" ]
modifyMeasureClause = "measureLocator" ( "renameClause" | SET
"setPropertiesClause" | "setAggFunctionClause" |
"setPreComputedLevelsClause" | "setCalcExprClause" )
modifyDimensionUseClause = "dimensionUseLocator" ( "renameClause" |
"moveToClause" | SET "setPropertiesClause" |
"modifyDimensionUseRoleClause" )
modifyCompositeDimensionClause = "compositeDimensionLocator" (
"renameClause" | SET "setPropertiesClause" |
"setCompositeDimensionReferenceClause" )
measureLocator = MEASURE "measureName"
compositeDimensionLocator = COMPOSITE_DIMENSION "compositeDimensionName"
dimensionUseLocator = DIMENSION_USE "dimensionUseName"
cubeBindingClause = ( TABLE "tableName" | VIEW "viewName" )
measureBindingClause = "measureLocator" BOUND TO COLUMN "columnName"
dimensionUseBindingClause = "dimensionUseLocator" BOUND TO COLUMN
"columnName"
cubeAutoBindingClause = SYSTEM
levelName = "QUOTED_STRING"
hierName = "QUOTED_STRING"
dimensionName = "QUOTED_STRING"
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
measureName = "QUOTED_STRING"
setAggFunctionClause = SET AGGREGATE_FUNCTIONS "aggFunctionList" FOR
DIMENSIONS "dimensionList"
setPreComputedLevelsClause = SET PRECOMPUTE_LEVELS "preComputedLevelList"
setCalcExprClause = SET CALCULATED_EXPRESSION "(" "calcExpr" ")"
dimensionUseName = "QUOTED_STRING"
setDimensionUseReferenceClause = [ USE ROLE "roleName" ] SET ( REF |
REFERENCE ) [ LEVEL "levelName" OF ] DIMENSION "dimensionName"
compositeDimensionName = "QUOTED_STRING"
setCompositeDimensionReferenceClause = SET ( REF | REFERENCE ) DIMENSIONS
"(" "dimensionName" { "," "dimensionName" } ")"
moveToClause = MOVE TO POSITION "INTEGER_LITERAL"
modifyDimensionUseRoleClause = SET "roleLocator" | UNSET "roleLocator"
tableName = "QUOTED_STRING"
viewName = "QUOTED_STRING"
columnName = "QUOTED_STRING"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
aggFunctionList = "(" "aggFunction" { "," "aggFunction" } ")"
dimensionList = "(" "dimension" { "," "dimension" } ")"
preComputedLevelList = "(" "preComputedLevel" { "," "preComputedLevel" }
")"
calcExpr = "QUOTED_STRING"
roleName = "QUOTED_STRING"
roleLocator = ROLE "roleName"
aggFunction = "QUOTED_STRING"
dimension = "QUOTED_STRING"
preComputedLevel = "QUOTED_STRING"
Keywords And Parameters
setPropertiesClause
Basic properties for CUBE, MEASURE and DIMENSION_USE:
Basic properties for CUBE :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Cube
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Cube
Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: 'true', 'false'
Default: 'true'
The dimension is visible to OLAP end user
Name: UNIQUE_KEY_CONSTRAINT
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
set the Unique Key constraint on the Business Key
Name: STORAGE
Type: STRING
Valid Values: 'RELATIONAL', 'MOLAP'
Default: 'RELATIONAL'
The storage of a cube can be relational or molap
Name: AW_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
Set the analytical workspace name where the cube is implemented
Name: AW_CUBE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
Set the Analytical Workspace cube physical object name
Name: USE_GLOBAL_INDEX
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Sets the flag to say whether to generate a composite for measure partition
combination
Name: BITMAP_INDEX
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Sets the flag to say whether to generate a bitmap for a cube
Name: SUMMARY_REFRESH_METHOD
Type: STRING
Valid Values: 'On Demand', 'On Commit'
Default: 'On Commit'
Sets the Solve flag for Relational Cube whether to solve the cube 'On
Demand' or 'On Commit'
Name: SPARSITY_ULTRA_COMPRESS
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Sets the flag to say whether its a compressed cube. Only valid for Molap
cube.
Basic properties for Measure :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Cube
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Cube
Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: 'true', 'false'
Default: 'true'
The dimension is visible to OLAP end user
Name: CALCULATED_MEASURE
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Sets the measure to be aggregatable
Name: AUTO_SOLVE
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Sets the flag to say whether to measure is Auto Solve
Name: AW_MEASURE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
Set the Analytical Workspace measure physical object name
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 TIME ZONE, TIMESTAMP WITH
LOCAL TIME ZONE, VARCHAR, VARCHAR2
Default: NUMBER
Sets the datatype of a Cube Measure
Name: SCALE
Type: NUMBER
Valid Values: -85 - 125
Default: 1
The scale of a number.
Name: LENGTH
Type: NUMBER
Valid Values:
Default: 1
The length of a number
Name: PRECISION
Type: NUMBER
Valid Values: 0 - 39
Default: 1
The precision of a number.
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.
Basic properties for Cube Dimension Use :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Cube Dimension Use
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Cube Dimension Use
Properties for CUBE:
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: DEPLOYMENT_OPTIONS
Type: STRING
Valid Values: DEPLOY_AGGREGATION, DEPLOY_ALL, DEPLOY_DATA_OBJECTS_ONLY,
DEPLOY_TO_CATALOG_ONLY
Default: DEPLOY_DATA_OBJECTS_ONLY
Warehouse Builder generates a set of scripts for cube, they are DDL Scripts
for Relational Cube or Scripts for OLAP API-II or Scripts for AW.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: MATERIALIZED_VIEW_INDEX_TABLESPACE
Type: STRING
Valid Values: N/A
Default: USERS
Tablespace for materialized view indexes.
Name: MATERIALIZED_VIEW_TABLESPACE
Type: STRING
Valid Values: N/A
Default: USERS
Tablespace for materialized view.
Name: VISIBLE
Type: BOOLEAN
Valid Values: true, false
Default: true
The Cube is visible to OLAP end user if value is set = true.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
See Also
OMBALTER, OMBCREATE CUBE, OMBRETRIEVE CUBE, OMBDROP CUBE
Purpose
Alter the content of a data auditor.
Prerequisites
1. The current context of scripting must be an Oracle Module
2. No concurrent user should be modifying the data auditor
Syntax
alterDataAuditorCommand = OMBALTER DATA_AUDITOR "dataAuditorName" (
"renameClause" [ "alterPropertiesOrIconSetClause" ] [
"alterDataAuditorDecendantsClause" ] |
"alterPropertiesOrIconSetClause" [ "alterDataAuditorDecendantsClause"
] | "alterDataAuditorDecendantsClause" )
dataAuditorName = "QUOTED_STRING"
renameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = ( SET ( ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] )
| "setReferenceIconSetClause" ) ) | UNSET
"unsetReferenceIconSetClause"
alterDataAuditorDecendantsClause = ( ADD "addOperatorClause" | MODIFY (
"modifyOperatorClause" | "modifyChildClause" ) | DELETE
"operatorLocator" )+
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
addOperatorClause = "operatorType" OPERATOR "operatorName" [ SET
"setPropertiesClause" ] [ BOUND TO "setBindingClause" ]
modifyOperatorClause = "operatorLocator" ( SET "setPropertiesClause" )
modifyChildClause = "childBottomUpLocator" ( "renameClause" | SET
"setPropertiesClause" )
operatorLocator = OPERATOR "operatorName"
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
operatorType = "UNQUOTED_STRING"
operatorName = "QUOTED_STRING"
setBindingClause = "bindableLocator"
childBottomUpLocator = "childType" "childName" { OF "childType"
"childName" } [ OF "mappableBottomUpLocator" ]
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
bindableLocator = "bindableType" "bindableName"
childType = "UNQUOTED_STRING"
childName = "QUOTED_STRING"
mappableBottomUpLocator = "operatorLocator"
bindableType = "UNQUOTED_STRING"
bindableName = "QUOTED_STRING"
Keywords And Parameters
alterDataAuditorCommand
Alter the content of a data auditor.
dataAuditorName
Name of data auditor.
renameClause
Rename a data auditor
alterPropertiesOrIconSetClause
Alter properties or the icon set.
alterDataAuditorDecendantsClause
Add, modify, delete or alter operators.
setPropertiesClause
Set the properties of the data auditor.
setReferenceIconSetClause
Set icon set for the data auditor.
unsetReferenceIconSetClause
Unset icon set for the data auditor.
addOperatorClause
Adds an operator to a data auditor.OMBCREATE DATA_AUDITOR 'MAP1'
SET PROPERTIES (business_name, description)
VALUES ('My map', 'Audit table foo')
ADD TABLE OPERATOR 'CUST_SRC'
BOUND TO TABLE '../SRC_MODULE/CUST_SRC'
modifyOperatorClause
Modify operator.
modifyChildClause
Modify a child that belongs to a data auditor.
operatorLocator
Locate operator.
propertyKeyList
The list of property keys.
propertyValueList
A list of property values.
operatorType
Type of a mapping operator. The following operator types are available:
CUBE, DIMENSION, MATERIALIZED_VIEW, TABLE, VIEW.
operatorName
Name of an operator.
setBindingClause
Set the binding during the creation of a operator.
childBottomUpLocator
Locate object in data auditor.
propertyKey
A property key for an object.
Basic properties for DATA_AUDITOR:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the data auditor
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the daa auditor
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
#
Properties for DATA_AUDITOR:
Name: ANALYZE_TABLE_SAMPLE_PERCENTAGE
Type: NUMBER
Valid Values: N/A
Default: 90
The default percentage of rows to be sampled when the target tables are
analyzed for statistics to improve performance during insertion.
Name: ANALYZE_TABLE_STATEMENTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate statistics collection statement if this is true.
Name: ANSI_SQL_SYNTAX
Type: BOOLEAN
Valid Values: true, false
Default: true
A switch between ANSI and Oracle SQL Syntax.
Name: BULK_PROCESSING_CODE
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate bulk processing code if this is true.
Name: BULK_SIZE
Type: NUMBER
Valid Values: N/A
Default: 50
The default number of rows to be fetched in batch during cursor processing.
Name: COMMIT_CONTROL
Type: STRING
Valid Values: AUTO_COMMIT, AUTO_CORR_COMMIT, MANUAL_COMMIT
Default: AUTO_COMMIT
Options for how commit is performed
Name: COMMIT_FREQUENCY
Type: NUMBER
Valid Values: N/A
Default: 1000
The default number of rows processed before a commit is issued.
Name: DEFAULT_AUDIT_LEVEL
Type: STRING
Valid Values: COMPLETE, ERROR_DETAILS, NONE, STATISTICS
Default: ERROR_DETAILS
The default audit level when the step is executed.
Name: DEFAULT_OPERATING_MODE
Type: STRING
Valid Values: ROW_BASED, ROW_BASED_TARGET_ONLY, SET_BASED,
SET_BASED_FAIL_OVER_TO_ROW_BASED,
SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY
Default: SET_BASED_FAIL_OVER_TO_ROW_BASED
The default operating mode.
Name: DEFAULT_PURGE_GROUP
Type: STRING
Valid Values: N/A
Default: WB
The default purge group to be used when the step is executed.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
True if the map is deployable to a physical implementation
Name: ENABLE_PARALLEL_DML
Type: BOOLEAN
Valid Values: true, false
Default: true
Determine if PDML is enabled at runtime.
Name: ERROR_TRIGGER
Type: STRING
Valid Values: N/A
Default: ''
Error trigger procedure name.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: GENERATION_MODE
Type: STRING
Valid Values: ALL_MODES, ROW_BASED, ROW_BASED_TARGET_ONLY, SET_BASED,
SET_BASED_FAIL_OVER_TO_ROW_BASED,
SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY
Default: ALL_MODES
The operating modes for which code should be generated.
Name: MAXIMUM_NUMBER_OF_ERRORS
Type: NUMBER
Valid Values: N/A
Default: 50
The default maximum number of errors encountered before aborting the step
execution.
Name: OPTIMIZED_CODE
Type: BOOLEAN
Valid Values: true, false
Default: true
Attempt to generate optimized code if this is true.
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.
Name: TARGET_LOAD_ORDERING
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate target load ordering code.
Name: THRESHOLD_MODE
Type: STRING
Valid Values: PERCENTAGE, SIX_SIGMA
Default: PERCENTAGE
Use six sigma or percentage for failure thresholds.
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 an operator.
childType
Type of a child that belongs to data auditor or operator
childName
Name of a child that belongs to data auditor, operator.
mappableBottomUpLocator
Locate mappable object in data auditor.
bindableType
Type of object bound to an operator.
bindableName
Name of the object bound to operator.
See Also
OMBALTER, OMBCREATE DATA_AUDITOR, OMBRETRIEVE DATA_AUDITOR, OMBDROP DATA_AUDITOR
Purpose
Alter the Data Profile by renaming it, and/or reset its properties.
Prerequisites
Should be in the context of project.
Syntax
alterDataProfileCommand = OMBALTER ( DATA_PROFILE "QUOTED_STRING" (
"renameClause" [ "alterPropertiesOrReferenceClause" ] | ( [
"alterPropertiesOrReferenceClause" ] ( { ( ADD | DELETE ) ( TABLE |
VIEW | EXTERNAL_TABLE | MATERIALIZED_VIEW | DIMENSION | CUBE )
"QUOTED_STRING" } ) ) ) )
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
alterDataProfileCommand
This command modifies an existing Data Profile.
QUOTED_STRING
Name of the existing Data Profile in single quotes.
renameClause
Rename a Data Profile.
alterPropertiesOrReferenceClause
Alter existing Data Profile's core properties, locations and icon sets.
setPropertiesClause
Associate a set of properties with the existing Data Profile.
Configuration properties for DATA_PROFILE 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
This tells the profiler if common formats are to be discovered for all
sources in this profile.
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: NUMBER
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 DATA_PROFILE 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.
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.
Properties for DATA_PROFILE:
Name: ABAP_DIRECTORY
Type: STRING
Valid Values: N/A
Default: /tmp
Location where SAP data is dumped as flat files
Name: CALCULATE_COMMON_FORMATS
Type: BOOLEAN
Valid Values: true, false
Default: false
Setting this to true will enable common format discovery for all the
columns in this profile.
Name: CALCULATE_DATATYPES
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable data type discovery for all the columns in
this profile.
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.
Name: CALCULATE_DOMAINS
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable domain discovery.
Name: CALCULATE_FD
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable functional dependency discovery.
Name: CALCULATE_FK
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable foreign key discovery.
Name: CALCULATE_PATTERNS
Type: BOOLEAN
Valid Values: true, false
Default: false
Setting this to true will enable pattern discovery.
Name: CALCULATE_REDUNDANT_COLUMNS
Type: BOOLEAN
Valid Values: true, false
Default: false
Setting this to true will enable redundant column discovery.
Name: CALCULATE_UK
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable unique key discovery.
Name: COPY_DATA
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable copying of data from source to profile
staging area.
Name: DOMAIN_MAX_COUNT
Type: NUMBER
Valid Values: N/A
Default: 100
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: 0 - 100
Default: 50
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: N/A
Default: 2
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: 0 - 100
Default: 1
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: FD_MIN_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 100
This is the minimum percentage of rows that need to satisfy a functional
dependency relationship.
Name: FD_UK_FK_LHS_COUNT
Type: NUMBER
Valid Values: N/A
Default: 1
This is the maximum number of attributes for unique key and functional
dependency profiling.
Name: FK_MIN_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 75
This is the minimum percentage of rows that need to satisfy a foreign key
relationship.
Name: MAX_NUM_PATTERNS
Type: NUMBER
Valid Values: N/A
Default: 10
This tells the profiler to get the top-N patterns for the attribute.
Name: NULL_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 10
If the percentage of null values in a column is less than this threshold
percentage, then that column will be discovered as a possible Not Null
column.
Name: NULL_VALUE
Type: STRING
Valid Values: N/A
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: REDUNDANT_MIN_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 75
This is the minimum percentage of rows that are redundant with respect to a
foreign key-unique key pair.
Name: SAMPLE_RATE
Type: NUMBER
Valid Values: 0 - 100
Default: 100
This value will be the percent of total rows that will be randomly selected
during loading.
Name: UK_MIN_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 75
This is the minimum percentage of rows that need to satisfy a unique key
relationship.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceClause
A general clause for setting references for a Data Profile.
unsetReferenceClause
A general clause for unsetting references for a Data Profile.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
setReferenceLocationClause
Set a location for an existing Data Profile.
setReferenceIconSetClause
Set icon set for the Data Profile.
unsetReferenceLocationClause
Unset a location for an existing Data Profile.
unsetReferenceIconSetClause
Unset icon set for the Data Profile.
propertyValue
Value of a property.
See Also
OMBALTER, OMBCREATE DATA_PROFILE, OMBDROP DATA_PROFILE
Purpose
= Alter the content of a data rule.
Prerequisites
1. The current context of scripting must be an DataRule Rule Module
2. No concurrent user should be modifying the data rule
Syntax
alterDataRuleCommand = OMBALTER ( DATA_RULE "QUOTED_STRING" (
"ruleRenameClause" [ "alterPropertiesOrIconSetClause" ] |
"alterPropertiesOrIconSetClause" | ( ADD "addDomainValueClause" )+ | (
REMOVE "removeDomainValueClause" )+ | "alterGroupClause"+ |
"alterDomainValueClause"+ ) )
ruleRenameClause = RENAME TO "QUOTED_STRING"
alterPropertiesOrIconSetClause = SET ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
addDomainValueClause = ( DOMAIN_VALUE "QUOTED_STRING" )
removeDomainValueClause = DOMAIN_VALUE "QUOTED_STRING"
alterGroupClause = GROUP "QUOTED_STRING" ( "setGroupPropertiesClause" |
"addAttributeClause"+ | "removeAttributeClause"+ |
"alterAttributeClause"+ )
alterDomainValueClause = DOMAIN_VALUE "QUOTED_STRING"
"domainValueRenameClause"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
setGroupPropertiesClause = SET PROPERTIES "(" "propertyNameList" ")"
VALUES "(" "propertyValueList" ")"
addAttributeClause = ADD ATTRIBUTE ( "QUOTED_STRING" [ SET
"setPropertiesClause" ] )
removeAttributeClause = REMOVE ATTRIBUTE "QUOTED_STRING"
alterAttributeClause = ATTRIBUTE ( "QUOTED_STRING" SET
"setPropertiesClause" )
domainValueRenameClause = RENAME TO "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterDataRuleCommand
Alter a data rule.
QUOTED_STRING
Data rule name.
ruleRenameClause
Rename a data rule.
QUOTED_STRING
New name.
alterPropertiesOrIconSetClause
Alter properties or the icon set.
addDomainValueClause
Add a domain value.
QUOTED_STRING
Domain value.
removeDomainValueClause
Remove a domain value.
QUOTED_STRING
Domain value.
alterGroupClause
Alter a data rule group.
QUOTED_STRING
Data rule group name.
alterDomainValueClause
Alter a domain value.
QUOTED_STRING
Domain value name.
setPropertiesClause
Set the properties of the data rule.
Properties of Data Rule are:
Basic properties for DATA_RULE:
Name: DATA_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Data Rule
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Data Rule
Name: RULE_TYPE
Type: STRING
Valid Values: ATTR_VALUE_RULE
DOMAIN_NO_NULL_RULE
DOMAIN_LIST_RULE
DOMAIN_PATTERN_LIST_RULE
DOMAIN_RANGE_RULE
DOMAIN_FORMAT_TELEPHONE_RULE
DOMAIN_FORMAT_IP_RULE
DOMAIN_FORMAT_SSN_RULE
DOMAIN_FORMAT_DATE_RULE
DOMAIN_FORMAT_NUMBER_RULE
DOMAIN_FORMAT_URL_RULE
DOMAIN_FORMAT_EMAIL_RULE
FUNCTIONAL_DEP_RULE
SET_RULE
IDENTITY_RULE
REFERENCE_RULE
Default: ATTR_VALUE_RULE
Data Rule type
Name: ATTR_VALUE_CLAUSE
Type: STRING(4000)
Valid Values: N/A
Default: ''
Expression used in the ATTR_VALUE_RULE
Name: LOCAL_MIN_COUNT
Type: STRING
Valid Values: N/A
Default: 1
Used in the REFERENCE_RULE to set the max and min counts for the local and
remote side of a relation. For a 1-n relationship, set the local max count
to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local
max count to n and remote max count to 1.
Name: LOCAL_MAX_COUNT
Type: STRING
Valid Values: N/A
Default: n
Used in the REFERENCE_RULE to set the max and min counts for the local and
remote side of a relation. For a 1-n relationship, set the local max count
to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local
max count to n and remote max count to 1.
Name: REMOTE_MIN_COUNT
Type: STRING
Valid Values: N/A
Default: 0
Used in the REFERENCE_RULE to set the max and min counts for the local and
remote side of a relation. For a 1-n relationship, set the local max count
to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local
max count to n and remote max count to 1.
Name: REMOTE_MAX_COUNT
Type: STRING
Valid Values: N/A
Default: 'n'
Used in the REFERENCE_RULE to set the max and min counts for the local and
remote side of a relation. For a 1-n relationship, set the local max count
to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local
max count to n and remote max count to 1.
Name: MAX_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Used in the DOMAIN_RANGE_RULE. Leave the min or max value blank is not
used. For instance, the rule: attr >= 10 would have a max value and no
min_value.
Name: MIN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Used in the DOMAIN_RANGE_RULE. Leave the min or max value blank is not
used. For instance, the rule: attr >= 10 would have a max value and no
min_value.
Name: IGNORE_NULLS
Type: BOOLEAN
Valid Values: N/A
Default: false
Used in identity and reference rules. If set, then records containing null
values will not evaluated.
Properties of Data Rule Attribute are:
Name: DATATYPE
Type: STRING
Valid Values: DATE, NUMBER, VARCHAR2
Default: NUMBER
Set the data type for Parameter. Should be set for attributes on ATTR_VALUE
and DOMAIN_RANGE rules
Properties for DATA_RULE:
Name: ATTR_VALUE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: DUAL_ADDRESS_ASSIGNMENT
Type: STRING
Valid Values: NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX,
NA_DUALADDR_STREET
Default: NA_DUALADDR_STREET
Description not available.
Name: FUNCTIONAL_DEP_THRESHOLD
Type: NUMBER
Valid Values: N/A
Default: 0
Description not available.
Name: IGNORE_NULLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: LOCAL_MAX_COUNT
Type: STRING
Valid Values: N/A
Default: n
Description not available.
Name: LOCAL_MIN_COUNT
Type: STRING
Valid Values: N/A
Default: 1
Description not available.
Name: MAX_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: MIN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: NAMEADDR_PASS_CONDITION
Type: STRING
Valid Values: PASS_PARSED, PASS_POSTALMATCHED_AVAIL
Default: PASS_PARSED
Description not available.
Name: PARSING_TYPE
Type: STRING
Valid Values: NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY
Default: NA_NAMEANDADDRESS
Description not available.
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
Description not available.
Name: REMOTE_MAX_COUNT
Type: STRING
Valid Values: N/A
Default: n
Description not available.
Name: REMOTE_MIN_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: RULE_TYPE
Type: STRING
Valid Values: , ATTR_VALUE_RULE, DOMAIN_FORMAT_DATE_RULE,
DOMAIN_FORMAT_EMAIL_RULE, DOMAIN_FORMAT_IP_RULE, DOMAIN_FORMAT_NUMBER_RULE,
DOMAIN_FORMAT_SSN_RULE, DOMAIN_FORMAT_TELEPHONE_RULE,
DOMAIN_FORMAT_URL_RULE, DOMAIN_LIST_RULE, DOMAIN_NO_NULL_RULE,
DOMAIN_PATTERN_LIST_RULE, DOMAIN_RANGE_RULE, FUNCTIONAL_DEP_RULE,
IDENTITY_RULE, NAMEADDRESS_RULE, REFERENCE_RULE, SET_RULE
Default: ''
Description not available.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceIconSetClause
Set icon set for the data rule.
unsetReferenceIconSetClause
Unset icon set for the data rule.
setGroupPropertiesClause
Set the properties in a group.
addAttributeClause
Add an attribute to a group.
removeAttributeClause
Remove an attribute from a group.
alterAttributeClause
ALter an attribute.
domainValueRenameClause
Rename a domain value.
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 DATA_RULE, OMBDROP DATA_RULE
Purpose
To create a data rule module.
Prerequisites
Should be in the context of project.
Syntax
alterDataRuleModuleCommand = OMBALTER ( DATA_RULE_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
alterDataRuleModuleCommand
Alter data rule module.
QUOTED_STRING
Data rule module name.
renameClause
Rename a data rule.
QUOTED_STRING
New name.
alterPropertiesOrIconSetClause
Alter properties or the icon set.
setPropertiesClause
Set the properties of the data rule module.
Basic properties for DATA_RULE_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of a Data Rule Module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of a Data Rule Module
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceIconSetClause
Set icon set for the data rule module.
unsetReferenceIconSetClause
Unset icon set for the data rule module.
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 DATA_RULE_MODULE, OMBDROP DATA_RULE_MODULE
Purpose
Modify an existing deployment action plan.
Prerequisites
There must be a current working project.
Syntax
AlterActionPlanCommand = ( OMBALTER ( ( DEPLOYMENT_ACTION_PLAN |
ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" ( (
"renameActionPlanClause" { "addActionClause" | "modifyActionClause" |
"deleteActionClause" } ) | ( "addActionClause" { "addActionClause" |
"modifyActionClause" | "deleteActionClause" } ) | (
"modifyActionClause" { "addActionClause" | "modifyActionClause" |
"deleteActionClause" } ) | ( "deleteActionClause" { "addActionClause"
| "modifyActionClause" | "deleteActionClause" } ) ) )
renameActionPlanClause = RENAME TO "QUOTED_STRING"
addActionClause = ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
modifyActionClause = MODIFY ACTION "QUOTED_STRING" ( (
"renameActionClause" [ "setUnsetClause" ] ) | "setUnsetClause" )
deleteActionClause = DELETE ACTION "QUOTED_STRING"
setClause = ( "propertiesClause" [ SET "setReferenceClause" ] ) |
"setReferenceClause"
renameActionClause = RENAME TO "QUOTED_STRING"
setUnsetClause = ( ( SET "setClauseForAlter" ) | ( UNSET
"unsetReferenceClause" ) )
propertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
"useClause" }
setClauseForAlter = ( "propertiesClause" [ SET "setReferenceClause" |
UNSET "unsetReferenceClause" ] ) | "setReferenceClause"
unsetReferenceClause = ( REF | REFERENCE )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
useClause = USE DATA_RULE_USAGE "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
AlterActionPlanCommand
Modify an existing deployment action plan.
renameActionPlanClause
Rename an action plan.
addActionClause
Add an action to an action plan.
modifyActionClause
Modify an action of an action plan.
deleteActionClause
Remove an action from an action plan.
setClause
Set the properties of an action and/or associate an object with an action.
renameActionClause
Rename an action.
setUnsetClause
Set the properties and/or associate/disassociate an object with an action.
propertiesClause
Associate a set of properties with an action.
PROPERTIES
The only valid property is OPERATION, which specifies the type of action to
be taken.
setReferenceClause
Associate an object with an action.
ObjType
Object type. Valid values are ADVANCED_QUEUE, CUBE, DIMENSION,
EXTERNAL_TABLE, CONNECTOR, FUNCTION, MAPPING, MATERIALIZED_VIEW, PROCEDURE,
PROCESS_FLOW_PACKAGE, SCHEDULABLE, SEQUENCE, TABLE, and VIEW.
QUOTED_STRING
Absolute or relative path name of an object (e.g.
'/MY_PROJECT/MODULE_X/TABLE_Y').
setClauseForAlter
Set the properties and/or associate/disassociate an object with an action.
unsetReferenceClause
Disassociate a previously associated object from an action.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
useClause
Currently used only in CORRECTION_SCHEMA_ACTION_PLAN.
propertyValue
Value of a property. Valid values for OPERATION are DROP, CREATE, REPLACE
and UPGRADE.
See Also
OMBCREATE DEPLOYMENT_ACTION_PLAN, OMBDEPLOY
Purpose
Alter the Deployment by renaming it, and/or reset its properties and referenced Control Center.
Prerequisites
Should be in the context of a Configuration.
Syntax
alterDeploymentCommand = OMBALTER ( DEPLOYMENT "QUOTED_STRING" (
"renameClause" [ SET "setPropertiesClause" ] [
"setReferenceControlCenterClause" ] [ "setAsActiveClause" ] | SET
"setPropertiesClause" [ "setReferenceControlCenterClause" ] [
"setAsActiveClause" ] | "setReferenceControlCenterClause" [
"setAsActiveClause" ] | "setAsActiveClause" ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceControlCenterClause = SET ( REFERENCE | REF ) CONTROL_CENTER
"QUOTED_STRING"
setAsActiveClause = SET AS ACTIVE
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterDeploymentCommand
This command modifies an existing Deployment.
renameClause
Rename Deployment.
setPropertiesClause
Associate a set of properties with the existing Deployment.
Basic properties for DEPLOYMENT:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of a Deployment
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of a Deployment.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceControlCenterClause
Set a reference of a Control Center to the existing Deployment.
setAsActiveClause
Set this Deployment as Active.
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 DEPLOYMENT
Purpose
This command alters a dimension.
Prerequisites
Should be in Oracle Module context.
Syntax
alterDimensionCommand = OMBALTER DIMENSION "dimensionName" (
"renameClause" [ "setPropertiesClause" ] [ "setReferenceIconSetClause"
[ "setDimensionKeySequenceClause" ] | "unsetReferenceIconSetClause" [
"setDimensionKeySequenceClause" ] | "setDimensionKeySequenceClause" ]
[ ( ADD "addSurrogateKeyDimensionAttributeClause" | MODIFY
"modifySurrogateKeyDimensionAttributeClause" ) ] [ ( ADD
"addParentKeyDimensionAttributeClause" | MODIFY
"modifyParentKeyDimensionAttributeClause" ) ] [ ( ADD
"addBusinessKeyDimensionAttributeClause" | MODIFY
"modifyBusinessKeyDimensionAttributeClause" ) ] [
"alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
| "setPropertiesClause" [ "setReferenceIconSetClause" [
"setDimensionKeySequenceClause" ] | "unsetReferenceIconSetClause" [
"setDimensionKeySequenceClause" ] | "setDimensionKeySequenceClause" ]
[ ( ADD "addSurrogateKeyDimensionAttributeClause" | MODIFY
"modifySurrogateKeyDimensionAttributeClause" ) ] [ ( ADD
"addParentKeyDimensionAttributeClause" | MODIFY
"modifyParentKeyDimensionAttributeClause" ) ] [ ( ADD
"addBusinessKeyDimensionAttributeClause" | MODIFY
"modifyBusinessKeyDimensionAttributeClause" ) ] [
"alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
| ( "setReferenceIconSetClause" [ "setDimensionKeySequenceClause" ] |
"unsetReferenceIconSetClause" [ "setDimensionKeySequenceClause" ] |
"setDimensionKeySequenceClause" ) [ ( ADD
"addSurrogateKeyDimensionAttributeClause" | MODIFY
"modifySurrogateKeyDimensionAttributeClause" ) ] [ ( ADD
"addParentKeyDimensionAttributeClause" | MODIFY
"modifyParentKeyDimensionAttributeClause" ) ] [ ( ADD
"addBusinessKeyDimensionAttributeClause" | MODIFY
"modifyBusinessKeyDimensionAttributeClause" ) ] [
"alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
| ( ADD "addSurrogateKeyDimensionAttributeClause" | MODIFY
"modifySurrogateKeyDimensionAttributeClause" ) [ ( ADD
"addParentKeyDimensionAttributeClause" | MODIFY
"modifyParentKeyDimensionAttributeClause" ) ] [ ( ADD
"addBusinessKeyDimensionAttributeClause" | MODIFY
"modifyBusinessKeyDimensionAttributeClause" ) ] [
"alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
| ( ADD "addParentKeyDimensionAttributeClause" | MODIFY
"modifyParentKeyDimensionAttributeClause" ) [ ( ADD
"addBusinessKeyDimensionAttributeClause" | MODIFY
"modifyBusinessKeyDimensionAttributeClause" ) ] [
"alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
| ( ADD "addBusinessKeyDimensionAttributeClause" | MODIFY
"modifyBusinessKeyDimensionAttributeClause" ) [
"alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
| "alterDimensionDescendantsClause" [ "alterDimensionBindingClause" ]
| "alterDimensionBindingClause" | "alterDimensionUnBindingClause" )
dimensionName = "QUOTED_STRING"
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = SET PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = SET ( REFERENCE | REF ) ICONSET
"QUOTED_STRING"
setDimensionKeySequenceClause = SET ( REF | REFERENCE ) SEQUENCE
"sequenceName"
unsetReferenceIconSetClause = UNSET ( REFERENCE | REF ) ICONSET
addSurrogateKeyDimensionAttributeClause = DIMENSION_ATTRIBUTE
"dimensionAttributeName" SET AS SURROGATE_KEY [ "setPropertiesClause"
]
modifySurrogateKeyDimensionAttributeClause = DIMENSION_ATTRIBUTE
"dimensionAttributeName" SET AS SURROGATE_KEY [ "setPropertiesClause"
]
addParentKeyDimensionAttributeClause = DIMENSION_ATTRIBUTE
"dimensionAttributeName" SET AS PARENT_KEY [ "setPropertiesClause" ]
modifyParentKeyDimensionAttributeClause = DIMENSION_ATTRIBUTE
"dimensionAttributeName" SET AS PARENT_KEY [ "setPropertiesClause" ]
addBusinessKeyDimensionAttributeClause = DIMENSION_ATTRIBUTE
"dimensionAttributeName" SET AS BUSINESS_KEY [ "setPropertiesClause" ]
modifyBusinessKeyDimensionAttributeClause = DIMENSION_ATTRIBUTE
"dimensionAttributeName" SET AS BUSINESS_KEY [ "setPropertiesClause" ]
alterDimensionDescendantsClause = ( ADD ( "addDimensionAttributeClause" |
"addDimensionRoleClause" | "addLevelClause" |
"addLevelAttributeClause" | "addHierarchyClause" |
"addSkipLevelsClause" ) | MODIFY ( "modifyDimensionAttributeClause" |
"modifyDimensionRoleClause" | "modifyLevelClause" |
"modifyLevelAttributeClause" | "modifyHierarchyClause" |
"modifySkipLevelsClause" ) | DELETE ( "dimensionAttributeLocator" |
"roleLocator" | "levelLocator" | "levelAttributeBottomUpLocator" |
"hierarchyLocator" | "skipLevelLocator" ) )+
alterDimensionBindingClause = IMPLEMENTED BY ( SYSTEM ( STAR | SNOWFLAKE
) | STAR ( ( [ DIMENSION_KEY BOUND TO COLUMN "columnName" ] (
"levelBindingClause" | "levelAttributeBindingClause" |
"setBindRelationshipClause" | "setSkipBindRelationshipClause" )+ ) ) |
SNOWFLAKE ( ( "levelBindingClause" | "levelAttributeBindingClause" |
"setBindRelationshipClause" | "setSkipBindRelationshipClause" )+ ) )
alterDimensionUnBindingClause = DELETE BINDING
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
sequenceName = "QUOTED_STRING"
dimensionAttributeName = "QUOTED_STRING"
addDimensionAttributeClause = DIMENSION_ATTRIBUTE "dimensionAttributeName"
[ SET AS BUSINESS_KEY ] [ "setPropertiesClause" ]
addDimensionRoleClause = DIMENSION_ROLE "roleName" [ "setPropertiesClause"
]
addLevelClause = LEVEL "levelName" [ "setPropertiesClause" ]
addLevelAttributeClause = LEVEL_ATTRIBUTE "levelAttributeName" OF
"levelLocator" [ "setPropertiesClause" ]
"setLevelAttributeReferenceClause"
addHierarchyClause = HIERARCHY "hierarchyName" [ "setPropertiesClause" ] [
"hierarchyLevelReferenceClause" ]
addSkipLevelsClause = SKIP_LEVELS FROM "levelLocator" TO "levelLocator" IN
"hierarchyLocator"
modifyDimensionAttributeClause = "dimensionAttributeLocator" (
"renameClause" | "setPropertiesClause" )
modifyDimensionRoleClause = "roleLocator" ( "renameClause" |
"setPropertiesClause" )
modifyLevelClause = "levelLocator" ( "renameClause" |
"setPropertiesClause" )
modifyLevelAttributeClause = "levelAttributeBottomUpLocator" (
"renameClause" | "setPropertiesClause" |
"setLevelAttributeReferenceClause" )
modifyHierarchyClause = "hierarchyLocator" ( "renameClause" |
"setPropertiesClause" | "hierarchyLevelReferenceClause" )
modifySkipLevelsClause = SKIP_LEVELS FROM "levelLocator" TO "levelLocator"
IN "hierarchyLocator"
dimensionAttributeLocator = DIMENSION_ATTRIBUTE "dimensionAttributeName"
roleLocator = DIMENSION_ROLE "roleName"
levelLocator = LEVEL "levelName"
levelAttributeBottomUpLocator = LEVEL_ATTRIBUTE "levelAttributeName" OF
"levelLocator"
hierarchyLocator = HIERARCHY "hierarchyName"
skipLevelLocator = SKIP_LEVELS FROM "levelLocator" TO "levelLocator" IN
"hierarchyLocator"
columnName = "QUOTED_STRING"
levelBindingClause = "levelLocator" BOUND TO ( TABLE "tableName" | VIEW
"viewName" )
levelAttributeBindingClause = LEVEL_ATTRIBUTE "levelAttributeName" OF
LEVEL "levelName" BOUND TO COLUMN "columnName"
setBindRelationshipClause = LEVEL_RELATIONSHIP OF "levelLocator" IN
"hierarchyLocator" BOUND TO COLUMN "columnName"
setSkipBindRelationshipClause = SKIP_LEVEL_RELATIONSHIP OF "levelLocator"
IN "hierarchyLocator" BOUND TO COLUMN "columnName"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
roleName = "QUOTED_STRING"
levelName = "QUOTED_STRING"
levelAttributeName = "QUOTED_STRING"
setLevelAttributeReferenceClause = SET ( REF | REFERENCE ) (
"dimensionAttributeLocator" [ TYPE_THREE_SCD_PREVIOUS
"levelAttributeLocator" ] )
hierarchyName = "QUOTED_STRING"
hierarchyLevelReferenceClause = SET ( REF | REFERENCE ) LEVELS "("
"levelName" { "," "levelName" } ")"
tableName = "QUOTED_STRING"
viewName = "QUOTED_STRING"
levelAttributeLocator = LEVEL_ATTRIBUTE "levelAttributeName"
Keywords And Parameters
setPropertiesClause
Basic properties for DIMENSION, DIMENSION_ATTRIBUTE, LEVEL, LEVEL_ATTRIBUTE
and HIERARCHY:
Basic properties for DIMENSION :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Dimension
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Dimension
Name: SCD_TYPE
Type: INTEGER
Valid Values: 1, 2, 3
Default: 1
Slowly changing policy to be applied on the dimension. Give Integer values
1, 2, 3
for Slowly changing type one, two and three
Name: TYPE
Type: STRING
Valid Values: 'NONE', 'TIME'
Default: 'NONE'
'NONE' it does not recognize it as any specific type of dimension.
'TIME' dimension is a time dimension
Name: OLAP_TYPE
Type: STRING
Valid Values: NONE, TIME
Default: NONE
Dimension type for OLAP, get regular dimension 'NONE' and for OLAP Time
Dimension 'TIME'
Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The dimension is visible to OLAP end user
Name: UNIQUE_KEY_CONSTRAINT
Type: STRING
Valid Values: true, false
Default: false
set the Unique Key constraint on the Business Key
Name: STORAGE
Type: STRING
Valid Values: RELATIONAL, AW
Default: 'RELATIONAL'
The storage of a dimension can be AW or relational
Name: AW_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
Set the analytical workspace name where the dimension is implemented
Name: AW_DIMENSION_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
Set the Analytical Workspace dimension physical object name
Name: USE_BUSINESS_KEYS
Type: STRING
Valid Values: true, false
Default: false
Set the flag for Analytical Workspace dimension to use Business Keys as
data source
Basic properties for DIMENSION_ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Dimension_Attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Dimension_Attribute
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 TIME ZONE, TIMESTAMP WITH
LOCAL TIME ZONE, VARCHAR, VARCHAR2
Default: NUMBER
Sets the datatype of a Dimension_Attribute
Name: SCALE
Type: NUMBER
Valid Values: -85 - 125
Default: 1
The scale of a number.
Name: LENGTH
Type: NUMBER
Valid Values:
Default: 1
The length of a number
Name: PRECISION
Type: NUMBER
Valid Values: 0 - 39
Default: 1
The precision of a number.
Name: DESCRIPTOR
Type: STRING
Valid Values: NONE, SHORT_DESCRIPTION, LONG_DESCRIPTION, END_DATE,
TIME_SPAN, PRIOR_PERIOD, YEAR_AGO_PERIOD
Default: NONE
The following properties are set on dimension attribute so that it is
recognized by OLAP service
'NONE' it is not specially recognized type by OLAP service
'SHORT_DESCRIPTION' sets as a short description
'LONG_DESCRIPTION' sets as a long description
'END_DATE' sets as a last date of a period.
'TIME_SPAN' sets as a number of days in a period.
'PRIOR_PERIOD' sets as the prior period number.
'YEAR_AGO_PERIOD' sets as the time period a year before this period
Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The dimension attribute is visible to OLAP end user
Name: TYPE
Type: STRING
Valid Values: NONE, START_DATE, END_DATE, TIME_SPAN
Default: NONE
'NONE' dimension attribute so OWB does not recognize it as any specific
type.
'START_DATE' dimension attribute of time dimension as the start date of a
period
'END_DATE' dimension attribute of time dimension as the end date of a
period
'TIME_SPAN' dimension attribute of time dimension as the time span
Name: AW_ATTRIBUTE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
set the AW object name implementing the dimension attribute
Basic properties for Level :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Level
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Level
Name: TYPE
Type: STRING
Valid Values: NONE, DAY, FISCAL_WEEK, FISCAL_MONTH, FISCAL_QUARTER,
FISCAL_YEAR, CALENDAR_WEEK, CALENDAR_MONTH, CALENDAR_QUARTER, CALENDAR_YEAR
Default: NONE
For regular relational dimension level (non-time dimension level) use
'NONE'. For relational time dimension use other values.
Name: OLAP_TYPE
Type: STRING
Valid Values: NONE,DAY,MONTH,QUARTER,YEAR,TOTAL
Default: NONE
Level has an olap-type for OLAP-based levels; use 'NONE' for regular
levels, and other values for OLAP Time Dimension
Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The level is visible to OLAP end user
Basic properties for Level_Attribute :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Level_Attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Level_Attribute
Name: DEFAULT_VALUE
Type: STRING(200)
Valid Values: N/A
Default: ''
This is used to construct the default parent policy for loading data into
dimesion.
Name: OLAP_TYPE
Type: STRING
Valid Values: NONE, SHORT_DESCRIPTION, END_DATE, TIME_SPAN, PRIOR_PERIOD,
YEAR_AGO_PERIOD
Default: NONE
The following properties are set on level attribute so that it is
recognized by OLAP service
'NONE' it is not specially recognized type by OLAP service
'SHORT_DESCRIPTION' sets as a short description
'END_DATE' sets as a last date of a period.
'TIME_SPAN' sets as a number of days in a period.
'PRIOR_PERIOD' sets as the prior period number.
'YEAR_AGO_PERIOD' sets as the time period a year before this period
Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The level attribute is visible to OLAP end user
Name: TYPE
Type: STRING
Valid Values: NONE, START_DATE, END_DATE, TIME_SPAN
Default: 'NONE'
'NONE' level attribute so OWB does not recognize it as any specific type.
'START_DATE' level attribute of time dimension as the start date of a
period
'END_DATE' level attribute of time dimension as the end date of a period
'TIME_SPAN' level attribute of time dimension as the time span
Name: TYPE_TWO_SCD_EFFECTIVE_DATE
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Effective Date for Slowly changing type 2
Name: TYPE_TWO_SCD_EXPIRATION_DATE
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Expiration Date for Slowly changing type
2
Name: TYPE_TWO_SCD_TRIGGER
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Trigger for saving history for Slowly
changing type 2
Name: TYPE_THREE_SCD_EFFECTIVE_DATE
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Effective Date for Slowly changing type 3
Basic properties for Hierarchy :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Hierarchy
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Hierarchy
Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The hierarchy is visible to OLAP end user
Name: TYPE
Type: STRING
Valid Values: NONE, FISCAL, CALENDAR_YEAR, CALENDAR_WEEK
Default: NONE
'NONE' hierarchy so OWB does not recognize it as any specific type.
'FISCAL' fiscal hierarchy for time dimension
'CALENDAR_YEAR' calendar year hierarchy time dimension
'CALENDAR_WEEK' calendar week hierarchy time dimension
Name: DEFAULT_DISPLAY
Type: STRING
Valid Values: true, false
Default: false
The hierarchy is set as Default display hierarchy
Name: VALUE_BASED
Type: STRING
Valid Values: true, false
Default: false
Sets the flag to define a Value Based Hierarchy for AW only
Properties for DIMENSION:
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: DEPLOYMENT_OPTIONS
Type: STRING
Valid Values: DEPLOY_ALL, DEPLOY_DATA_OBJECTS_ONLY, DEPLOY_TO_CATALOG_ONLY
Default: DEPLOY_DATA_OBJECTS_ONLY
Warehouse Builder generates a set of scripts for Dimension, they are DDL
Scripts for Relational Dimensional or Scripts for ROLAP or or Scripts for
AW.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: VIEW_NAME
Type: STRING(30)
Valid Values: N/A
Default: ''
Name of the view that is generated to hide the control rows on the
dimension implementation table of a star schema. If this field is left
blank, the view name will default to '<Name of Dimension>_v'
Name: VISIBLE
Type: BOOLEAN
Valid Values: true, false
Default: true
The Dimension is visible to OLAP end user if value is set = true.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
See Also
OMBALTER, OMBCREATE DIMENSION, OMBRETRIEVE DIMENSION, OMBDROP DIMENSION
Purpose
Alters a drill path.
Prerequisites
Should be in the context of a business definition module or use the full
path.
Syntax
alterDrillPathCommand = ( OMBALTER DRILL_PATH "QUOTED_STRING" ( (
"renameClause" [ SET "setPropertiesClause" ] [ SET
"setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
{ "alterDrillPathLevelClauses" } ) | ( SET "setPropertiesClause" [ SET
"setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
{ "alterDrillPathLevelClauses" } ) | ( SET
"setReferenceIconSetClause" [ UNSET "unsetReferenceIconSetClause" ] {
"alterDrillPathLevelClauses" } ) | ( UNSET
"unsetReferenceIconSetClause" { "alterDrillPathLevelClauses" } ) | (
"alterDrillPathLevelClauses" { "alterDrillPathLevelClauses" } ) ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterDrillPathLevelClauses = ADD "addDrillPathLevelClauseForAlter" |
MODIFY "modifyDrillPathLevelClause" | DELETE
"deleteDrillPathLevelClause"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addDrillPathLevelClauseForAlter = DRILL_LEVEL "QUOTED_STRING" [ BELOW
DRILL_LEVEL "QUOTED_STRING" ] [ SET "setPropertiesClause" ] {
"setDrillItemClause" }
modifyDrillPathLevelClause = DRILL_LEVEL "QUOTED_STRING" [ "renameClause"
] [ "moveDrillLevelToClause" ] [ SET "setPropertiesClause" ] {
"setDrillItemClause" | "unsetDrillItemClause" | "unsetJoinUsage" }
deleteDrillPathLevelClause = DRILL_LEVEL "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setDrillItemClause = SET ( REF | REFERENCE ) ITEM "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING" "itemJoinUsages"
moveDrillLevelToClause = MOVE ( UP | DOWN )
unsetDrillItemClause = UNSET ( REF | REFERENCE ) ITEM "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING"
unsetJoinUsage = UNSET ( REF | REFERENCE ) USING JOIN "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING"
itemJoinUsages = { SET ( REF | REFERENCE ) USING JOIN "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING" }
Keywords And Parameters
alterDrillPathCommand
This clause alters a drill path.
QUOTED_STRING
name of the drill path.
renameClause
Renames a drill path with a different name.
setPropertiesClause
This clause sets the properties of the object.
Basic properties for DRILL_PATH:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the drill path
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the drill path
Basic properties for DRILL_LEVEL:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the drill level
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the drill level
Properties for DRILL_PATH:
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.
alterDrillPathLevelClauses
This clause modifies a drill path.
propertyNameList
This is the list of property names.
propertyValueList
This is the list of property values.
addDrillPathLevelClauseForAlter
This adds a drill level to a drill path.
QUOTED_STRING
name of the drill level.
modifyDrillPathLevelClause
This modifies a drill level in a drill path.
QUOTED_STRING
name of the drill level.
deleteDrillPathLevelClause
This deletes a drill level from a drill path.
QUOTED_STRING
name of the drill level.
propertyValue
This is a property value.
setDrillItemClause
This clause adds a reference to an item for the level.
moveDrillLevelToClause
This clause is for positioning a drill level in a drill path.
unsetDrillItemClause
This clause removes a reference to an item for the level.
unsetJoinUsage
removes a join usage.
itemJoinUsages
The specific joins to be used.
See Also
OMBCREATE DRILL_PATH, OMBRETRIEVE DRILL_PATH
Purpose
Alters a drill to detail.
Prerequisites
Should be in the context of a business definition module or use the full
path.
Syntax
alterDrillToDetailCommand = ( OMBALTER DRILL_TO_DETAIL "QUOTED_STRING" ( (
"renameClause" [ SET "setPropertiesClause" ] [ SET
"setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
{ "alterDrillToDetailClauses" } ) | ( SET "setPropertiesClause" [ SET
"setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
{ "alterDrillToDetailClauses" } ) | ( SET "setReferenceIconSetClause"
[ UNSET "unsetReferenceIconSetClause" ] { "alterDrillToDetailClauses"
} ) | ( UNSET "unsetReferenceIconSetClause" {
"alterDrillToDetailClauses" } ) | ( "alterDrillToDetailClauses" {
"alterDrillToDetailClauses" } ) ) )
renameClause = RENAME TO "QUOTED_STRING"
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
unsetReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
alterDrillToDetailClauses = "addDrillToDetailReferenceClause" | UNSET (
REF | REFERENCE ) "deleteDrillToDetailClauses"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addDrillToDetailReferenceClause = SET ( REF | REFERENCE ) ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
deleteDrillToDetailClauses = ( ITEM "QUOTED_STRING" OF ITEM_FOLDER
"QUOTED_STRING" )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
alterDrillToDetailCommand
This clause alters a drill to detail.
QUOTED_STRING
name of the drill to detail.
renameClause
Renames a drill to detail with a different name.
setPropertiesClause
This clause sets the properties of the object.
Basic properties for DRILL_TO_DETAIL:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the drill to detail
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the drill to detail
Properties for DRILL_TO_DETAIL:
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.
alterDrillToDetailClauses
This clause modifies a drill to detail.
propertyNameList
This is the list of property names.
propertyValueList
This is the list of property values.
addDrillToDetailReferenceClause
This adds a reference to an item to a drill to detail.
deleteDrillToDetailClauses
This deletes a reference to an item from a drill to detail.
propertyValue
This is a property value.
See Also
OMBCREATE DRILL_TO_DETAIL, OMBRETRIEVE DRILL_TO_DETAIL
