| Oracle® Warehouse Builder API and Scripting Reference 10g Release 2 (10.2) Part Number B28225-01 |
|
|
View PDF |
| Oracle® Warehouse Builder API and Scripting Reference 10g Release 2 (10.2) Part Number B28225-01 |
|
|
View PDF |
This chapter lists commands associated with OMBCREATE in alphabetical order, concluding with the command OMBCREATE PLSQL_TABLE_TYPE. Subsequent commands associated with OMBCREATE are contained in the next chapter.
Purpose
Create a new component.
Prerequisites
Should be in the context that stores the component type.
Syntax
createCommand = OMBCREATE [ TRANSIENT ] "fco_type" "fco_name" [
"setPropertiesClause" ] { "setReferenceClause" } { "addSCOClause" }
setPropertiesClause = SET PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = SET ( REF | REFERENCE ) [ "qualifier" ] "type"
"quotedNameList" [ { "parentSCOClause" } OF "fco_type" "fco_name" ]
addSCOClause = ADD "sco_type" "sco_name" { "parentSCOClause" } [
"setPropertiesClause" ] { "setReferenceClause" }
propertyNameList = "propertyName" { "," "propertyName" }
propertyValueList = "propertyValue" { "," "propertyValue" }
quotedNameList = "QUOTED_STRING" | "(" "QUOTED_STRING" { ","
"QUOTED_STRING" } ")"
parentSCOClause = OF "sco_type" "sco_name"
propertyName = "UNQUOTED_STRING"
propertyValue = "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL"
Keywords And Parameters
createCommand
Specify metadata for a new component.
TRANSIENT
Keyword used to specify that the object being created will not be persisted
in the repository.
fco_type
The type of the component.
fco_name
The physical name of the component in single quotes.
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.
addSCOClause
Add a new child object to the component.
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
propertyName
An unquoted string representing the name of a property.
propertyValue
The value of a property.
Examples
This is an example for creating an empty table:
OMBCREATE TABLE 'T1' SET PROPERTIES (DESCRIPTION) VALUES ('My First
Table')
The following statement creates a view with a column:
OMBCREATE VIEW 'V1'
ADD COLUMN 'COL1'
SET PROPERTIES (DATATYPE) VALUES ('VARCHAR2')
See Also
OMBALTER, OMBDROP
Purpose
To create an activity template.
Valid Activity Template types are:
ASSIGN
FILE_EXISTS
FTP
MANUAL
NOTIFICATION
SET_STATUS
SQLPLUS
USER_DEFINED
WAIT
Prerequisites
Should be in the context of an Activity Template Folder.
Syntax
createActivityTemplate = ( OMBCREATE ACTIVITY_TEMPLATE "QUOTED_STRING" [ (
OF ACTIVITY_TYPE "UNQUOTED_STRING" ) ] { ( SET "setPropertiesClause"
) | "setReferenceIconSetClause" } { "addParameterClause" } )
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = SET ( REFERENCE | REF ) ICONSET
"QUOTED_STRING"
addParameterClause = ( ADD PARAMETER "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 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
Examples
OMBCREATE ACTIVITY_TEMPLATE 'ASSIGN_TEMPLATE' OF ACTIVITY_TYPE ASSIGN
OMBCREATE ACTIVITY_TEMPLATE 'EMAIL_TEMPLATE' OF ACTIVITY_TYPE EMAIL
OMBCREATE ACTIVITY_TEMPLATE 'FILE_EXISTS_TEMPLATE' OF ACTIVITY_TYPE
FILE_EXISTS
OMBCREATE ACTIVITY_TEMPLATE 'FTP_TEMPLATE' OF ACTIVITY_TYPE FTP
OMBCREATE ACTIVITY_TEMPLATE 'MANUAL_TEMPLATE' OF ACTIVITY_TYPE MANUAL
OMBCREATE ACTIVITY_TEMPLATE 'NOTIFICATION_TEMPLATE' OF ACTIVITY_TYPE
NOTIFICATION
OMBCREATE ACTIVITY_TEMPLATE 'SET_STATUS_TEMPLATE' OF ACTIVITY_TYPE
SET_STATUS
OMBCREATE ACTIVITY_TEMPLATE 'SQLPLUS_TEMPLATE' OF ACTIVITY_TYPE SQLPLUS
OMBCREATE ACTIVITY_TEMPLATE 'USER_DEFINED_TEMPLATE' OF ACTIVITY_TYPE
USER_DEFINED
OMBCREATE ACTIVITY_TEMPLATE 'WAIT_TEMPLATE' OF ACTIVITY_TYPE WAIT
See Also
OMBCREATE, OMBALTER ACTIVITY_TEMPLATE, OMBDROP ACTIVITY_TEMPLATE, OMBRETRIEVE ACTIVITY_TEMPLATE
Purpose
To create an activity template folder.
Prerequisites
Should be in the context of a Project.
Syntax
createActivityTemplateFolder = OMBCREATE ACTIVITY_TEMPLATE_FOLDER
"QUOTED_STRING" { ( SET "setPropertiesClause" ) |
"setReferenceIconSetClause" }
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = SET ( REFERENCE | REF ) ICONSET
"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_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
Examples
OMBCREATE ACTIVITY_TEMPLATE_FOLDER 'FOLDER1'
See Also
OMBCREATE, OMBALTER ACTIVITY_TEMPLATE_FOLDER, OMBDROP ACTIVITY_TEMPLATE_FOLDER, OMBRETRIEVE ACTIVITY_TEMPLATE_FOLDER
Purpose
To create an Advanced Queue.
Prerequisites
Should be in the context of an Oracle Module. The Queue Table should exist
in the same Oracle Module.
Syntax
createAQCommand = OMBCREATE ( ADVANCED_QUEUE "QUOTED_STRING" [ SET (
"setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createAQCommand
Creates an Advanced Queue with the given name.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for Advanced Queue.
Valid properties are as shown:
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
Warehouse Builder generates a set of scripts to create an object only for
those objects marked as Deployable = true.
Name: DEQUEUE_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: true
Dequeue Enabled for AQ
Name: ENQUEUE_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: true
Enqueue enabled for AQ
Name: GENERATE_ADVANCED_QUEUE
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate the code to create the Advanced Queue.
Name: GENERATE_TEMPORARY_TABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate the code to create the temporary table.
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
Max. number of Retries
Name: RETENTION_TIME
Type: NUMBER
Valid Values: N/A
Default: 0
Message retention time
Name: RETRY_DELAY
Type: NUMBER
Valid Values: N/A
Default: 0
Delay period before retry
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceIconSetClause
Set the specified Icon Set.
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
Examples
OMBCREATE ADVANCED_QUEUE 'NEW_ADVANCED_QUEUE' SET PROPERTIES (DESCRIPTION,
QTABLE) VALUES ('this is an Advanced Queue', 'SOME_OBJECT_TYPE')
This will create an Advanced Queue named "NEW_ADVANCED_QUEUE", its
description is "this is an Advanced Queue" and its Queue Table
'SOME_QUEUE_TABLE'.
See Also
OMBCREATE ADVANCED_QUEUE, OMBALTER ADVANCED_QUEUE, OMBDROP ADVANCED_QUEUE
Purpose
Creates an Alternative Sort Order.
Prerequisites
Should be in the context of a Business Definition Module.
Syntax
createAlternativeSortOrderCommand = OMBCREATE ALTERNATIVE_SORT_ORDER
"QUOTED_STRING" [ SET "setPropertiesClauseforLOVandD2D" ] [ SET
"setReferenceIconSetClause" ] [ "addAlternativeSortOrderDefClause" ] [
"addAlternativeSortOrderOrdClause" ] {
"addAlternativeSortOrderReferenceClause" }
setPropertiesClauseforLOVandD2D = PROPERTIES "("
"propertyNameListforLOVandD2D" ")" VALUES "(" "propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addAlternativeSortOrderDefClause = SET ( REF | REFERENCE ) DEFINING ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
addAlternativeSortOrderOrdClause = SET ( REF | REFERENCE ) ORDERED ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
addAlternativeSortOrderReferenceClause = SET ( REF | REFERENCE ) ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
propertyNameListforLOVandD2D = ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
"," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createAlternativeSortOrderCommand
This command creates an alternative sort order.
QUOTED_STRING
Specify the name of the alternative sort order to be created.
setPropertiesClauseforLOVandD2D
Used to set properties (core, logical, physical, user-defined) for an
alternative sort order. Valid properties are as shown:
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.
addAlternativeSortOrderDefClause
This clause adds a defining item.
addAlternativeSortOrderOrdClause
This clause adds an ordering item.
addAlternativeSortOrderReferenceClause
This adds a reference to an item to an alternative sort order.
propertyNameListforLOVandD2D
This is the list of property names.
propertyValueList
This is the list of property values.
propertyValue
This is a property value.
Examples
OMBCREATE ALTERNATIVE_SORT_ORDER 'SALES_ITEM'
See Also
OMBALTER ALTERNATIVE_SORT_ORDER, OMBRETRIEVE ALTERNATIVE_SORT_ORDER
Purpose
Create an action plan for executing a profile.
Prerequisites
First make sure that all the sources you want to profile have been imported
into the OWB repository.
Syntax
CreateActionPlanCommand = ( OMBCREATE TRANSIENT ( ( DEPLOYMENT_ACTION_PLAN
| ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" { "addActionClause" }
)
addActionClause = ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
setClause = ( "propertiesClause" [ SET "setReferenceClause" ] ) |
"setReferenceClause"
propertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
"useClause" }
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
CreateActionPlanCommand
Create a profile action plan.
QUOTED_STRING
Action plan name.
addActionClause
Add an action to an action plan.
QUOTED_STRING
Action name.
setClause
Set the properties of an action and/or associate 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.
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.
Examples
OMBCREATE TRANSIENT ANALYZE_ACTION_PLAN 'PROFILE_PLAN'
ADD ACTION 'ACTION1'
SET REF PROFILE_REFERENCE 'LOC'
ADD ACTION 'ACTION2'
SET REF PROFILE_REFERENCE 'EMP'
ADD ACTION 'ACTION3'
SET REF PROFILE_REFERENCE 'DEPT'
OMBPROFILE ANALYZE_ACTION_PLAN 'PROFILE_PLAN'
See Also
OMBPROFILE
Purpose
Creates a Business Area to group business related items.
Prerequisites
Should be in the context of a Business Definition Module.
Syntax
createBusinessAreaCommand = ( OMBCREATE BUSINESS_AREA "QUOTED_STRING" [
SET "setPropertiesClause" ] [ SET "setReferenceIconSetClause" ] [ SET
( REF | REFERENCE ) "(" "setfolderNameList" ")" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
setfolderNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createBusinessAreaCommand
This command creates a business area.
QUOTED_STRING
Specify the name of the business area to be created.
setPropertiesClause
Used to set properties (core, logical, physical, user-defined) for business
areas. Valid properties are as shown:
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.
setfolderNameList
Used to set item folder references for this business area.
propertyNameList
This is the list of property names.
propertyValueList
This is the list of property values.
propertyValue
This is a property value.
Examples
OMBCREATE BUSINESS_AREA 'SALES'
See Also
OMBALTER BUSINESS_AREA, OMBRETRIEVE BUSINESS_AREA
Purpose
To create a business definition module.
Prerequisites
Should be in the context of project.
Syntax
createEULModuleCommand = OMBCREATE ( BUSINESS_DEFINITION_MODULE
"QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET
"setReferenceClauseForDataOnlyModule" ] |
"setReferenceClauseForDataOnlyModule" ) ] [
"addModuleReferenceLocationClause" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataOnlyModule = ( "setReferenceLocationClause" [ SET
"setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
addModuleReferenceLocationClause = "addReferenceLocationClause" {
"addReferenceLocationClause" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addReferenceLocationClause = ADD ( REFERENCE | REF ) LOCATION
"QUOTED_STRING" [ SET AS DEFAULT ]
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createEULModuleCommand
This command creates a business definition module.
QUOTED_STRING
Specify the name of a business definition module to be created.
setPropertiesClause
Associate a set of properties with a 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.
addModuleReferenceLocationClause
Add runtime locations to the new business definition module.
propertyNameList
Comma-delimited list of property names. Property names are not in quotes.
propertyValueList
Comma-delimited list of property values.
setReferenceLocationClause
Set a location for a business definition module.
setReferenceIconSetClause
Set icon set for the new business definition module.
addReferenceLocationClause
Add a runtime location to the new business definition module.
propertyValue
Value for a specified property.
Examples
OMBCREATE BUSINESS_DEFINITION_MODULE 'src_module' SET PROPERTIES
(DESCRIPTION, BUSINESS_NAME) VALUES ('this is a Business Definition
module', 'int module')
This will create a business definition module named "src_module", its
description is "this is a business definition module", and business name is
"int module".
See Also
OMBCREATE, OMBALTER BUSINESS_DEFINITION_MODULE, OMBDROP BUSINESS_DEFINITION_MODULE
Purpose
To create a presentation module.
Prerequisites
Should be in the context of project.
Syntax
createReportModuleCommand = OMBCREATE ( BUSINESS_PRESENTATION_MODULE
"QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET
"setReferenceClauseForDataOnlyModule" ] |
"setReferenceClauseForDataOnlyModule" ) ] [
"addModuleReferenceLocationClause" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataOnlyModule = ( "setReferenceLocationClause" [ SET
"setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
addModuleReferenceLocationClause = "addReferenceLocationClause" {
"addReferenceLocationClause" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addReferenceLocationClause = ADD ( REFERENCE | REF ) LOCATION
"QUOTED_STRING" [ SET AS DEFAULT ]
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createReportModuleCommand
This command creates a presentation module.
QUOTED_STRING
Specify the name of the presentation module to be created.
setPropertiesClause
Associate a set of properties with a 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.
addModuleReferenceLocationClause
Add runtime locations to the new business presentation module.
propertyNameList
Comma-delimited list of property names. Property names are not in quotes.
propertyValueList
Comma-delimited list of property values.
setReferenceLocationClause
Set a location for a presentation module.
setReferenceIconSetClause
Set icon set for the new business presentation module.
addReferenceLocationClause
Add a runtime location to the new business presentation module.
propertyValue
Value for a specified property.
Examples
OMBCREATE BUSINESS_PRESENTATION_MODULE 'salesrep_module' SET PROPERTIES
(DESCRIPTION, BUSINESS_NAME) VALUES ('this is a presentation module',
'source module')
This will create a presentation module named "salesrep_module", its
description is "this is a presentation module", and business name is
"source module".
See Also
OMBCREATE, OMBALTER BUSINESS_PRESENTATION_MODULE, OMBDROP BUSINESS_PRESENTATION_MODULE
Purpose
To create a calendar.
Prerequisites
Should be in the context of a Calendar Folder.
Syntax
createCalendarCommand = ( OMBCREATE CALENDAR "QUOTED_STRING" [ SET ( (
"setPropertiesClause" [ SET "setReferenceIconSetClause" ] ) |
"setReferenceIconSetClause" ) ] ( ADD SCHEDULE ) [ SET
"setPropertiesClause" ] )
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "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:
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, that is 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 preceding 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
Examples
OMBCREATE CALENDAR 'CAL1' ADD SCHEDULE
OMBCREATE CALENDAR 'CAL_10G' ADD SCHEDULE SET PROPERTIES (START_TIME,
END_TIME, REPEAT_EXPRESSION, TIME_ZONE) VALUES ('22:Feb:2001:14:20:10',
'22:Feb:2002:14:20:10', 'FREQ=MINUTELY;INTERVAL=20', 'Europe/London')
OMBCREATE CALENDAR 'CAL_10G_2' ADD SCHEDULE SET PROPERTIES
(REPEAT_EXPRESSION) VALUES
('FREQ=YEARLY;INTERVAL=1;BYMONTH=APR;BYMONTHDAY=1;BYHOUR=12;BYMINUTE=0;BYSECOND=0')
OMBCREATE CALENDAR 'ONE_TIME' ADD SCHEDULE SET PROPERTIES (START_TIME,
TIME_ZONE) VALUES ('22:Feb:2001:14:20:10', 'Europe/London')
<b> For this release the user will only be able to create one
schedule under a calendar, and the default name used
will be 'LOCALWINDOW', the user will have to use
this name to retrieve the properties of the schedule.</b>
See Also
OMBCREATE, OMBALTER CALENDAR, OMBDROP CALENDAR, OMBRETRIEVE CALENDAR
Purpose
To create an calendar module.
Prerequisites
Should be in the context of a Calendar Folder.
Syntax
createModuleCommand = OMBCREATE CALENDAR_MODULE "QUOTED_STRING" [
"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
Examples
OMBCREATE CALENDAR_MODULE 'CAL_MODULE1'
See Also
OMBCREATE, OMBALTER CALENDAR_MODULE, OMBDROP CALENDAR_MODULE, OMBRETRIEVE CALENDAR_MODULE
Purpose
This command creates a change data capture with the given name and properties
Prerequisites
This command can only be executed in the context of a module
Syntax
createChangeSetCommand = OMBCREATE ( CHANGE_DATA_CAPTURE "QUOTED_STRING" (
CAPTURE CHANGES | USE CHANGES ) { ( SET "setPropertiesClause" ) |
"addChangeSetSCOClauses" } )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
addChangeSetSCOClauses = ( ( ADD CAPTURE ( TABLE | VIEW |
MATERIALIZED_VIEW ) "QUOTED_STRING" ) { "addCaptureSCOClauses" } [
"specialCaptureColumnsClause"+ ] )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addCaptureSCOClauses = ( "addCaptureColumnsClause" | "addChangeSpecClause"
| "addRowIdentifierClause" | "addTxnIdentifierClause" )
specialCaptureColumnsClause = [ DONT ] CAPTURE ( OLD_VALUES | USER_NAME )
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
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" ")" ) ) ) )
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: FROM_START_DATE, ALL_AVAILABLE
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: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
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
Examples
OMBCREATE CHANGE_DATA_CAPTURE 'EMPLOYEE_CHANGES' CAPTURE CHANGES ADD
CAPTURE TABLE 'EMPLOYEE' CAPTURE_COLUMNS ('EMPID', 'EMPNAME')
This creates a change data capture called EMPLOYEE_CHANGES that captures
the changes to columns EMPID, EMPNAME of table EMPLOYEE
See Also
OMBCREATE CHANGE_DATA_CAPTURE, OMBALTER CHANGE_DATA_CAPTURE, OMBDROP CHANGE_DATA_CAPTURE
Purpose
To create an CMI definition.
Prerequisites
Should be in the root context.
Syntax
createMIVDefinitionCommand = OMBCREATE ( CMI_DEFINITION "QUOTED_STRING"
USING DEFINITION_FILE "QUOTED_STRING" ) [ SET "setPropertiesClause" ]
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createMIVDefinitionCommand
This command creates an CMI definition
QUOTED_STRING
Name of the CMI definition to be created.
setPropertiesClause
Associate a set of properties with an CMI definition.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
propertyValue
Value of a property.
Examples
OMBCREATE CMI_DEFINITION 'src_definition' USING DEFINITION_FILE
'/private/user1/miv_navision.xml'
See Also
OMBCREATE, OMBDROP CMI_DEFINITION
Purpose
To create an CMI module.
Prerequisites
Should be in the context of project.
Syntax
createMIVModuleCommand = OMBCREATE ( CMI_MODULE "QUOTED_STRING" USING
CMI_DEFINITION "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET
"setReferenceClauseForDataMetadataModule" ] |
"setReferenceClauseForDataMetadataModule" ) ] [
"addModuleReferenceLocationClause" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataMetadataModule = ( "setReferenceLocationClause" [
SET "setReferenceMetadataLocationOrIconSetClause" ] |
"setReferenceMetadataLocationOrIconSetClause" )
addModuleReferenceLocationClause = "addReferenceLocationClause" {
"addReferenceLocationClause" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceMetadataLocationOrIconSetClause = (
"setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
] | "setReferenceIconSetClause" )
addReferenceLocationClause = ADD ( 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"
Keywords And Parameters
createMIVModuleCommand
This command creates an CMI module
setPropertiesClause
Associate a set of properties with an CMI module.
Basic properties for CMI_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of an CMI Module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of an CMI Module
Properties for CMI_MODULE:
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
If this is a source module, this value indicates the location from which
data will be read. If this is a target warehouse module, this value
indicates the location where generated code will be deployed to and/or
where data will be written to.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceClauseForDataMetadataModule
Set location and/or icon set for the CMI module.
addModuleReferenceLocationClause
Add runtime locations to the CMI module.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
setReferenceLocationClause
Set a runtime location to the CMI module.
setReferenceMetadataLocationOrIconSetClause
Set metadata location and/or icon set for the CMI module.
addReferenceLocationClause
Add a runtime location to the CMI module.
propertyValue
Value of a property.
setReferenceMetadataLocationClause
Set metadata location for the CMI module.
setReferenceIconSetClause
Set icon set for the CMI module.
Examples
OMBCREATE CMI_MODULE 'src_module' SET PROPERTIES (DESCRIPTION,
BUSINESS_NAME) VALUES ('this is an CMI module', 'source module')
This will create an CMI module named "src_module", its description is
"this is an CMI module", and bousiness name is "source module".
See Also
OMBCREATE, OMBALTER CMI_MODULE, OMBDROP CMI_MODULE
Purpose
This is an arbitrary grouping mechanism in OWB. Any first class object can be added to the collection.
Prerequisites
Should be in the context of a project, before creating a collection.
Syntax
createCollectionCommand = OMBCREATE ( COLLECTION "QUOTED_STRING" [ SET
"setPropertiesClause" [ SET "setReferenceIconSetClause" ] | SET
"setReferenceIconSetClause" ] ( { "addReferenceClause" } ) )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addReferenceClause = ADD REFERENCE TO "componentRefClause"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
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 | BUSINESS_PRESENTATION_MODULE |
PRESENTATION_TEMPLATE | 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"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createCollectionCommand
Create a collection of objects.
setPropertiesClause
Set values for a number of properties when creating the 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
addReferenceClause
Add a reference to the collection.
propertyNameList
Comma separated list of property names to retrieve values. Property names
are unquoted.
propertyValueList
Comma separated list of property values.
componentRefClause
Specify the type of the object to reference.
propertyValue
Value of property.
Examples
OMBCREATE COLLECTION 'PURCHASING_WAREHOUSE' ADD REFERENCE TO TABLE
'PURCHASING/ORDER' ADD REFERENCE TO TABLE 'PURCHASING/CUSTOMER'
OMBCREATE COLLECTION 'MY_FOLDERS' ADD REFERENCE TO ORACLE_MODULE
'PURCHASING' ADD REFERENCE TO ORACLE_MODULE 'HUMAN_RESOURCES'
See Also
OMBCREATE, OMBALTER COLLECTION, OMBDROP COLLECTION
Purpose
To create a Configuration for supporting of objects multi-configuration.
Prerequisites
Should be in the context of project.
Syntax
createConfigurationCommand = OMBCREATE ( CONFIGURATION "QUOTED_STRING" [
SET ( "setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createConfigurationCommand
This command creates an Configuration.
setPropertiesClause
Associate a set of properties with a 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
Associate an Icon Set a Configuration.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
propertyValue
Value of a property.
Examples
OMBCREATE CONFIGURATION 'QA_CONFIG' SET PROPERTIES (DESCRIPTION,
BUSINESS_NAME) VALUES ('This is a configuration for the QA Control Center',
'QA Configuration')
This will create a Configuration named "QA_CONFIG", its description is
"This is a configuration for QA Control Center", and business name is "QA
Configuration".
See Also
OMBCREATE, OMBALTER CONFIGURATION, OMBDROP CONFIGURATION
Purpose
To create a connector.
Prerequisites
Can be in any context; the name is a name of the connector's owning
location and a new connector name separated by slash.
Syntax
createConnectorCommand = OMBCREATE ( CONNECTOR "QUOTED_STRING" SET [
"setPropertiesClause" SET ] "setReferenceToLocationClause" [ SET
"setReferenceIconSetClause" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceToLocationClause = ( REFERENCE | REF ) LOCATION
"QUOTED_STRING"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createConnectorCommand
Create a new connector.
setPropertiesClause
Set specified properties of the connector.
setReferenceToLocationClause
Set the name of the location which the connector references.
setReferenceIconSetClause
Set 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.
propertyValue
A property value.
Examples
OMBCREATE CONNECTOR 'LOCATION_NAME/NEW_CONNECTOR_NAME' SET PROPERTIES
(DESCRIPTION, BUSINESS_NAME) VALUES ('this is a connector', 'connector')
SET REF LOCATION 'MY_TARGET_LOCATION'
This will create a connector named "NEW_CONNECTOR_NAME" for the location
"LOCATION_NAME" ', and will assign MY_TARGET_LOCATION as a target location
for the created connector; its description is "this is a connector", and
business name is "connector".
See Also
OMBCREATE, OMBALTER CONNECTOR, OMBDROP CONNECTOR
Purpose
To create a control center.
Prerequisites
Can be in any context.
Syntax
createControlCenterCommand = OMBCREATE ( CONTROL_CENTER "QUOTED_STRING" (
"createControlCenterSetPropertiesClause" [ SET
"setReferenceIconSetClause" ] { "addReferenceLocationClause" } ) )
createControlCenterSetPropertiesClause = SET PROPERTIES "("
"propertyNameList" ")" VALUES "(" "propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addReferenceLocationClause = ADD ( REF | REFERENCE ) LOCATION
"QUOTED_STRING" [ SET "setPropertiesClause" ]
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createControlCenterCommand
Create a new control center.
createControlCenterSetPropertiesClause
Set the specified properties of the control center.
setReferenceIconSetClause
Set the specified icon set.
addReferenceLocationClause
Add a referenced location and set the specified properties of that
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: SCHEMA
Type: STRING
Valid Values: N/A
Default: N/A
The name of the schema in which the control center is installed.
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: ''
Schema name for the location
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.
propertyValue
A property value.
Examples
OMBCREATE CONTROL_CENTER 'MY_CONTROL_CENTER' SET PROPERTIES (DESCRIPTION,
BUSINESS_NAME, HOST, PORT, SERVICE_NAME, USER, SCHEMA) VALUES ('this is my
control center', 'My Control Center', 'localhost', 1521, 'orcl9i', 'scott',
'tgu_repos')
This will create a control center named "my_control_center", its
description is "this is my control center", business name is "My Control
Center", host is localhost, port is 1521, service name is orcl9i, user is
Scott, schema is tgu_repos.
See Also
OMBCREATE, OMBALTER CONTROL_CENTER, OMBDROP CONTROL_CENTER
Purpose
Create an action plan for creating correction maps.
Prerequisites
Done after creating a correction schema, using a
CORRECTION_SCHEMA_ACTION_PLAN.
Syntax
CreateActionPlanCommand = ( OMBCREATE TRANSIENT ( ( DEPLOYMENT_ACTION_PLAN
| ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" { "addActionClause" }
)
addActionClause = ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
setClause = ( "propertiesClause" [ SET "setReferenceClause" ] ) |
"setReferenceClause"
propertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
"useClause" }
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
CreateActionPlanCommand
Create a correction schema action plan.
Name: DATA_RULE_USAGE_NAME
Type: String
Valid Values: Any data rule usage name associated with the profile table
Name: ERROR_HANDLING_STRATEGY
Type: String
One of IGNORE REPORT CLEANSE
This property determines the action to take when the rule fails. If the
action is cleanse, then a CORRECTION_STRATEGY
is used to determine the specific cleansing action.
Name: CORRECTION_STRATEGY
Type: String
One of DISCARD DOMAINSOUNDEX DOMAINSIMILARITY DISCARD MIN MAX FD_MAPLET
FIX_REMOTE UK_MATCHMERGE
This property determines the correction action to take when the rule fails.
Not all correction strategies are supported with all data rule types.
Data Rule Type Correction Strategy
DOMAIN_LIST_RULE DISCARD
DOMAINSOUNDEX
DOMAINSIMILARITY
DOMAIN_RANGE_RULE DISCARD
MIN
MAX
FUNCTIONAL_DEPENDENCY_RULE DISCARD
FD_MAPLET
REFERENCE_RULE DISCARD
FIX_REMOTE
IDENTITY_RULE DISCARD
UK_MATCHMERGE
All other rule types DISCARD
Name: CORRECTION_ORDER
Type: NUMBER
Valid Values: 1-any number
Optional: This sets the relative order of the data corrections.
addActionClause
Add an action to an action plan.
QUOTED_STRING
Action name.
setClause
Set the properties of an action and/or associate 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.
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.
Examples
OMBCREATE TRANSIENT CORRECTION_MAPS_ACTION_PLAN 'CMAPS_PLAN'
ADD ACTION 'ACTION1'
SET PROPERTIES (DATA_RULE_USAGE_NAME, ERROR_HANDLING_STRATEGY)
VALUES ('CHECK_MIN_SALARY', 'REPORT')
SET REF PROFILE_REFERENCE 'EMP'
ADD ACTION 'ACTION2'
SET PROPERTIES (DATA_RULE_USAGE_NAME, ERROR_HANDLING_STRATEGY,
CORRECTION_STRATEGY, CORRECTION_ORDER)
VALUES ('CHECK_JOB', 'CLEANSE', 'DOMAINSOUNDEX', 2)
SET REF PROFILE_REFERENCE 'EMP'
ADD ACTION 'ACTION3'
SET PROPERTIES (DATA_RULE_USAGE_NAME, ERROR_HANDLING_STRATEGY,
CORRECTION_STRATEGY, CORRECTION_ORDER)
VALUES ('CHECK_MIN_DEPTNO', 'CLEANSE', 'MIN', 1)
SET REF PROFILE_REFERENCE 'EMP'
OMBPROFILE CORRECTION_MAPS_ACTION_PLAN 'CMAPS_PLAN'
IN ORACLE_MODULE '/PROJ/CORR_MOD'
See Also
OMBPROFILE
Purpose
Create an action plan for creating a correction schema, identifying the tables that will be mapped to
that schema.
Prerequisites
First do OMBCREATE DATA_RULE, and OMBALTER TABLE 'T' ADD DATA_RULE_USAGE,
on the tables that will be mapped.
Syntax
CreateActionPlanCommand = ( OMBCREATE TRANSIENT ( ( DEPLOYMENT_ACTION_PLAN
| ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" { "addActionClause" }
)
addActionClause = ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
setClause = ( "propertiesClause" [ SET "setReferenceClause" ] ) |
"setReferenceClause"
propertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
"useClause" }
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
CreateActionPlanCommand
Create a correcton schmema action plan.
QUOTED_STRING
Action plan name.
addActionClause
Add an action to an action plan.
QUOTED_STRING
Action name.
setClause
Set the properties of an action and/or associate 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.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
useClause
Use data rule in construction of correction schema.
QUOTED_STRING
Name of data rule usage.
propertyValue
Value of a property.
Examples
OMBCREATE TRANSIENT CORRECTION_SCHEMA_ACTION_PLAN 'CSCHEMA_PLAN'
ADD ACTION 'ACTION1'
SET REF PROFILE_REFERENCE 'LOC'
ADD ACTION 'ACTION2'
SET REF PROFILE_REFERENCE 'EMP'
USE DATA_RULE_USAGE 'CHECK_JOB'
USE DATA_RULE_USAGE 'MIN_SALARY'
ADD ACTION 'ACTION3'
SET REF PROFILE_REFERENCE 'DEPT'
USE DATA_RULE_USAGE 'CHECK_MAX_DEPTNO'
OMBPROFILE CORRECTION_SCHEMA_ACTION_PLAN 'CSCHEMA_PLAN'
IN ORACLE_MODULE '/PROJ/CORR_MOD'
See Also
OMBPROFILE
Purpose
This command creates a Cube.
Prerequisites
Should be in Oracle Module context.
Syntax
createCubeCommand = OMBCREATE CUBE "cubeName" [ SET ( (
"setPropertiesClause" [ SET "setReferenceIconSetClause" ] ) |
"setReferenceIconSetClause" ) ] [ "setCubeAggFunctionClause" ] { ADD (
"addMeasureClause" | "addDimensionUseClause" |
"addCompositeDimensionClause" ) } [ "cubeImplementationClause" ]
cubeName = "QUOTED_STRING"
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
setCubeAggFunctionClause = SET AGGREGATE_FUNCTION TO "aggFunctionName"
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" ]
cubeImplementationClause = IMPLEMENTED BY ( ( "cubeBindingClause" {
"measureBindingClause" | "dimensionUseBindingClause" } ) |
"cubeAutoBindingClause" )
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
aggFunctionName = "QUOTED_STRING"
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" } ")"
cubeBindingClause = ( TABLE "tableName" | VIEW "viewName" )
measureBindingClause = "measureLocator" BOUND TO COLUMN "columnName"
dimensionUseBindingClause = "dimensionUseLocator" BOUND TO COLUMN
"columnName"
cubeAutoBindingClause = SYSTEM
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"
levelName = "QUOTED_STRING"
dimensionName = "QUOTED_STRING"
tableName = "QUOTED_STRING"
viewName = "QUOTED_STRING"
measureLocator = MEASURE "measureName"
columnName = "QUOTED_STRING"
dimensionUseLocator = DIMENSION_USE "dimensionUseName"
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
Examples
OMBCREATE CUBE 'ALL_SALES'
SET PROPERTIES (BUSINESS_NAME, DESCRIPTION)
VALUES ('Sales Cube', 'Sales Cube')
ADD MEASURE 'AMOUNT'
SET PROPERTIES (DATATYPE,PRECISION,SCALE) VALUES ('NUMBER',10,2)
ADD MEASURE 'QUANTITY'
SET PROPERTIES (DATATYPE) VALUES ('NUMBER')
ADD MEASURE 'COST'
SET PROPERTIES (DATATYPE,PRECISION,SCALE) VALUES ('NUMBER',10,2)
ADD DIMENSION_USE 'CHANNELS'
SET REF LEVEL 'CHANNEL' OF DIMENSION 'CHANNELS'
See Also
OMBCREATE, OMBALTER CUBE, OMBRETRIEVE CUBE, OMBDROP CUBE
Purpose
Create a data auditor in an Oracle Module.
Prerequisites
1. The current context of scripting must be an Oracle Module.
2. No concurrent user should be locking the Oracle Module or any of its
ancestors exclusively at the moment the map is being created.
3. The data auditor name must not conflict with existing data auditor
names, map names and the maps names that concurrent user tries to use.
Syntax
createDataAuditorCommand = OMBCREATE DATA_AUDITOR "dataAuditorName" [ SET
( ( "setPropertiesClause" [ SET "setReferenceIconSetClause" ] ) |
"setReferenceIconSetClause" ) ] { ADD "addOperatorClause" }
dataAuditorName = "QUOTED_STRING"
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addOperatorClause = "operatorType" OPERATOR "operatorName" [ SET
"setPropertiesClause" ] [ BOUND TO "setBindingClause" ]
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
operatorType = "UNQUOTED_STRING"
operatorName = "QUOTED_STRING"
setBindingClause = "bindableLocator"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
bindableLocator = "bindableType" "bindableName"
bindableType = "UNQUOTED_STRING"
bindableName = "QUOTED_STRING"
Keywords And Parameters
createDataAuditorCommand
Create a data auditor in an Oracle Module.
dataAuditorName
Name of data auditor.
setPropertiesClause
Set the properties of the data auditor.
setReferenceIconSetClause
Set 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'
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.
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 terminating 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 enables 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.
bindableType
Type of object bound to an operator.
bindableName
Name of the object bound to operator.
Examples
OMBCREATE DATA_AUDITOR 'MAP1'
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'
See Also
OMBCREATE DATA_AUDITOR, OMBALTER DATA_AUDITOR, OMBRETRIEVE DATA_AUDITOR, OMBDROP DATA_AUDITOR
Purpose
createDataProfileCommandPurposeTag??
Prerequisites
Should be in the context of project.
Syntax
createDataProfileCommand = OMBCREATE ( DATA_PROFILE "QUOTED_STRING" [ SET
( "setPropertiesClause" [ SET "setReferenceClause" ] |
"setReferenceClause" ) ] { ADD ( TABLE | VIEW | EXTERNAL_TABLE |
MATERIALIZED_VIEW | DIMENSION | CUBE | FLAT_FILE ) "QUOTED_STRING" } )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = ( "setReferenceLocationClause" [ SET
"setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createDataProfileCommand
This command creates a Data Profile
QUOTED_STRING
Name of the Data Profile to be created.
setPropertiesClause
Associate a set of properties with a 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.
setReferenceClause
The location where the profile will be deployed.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
setReferenceLocationClause
Set a location to a Data Profile.
setReferenceIconSetClause
Set icon set for the profile.
propertyValue
Value of a property.
Examples
OMBCREATE DATA_PROFILE 'HR_DP' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME)
VALUES ('This is a Data Profile', 'data profile') \
ADD TABLE 'HR/EMPLOYEES' \
ADD TABLE 'HR/DEPARTMENTS' \
ADD TABLE 'HR/REGIONS' \
ADD TABLE 'HR/LOCATIONS' \
ADD TABLE 'HR/JOBS' \
ADD TABLE 'HR/JOB_HISTORY' \
ADD TABLE 'HR/COUNTRIES'
This will create a Data Profile named "data_profile", with a description of
"this is a Data Profile", business name of "data_profile" and all the
tables in the Oracle supplied schema HR.
See Also
OMBCREATE, OMBALTER DATA_PROFILE, OMBDROP DATA_PROFILE
Purpose
Create a DataRule rule in an dataRule rule Module.
Prerequisites
1. The current context of scripting must be an DataRule Rule Module.
2. No concurrent user should be locking the DataRule Rule Module or any of
its ancestors exclusively at the moment the rule is being created.
3. The rule name must not conflict with existing rule names.
Syntax
createDataRuleCommand = OMBCREATE ( DATA_RULE "QUOTED_STRING" [ SET (
"setInitialPropertiesClause" [ SET "setReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) ] [ ADD "addDomainValueClause" ] )
setInitialPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES
"(" "propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addDomainValueClause = ( DOMAIN_VALUE "QUOTED_STRING" )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createDataRuleCommand
Create a data rule.
QUOTED_STRING
Data rule name.
setInitialPropertiesClause
Set properties associated with the created data rule. The property
RULE_TYPE must be set.
setReferenceIconSetClause
Set icon set for the data rule.
addDomainValueClause
Add a domain value.
QUOTED_STRING
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.
Examples
OMBCREATE DATA_RULE 'NOT_NULL'
SET PROPERTIES(RULE_TYPE)
VALUES('ATTR_VALUE_RULE')
The data rule will be created with the appropriate groups and attributes
for the specific rule type.
Rule types Group Name Attribute Name
ATTR_VALUE_RULE THIS VALUE
DOMAIN_NO_NULL_RULE THIS NO_NULL_VALUE
DOMAIN_LIST_RULE THIS VALUE
DOMAIN_PATTERN_LIST_RULE THIS VALUE
DOMAIN_RANGE_RULE THIS VALUE
DOMAIN_FORMAT_TELEPHONE_RULE THIS PHONE_NUMBER
DOMAIN_FORMAT_IP_RULE THIS IP_ADDRESS
DOMAIN_FORMAT_SSN_RULE THIS SOCIAL_SECURITY_NUMBER
DOMAIN_FORMAT_DATE_RULE THIS DATE_VALUE
DOMAIN_FORMAT_NUMBER_RULE THIS NUMBER_VALUE
DOMAIN_FORMAT_URL_RULE THIS URL
DOMAIN_FORMAT_EMAIL_RULE THIS EMAIL
FUNCTIONAL_DEP_RULE DEPENDENCY DEPENDENCY
: DETERMINANTS DETERMINANT_1
IDENTITY_RULE THIS KEY_ATTRIBUTE_1
REFERENCE_RULE LOCAL LOCAL_KEY_ATTRIBUTE_1
: REMOTE REMOTE_KEY_ATTRIBUTE_1
NAMEADDRESS_RULE THIS NA_LINE1
: NA_LINE2
: NA_LINE3
: NA_LINE4
: NA_LINE5
: NA_LINE6
: NA_LINE7
: NA_LINE8
: NA_LINE9
: NA_LINE10
: NA_FIRSTNAME
: NA_MIDDLENAME
: NA_MIDDLENAME2
: NA_MIDDLENAME3
: NA_LASTNAME
: NA_FIRSTPARTNAME
: NA_LASTPARTNAME
: NA_PRENAME
: NA_POSTNAME
: NA_PERSON
: NA_PERSON2
: NA_PERSON3
: NA_FIRMNAME
: NA_PRIMARYADDRESS
: NA_SECONDARYADDRESS
: NA_ADDRESS
: NA_ADDRESS2
: NA_NEIGHBORHOOD
: NA_LASTLINE
: NA_LASTLINE_2
: NA_CITY
: NA_LOCALITYNAME
: NA_LOCALITY_2
: NA_LOCALITY_3
: NA_LOCALITY_4
: NA_STATE
: NA_POSTALCODE
: NA_COUNTRYNAME
: NA_COUNTRYCODE
/
See Also
OMBCREATE, OMBALTER DATA_RULE, OMBDROP DATA_RULE
Purpose
To create a data rule module.
Prerequisites
Should be in the context of project.
Syntax
createDataRuleModuleCommand = OMBCREATE ( DATA_RULE_MODULE "QUOTED_STRING"
( [ SET ( "setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) ] ) )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createDataRuleModuleCommand
Create data rule module.
QUOTED_STRING
Data rule module name.
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.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
propertyValue
Value of a property.
Examples
OMBCREATE DATA_RULE_MODULE 'br_mod' SET PROPERTIES (DESCRIPTION,
BUSINESS_NAME) VALUES ('this is a data rule module', 'br module')
This will create a data rule module named "br_module", its description is
"this is a data rule module", and data name is "br module".
See Also
OMBCREATE, OMBALTER DATA_RULE_MODULE, OMBDROP DATA_RULE_MODULE
Purpose
To create a Deployment.
Prerequisites
Should be in the context of CONFIGURATION.
Syntax
createDeploymentCommand = OMBCREATE ( DEPLOYMENT "QUOTED_STRING" [ SET
"setPropertiesClause" ] [ "setReferenceControlCenterClause" ] [
"setAsActiveClause" ] )
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
createDeploymentCommand
This command creates a Deployment.
setPropertiesClause
Associate a set of properties with a 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
Sets the reference of a Control Center to the created Deployment.
setAsActiveClause
Sets 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.
Examples
OMBCREATE DEPLOYMENT 'QA_DEPLOYMENT' SET REF CONTROL_CENTER 'QA_CC' SET
PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This is a Deployment of
the QA_CONFIG Configuration of QA_CC Control Center', 'QA Deployment') SET
AS ACTIVE
This will create a Deployment named "QA_DEPLOYMENT", set the reference of
a control center "QA_CC", set this Deployment as active; the Deployment
description is "This is a Deployment of the QA_CONFIG Configuration of
QA_CC Control Center", and business name is "QA Deployment".
See Also
OMBCREATE, OMBALTER DEPLOYMENT, OMBDROP DEPLOYMENT
Purpose
Create a deployment action plan.
Prerequisites
There must be a current working project.
Syntax
CreateActionPlanCommand = ( OMBCREATE TRANSIENT ( ( DEPLOYMENT_ACTION_PLAN
| ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" { "addActionClause" }
)
addActionClause = ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
setClause = ( "propertiesClause" [ SET "setReferenceClause" ] ) |
"setReferenceClause"
propertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClause = ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
"useClause" }
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
CreateActionPlanCommand
Create a deployment action plan.
QUOTED_STRING
Name of the action plan in a single-quoted string. It is case-insensitive.
Must be unique within a project.
addActionClause
Add an action to an action plan.
QUOTED_STRING
Name of the action in a single-quoted string. It is case-insensitive.
Must be unquie within an action plan.
setClause
Set the properties of an action and/or associate 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 (for example
'/MY_PROJECT/MODULE_X/TABLE_Y').
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.
Examples
OMBCREATE TRANSIENT DEPLOYMENT_ACTION_PLAN 'MY_PLAN'
OMBCREATE TRANSIENT DEPLOYMENT_ACTION_PLAN 'MY_PLAN' ADD ACTION 'DUMMY'
OMBCREATE TRANSIENT DEPLOYMENT_ACTION_PLAN 'MY_PLAN'
ADD ACTION 'MY_TABLE_DEPLOY' SET PROPERTIES (OPERATION) VALUES ('DROP')
SET REFERENCE TABLE '/MY_PROJECT/MY_MODULE/MY_TABLE'
ADD ACTION 'MY_VIEW_CREATE' SET PROPERTIES (OPERATION) VALUES ('CREATE')
SET REFERENCE VIEW 'MY_MODULE/MY_VIEW'
OMBCREATE TRANSIENT DEPLOYMENT_ACTION_PLAN 'MY_PLAN'
ADD ACTION 'MY_SCHEDULE_MAP_DEPLOY' SET PROPERTIES (OPERATION) VALUES
('CREATE')
SET REFERENCE SCHEDULABLE 'MY_MODULE/MY_MAP'
Purpose
This command creates a dimension.
Prerequisites
Should be in Oracle Module context.
Syntax
createDimensionCommand = OMBCREATE DIMENSION "dimensionName" [
"setPropertiesClause" ] [ "setReferenceIconSetClause" ] [
"setDimensionKeySequenceClause" ] [ ADD
"addSurrogateKeyDimensionAttributeClause" ] [ ADD
"addParentKeyDimensionAttributeClause" ] { ADD (
"addDimensionAttributeClause" | "addDimensionRoleClause" |
"addLevelClause" | "addLevelAttributeClause" | "addHierarchyClause" |
"addSkipLevelsClause" ) } [ "createDimensionBindingClause" ]
dimensionName = "QUOTED_STRING"
setPropertiesClause = SET PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = SET ( REFERENCE | REF ) ICONSET
"QUOTED_STRING"
setDimensionKeySequenceClause = SET ( REF | REFERENCE ) SEQUENCE
"sequenceName"
addSurrogateKeyDimensionAttributeClause = DIMENSION_ATTRIBUTE
"dimensionAttributeName" SET AS SURROGATE_KEY [ "setPropertiesClause"
]
addParentKeyDimensionAttributeClause = DIMENSION_ATTRIBUTE
"dimensionAttributeName" SET AS PARENT_KEY [ "setPropertiesClause" ]
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"
createDimensionBindingClause = IMPLEMENTED BY ( SYSTEM ( STAR | SNOWFLAKE
) | STAR ( ( DIMENSION_KEY BOUND TO COLUMN "columnName" (
"levelBindingClause" { "levelAttributeBindingClause" } )+ {
"setBindRelationshipClause" } [ "setSkipBindRelationshipClause" ] ) )
| SNOWFLAKE ( ( ( "levelBindingClause" { "levelAttributeBindingClause"
} )+ { "setBindRelationshipClause" } [
"setSkipBindRelationshipClause" ] ) ) )
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
sequenceName = "QUOTED_STRING"
dimensionAttributeName = "QUOTED_STRING"
roleName = "QUOTED_STRING"
levelName = "QUOTED_STRING"
levelAttributeName = "QUOTED_STRING"
levelLocator = LEVEL "levelName"
setLevelAttributeReferenceClause = SET ( REF | REFERENCE ) (
"dimensionAttributeLocator" [ TYPE_THREE_SCD_PREVIOUS
"levelAttributeLocator" ] )
hierarchyName = "QUOTED_STRING"
hierarchyLevelReferenceClause = SET ( REF | REFERENCE ) LEVELS "("
"levelName" { "," "levelName" } ")"
hierarchyLocator = HIERARCHY "hierarchyName"
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" )
dimensionAttributeLocator = DIMENSION_ATTRIBUTE "dimensionAttributeName"
levelAttributeLocator = LEVEL_ATTRIBUTE "levelAttributeName"
tableName = "QUOTED_STRING"
viewName = "QUOTED_STRING"
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
Examples
OMBCREATE SEQUENCE 'PRODUCT_STAR_SEQ'
OMBCREATE DIMENSION 'PRODUCTS'
SET PROPERTIES (BUSINESS_NAME, DESCRIPTION)
VALUES ('products','this is a products dimension')
SET REF SEQUENCE 'PRODUCT_STAR_SEQ'
ADD DIMENSION_ATTRIBUTE 'ID' SET AS SURROGATE_KEY
ADD DIMENSION_ATTRIBUTE 'NAME'
SET PROPERTIES (DATATYPE,LENGTH,DESCRIPTOR)
VALUES ('VARCHAR2',60,'SHORT_DESCRIPTION')
ADD DIMENSION_ATTRIBUTE 'DESCRIPTION'
SET PROPERTIES (DATATYPE,LENGTH,DESCRIPTOR)
VALUES ('VARCHAR2',100,'LONG_DESCRIPTION')
ADD DIMENSION_ATTRIBUTE 'SOURCE_ID'
SET PROPERTIES (DATATYPE) VALUES ('NUMBER')
ADD DIMENSION_ATTRIBUTE 'PACK_SIZE'
SET PROPERTIES (DATATYPE,LENGTH) VALUES ('VARCHAR2',30)
ADD DIMENSION_ATTRIBUTE 'LIST_PRICE'
SET PROPERTIES (DATATYPE,LENGTH) VALUES ('VARCHAR2',10)
ADD DIMENSION_ATTRIBUTE 'DATE_UPDATED'
SET PROPERTIES (DATATYPE,LENGTH) VALUES ('VARCHAR2',10)
ADD DIMENSION_ATTRIBUTE 'SUPPLIER_ID'
SET PROPERTIES (DATATYPE) VALUES ('NUMBER')
ADD LEVEL 'PRODUCT'
ADD LEVEL 'SUBCATEGORY'
ADD LEVEL 'CATEGORY'
ADD LEVEL 'TOTAL'
ADD LEVEL_ATTRIBUTE 'ID' OF LEVEL 'PRODUCT'
SET REF DIMENSION_ATTRIBUTE 'ID'
ADD LEVEL_ATTRIBUTE 'NAME' OF LEVEL 'PRODUCT'
SET REF DIMENSION_ATTRIBUTE 'NAME'
ADD LEVEL_ATTRIBUTE 'DESCRIPTION' OF LEVEL 'PRODUCT'
SET REF DIMENSION_ATTRIBUTE 'DESCRIPTION'
ADD LEVEL_ATTRIBUTE 'SOURCE_ID' OF LEVEL 'PRODUCT'
SET REF DIMENSION_ATTRIBUTE 'SOURCE_ID'
ADD LEVEL_ATTRIBUTE 'PACK_SIZE' OF LEVEL 'PRODUCT'
SET REF DIMENSION_ATTRIBUTE 'PACK_SIZE'
ADD LEVEL_ATTRIBUTE 'LIST_PRICE' OF LEVEL 'PRODUCT'
SET REF DIMENSION_ATTRIBUTE 'LIST_PRICE'
ADD LEVEL_ATTRIBUTE 'SUPPLIER_ID' OF LEVEL 'PRODUCT'
SET REF DIMENSION_ATTRIBUTE 'SUPPLIER_ID'
ADD LEVEL_ATTRIBUTE 'DATE_UPDATED' OF LEVEL 'PRODUCT'
SET REF DIMENSION_ATTRIBUTE 'DATE_UPDATED'
ADD LEVEL_ATTRIBUTE 'ID' OF LEVEL 'SUBCATEGORY'
SET REF DIMENSION_ATTRIBUTE 'ID'
ADD LEVEL_ATTRIBUTE 'NAME' OF LEVEL 'SUBCATEGORY'
SET REF DIMENSION_ATTRIBUTE 'NAME'
ADD LEVEL_ATTRIBUTE 'DESCRIPTION' OF LEVEL 'SUBCATEGORY'
SET REF DIMENSION_ATTRIBUTE 'DESCRIPTION'
ADD LEVEL_ATTRIBUTE 'SOURCE_ID' OF LEVEL 'SUBCATEGORY'
SET REF DIMENSION_ATTRIBUTE 'SOURCE_ID'
ADD LEVEL_ATTRIBUTE 'ID' OF LEVEL 'CATEGORY'
SET REF DIMENSION_ATTRIBUTE 'ID'
ADD LEVEL_ATTRIBUTE 'NAME' OF LEVEL 'CATEGORY'
SET REF DIMENSION_ATTRIBUTE 'NAME'
ADD LEVEL_ATTRIBUTE 'DESCRIPTION' OF LEVEL 'CATEGORY'
SET REF DIMENSION_ATTRIBUTE 'DESCRIPTION'
ADD LEVEL_ATTRIBUTE 'SOURCE_ID' OF LEVEL 'CATEGORY'
SET REF DIMENSION_ATTRIBUTE 'SOURCE_ID'
ADD LEVEL_ATTRIBUTE 'ID' OF LEVEL 'TOTAL'
SET REF DIMENSION_ATTRIBUTE 'ID'
ADD LEVEL_ATTRIBUTE 'NAME' OF LEVEL 'TOTAL'
SET REF DIMENSION_ATTRIBUTE 'NAME'
ADD LEVEL_ATTRIBUTE 'DESCRIPTION' OF LEVEL 'TOTAL'
SET REF DIMENSION_ATTRIBUTE 'DESCRIPTION'
ADD HIERARCHY 'PROD_STD'
SET REF LEVELS ('TOTAL','CATEGORY','SUBCATEGORY','PRODUCT')
IMPLEMENTED BY SYSTEM STAR
See Also
OMBCREATE, OMBALTER DIMENSION, OMBRETRIEVE DIMENSION, OMBDROP DIMENSION
Purpose
Creates a Drill path to enable drilling to detail.
Prerequisites
Should be in the context of a Business Definition Module.
Syntax
createDrillPathCommand = OMBCREATE DRILL_PATH "QUOTED_STRING" [ SET
"setPropertiesClause" ] [ SET "setReferenceIconSetClause" ] {
"DrillLevelClause" }
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
DrillLevelClause = ADD DRILL_LEVEL "QUOTED_STRING" [ SET
"setPropertiesClause" ] { "setDrillItemClause" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setDrillItemClause = SET ( REF | REFERENCE ) ITEM "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING" "itemJoinUsages"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
itemJoinUsages = { SET ( REF | REFERENCE ) USING JOIN "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING" }
Keywords And Parameters
createDrillPathCommand
This command creates a drill path.
QUOTED_STRING
Specify the name of the drill path to be created.
setPropertiesClause
Used to set properties (core, logical, physical, user-defined) for drill
paths. Valid properties are as shown:
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.
DrillLevelClause
This clause adds a drill level to a drill path.
DRILL_LEVEL
A level in a drill path.
propertyNameList
This is the list of property names.
propertyValueList
This is the list of property values.
setDrillItemClause
This clause adds a reference to an item for the level.
propertyValue
This is a property value.
itemJoinUsages
The specific joins to be used.
Examples
OMBCREATE DRILL_PATH 'SALES'
See Also
OMBALTER DRILL_PATH, OMBRETRIEVE DRILL_PATH
Purpose
Creates a Drill to detail to allow drilling between items.
Prerequisites
Should be in the context of a Business Definition Module.
Syntax
createDrillToDetailCommand = OMBCREATE DRILL_TO_DETAIL "QUOTED_STRING" [
SET "setPropertiesClause" ] [ SET "setReferenceIconSetClause" ] {
"addDrillToDetailReferenceClause" }
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addDrillToDetailReferenceClause = SET ( REF | REFERENCE ) ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createDrillToDetailCommand
This command creates a drill to detail.
QUOTED_STRING
Specify the name of the drill to detail to be created.
setPropertiesClause
Used to set properties (core, logical, physical, user-defined) for a drill
to detail. Valid properties are as shown:
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.
addDrillToDetailReferenceClause
This adds a reference to an item to a drill to detail.
propertyNameList
This is the list of property names.
propertyValueList
This is the list of property values.
propertyValue
This is a property value.
Examples
OMBCREATE DRILL_TO_DETAIL 'SALES_ITEM'
See Also
OMBALTER DRILL_TO_DETAIL, OMBRETRIEVE DRILL_TO_DETAIL
Purpose
To create an expert.
Prerequisites
In the context of an expert module.
Syntax
createExpertCommand = OMBCREATE EXPERT "QUOTED_STRING" [ SET (
"setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) ] { "addExpertDetailClauses" }
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addExpertDetailClauses = ADD ( "addParameterClause" | "addVariableClause"
| "addNestedExpertClause" | "addTaskClause" | "addTransitionClause" )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addParameterClause = PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
[ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
addVariableClause = VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
addNestedExpertClause = NESTED_EXPERT TASK "QUOTED_STRING" SET [
"collectPropertiesClause" SET ] ( REF | REFERENCE ) EXPERT
"QUOTED_STRING" [ SET "setReferenceIconSetClause" ]
addTaskClause = "TASK_TYPE" TASK "QUOTED_STRING" [ SET (
"setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) ]
addTransitionClause = TRANSITION "QUOTED_STRING" FROM TASK "QUOTED_STRING"
TO "QUOTED_STRING" [ SET "setPropertiesClause" ]
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
parameterBindingClause = UNBIND | BIND TO ( "parameterLocator" |
"variableLocator" )
collectPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
parameterLocator = PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
variableLocator = VARIABLE "QUOTED_STRING"
Keywords And Parameters
createExpertCommand
Creates an expert. The following expert parameters will be created by
default:
1) EXP_LAUNCH_CONTEXT, type: STRING, direction: IN
The console context in which this expert is being launched.
2) EXP_LAUNCH_CONTEXT_TYPE, type: STRING, direction: IN
The type of the console context in which this expert is being launched.
3) EXP_OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) EXP_TYPE_TO_CREATE, type: STRING, direction: IN
The object type selected to be created when this expert is launched.
setPropertiesClause
This clause sets properties for the corresponding object.
Basic properties for EXPERT:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the expert
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the expert
Basic properties for TASK:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the task
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the task. This is equivalent to the Goal of task in the
expert editor.
Name: INSTRUCTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
The instruction for the task
Name: PREPROCESSING
Type: STRING
Valid Values: N/A
Default: N/A
The pre-processing script for the task
Name: MAIN
Type: STRING
Valid Values: N/A
Default: N/A
The main script for the task
Name: POSTPROCESSING
Type: STRING
Valid Values: N/A
Default: N/A
The post-processing script for the task
Basic propeties for START TASK:
Name: PROC_DECL
Type: STRING(4000)
Valid Values: N/A
Default: ''
The procedure declaration for the expert.
Basic properties for TRANSITION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the transition
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the transition
Name: TRANSITION_CONDITION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Condition of the transition
Name: TRANSITION_ORDER
Type: NUMBER
Valid Values: N/A
Default: N/A
Order of the transition
Basic properties for PARAMETER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the parameter
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the parameter
Name: DATATYPE
Type: STRING
Valid Values: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the parameter
Name: DIRECTION
Type: STRING
Valid Values: IN, OUT, INOUT
Default: IN
Direction of the parameter
Name: VALUE
Type: Same as datatype of the parameter
Valid Values: N/A
Default: N/A
The static value of the parameter
Basic properties for VARIABLE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the variable
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the variable
Name: DATATYPE
Type: STRING
Valid Values: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the variable
Name: VALUE
Type: Same as datatype of the variable
Valid Values: N/A
Default: N/A
The static value of the variable
Properties for EXPERT:
Name: CLOSE_ASSISTANT_ON_COMPLETION
Type: BOOLEAN
Valid Values: true, false
Default: true
Sets whether the task assistant should be automatically closed after the
expert has been run.
Name: CLOSE_WINDOWS_ON_EXECUTION
Type: BOOLEAN
Valid Values: true, false
Default: true
Close all open windows when this expert is run.
Name: FINISH_DIALOG_ON_COMPLETION
Type: BOOLEAN
Valid Values: true, false
Default: true
Shows the finish dialog upon completion of expert.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: LOGGING
Type: BOOLEAN
Valid Values: true, false
Default: false
Log output to file when this expert is being run. A log file will be
created in <shiphome>/owb/log directory whenever this expert is run.
Name: MENU_ITEM_DISPLAY_STRING
Type: STRING
Valid Values: N/A
Default: ''
The display string when this expert is added as a menu item.
Name: ONLY_RUN_FROM_MENU
Type: BOOLEAN
Valid Values: true, false
Default: false
Only allow this expert to be run when it is attached to a menu item.
Name: REVERT_TO_SAVED_ON_ERROR
Type: BOOLEAN
Valid Values: true, false
Default: false
Revert to saved metadata if error occurs when the expert is run.
Name: RUN_STANDALONE
Type: BOOLEAN
Valid Values: true, false
Default: true
Sets whether the expert should be run as a standalone in expert assistant
mode or not.
Name: SAVE_ALL_BEFORE_START
Type: BOOLEAN
Valid Values: true, false
Default: false
Save all metadata before running the expert.
Name: SHOW_BUSY_DIALOG
Type: BOOLEAN
Valid Values: true, false
Default: true
Sets whether busy dialog should be shown when OMB or Java tasks are
executed in non-standalone mode.
Name: SHOW_LOG_WINDOW
Type: BOOLEAN
Valid Values: true, false
Default: false
Sets whether the log window should be shown when running the expert.
Name: SHOW_PROGRESS_GRAPH
Type: BOOLEAN
Valid Values: true, false
Default: true
Sets whether the progress graph dialog should be shown when running the
expert.
Name: SHOW_TASK_ASSISTANT
Type: BOOLEAN
Valid Values: true, false
Default: true
Sets whether the task assistant should be shown when running the expert.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceIconSetClause
Set icon set for the expert module.
addExpertDetailClauses
Add child objects for the expert.
propertyNameList
The list of property names.
propertyValueList
The list of property values being set.
addParameterClause
Add a parameter to the expert or one of it's tasks.
addVariableClause
Add a variable to the expert.
addNestedExpertClause
Add a nested expert to the expert. The nested expert is added by
reference.
addTaskClause
Add a task to the expert. Valid task types include: ADVANCED_QUEUE,
ALTERNATIVE_SORT_ORDER, ANALYZE_IMPACT, ANALYZE_LINEAGE, BUSINESS_AREA,
CHANGE_MANAGER, COMMIT, CONTROLCENTERJOBS, CUBE, CUSTOM_DIALOG,
DATA_AUDITOR, DATA_PROFILE, DATA_RULE, DATA_VIEWER, DEPLOY, DERIVATION,
DIMENSION, DRILL_PATH, DRILL_TO_DETAIL, END, EXTERNAL_TABLE, FLAT_FILE,
FUNCTION, GENERATION, ITEM_FOLDER, JAVA, LIST_OF_VALUES, MAPPING,
MATERIALIZED_VIEW, NESTED_EXPERT, OBJECT_SELECTOR, OMB, PLUGGABLE_MAPPING,
PRESENTATION_TEMPLATE, PROCEDURE, PROCESS_FLOW, REGISTERED_FUNCTION,
SELECT_SOURCE, SELECT_TARGET, SEQUENCE, SOURCE_IMPORT, START, STARTJOB,
TABLE, VALIDATION, VIEW.
Definition of each task is as follow:
Task type : ADVANCED_QUEUE
Group : MML
Description: A task to create or alter an advanced queue.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : ALTERNATIVE_SORT_ORDER
Group : MML
Description: A task to create or alter an alternative sort order.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : ANALYZE_IMPACT
Group : Service
Description: A task to analyze impact of an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object for analyzing impact.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object whose impact will be analyzed.
Task type : ANALYZE_LINEAGE
Group : Service
Description: A task to analyze lineage of an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object for analyzing lineage.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object whose lineage will be analyzed.
Task type : BUSINESS_AREA
Group : MML
Description: A task to create or alter a business area.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : CHANGE_MANAGER
Group : Service
Description: A task to invoke the change manager.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : COMMIT
Group : Service
Description: A task to perform commit in the design repository.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
Task type : CONTROLCENTERJOBS
Group : Service
Description: A task to launch the Control Center Job Monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) CONTROL_CENTER_NAME, type: STRING, direction: IN
The Control Center to use.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : CUBE
Group : MML
Description: A task to create or alter a cube.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : CUSTOM_DIALOG
Group : UI
Description: A task to show a custom dialog for user interaction.
Built-in parameters:
1) GUI_RETURN_VALUE, type: ARRAY, direction: OUT
The return value of type ARRAY that stores the name and return value pair
for each UI component.
2) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
3) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
Task type : DATA_AUDITOR
Group : MML
Description: A task to create or alter a data auditor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : DATA_PROFILE
Group : MML
Description: A task to create or alter a data profile.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : DATA_RULE
Group : MML
Description: A task to create or alter a data rule.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : DATA_VIEWER
Group : Service
Description: A task to launch the data viewer.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of the OWB FCO, such as TABLE.
4) OBJECT_NAME, type: STRING, direction: IN
The name of the OWB FCO.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : DEPLOY
Group : Service
Description: A task to launch the Control Center deployment monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) ACTION_PLAN_NAME, type: STRING, direction: IN
The deployment action plan to use.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : DERIVATION
Group : Service
Description: A task to run derivation service.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to derive.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be derived.
Task type : DIMENSION
Group : MML
Description: A task to create or alter a dimension.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : DRILL_PATH
Group : MML
Description: A task to create or alter a drill path.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : DRILL_TO_DETAIL
Group : MML
Description: A task to create or alter a drill to detail.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : END
Group : FlowControl
Description: A task that marks the end of the flow.
Built-in parameters:
Task type : EXTERNAL_TABLE
Group : MML
Description: A task to create or alter an external table.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : FLAT_FILE
Group : MML
Description: A task to create or alter a file.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : FUNCTION
Group : MML
Description: A task to create or alter a function.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : GENERATION
Group : Service
Description: A task to invoke the generation dialog.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to generate.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be generated.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : ITEM_FOLDER
Group : MML
Description: A task to create or alter an item folder.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : JAVA
Group : Integration
Description: A task to execute a Java program.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) CLASS_URL, type: STRING, direction: IN
The URL specification of the Jar file. An example for a local jar file
xyz.jar can be specified as file:/xyz.jar
4) CLASS_NAME, type: STRING, direction: IN
The class to load. This includes the package as well in dotted notation.
For example, oracle.owb.Test
5) METHOD_NAME, type: STRING, direction: IN
The static method to execute.
6) ARGUMENT_LIST, type: STRING, direction: IN
The argument list to be passed into the static method.
Task type : LIST_OF_VALUES
Group : MML
Description: A task to create or alter a list of values.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : MAPPING
Group : MML
Description: A task to create or alter a mapping.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : MATERIALIZED_VIEW
Group : MML
Description: A task to create or alter a materialized view.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : NESTED_EXPERT
Group : FlowControl
Description: A task that references another expert.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
Task type : OBJECT_SELECTOR
Group : UI
Description: A task that shows a dialog for user to select an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) OBJECT_TYPE, type: STRING, direction: IN
The type of object for selection.
Task type : OMB
Group : Integration
Description: A task to launch a generic OMB script.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
Task type : PLUGGABLE_MAPPING
Group : MML
Description: A task to create or alter a pluggable mapping.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : PRESENTATION_TEMPLATE
Group : MML
Description: A task to create or alter a presentation template.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : PROCEDURE
Group : MML
Description: A task to create or alter a procedure.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : PROCESS_FLOW
Group : MML
Description: A task to create or alter a process flow.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : REGISTERED_FUNCTION
Group : MML
Description: A task to create or alter a registered function.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : SELECT_SOURCE
Group : UI
Description: A task that allows users to pick a metadata source.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) MODULE_NAME, type: STRING, direction: OUT
The name of the module.
5) LOCATION_NAME, type: STRING, direction: OUT
The name of the location.
6) OBJECT_TYPE, type: STRING, direction: OUT
The type of object selected as the source.
7) SOURCE_TYPE, type: STRING, direction: INOUT
The type of the source, for example file or database.
Task type : SELECT_TARGET
Group : UI
Description: A task that allows users to pick a target.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) MODULE_NAME, type: STRING, direction: OUT
The name of the module.
5) LOCATION_NAME, type: STRING, direction: OUT
The name of the location.
6) OBJECT_TYPE, type: STRING, direction: OUT
The type of object selected as the target.
7) SOURCE_TYPE, type: STRING, direction: INOUT
The type of the source, for example file or database.
Task type : SEQUENCE
Group : MML
Description: A task to create or alter a sequence.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : SOURCE_IMPORT
Group : Service
Description: A task to invoke the import wizard.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) OBJECT_TYPE, type: STRING, direction: IN
The type of object to import.
5) IMPORT_MODE, type: STRING, direction: IN
The mode for import. Select FULL_MODE for importing multiple objects, or
MINIMAL_MODE for single import.
Task type : START
Group : FlowControl
Description: A task that marks the beginning of the flow.
Built-in parameters:
Task type : STARTJOB
Group : Service
Description: A task to launch the start job monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to be started.
4) OBJECT_PATH, type: STRING, direction: IN
The context path of the object to be started.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : TABLE
Group : MML
Description: A task to create or alter a table.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
Task type : VALIDATION
Group : Service
Description: A task to invoke the validation dialog.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to validate.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be validated.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
Task type : VIEW
Group : MML
Description: A task to create or alter a view.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An
exit code of 0 means the task executed successfully, 1 for error, and -1
for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed. It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is
specified as EDIT.
addTransitionClause
Add a transition to the expert.
propertyValue
Value of a property.
parameterBindingClause
Bind or unbind two parameters. Note that this is setting the binding
attribute of the parameter object and is not necessarily the same as the
direction of data flow. The parameter to be set should be the one whose
binding attribute is modified by the Object Inspector in the expert
editor.
collectPropertiesClause
This clause sets properties for the corresponding object.
parameterLocator
Specify a parameter, either one of the expert or of a task.
variableLocator
Specify a variable in the expert.
Examples
This command will create a simple expert with just a table task between the
START and END task:
OMBCREATE EXPERT 'EXP1' \
SET PROPERTIES (DESCRIPTION) VALUES ('My first expert') \
ADD TABLE TASK 'MY_TABLE_TASK' \
ADD TRANSITION 'X1' FROM TASK 'START_TASK' TO 'MY_TABLE_TASK' \
ADD TRANSITION 'X2' FROM TASK 'MY_TABLE_TASK' TO 'END_TASK'
See Also
OMBCREATE, OMBALTER EXPERT, OMBRETRIEVE EXPERT, OMBDROP EXPERT
Purpose
To create an expert module.
Prerequisites
In the context of a project.
Syntax
createExpertModuleCommand = OMBCREATE EXPERT_MODULE "QUOTED_STRING" [ SET
( "setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) ]
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createExpertModuleCommand
Create an expert module.
setPropertiesClause
Set properties for the expert module.
Basic properties for EXPERT_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the expert module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the expert module
setReferenceIconSetClause
Set icon set for the expert module.
propertyNameList
The list of properties to set.
propertyValueList
The list of property values to set.
propertyValue
The value of the property.
Examples
This command will create an expert module with name 'EM1':
OMBCREATE EXPERT_MODULE 'EM1'
See Also
OMBCREATE, OMBALTER EXPERT_MODULE, OMBDROP EXPERT_MODULE
Purpose
To create an external table.
Prerequisites
Should be in the context of an Oracle Module.
Syntax
createExternalTableCommand = OMBCREATE ( EXTERNAL_TABLE "QUOTED_STRING" [
SET "setPropertiesAndReferencesClauses" ] [
"addExternalTableSCOClauses" ] )
setPropertiesAndReferencesClauses = "setPropertiesClause" [ SET ( REF |
REFERENCE ) "setReferencesToRecordAndLocationClauses" ] | ( REF |
REFERENCE ) "setReferencesToRecordAndLocationClauses"
addExternalTableSCOClauses = ADD ( "addExternalTableColumnClause" [
"addExternalTableSCOClauses" ] | "addExternalTableDatafileClause" {
ADD "addExternalTableDatafileClause" } )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferencesToRecordAndLocationClauses =
"setReferencesToRecordFileModuleClause" [
"setReferencesToLocationClause" ] [ SET ( REF | REFERENCE )
"setReferenceIconSetClause" ] | "setReferencesToFileAndModuleClause" [
"setReferencesToLocationClause" ] [ SET ( REF | REFERENCE )
"setReferenceIconSetClause" ] | "setReferencesToLocationClause" [ SET
( REF | REFERENCE ) "setReferenceIconSetClause" ] |
"setReferenceIconSetClause"
addExternalTableColumnClause = COLUMN "QUOTED_STRING" [ SET
"setPropertiesAndReferencesToFieldClauses" ]
addExternalTableDatafileClause = DATA_FILE "QUOTED_STRING" [ SET
"setPropertiesClause" ]
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferencesToRecordFileModuleClause = RECORD "QUOTED_STRING" OF
FLAT_FILE "QUOTED_STRING"
setReferencesToLocationClause = DEFAULT_LOCATION "QUOTED_STRING"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
setReferencesToFileAndModuleClause = FLAT_FILE "QUOTED_STRING"
setPropertiesAndReferencesToFieldClauses = "setPropertiesClause" [ SET (
REF | REFERENCE ) "setReferencesToFieldClause" ] | ( REF | REFERENCE )
"setReferencesToFieldClause"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setReferencesToFieldClause = FIELD "QUOTED_STRING"
Keywords And Parameters
createExternalTableCommand
Create a new external table.
QUOTED_STRING
The name of the new external table.
setPropertiesAndReferencesClauses
Set the properties and/or flat file reference of the external table.
addExternalTableSCOClauses
Add columns and/or data files to the external table.
setPropertiesClause
Set specified properties of the external table.
setReferencesToRecordAndLocationClauses
Set the referenced record and/or default location.
addExternalTableColumnClause
Add an external table column.
addExternalTableDatafileClause
Add a data file to the external table.
propertyNameList
The names of the properties whose values you want to set.
Basic properties for COLUMN:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the column
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the column
Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE,
TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2
Default: NUMBER
The datatype of a column
Name: LENGTH
Type: NUMBER
Valid Values:
Default: 1
The length of a number
Name: PRECISION
Type: NUMBER
Valid Values: 0 - 38
Default: 1
The precision of a number. Use 0 to specify floating-point numbers.
Name: SCALE
Type: NUMBER
Valid Values: -84 - 127
Default: 1
The scale of a number.
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.
Properties for EXTERNAL_TABLE:
Name: BAD_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: USE_DEFAULT_LOCATION
Location to use when creating the bad file. When the Access Parameters
property is specified for the External Table, this configuration parameter
is ignored.
Name: BAD_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name to use when creating the bad file. When the Access Parameters
property is specified for the External Table, this configuration parameter
is ignored.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
When deployable is set to true, a script to create an External Table is
generated.
Name: DISCARD_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: USE_DEFAULT_LOCATION
Location to use when creating the discard file. When the Access Parameters
property is specified for the External Table, this configuration parameter
is ignored.
Name: DISCARD_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name to use when creating the discard file. When the Access Parameters
property is specified for the External Table, this configuration parameter
is ignored.
Name: ENDIAN
Type: STRING
Valid Values: BIG, LITTLE, PLATFORM
Default: PLATFORM
Data endian should be platform default, little or big. When the Access
Parameters property is specified for the External Table, this configuration
parameter is ignored.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: LOAD_NULLS_WHEN_MISSING_VALUES
Type: BOOLEAN
Valid Values: true, false
Default: false
If TRUE, then NULLs are loaded for any missing values in the record. If
FALSE, then records with missing values are rejected. When the Access
Parameters property is specified for the External Table, this configuration
parameter is ignored.
Name: LOG_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: USE_DEFAULT_LOCATION
Location to use when creating the log file. When the Access Parameters
property is specified for the External Table, this configuration parameter
is ignored.
Name: LOG_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name to use when creating the log file. When the Access Parameters
property is specified for the External Table, this configuration parameter
is ignored.
Name: NLS_CHARACTERSET
Type: STRING
Valid Values: N/A
Default: ''
NLS Characterset of the file. When the Access Parameters property is
specified for the External Table, this configuration parameter is ignored.
Name: NUMBER_OF_REJECTS_ALLOWED
Type: NUMBER
Valid Values: 0 - 2147483647
Default: 0
The number of rejects allowed before processing is terminated.
Name: PARALLEL_ACCESS_DRIVERS
Type: NUMBER
Valid Values: 1 - 63999
Default: 1
The number of parallel access drivers to enable.
Name: PARALLEL_ACCESS_MODE
Type: BOOLEAN
Valid Values: true, false
Default: false
Enable or disable parallel processing.
Name: REJECTS_ARE_UNLIMITED
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable or disable limiting the number of rejected records.
Name: SHADOW_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Name: SHADOW_TABLE_NAME
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the shadow table name to specify the name of Shadow Table.
Name: STRING_SIZES_IN
Type: STRING
Valid Values: BYTES, CHARACTERS
Default: BYTES
String sizes are in bytes or characters. When the Access Parameters
property is specified for the External Table, this configuration parameter
is ignored.
Name: TRIM
Type: STRING
Valid Values: BOTH, LEFT, NONE, RIGHT, SQL*LOADER
Default: NONE
Specification from trim option on input fields. When the Access Parameters
property is specified for the External Table, this configuration parameter
is ignored.
Properties for DATA_FILE:
Name: DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: USE_DEFAULT_LOCATION
The location of this data file for the external table.
Name: DATA_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of this data file.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValueList
The values for the named properties.
setReferencesToRecordFileModuleClause
Specify the record and full path to the flat file for the external table to
reference.
setReferencesToLocationClause
The name of the external table's default location.
setReferencesToFileAndModuleClause
Specify the full path to the flat file for the external table to reference.
setPropertiesAndReferencesToFieldClauses
Set the properties and/or field reference of the external table column.
propertyValue
A property value.
setReferencesToFieldClause
Set the name of the field which the external table column references.
Examples
OMBCREATE EXTERNAL_TABLE 'SRC_TABLE' SET REFERENCE RECORD 'REC_1' OF
FLAT_FILE '../SRC_FILES/FILE_1'
This will create an external table named "SRC_TABLE" based upon the record
"REC_1" of flat file "FILE_1" of flat file module "SRC_FILES".
ombcreate_external_table$createExternalTableCommand =
See Also
OMBCREATE, OMBALTER EXTERNAL_TABLE, OMBDROP EXTERNAL_TABLE, OMBRETRIEVE EXTERNAL_TABLE
Purpose
To create a flat file.
Prerequisites
Should be in the context of a flat file module.
Syntax
createFlatFileCommand = OMBCREATE ( FLAT_FILE "QUOTED_STRING" [ SET (
"setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) ] { "addRecordClause" } )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addRecordClause = ADD ( RECORD "QUOTED_STRING" [ SET "setPropertiesClause"
] { "addFieldClause" } )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addFieldClause = ADD FIELD "QUOTED_STRING" [ SET "setPropertiesClause" ]
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createFlatFileCommand
Create a new flat file object.
QUOTED_STRING
The name of the new flat file.
setPropertiesClause
Set the properties of the flat file, record, or field.
addRecordClause
Add a record to the flat file.
QUOTED_STRING
The name of the new record.
propertyNameList
The names of the properties whose values you want to set.
Properties for FLAT_FILE:
Name: DATA_FILE_NAME
Type: STRING
Valid Values: N/A
Default ''
The name of the "sampled" file. Also the default data file value used in
SQL*Loader maps and External Tables.
Name: IS_DELIMITED
Type: BOOLEAN
Valid Values: true, false, 1, 0
Default: true
True indicates that this flat file is delimited. False indicates that its
fields are defined by fixed lengths
Name: CHARACTERSET
Type: STRING
Valid Values:
AL24UTFFSS,AR8ARABICMAC,AR8ARABICMACS,AR8ISO8859P6,AR8MSAWIN,AR8MSWIN1256,BLT8CP921,BLT8EBCDIC1112,BLT8MSWIN1257,BLT8PC775,CDN8PC863,CL8EBCDIC1025,CL8EBCDIC1025X,CL8ISO8859P5,CL8KOI8R,CL8MACCYRILLIC,CL8MACCYRILLICS,CL8MSWIN1251,D8EBCDIC273,DK8EBCDIC277,EE8EBCDIC870,EE8ISO8859P2,EE8MACCE,EE8MACCES,EE8MACCROATIAN,EE8MACCROATIANS,EE8MSWIN1250,EE8PC852,EL8EBCDIC875,EL8ISO8859P7,EL8MACGREEK,EL8MACGREEKS,EL8MSWIN1253,EL8PC437S,EL8PC737,EL8PC869,F8EBCDIC297,I8EBCDIC280,IS8MACICELANDIC,IS8MACICELANDICS,IS8PC861,IW8EBCDIC424,IW8ISO8859P8,IW8MACHEBREW,IW8MACHEBREWS,IW8MSWIN1255,JA16EBCDIC930,JA16EUC,JA16EUCYEN,JA16MACSJIS,JA16SJIS,JA16SJISYEN,JA16VMS,KO16KSC5601,LT8MSWIN921,N8PC865,NEE8ISO8859P4,RU8PC855,RU8PC866,S8EBCDIC278,SE8ISO8859P3,TH8MACTHAI,TH8MACTHAIS,TH8TISASCII,TR8EBCDIC1026,TR8MACTURKISH,TR8MACTURKISHS,TR8MSWIN1254,TR8PC857,US7ASCII,US8PC437,UTF8,WE8EBCDIC284,WE8EBCDIC285,WE8EBCDIC37,WE8EBCDIC37C,WE8EBCDIC500,WE8EBCDIC500C,WE8EBCDIC871,WE8ISO8859P1,WE8ISO8859P9,WE8MACROMAN8,WE8MACROMAN8S,WE8MSWIN1252,WE8PC850,WE8PC860,ZHS16CGB231280,ZHS16GBK,ZHS16MACCGB231280,ZHT16BIG5,ZHT16MSWIN950,ZHT32EUC
Default: WE8MSWIN1252
The character set of the data file.
Name: RECORD_DELIMITER
Type: STRING
Valid Values: N/A
Default: ''
The character(s) which denote the end of a physical record in a data file.
A hex value may be entered by entering embedded single quotes twice as:
'x''0f''' (all are single quotes). The outside single quote indicates a
quoted string and the inside single quotes single-quote x single-quote
single-quote 0F single-quote single-quote single-quote. (Please note
that this is not the FIELD_DELIMITER.
Name: RECORD_LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0 (Records are delimited by default)
The length (in characters) of the records in the data file.
Name: RECORD_TYPE_COLUMN_NUMBER
Type: NUMBER
Valid Values: 0+
Default: 0
The column which contains the record type values for a delimited,
multi-record type file.
Name: RECORD_TYPE_START_POSITION
Type: NUMBER
Valid Values: 0+
Default: 0
The starting position of the field (relative to 0) which contains the
record type values for a fixed-length, multi-record type file.
Name: RECORD_TYPE_END_POSITION
Type: NUMBER
Valid Values: 0+
Default: 0
The ending position of the field (relative to 0) which contains the record
type values for a fixed-length, multi-record type file.
Name: NUMBER_OF_RECORDS_TO_SKIP
Type: NUMBER
Valid Values: 0 - 1000
Default: 0
The default number of records to skip when loading this file.
Name: FIELD_DELIMITER
Type: STRING
Valid Values: Any single character
Default: ',' (Comma)
The character to divide the fields in a delimited file.
Name: FIELD_LEFT_ENCLOSURE
Type: STRING
Valid Values: Any single character
Default: None
A character to enclose fields which may contain the field delimiter.
Name: FIELD_RIGHT_ENCLOSURE
Type: STRING
Valid Values: Any single character
Default: None
A character to enclose fields which may contain the field delimiter.
Name: NUMBER_OF_PHYSICAL_RECORDS_PER_LOGICAL
Type: Number
Valid Values: 0+
Default: 0
Set this value if you wish to concatenate a fixed number of physical
records to form a single logical record.
Name: CONTINUE_IF_ENDS_WITH
Type: STRING
Valid Values: Any single character
Default: None
Set this value if you wish to concatenate a variable number of physical
records to form a single logical record, determined by records ending with
this character.
Name: CONTINUE_IF_STARTS_WITH
Type: STRING
Valid Values: N/A
Default: None
Set this value if you wish to concatenate a variable number of physical
records to form a single logical record, determined by records beginning
with this character.
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the record
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the record
Properties for RECORD:
Name: RECORD_TYPE_VALUE
Type: STRING
Valid Values: N/A
Default: None
This is a mandatory property for each record of a multi-record type file.
It is the string which will identify this record type in the data file.
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the record
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the record
Properties for FIELD:
Name: DATATYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE,
FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER
EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH,
LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH
LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARRAW,
VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
This is the SQL*Loader data type for the field.
Name: MAXIMUM_LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0
This is the maximum length of the field.
Name: LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0
Depreciated. This is the length of the field in a fixed length file. This
is the max length of the field in a delimited file.
Name: PRECISION
Type: NUMBER
Valid Values: Depends on data type
Default: 0
Precision of the field.
Name SCALE
Type: NUMBER
Valid Values: Depends on data type
Default: 0
Scale of the field
Name: START_POSITION
Type: NUMBER
Valid Values: 1+
Default: 1
The starting position of a field for a fixed length file.
Name: END_POSITION
Type: NUMBER
Valid Values: 1+
Default: 1
The ending position of a field for a fixed length file.
Name: SQL_DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE,
TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: DEFAULT. This will derive the SQL_DATATYPE from the value of
DATATYPE.
The data type which the field will be treated as in mapping and for
External Tables.
Name: SQL_LENGTH
Type: NUMBER
Valid Values: 1 - 4000
Default: 0
Name: SQL_PRECISION
Type: NUMBER
Valid Values: 1 - 38
Default: 1
Name: SQL_SCALE
Type: NUMBER
Valid Values: -84 - 127
Default: 0
Name: MASK
Type: STRING
Valid Values: N/A
Default: None
This is the mask used to define the format of DATE fields in the data file.
Name: NULL_IF
Type: STRING
Valid Values: Either = or != followed by either 'BLANKS', a single quoted
string, or a hexadecimal string
Default: None
If this condition is true for a field, the value loaded will be NULL.
Name: DEFAULT_IF
Type: STRING
Valid Values: Either = or != followed by either 'BLANKS', a single quoted
string, or a hexadecimal string
Default: None
If this condition is true for a field, the value loaded will be either NULL
or 0, dependent on data type.
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the field
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the field
propertyValueList
The values for the named properties.
addFieldClause
Add a field to the record.
QUOTED_STRING
The name of the new field.
propertyValue
A property value.
Examples
OMBCREATE FLAT_FILE 'SRC_FILE' \
SET PROPERTIES (DATA_FILE_NAME, FIELD_DELIMITER, FIELD_LEFT_ENCLOSURE,
FIELD_RIGHT_ENCLOSURE, RECORD_TYPE_COLUMN_NUMBER) \
VALUES ('src_data.dat', '|', '{', '}', 1) \
ADD RECORD 'REC1' \
SET PROPERTIES (RECORD_TYPE_VALUE) VALUES ('E') \
ADD FIELD 'F1' \
SET PROPERTIES (DATATYPE, MASK) VALUES ('DATE', 'dd-mon-yyyy') \
ADD FIELD 'F2' \
ADD RECORD 'REC2' \
SET PROPERTIES (RECORD_TYPE_VALUE) VALUES ('P') \
ADD FIELD 'F1' \
ADD FIELD 'F2' \
ADD FIELD 'F3'
This will create a flat file named "SRC_FILE" with multiple record types.
See Also
OMBCREATE, OMBALTER FLAT_FILE, OMBDROP FLAT_FILE
Purpose
To create a flat file module.
Prerequisites
Should be in the context of project.
Syntax
createFlatFileModuleCommand = OMBCREATE ( FLAT_FILE_MODULE "QUOTED_STRING"
[ SET ( "setPropertiesClause" [ SET
"setReferenceClauseForDataMetadataModule" ] |
"setReferenceClauseForDataMetadataModule" ) ] [
"addModuleReferenceLocationClause" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataMetadataModule = ( "setReferenceLocationClause" [
SET "setReferenceMetadataLocationOrIconSetClause" ] |
"setReferenceMetadataLocationOrIconSetClause" )
addModuleReferenceLocationClause = "addReferenceLocationClause" {
"addReferenceLocationClause" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceMetadataLocationOrIconSetClause = (
"setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
] | "setReferenceIconSetClause" )
addReferenceLocationClause = ADD ( 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"
Keywords And Parameters
createFlatFileModuleCommand
Create a new flat file module.
QUOTED_STRING
The name for the new flat file module.
setPropertiesClause
Set specified properties of the new flat file module.
setReferenceClauseForDataMetadataModule
Set location and/or icon set for the new flat file module.
addModuleReferenceLocationClause
Add runtime locations to the new flat file module.
propertyNameList
The names of the properties whose values you want to set.
Basic properties for FLAT_FILE_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of the flat file module.
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the flat file module.
propertyValueList
The values for the named properties.
setReferenceLocationClause
Set a runtime location to the new flat file module.
setReferenceMetadataLocationOrIconSetClause
Set metadata location and/or icon set for the new flat file module.
addReferenceLocationClause
Add a runtime location to the new flat file module.
propertyValue
A property value.
setReferenceMetadataLocationClause
Set metadata location for the new flat file module.
setReferenceIconSetClause
Set icon set for the new flat file module.
Examples
OMBCREATE FLAT_FILE_MODULE 'src_module' SET PROPERTIES (DESCRIPTION,
BUSINESS_NAME) VALUES ('this is a flat file module', 'source module')
This will create a flat file module named "src_module", its description is
"this is a flat file module", and business name is "source module".
See Also
OMBCREATE, OMBALTER FLAT_FILE_MODULE, OMBDROP FLAT_FILE_MODULE
Purpose
To create a Function.
Prerequisites
Should be in the context of a Oracle Module or Package or Transformation
Module.
A Transformation Module may be WB_CUSTOM_TRANS for Public Transformations.
WB_CUSTOM_TRANS may by modified by an administrator.
WB_CUSTOM_TRANS is not dependent on any project.
Syntax
createFunctionCommand = OMBCREATE ( FUNCTION "QUOTED_STRING" ( [ SET (
"setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) ] ) { ADD ( "addFuncProcParameterClause"
| "addRelationalDependentClause" ) } )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addFuncProcParameterClause = PARAMETER "QUOTED_STRING" [ SET
"setPropertiesClause" ]
addRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
"QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createFunctionCommand
This command creates a Function
QUOTED_STRING
Name of the Function to be created.
setPropertiesClause
Used to set properties (core, user-defined) for function. Valid properties
are as shown:
Basic properties for FUNCTION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Function
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Function
Name: RETURN_TYPE
Type: STRING
Valid Values: PLS_INTEGER, BINARY_INTEGER, BOOLEAN, NUMBER, FLOAT, CHAR,
VARCHAR, VARCHAR2, DATE
Default: NUMBER
Set the Return Type for Function
Name: IMPLEMENTATION
Type: STRING
Valid Values: N/A
Default: ''
Set the code for Function which is included global variable declaration and
code between BEGIN and END.
Name: IS_DETERMINISTIC
Type: BOOLEAN
Valid Values: true, false
Default: false
This setting helps the optimizer avoid redundant function calls.
Name: IS_PARALLEL_ENABLE
Type: BOOLEAN
Valid Values: true, false
Default: false
This option sets flag to a stored function can be used safely in the slave
sessions of parallel DML evaluations.
Basic properties for PARAMETER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Parameter
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Parameter
Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BINARY_INTEGER, BLOB, BOOLEAN,
CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO
MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, PLS_INTEGER, RAW, TIMESTAMP,
TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR,
VARCHAR2, XMLTYPE
Default: NUMBER
Set the data type for Parameter
Name: IN_OUT
Type: STRING
Valid Values: IN, OUT, INOUT
Default: 'IN'
Set the parameter mode for Parameter
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Set the default value for Parameter
Properties for FUNCTION:
Name: AUTHID
Type: STRING
Valid Values: Current_User, Definer, None
Default: None
Generate the transformation with selected AUTHID option. Function will be
executed with the permissions defined by the AUTHID clause rather than the
function owner's permissions.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
addFuncProcParameterClause
Adds one or more Parameters to this Function.
addRelationalDependentClause
This clause adds referential dependencies to other relational objects.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
propertyValue
Value of a property.
Examples
OMBCREATE FUNCTION 'func' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME,
RETURN_TYPE, IMPLEMENTATION, IS_DETERMINISTIC, IS_PARALLEL_ENABLE) VALUES
('this is a Function', 'function', 'NUMBER', 'BEGIN RETURN 1 END func \;',
'true', 'true')
ADD PARAMETER 'PARAM_1'
SET PROPERTIES (DESCRIPTION, BUSINESS_NAME, IN_OUT, DATATYPE,
DEFAULT_VALUE) VALUES ('param_1', 'this is a param_1','IN', 'VARCHAR2',
'this is a Varchar2')
ADD PARAMETER 'PARAM_2'
SET PROPERTIES (DESCRIPTION, BUSINESS_NAME, IN_OUT, DATATYPE,
DEFAULT_VALUE) VALUES ('param_2', 'this is a param_2','INOUT', 'DATE',
'this is a Date')
This will create a Function named "func", its description is "this is a
Function", and business name is "function", return datatype NUMBER, and
body of function as 'BEGIN RETURN 1 END func;'. It creates two parameters
'PARAM_1' and 'PARAM_2'
See Also
OMBCREATE, OMBALTER FUNCTION, OMBDROP FUNCTION
Purpose
To create a Gateway module.
Prerequisites
Should be in the context of project.
Syntax
createGatewayModuleCommand = OMBCREATE ( GATEWAY_MODULE "QUOTED_STRING" (
SET "setPropertiesClause" ) [ SET
"setReferenceClauseForDataMetadataModule" ] [
"addModuleReferenceLocationClause" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataMetadataModule = ( "setReferenceLocationClause" [
SET "setReferenceMetadataLocationOrIconSetClause" ] |
"setReferenceMetadataLocationOrIconSetClause" )
addModuleReferenceLocationClause = "addReferenceLocationClause" {
"addReferenceLocationClause" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceMetadataLocationOrIconSetClause = (
"setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
] | "setReferenceIconSetClause" )
addReferenceLocationClause = ADD ( 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"
Keywords And Parameters
createGatewayModuleCommand
This command creates a Gateway module
QUOTED_STRING
Name of the Gateway module to be created.
setPropertiesClause
Associate a set of properties with the Gateway module.
Basic properties for GATEWAY_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of an Oracle Module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of an Oracle Module
Name: GATEWAY_TYPE
Type: STRING
Valid Values: N/A
Default: N/A
Type of gateway module. Supported values are: 'DB2 Gateway Module', 'Sybase
Gateway Module', 'Sql*server Gateway Module', 'Informix Gateway Module',
'ODBC Gateway Module', 'DRDA Gateway Module', 'RDB Gateway Module',
'Teradata Gateway Module', 'Other Gateway Module'.
Properties for GATEWAY_MODULE:
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
Location for referenced objects
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceClauseForDataMetadataModule
Set location and/or icon set for the gateway module.
addModuleReferenceLocationClause
Add runtime locations to the gateway module.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
setReferenceLocationClause
Set a runtime location to the gateway module.
setReferenceMetadataLocationOrIconSetClause
Set metadata location and/or icon set for the gateway module.
addReferenceLocationClause
Add a runtime location to the gateway module.
propertyValue
Value of a property.
setReferenceMetadataLocationClause
Set metadata location for the gateway module.
setReferenceIconSetClause
Set icon set for the gateway module.
Examples
OMBCREATE GATEWAY_MODULE 'db2_module' SET PROPERTIES (GATEWAY_TYPE) VALUES
('DB2 Gateway Module')
This will create a gateway module named "db2_module", and its type is DB2.
See Also
OMBCREATE, OMBALTER GATEWAY_MODULE, OMBDROP GATEWAY_MODULE
Purpose
To create an icon set.
Prerequisites
In any context.
Syntax
createIconSetCommand = OMBCREATE ( ICONSET "QUOTED_STRING" [ SET
"setPropertiesClause" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createIconSetCommand
This command creates an iconset.
QUOTED_STRING
Specify the name of the iconset to be created.
setPropertiesClause
This clause sets a list properties to the specified values.
Basic properties for ICONSET:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the iconset
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the iconset
Name: BELONGS_TO_GROUP
Type: STRING
Valid Values: N/A
Default: ''
Name of the Group to which the iconset belongs
Name: CANVAS_ICON
Type: STRING
Valid Values: N/A
Default: ''
URL of the canvas icon (36x36)
Name: PALETTE_ICON
Type: STRING
Valid Values: N/A
Default: ''
URL of the palette icon (18x18)
Name: TREE_ICON
Type: STRING
Valid Values: N/A
Default: ''
URL of the tree icon (16x16)
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
A property value.
Examples
OMBCREATE ICONSET 'NEW_ICONSET' SET PROPERTIES (DESCRIPTION,
BELONGS_TO_GROUP, CANVAS_ICON, PALETTE_ICON, TREE_ICON) VALUES ('this is a
new iconset', 'Tasks', 'canvas_icon.gif', 'palette_icon.gif',
'tree_icon.gif')
See Also
OMBCREATE ICONSET, OMBALTER ICONSET, OMBDROP ICONSET
Purpose
To create a transient import action plan.
Prerequisites
In the context of a project.
Syntax
createImportActionPlanCommand = ( OMBCREATE TRANSIENT IMPORT_ACTION_PLAN
"QUOTED_STRING" { "addActionClause" } )
addActionClause = ADD ACTION "QUOTED_STRING" ( "setPropertiesClause" [
"setRefSourceAndTargetClause" ] | "setRefSourceAndTargetClause" )
setPropertiesClause = SET PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setRefSourceAndTargetClause = SET ( REF | REFERENCE ) "sourcesClause" SET
( REF | REFERENCE ) "targetClause"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
sourcesClause = SOURCE "ObjType" "QUOTED_STRING" [ SET ( REF | REFERENCE )
"sourcesClause" ]
targetClause = TARGET "ObjType" "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createImportActionPlanCommand
This command is for creating a transient import action plan, which is
composed of a set of import actions. Each import action includes
specification of source objects from which metadata will be extracted and
one target object, into which the metadata will be added.
QUOTED_STRING
The name of the import action plan to be created.
addActionClause
For adding an action to the import action plan.
QUOTED_STRING
The name of the action to be added.
setPropertiesClause
For setting any properties for the import action. For the current release,
there are no predefined property for import actions.
setRefSourceAndTargetClause
For specifying source and target objects for the import action. The source
objects are to be imported into target.
sourcesClause
For specifying source objects in an import action. Valid object types are
as follows.
TABLE
VIEW
SEQUENCE
MATERIALIZED_VIEW
EXTERNAL_TABLE
ADVANCED_QUEUE
QUEUE_TABLE
OBJECT_TYPE
VARRAY
NESTED_TABLE
DIMENSION
CUBE
FUNCTION
PROCEDURE
PACKAGE
QUOTED_STRING
The name of the source object. Note that the name of the source object must
be qualified with schema name, such as 'SCOTT.EMP'.
For importing into a transportable module, the object specification
requires an optional tablespace name qualifier, such as 'USERS.SCOTT.EMP'
or 'DEFAULT.SCOTT.EMP'. The tablespace name is required because schemas are
listed under tablespaces in the transportable module tree in OWB designer
console. If 'DEFAULT' is specified as tablespace name, then the default
tablespace name of the schema is used. If the tablespace name is ommitted,
then the following rule is used to deduce the appropriate tablespace name.
First, if the object is a database segment (that is, table and materialized
view), then use the tablespace name of the tablespace where the segment
resides.
Second if the object is not a database segment, then the default tablespace
name for the schema is used, that is, it is equivalent to specifying 'DEFAULT'
as tablespace name.
targetClause
For specifying the target object in an import action. There can only be
one target object in an import action.
QUOTED_STRING
The name of the target object.
Examples
OMBCREATE TRANSIENT IMPORT_ACTION_PLAN 'PLAN1'
ADD ACTION 'A1'
SET REF SOURCE TABLE 'SCOTT.T1'
SET REF SOURCE VIEW 'SCOTT2.V1'
SET REF TARGET TRANSPORTABLE_MODULE 'TM101'
This command will create an import plan named PLAN1, which contains one
import action named A1. The import action is for importing the metadata
definitions of table T1 in schema SCOTT and view V1 in schema SCOTT2 into
transportable module TM101.
See Also
OMBIMPORT
Purpose
Creates an item folder that can be used in a business view.
Prerequisites
Should be in the context of a Business Definition Module.
Syntax
createItemFolderCommand = ( OMBCREATE ITEM_FOLDER "QUOTED_STRING" [ SET
"setpropertiesClauseDelayed" ] [ SET "setReferenceIconSetClause" ] {
"addItemFolderSCOClauses" } )
setpropertiesClauseDelayed = PROPERTIES "(" "propertyNameListVector" ")"
VALUES "(" "propertyValueListVector" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addItemFolderSCOClauses = ADD ( "addItemClause" | "addConditionClause" |
"addJoinClause" )
propertyNameListVector = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueListVector = "propertyValue" { "," "propertyValue" }
addItemClause = ITEM "QUOTED_STRING" [ SET "setPropertiesClause" ] [ SET (
REF | REFERENCE ) ( "ItemItemReferencesClause" |
"ItemListOfValuesReferencesClause" |
"ItemDrillToDetailReferencesClause" |
"ItemAlternativeSortOrderReferencesClause" |
"ItemColumnReferencesClause" ) ]
addConditionClause = CONDITION "QUOTED_STRING" [ SET "setPropertiesClause"
]
addJoinClause = JOIN "QUOTED_STRING" [ SET "setPropertiesClause" ] [ SET (
REF | REFERENCE ) "JoinForeignKeyReferencesClause" ] {
"joinComponentClause" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
ItemItemReferencesClause = ITEM "QUOTED_STRING" OF ITEM_FOLDER
"QUOTED_STRING" "itemJoinUsages"
ItemListOfValuesReferencesClause = LIST_OF_VALUES "QUOTED_STRING"
ItemDrillToDetailReferencesClause = DRILL_TO_DETAIL "QUOTED_STRING"
ItemAlternativeSortOrderReferencesClause = ALTERNATIVE_SORT_ORDER
"QUOTED_STRING"
ItemColumnReferencesClause = COLUMN "QUOTED_STRING" OF ( TABLE | (
EXTERNAL_TABLE | VIEW ) ) "QUOTED_STRING"
JoinForeignKeyReferencesClause = FOREIGN_KEY "QUOTED_STRING" OF ( TABLE |
VIEW ) "QUOTED_STRING"
joinComponentClause = ADD JOIN_COMPONENT "QUOTED_STRING" [ SET
"setPropertiesClause" ] { SET ( REF | REFERENCE )
"setJoinComponentClauseDetails" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
itemJoinUsages = { SET ( REF | REFERENCE ) USING JOIN "QUOTED_STRING" OF
ITEM_FOLDER "QUOTED_STRING" }
setJoinComponentClauseDetails = LOCAL ITEM "QUOTED_STRING" | REMOTE ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
Keywords And Parameters
createItemFolderCommand
This command creates an item folder.
QUOTED_STRING
Specify the name of the item folder to be created.
setpropertiesClauseDelayed
This clause sets the properties.
setReferenceIconSetClause
Set specified Icon Set.
addItemFolderSCOClauses
This clause adds items to an item folder.
propertyNameListVector
This clause holds the names of the properties.
propertyValueListVector
This clause holds the values of the properties.
addItemClause
This clause adds an item to an item folder.
ITEM
A field within the item folder.
QUOTED_STRING
The name of the item to be added.
addConditionClause
This clause adds a condition to an item folder.
CONDITION
A field within the item folder.
QUOTED_STRING
The name of the condition to be added.
addJoinClause
This clause adds a foreign key relationship to another item folder.
JOIN
A foreign key relationship with another item folder.
QUOTED_STRING
The name of the join to be added.
propertyValue
This is a property value.
setPropertiesClause
Used to set properties (core, logical, physical, user-defined) for item
folders. Valid properties are as shown:
Basic properties for ITEM_FOLDER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the item folder
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the item folder
Name: EXTERNAL_TABLE_NAME
Type: STRING(255)
Valid Values: N/A
Default: ''
The physical name for the corresponding table or view. This is
automatically set if the Folder is associated with a Table
Name: VISIBLE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the item folder should be visible to the user
Name: FOLDER_TYPE
Type: STRING(40)
Valid Values: SIMPLE, COMPLEX
Default: ''
The type of item folder
Basic properties for ITEM:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the item
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the item
Name: ALIGNMENT
Type: STRING(40)
Valid Values: GENERAL, LEFT, CENTER, RIGHT
Default: 'GENERAL'
The default alignment for displaying the item
Name: DISPLAY_CASE
Type: STRING(40)
Valid Values: GENERAL, LOWER, UPPER, INITCAPPED
Default: 'GENERAL'
How alphabetic characters should be displayed
Name: CASE_STORAGE
Type: STRING(40)
Valid Values: GENERAL, LOWER, UPPER, MIXED
Default: 'GENERAL'
How alphabetic characters are stored
Name: CONTENT_TYPE
Type: STRING(40)
Valid Values: No Value or FILE. For datatypes such as BLOB, it may contain
a file extension such as DOC, AVI, WAV, JPG
Default: ''
Details on whether the Item contains a file name or should be processed by
an external application
Name: DEFAULT_AGGREGATE
Type: STRING(255)
Valid Values: Detail, AVG, COUNT, MAX, MIN, SUM
Default: 'SUM' when the datatype is Numeric, 'Detail' otherwise
Name of the default rollup function for the item
Name: DEFAULT_POSITION
Type: STRING(40)
Valid Values: MEASURE, TOP OR SIDE, TOP, SIDE, PAGE
Default: 'MEASURE' when the datatype is NUMBER or FLOAT, 'TOP OR SIDE'
otherwise
Default position for the item
Name: REPLACE_NULL_WITH
Type: STRING(255)
Valid Values: N/A
Default: ''
The value to be displayed for null values
Name: FORMULA
Type: STRING
Valid Values: N/A
Default: ''
The text of the derivation expression for a derived item
Name: EXTERNAL_COLUMN_NAME
Type: STRING(255)
Valid Values: N/A
Default: ''
The external name of the corresponding column. This is automatically set
if the Item is is associated with a Column
Name: FORMAT_MASK
Type: STRING(255)
Valid Values: N/A
Default: ''
The display format mask for the item
Name: HEADING
Type: STRING(255)
Valid Values: N/A
Default: ''
The displayed heading text for the item
Name: DATATYPE
Type: STRING(40)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH
NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.ROW_LCR, TIMESTAMP,
TIMESTAMP WITH LOCAL TIME ZONE
TIMESTAMP WITH TIME ZONE, UNSPECIFIED, VARCHAR, VARCHAR2, XMLTYPE,
SYS.XMLFORMAT, BLAST_ALIGN_PLSQLRECORDTYPE
SYS.LCR$_ROW_RECORD, BLAST_SQL_TABLE_OF_NUMBERS, SYS.XMLSEQUENCETYPE,
SYS_REFCURSOR, BLAST_MATCH_PLSQLRECORDTYPE
Default: 'VARCHAR2'
The datatype for the item
Name: VISIBLE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the item should be visible to the user
Name: MAX_CHAR_FETCHED
Type: Number
Valid Values: N/A
Default: ''
The maximum number of characters fetched for an item
Name: DEFAULT_WIDTH
Type: Number
Valid Values: N/A
Default: ''
The default number of characters to display
Name: WORD_WRAP
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether wordwrap is allowed in the display
Basic properties for JOIN:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the join
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the join
Name: OUTER_JOIN_ON_MASTER
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether detail rows with no related master row should be included in the
join
Name: OUTER_JOIN_ON_DETAIL
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether master rows with no related detail rows should be included in the
join
Name: EXTERNAL_KEY_NAME
Type: STRING(255)
Valid Values: N/A
Default: ''
The external name of the corresponding foreign key. This is automatically
set if the Join is is associated with a Foreign Key
Name: DETAIL_ALWAYS_HAS_MASTER
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether every detail row must reference a unique master row
Name: ONE_TO_ONE
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether a master row only ever has a single detail row
Basic properties for JOIN_COMPONENT:
Name: JOIN_OPERATOR
Type: STRING(200)
Valid Values: =, <>, <, <=, > or >=
Default: ''
Business name of the join
Basic properties for CONDITION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the condition
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the condition
Name: MATCH_CASE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the case of alphabetic characters must match exactly
Name: FORMULA
Type: STRING
Valid Values: N/A
Default: ''
The expression for the condition
Name: MANDATORY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the Condition is optional or mandatory
Properties for ITEM_FOLDER:
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
Location for the referenced database object
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts
to create an object only for those objects marked as Deployable = true
Name: OPTIMIZER_HINT
Type: STRING
Valid Values: N/A
Default: ''
Optimizer Hint to be added when this Item Folder is used in a query
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
ItemItemReferencesClause
This clause is used to reference another item.
QUOTED_STRING
name of the referenced item.
ItemListOfValuesReferencesClause
This clause is used to reference a list of values.
QUOTED_STRING
name of the list of values.
ItemDrillToDetailReferencesClause
This clause is used to reference a drill to detail.
QUOTED_STRING
name of the drill to detail.
ItemAlternativeSortOrderReferencesClause
This clause is used to reference an alternative sort order.
QUOTED_STRING
name of the alternative sort order.
ItemColumnReferencesClause
This clause is used to reference a column.
QUOTED_STRING
name of the referenced column.
JoinForeignKeyReferencesClause
The foreign key reference.
joinComponentClause
The join components.
propertyNameList
This is the list of property names.
propertyValueList
This is the list of property values.
itemJoinUsages
The specific joins to be used.
setJoinComponentClauseDetails
The structure of the join component.
Examples
OMBCREATE ITEM_FOLDER 'SALES'
See Also
OMBALTER ITEM_FOLDER, OMBRETRIEVE ITEM_FOLDER
Purpose
Creates a List of Values.
Prerequisites
Should be in the context of a Business Definition Module.
Syntax
createListOfValuesCommand = OMBCREATE LIST_OF_VALUES "QUOTED_STRING" [ SET
"setPropertiesClauseforLOVandD2D" ] [ SET "setReferenceIconSetClause"
] [ "addListOfValuesClause" ] { "addListOfValuesReferenceClause" }
setPropertiesClauseforLOVandD2D = PROPERTIES "("
"propertyNameListforLOVandD2D" ")" VALUES "(" "propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addListOfValuesClause = SET ( REF | REFERENCE ) DEFINING ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
addListOfValuesReferenceClause = SET ( REF | REFERENCE ) ITEM
"QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
propertyNameListforLOVandD2D = ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
"," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createListOfValuesCommand
This command creates a list of values.
QUOTED_STRING
Specify the name of the list of values to be created.
setPropertiesClauseforLOVandD2D
Used to set properties (core, logical, physical, user-defined) for a list
of values. Valid properties are as shown:
Basic properties for LIST_OF_VALUES:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the list of values
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the list of values
Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the list of values enables drilling between the item folders
containing the items that use the list of values
Name: RETRIEVE_VALUES_GROUP_SIZE
Type: Number
Valid Values: N/A
Default: '100'
The number of rows to be fetched from the database at a time
Name: CACHE_VALUES
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the list of values should be cached in memory
Name: REQUIRE_SEARCH
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether search criteria should be requested
Name: SHOW_IN_NAVIGATOR
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be shown in the item navigator
Name: SORTED_DISTINCT
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be displayed sorted with duplicates hidden
Properties for LIST_OF_VALUES:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts
to create an object only for those objects marked as Deployable = true
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceIconSetClause
Set specified Icon Set.
addListOfValuesClause
This clause modifies a list of values.
addListOfValuesReferenceClause
This adds a reference to an item to a list of values.
propertyNameListforLOVandD2D
This is the list of property names.
propertyValueList
This is the list of property values.
propertyValue
This is a property value.
Examples
OMBCREATE LIST_OF_VALUES 'SALES_ITEM'
See Also
OMBALTER LIST_OF_VALUES, OMBRETRIEVE LIST_OF_VALUES
Purpose
To create a location.
Prerequisites
Can be in any context.
Syntax
createLocationCommand = OMBCREATE ( LOCATION "QUOTED_STRING" (
"createLocationSetPropertiesClause" [ SET "setReferenceIconSetClause"
] ) )
createLocationSetPropertiesClause = SET PROPERTIES "(" "propertyNameList"
")" VALUES "(" "propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createLocationCommand
Create a new location.
createLocationSetPropertiesClause
Set specified properties of the new location.
setReferenceIconSetClause
Set the Icon Set for the new location.
propertyNameList
The names of the properties whose values you want to set.
Properties for LOCATION:
Basic properties:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the location.
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the location.
Name: TYPE
Type: STRING
Valid Values:
'CONCURRENT_MANAGER'
'AUTOSYS_AGENT'
'AUTOSYS_INSTANCE'
'BIBEANS'
'DISCOVERER'
'FILE_SYSTEM'
'OEM_AGENT'
'ORACLE_DATABASE'
'ORACLE_GATEWAY'
'ORACLE_WORKFLOW'
'SAP'
'TRANSPORTABLE_MODULE_SOURCE'
'TRANSPORTABLE_MODULE_TARGET'
Default: N/A
The type of system the location represents.
Name: VERSION
Type: STRING
Valid Values:
for 'CONCURRENT_MANAGER' : '11i'
for 'AUTOSYS_AGENT' : '0'
for 'AUTOSYS_INSTANCE' : '0'
for 'BIBEANS' : '10.1'
for 'DISCOVERER' : '10.1'
for 'FILE_SYSTEM' : do not set version
for 'OEM_AGENT' : '9.0','9.2'
for 'ORACLE_DATABASE' : '8.1','9.0','9.2','10.1','10.2'
for 'ORACLE_GATEWAY' : do not set version
for 'ORACLE_WORKFLOW' : '2.6.2','2.6.3','2.6.4','11i'
for 'SAP' : '4.x','3.x'
for 'TRANSPORTABLE_MODULE_SOURCE' : '8.1','9.0','9.2','10.1','10.2'
for 'TRANSPORTABLE_MODULE_TARGET' : '8.1','9.0','9.2','10.1','10.2'
Default: N/A
The version of the system(s) the location represents.
Lists of available properties for different types of LOCATION:
for 'CONCURRENT_MANAGER' :
TYPE,PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME,SCHEMA,VERSION,APPLICATION,APPLICATION_USER,RESPONSIBILITY
for 'AUTOSYS_AGENT':
TYPE,VERSION,PASSWORD,HOST
for 'AUTOSYS_INSTANCE':'
TYPE,VERSION,USER (or USER_NAME),PASSWORD,INSTANCE
for 'BIBEANS':
TYPE,VERSION,USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME
for 'DISCOVERER':
TYPE,VERSION,USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME
for 'FILE_SYSTEM':
TYPE,USER (or USER_NAME),PASSWORD,HOST,ROOTPATH
for 'OEM_AGENT':
TYPE,USER (or USER_NAME),PASSWORD,VERSION,DOMAIN,AGENT
for 'ORACLE_DATABASE':
TYPE,VERSION,CONNECT_AS_USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME,DATABASE_NAME,SCHEMA
for 'ORACLE_GATEWAY':
TYPE,CONNECT_AS_USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME,SCHEMA
for 'ORACLE_WORKFLOW':
TYPE,VERSION,PASSWORD,HOST,PORT,SERVICE_NAME,NET_SERVICE_NAME,SCHEMA
for 'SAP':
TYPE, VERSION, USER (or USER_NAME), PASSWORD, APPLICATION_SERVER,
SYSTEM_NUMBER, CLIENT, LANGUAGE, HOST_LOGIN_USER, HOST_LOGIN_PASSWORD,
FTP_DIRECTORY, EXECUTION_FM
for 'TRANSPORTABLE_MODULE_SOURCE':
TYPE, VERSION,CONNECT_AS_USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,FTP_USER,FTP_PASSWORD
for 'TRANSPORTABLE_MODULE_TARGET':
TYPE, VERSION,CONNECT_AS_USER (or
USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME
Some other properties for LOCATIONs:
Name: CONNECTION_TYPE
Type: STRING
Valid Values: 'HOST_PORT_SERVICE', 'SQL_NET_CONNECTION', 'DATABASE_LINK'
Default: 'HOST_PORT_SERVICE'
The location connection details format.
Name: HOST
Type: STRING
Valid Values: N/A
Default: N/A
The machine name.
Name: PORT
Type: NUMBER
Valid Values: 1 - 65535
Default: 1521
The port number of a database listener.
Name: SERVICE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The database service name.
Name: NET_SERVICE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The database netservice name.
Name: SCHEMA
Type: STRING
Valid Values: N/A
Default: N/A
The database schema name.
Name: PASSWORD
Type: STRING
Valid Values: N/A
Default: N/A
The password.
Name: USER
Type: STRING
Valid Values: N/A
Default: N/A
The user name.
Name: CONNECT_AS_USER
Synonym: USER_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The user name.
Name: DOMAIN
Type: STRING
Valid Values: N/A
Default: N/A
The address of a machine running the Oracle Management Service.
Name: AGENT
Type: STRING
Valid Values: N/A
Default: N/A
The name of an Oracle Enterprise Manager (OEM) node runnng an OEM Agent.
This name must be entered exactly as shown under the nodes in the Oracle
Management Service.
Name: ROOTPATH
Type: STRING
Valid Values: N/A
Default: N/A
The file system directory.
Name: APPLICATION
Type: STRING
Valid Values: N/A
Default: N/A
The Application name.
Name: APPLICATION_USER
Type: STRING
Valid Values: N/A
Default: N/A
The user name.
Name: DATABASE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The Data Base name.
Name: RESPONSIBILITY
Type: STRING
Valid Values: N/A
Default: N/A
The resposibility role.
Name: APPLICATION_SERVER
Type: STRING
Valid Values: N/A
Default: N/A
The application server.
Name: SYSTEM_NUMBER
Type: STRING
Valid Values: N/A
Default: N/A
The number of SAP system.
Name: CLIENT
Type: STRING
Valid Values: N/A
Default: N/A
The client.
Name: LANGUAGE
Type: STRING
Valid Values: N/A
Default: N/A
The languge of SAP.
Name: HOST_LOGIN_USER
Type: STRING
Valid Values: N/A
Default: N/A
The user.
Name: HOST_LOGIN_PASSWORD
Type: STRING
Valid Values: N/A
Default: N/A
The password.
Name: EXECUTION_FM
Type: STRING
Valid Values: N/A
Default: N/A
RFC Function Module for remote ABAP report execution
Name: FTP_USER
Type: STRING
Valid Values: N/A
Default: N/A
The user name used for creating ftp connection.
Name: FTP_PASSWORD
Type: STRING
Valid Values: N/A
Default: N/A
The ftp password.
Name: FTP_DIRECTORY
Type: STRING
Valid Values: N/A
Default: N/A
The directory used in a ftp session
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValueList
The values for the named properties.
propertyValue
A property value.
Examples
OMBCREATE LOCATION 'MY_LOCATION' SET PROPERTIES (TYPE, VERSION,
DESCRIPTION, BUSINESS_NAME) VALUES ('ORACLE_DATABASE', '9.2','this is a
location', 'location')
This will create a location named "MY_LOCATION". Its type is "Oracle
Database", version is "9.2", description is "this is a location", and
business name is "location".
By default, the CONNECTION_TYPE for the newly created location is
HOST:PORT:SERVICE. Other available values are: SQL*NET Connection, Database
Link.
To create a dblink type location, it is user responsibility to issue a
separate OMBCREATE CONNECTOR command. For example, to create a dblink type
location "DBLINK_LOC", whose from location is "SCOTT_LOC", and database
link name is "P1.US.ORACLE.COM", try following:
OMBCREATE LOCATION 'DBLINK_LOC' SET PROPERTIES
(TYPE,VERSION,CONNECTION_TYPE) VALUES('Oracle Database', '10.1', 'Database
Link')
OMBCREATE CONNECTOR 'SCOTT_LOCSCOTT_LOC_TO_DBLINK_LOC' SET PROPERTIES
(DATABASE_LINK_NAME) VALUES ('P1.US.ORACLE.COM') SET REF LOCATION
'SCOTT_LOC'.
See Also
OMBCREATE, OMBALTER LOCATION, OMBDROP LOCATION
Purpose
Create a mapping in an Oracle Module.
Prerequisites
1. The current context of scripting must be an Oracle Module.
2. No concurrent user should be locking the Oracle Module or any of its
ancestors exclusively at the moment the map is being created.
3. The map name must not conflict with existing map names and the maps
names that concurrent user tries to use.
Syntax
createMappingCommand = OMBCREATE MAPPING "mappingName" ( [ AS (
TRICKLE_FEED_MAPPING | BATCH_MAPPING ) ] )
"createOperatorOwnerDetailClause"
mappingName = "QUOTED_STRING"
createOperatorOwnerDetailClause = [ SET ( ( "setPropertiesClause" [ SET
"setReferenceIconSetClause" ] ) | "setReferenceIconSetClause" ) ]
"createOperatorOwnerDescendantsClause"
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
createOperatorOwnerDescendantsClause = { ADD ( "addOperatorClause" |
"addGroupClause" | "addAttributeClause" | "addChildClause" |
"addConnectionClause" ) }
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
addOperatorClause = "operatorType" OPERATOR "operatorName" [
"pluggableMapBottomUpLocator" ] [ SET "setPropertiesClause" ] [
"setBindingClause" ]
addGroupClause = "groupDirection" GROUP "groupName" OF
"operatorBottomUpLocator" [ SET "setPropertiesClause" ]
addAttributeClause = ATTRIBUTE "attributeName" OF "groupBottomUpLocator" [
SET "setPropertiesClause" ]
addChildClause = "childType" "childName" "childOwnerBottomUpLocator" [ SET
"setPropertiesClause" ]
addConnectionClause = CONNECTION FROM ( "groupBottomUpLocator" TO
"groupBottomUpLocator" [ "groupToGroupConnectType" ] |
"attributeBottomUpLocator" TO ( "attributeBottomUpLocator" |
"attributesBottomUpLocator" | "groupBottomUpLocator" ) |
"attributesBottomUpLocator" TO ( "attributesBottomUpLocator" |
"groupBottomUpLocator" ) )
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
operatorType = PLUGGABLE_MAPPING | "UNQUOTED_STRING"
operatorName = "QUOTED_STRING"
pluggableMapBottomUpLocator = ( OF PLUGGABLE_MAPPING "pluggableMapName" [
"pluggableMapBottomUpLocator" ] )
setBindingClause = BOUND TO "bindableLocator"
groupDirection = INPUT | OUTPUT | INPUT_OUTPUT
groupName = "QUOTED_STRING"
operatorBottomUpLocator = OPERATOR "operatorName" [
"pluggableMapBottomUpLocator" ]
attributeName = "QUOTED_STRING"
groupBottomUpLocator = GROUP "groupName" OF "operatorBottomUpLocator"
childType = "UNQUOTED_STRING"
childName = "QUOTED_STRING"
childOwnerBottomUpLocator = { OF "childType" "childName" } [ OF
"mappableBottomUpLocator" ]
groupToGroupConnectType = COPY ALL | BY ( NAME [ IGNORE ( SPECIAL_CHARS
"QUOTED_STRING" | SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX
"QUOTED_STRING" | TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX
"QUOTED_STRING" ) { "," IGNORE ( SPECIAL_CHARS "QUOTED_STRING" |
SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX "QUOTED_STRING" |
TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX "QUOTED_STRING" ) } ] |
POSITION )
attributeBottomUpLocator = ATTRIBUTE "attributeName" OF
"groupBottomUpLocator"
attributesBottomUpLocator = ATTRIBUTES "attributeNameList" OF
"groupBottomUpLocator"
pluggableMapName = "QUOTED_STRING"
bindableLocator = "bindableType" "bindableName" [ OF "bindableType"
"bindableName" ]
mappableBottomUpLocator = "operatorBottomUpLocator" |
"groupBottomUpLocator" | "attributeBottomUpLocator"
attributeNameList = "(" "attributeName" { "," "attributeName" } ")"
bindableType = PLUGGABLE_MAPPING | OBJECT_TYPE | "UNQUOTED_STRING"
bindableName = "QUOTED_STRING"
Keywords And Parameters
createMappingCommand
Create a mapping in an Oracle Module.
mappingName
Name of the mapping.
createOperatorOwnerDetailClause
Create the desired detail of a pluggable mapping.
setPropertiesClause
Describe the keys of properties for the map or objects in the map.
createOperatorOwnerDescendantsClause
Create the desired child objects of a mapping or a pluggable mapping.
propertyKeyList
The list of property keys.
propertyValueList
A list of property values.
addOperatorClause
Adds a mapping operator to a map. When you add an operator, Warehouse
Builder creates default groups and parameters for the operator. Please see
the appendix section of the Scripting Reference.
The following is an example for creating an operator:
OMBALTER MAPPING 'M1' ADD TABLE OPERATOR 'T1'
addGroupClause
Add a mapping group to a mapping operator.
addAttributeClause
Add a mapping attribute to a mapping group.
addChildClause
Add a child to a mapping, mapping operator, mapping group or mapping
attribute.
The following is an example for creating a child object under a mapping
OMBALTER MAPPING 'M1' ADD SOURCE_DATA_FILE 'FILE1'
Note: Key word "OPERATOR" "GROUP" "ATTRIBUTE" are important for their
respective ADD clauses. Without the key words, OMBPlus will interpret the
ADD clause as an addChildClause. Here is an example:
OMB+> OMBALTER MAPPING 'M1' ADD TABLE 'T1'
OMB02932: Error getting child objects of type TABLE in M1
OMBPLUS interprets the ADD clause as one for creating a non-operator child
object under the mapping object. Therefore, it tries to find type
definition for non-operator child object "TABLE" and cannot find it.
addConnectionClause
Add connections between mapping groups or mapping attributes.
propertyKey
A property key for an object.
Basic properties for MAPPING:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the mapping
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the mapping
Basic properties for OPERATOR:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the operator
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the operator
Basic properties for GROUP:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the group
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the group
Basic properties for ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the attribute
Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE,
TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: ''
Datatype of the Attribute
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Length of the attribute.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Precision of the attribute.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Scale of the attribute.
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.
Properties for MAPPING:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
True if the map is deployable to a physical implementation
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: GENERATION_LANGUAGE
Type: STRING
Valid Values: ABAP, PLSQL, SQLLOADER, UNDEFINED
Default: UNDEFINED
The language used when generating code for the mapping.
Name: REFERRED_CALENDAR
Type: STRING
Valid Values: N/A
Default: ''
Enter the Schedule to associate with this object.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property enables you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Properties for GROUP:
Name: COMMANDTYPE
Type: STRING
Valid Values: ALL_COMMAND_TYPES, DELETE, INSERT, UPDATE
Default: ALL_COMMAND_TYPES
The operation causing the change described by the LCR
Name: DEFAULT_EXPIRATION_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: NULL
A date value to be served as the expiration time of a newly created open
record.
Name: DIMENSION_KEY
Type: STRING(32)
Valid Values: N/A
Default: ''
The column in which dimension key value is to be stored when this is a
target of star schema.
Name: EXPRESSION_INOUT
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: EXPRESSION_OUT
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: EXTRACTING_TYPE
Type: STRING
Valid Values: FROM_ALL, FROM_CURRENT
Default: FROM_CURRENT
The extracting operation to be performed when this is a source. If Extract
Current Only (Type 2 Only) is specified, only current records will be
extracted. If Extract All is specified, all records will be extracted.
Name: GROUP_TYPE
Type: STRING
Valid Values: REF_CURSOR, SCALAR
Default: SCALAR
This property specifies whether the input parameter is a scalar or a ref
cursor type
Name: INTERNAL_TABLE
Type: STRING
Valid Values: N/A
Default: ''
Internal staging table for this operator group
Name: LEVEL_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of this level.
Name: MODULENAME
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parameter group
Name: RECORD_TYPE_VALUES
Type: STRING
Valid Values: N/A
Default: ''
Record Type Values.
Name: RETURN_TABLE_OF_SCALAR
Type: BOOLEAN
Valid Values: true, false
Default: false
This property specifies whether the return of the table function is a TABLE
of SCALAR or not.
Name: ROW_LOCATOR
Type: STRING
Valid Values: N/A
Default: ''
An expression indicating which attribute within the input group is the row
locator.
Name: ROW_LOCATOR_VALUES
Type: STRING
Valid Values: N/A
Default: NULL, NULL
A comma-delimited expression that gives the possible values of the row
locator within a unpivot group.
Name: SLOWLY_CHANGING_TYPE
Type: STRING
Valid Values: TYPE1, TYPE2, TYPE3
Default: TYPE2
The slowly changing type of this target.
Name: SPLIT_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
Condition that defines when to perform the attribute maps for the
attributes in this group.
Name: TABLENAME
Type: STRING
Valid Values: N/A
Default: ''
The source table corresponding to the LCR
Name: TARGET_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The table name bound to this target.
Properties for ATTRIBUTE:
Name: ADDRESS_TYPE
Type: STRING
Valid Values: NA_ADDRTYPE_DUAL, NA_ADDRTYPE_NORMAL
Default: NA_ADDRTYPE_NORMAL
You can designate an address type as Normal or Dual. For example, a dual
address occurs when a record contains both a street address and a P.O. Box;
this is common with business data. A normal address contains only one type
of address.
Name: ATTRIBUTE_ROLE
Type: STRING
Valid Values: END_DATE, LOOKUP_ACTIVE_DATE, MEASURE, NATURAL_KEY, NONE,
PARENT_NATURAL_KEY, PARENT_REF_KEY, PARENT_SURROGATE_KEY, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: BINDING_COLUMN_NAME
Type: STRING
Valid Values: N/A
Default: ''
The binding column name for this attribute
Name: DATA_TYPE
Type: STRING
Valid Values: N/A
Default: ''
The data type of the attribute
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The Default Value for the function input parameter
Name: DIMENSION_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The dimension attribute referenced to by this level attribute.
Name: EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
The output expression for the attribute
Name: FIELD_DATA_TYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE,
FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER
EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH,
LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH
LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARGRAPHIC,
VARRAW, VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
SQL Data Type of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Field Length of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Field Precision of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Field Scale of the field in the file to which this operator is bound.
Name: FIELD_DEFAULTIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is blank or zero,
based on the datatype.
Name: FIELD_END_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The ending position of the field in the file
Name: FIELD_MASK
Type: STRING
Valid Values: N/A
Default: ''
The mask for the field
Name: FIELD_NULLIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is null
Name: FIELD_START_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The starting position of the field in the file
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data fractional seconds precision value of the attribute
Name: FUNCTION_RETURN
Type: BOOLEAN
Valid Values: true, false
Default: false
Specifies whether this output is the return value of this function
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this input attribute is a part of the
unpivot group key.
Name: INPUT_ROLE
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_CITY, NA_COUNTRYCODE,
NA_COUNTRYNAME, NA_FIRMNAME, NA_FIRSTNAME, NA_FIRSTPARTNAME, NA_LASTLINE,
NA_LASTLINE_2, NA_LASTNAME, NA_LASTPARTNAME, NA_LINE1, NA_LINE10, NA_LINE2,
NA_LINE3, NA_LINE4, NA_LINE5, NA_LINE6, NA_LINE7, NA_LINE8, NA_LINE9,
NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_NEIGHBORHOOD, NA_NONE,
NA_PASSTHRU, NA_PERSON, NA_PERSON2, NA_PERSON3, NA_POSTALCODE, NA_POSTNAME,
NA_PRENAME, NA_PRIMARYADDRESS, NA_SECONDARYADDRESS, NA_STATE
Default: NA_NONE
Assigns a name-address input role to the selected input attribute
Name: INSTANCE
Type: STRING
Valid Values: NA_INSTANCE_FIFTH, NA_INSTANCE_FIRST, NA_INSTANCE_FOURTH,
NA_INSTANCE_SECOND, NA_INSTANCE_SIXTH, NA_INSTANCE_THIRD
Default: NA_INSTANCE_FIRST
The instance option is used when an address contains multiple names, you
can specify which name in the group should be used. In addition, you can
use this option to assign an address type to a miscellaneous address
component.
Name: IS_CAST_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: IS_OPTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the input is not required to be connected
Name: IS_PREDEFINED_CONSTANT
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
The data length value of the attribute
Name: LEVEL_ATTRIBUTE_COLNAME_NAME
Type: STRING
Valid Values: N/A
Default: ''
Column name in the AW staging table and source view for this attribute.
Name: LEVEL_ATTRIBUTE_LEVEL_INDICATOR_COLNAME
Type: STRING
Valid Values: N/A
Default: ''
Level indicating columns name. This level will contain the name of the name
of the level this parent reference belongs to. This is relavant only for
skip level hierarchies.
Name: LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Level Attribute.
Name: LEVEL_RELATIONSHIP_NAME
Type: STRING
Valid Values: N/A
Default: ''
The level relationship name associated to this attribute.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
update load operation.
Name: LOOKUP_ATTRIBUTE_ROLE
Type: STRING
Valid Values: DIMENSION_KEY, END_DATE, NATURAL_KEY, NONE, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: MATCHING_ROW
Type: NUMBER
Valid Values: 1 - 1000
Default: 1
An positive integer to indicate from which row within the unpivot group
this output attribute obtains its data.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the update load operation.
Name: MERGE_ATTR
Type: STRING
Valid Values: N/A
Default: ''
Related merge attribute
Name: OUTPUT_COMPONENT
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_ADDRESSCORRECTED, NA_ADDRESSTYPE,
NA_AUTO_ZONE_IND, NA_BOXNAME, NA_BOXNUMBER, NA_BUILDINGNAME, NA_CART,
NA_CBSA_CODE, NA_CBSA_DESC, NA_CENSUSID, NA_CHECKDIGIT, NA_CITY,
NA_CITYCORRECTED, NA_CITYMATCH, NA_CITYWARNING, NA_CITY_ABBREV,
NA_CITY_ABBREV_2, NA_CITY_ALTERNATE, NA_COMPLEX, NA_COUNTRYCODE,
NA_COUNTRYCODE3, NA_COUNTRYNAME, NA_COUNTYNAME, NA_DELIVERYBEATCODE,
NA_DELIVERYOFFICECODE, NA_DELIVERYPOINT, NA_EMAIL, NA_EXTRA_1, NA_EXTRA_10,
NA_EXTRA_11, NA_EXTRA_12, NA_EXTRA_13, NA_EXTRA_14, NA_EXTRA_15,
NA_EXTRA_16, NA_EXTRA_17, NA_EXTRA_18, NA_EXTRA_19, NA_EXTRA_2,
NA_EXTRA_20, NA_EXTRA_3, NA_EXTRA_4, NA_EXTRA_5, NA_EXTRA_6, NA_EXTRA_7,
NA_EXTRA_8, NA_EXTRA_9, NA_FIPS, NA_FIPSCOUNTY, NA_FIPS_PLACE_CODE,
NA_FIRMCOUNT, NA_FIRMNAME, NA_FIRM_LOC, NA_FIRSTNAME, NA_FIRSTNAMESTD,
NA_GENDER, NA_GEO_MATCH_PREC, NA_INSTALLATIONNAME, NA_INSTALLATIONTYPE,
NA_ISADDRESSVERIFIABLE, NA_ISFOUND, NA_ISGOODADDRESS, NA_ISGOODGROUP,
NA_ISGOODNAME, NA_ISPARSED, NA_LACS, NA_LASTLINE, NA_LASTLINE_2,
NA_LASTNAME, NA_LATITUDE, NA_LOCALITYCODE, NA_LOCALITYNAME, NA_LOCALITY_2,
NA_LOCALITY_3, NA_LOCALITY_4, NA_LONGITUDE, NA_LOT, NA_LOT_ORDER, NA_MCD,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME2STD, NA_MIDDLENAME3,
NA_MIDDLENAME3STD, NA_MIDDLENAMESTD, NA_MISCADDRESS, NA_MSA,
NA_NAMEDESIGNATOR, NA_NAMEWARNING, NA_NAME_FIRM_EXTRA, NA_NEIGHBORHOOD,
NA_NONAMBIGUOUSMATCH, NA_NONE, NA_NP_SEC_ADDR, NA_NP_UNIT_DESIG,
NA_NP_UNIT_NBR, NA_OTHERPOSTNAME, NA_PARSESTATUS, NA_PARSESTATUSDESC,
NA_PARSINGCOUNTRY, NA_PASSTHRU, NA_PERSON, NA_PERSONCOUNT, NA_PHONE,
NA_POSTALCODE, NA_POSTALCODECORRECTED, NA_POSTALCODEFORMATTED,
NA_POSTDIRECTIONAL, NA_POSTNAME, NA_PREDIRECTIONAL, NA_PRENAME,
NA_PRIMARYADDRESS, NA_PRIM_NAME_2, NA_RELATIONSHIP, NA_ROUTENAME,
NA_ROUTENUMBER, NA_SECONDARYADDRESS, NA_SSN, NA_STATE,
NA_STREETCOMPCORRECTED, NA_STREETCOMPMATCH, NA_STREETCORRECTED,
NA_STREETNAME, NA_STREETNAMEMATCH, NA_STREETNUMBER, NA_STREETNUMBERMATCH,
NA_STREETTYPE, NA_STREETWARNING, NA_TITLE, NA_UNITDESIGNATOR,
NA_UNITNUMBER, NA_URBANIZATIONNAME, NA_URBAN_IND, NA_ZIP4, NA_ZIP5
Default: NA_NONE
Assigns a Name and Address output component to the selected output
attribute.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parmater
Name: PIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
A comma-delimited expression that gives the input attribute to be used for
each output row in the pivot group.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data precision value of the attribute
Name: REFERENCED_LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level attribute associated to this attribute.
Name: REFERENCED_LEVEL_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level group associated to this attribute.
Name: REFERENCING_TYPE
Type: STRING
Valid Values: LOOKUP_KEY, NONE, REFERENCE_KEY_ALL, REFERENCE_KEY_ONLY
Default: NONE
The type of reference to indicate how this attribute participates in
resolving existing level relationships and level implementations. If Lookup
Reference Attribute is specified, this attribute will be used as lookup
attribute upon parent level to resolve level implementations during
loading. If Level Relationship Attribute (Snowflake) is specified, this
attribute will be directly used as level relationship attribute and no
lookup upon parent level would be performed during loading. If Level
Relationship Attribute (Star) is specified, this attribute will be directly
used as level relationship attribute, as well as lookup attribute upon
parent level to resolve level implementations during loading. If none is
specified, this attribute does not participate in any level relationship.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
The data scale value of the attribute
Name: SKIP_LEVEL_DIMENSION
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether this level has a skip level parent.
Name: TYPE_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the field of the PLS Record or attribute of the Object Type or
column of the ROWTYPE that corresponds to this attribute. This property is
not applicable if the return type is TABLE of SCALAR.
Name: UNPIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: NULL
An expression that gives the input attribute to be used as the output of
this attribute.
Name: UPDATE_OPERATION
Type: STRING(3)
Valid Values: +=, -=, =, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data
and the existing data on the target during the update load operation.
Name: VALUETYPE
Type: STRING
Valid Values: NEW, NEW_OLD, OLD
Default: NEW_OLD
Specifies the value type of this attribute
Properties for AGGREGATOR_OPERATOR:
Name: GROUP_BY_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Group By clause for the aggregation
Name: HAVING_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Having clause for the aggregation
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for CONSTRUCT_OBJECT_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for CUBE_OPERATOR:
Name: ALLOW_PARALLEL_SOLVE
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, allow parallel solve when solving the cube.
Name: AW_STAGED_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the set-based AW load data is staged into a temporary table before
loading into the AW.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: CUBE_STORAGE_ISAW
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether the storage for this cube in AW.
Name: DIMENSION_AWNAME
Type: STRING
Valid Values: N/A
Default: ''
AW Name which contains this Dimension.
Name: INCREMENTAL_AGGREGATION
Type: BOOLEAN
Valid Values: true, false
Default: true
Indicates whether incremental aggregation should be done or full
aggregation.
Name: LOADING_TYPE
Type: STRING
Valid Values: LOAD, REMOVE
Default: LOAD
The loading operation to be performed when this is a target. If LOAD is
specified, OWB will try to insert all input data into target. If REMOVE is
specified, OWB will try to match between the input data and target data to
compute existing data; it will then remove existing data from target.
Name: MAX_JOB_QUEUES_ALLOCATED
Type: NUMBER
Valid Values: 1 - 1000
Default: 0
The maximum number of job queues allocated when solving the cube.
Name: RUN_AGGREGATION
Type: STRING
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether to solve the cube or not . Specify YES
and cube data will be precomputed for the levels specified in the
definition of cube
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property enables you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRUNCATE_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
The truncate flag to indicate whether all existing dimension values should
be truncated before load begins (AW only).
Properties for DEDUPLICATOR_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for DIMENSION_OPERATOR:
Name: AW_LOAD_MODEL
Type: STRING
Valid Values: OTHER, SNOWFLAKE, STAR
Default: SNOWFLAKE
The loading model for the AW dimension - star, snowflake, or other.
Name: AW_STAGED_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the set-based AW load data is staged into a temporary table before
loading into the AW.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DEFAULT_EFFECTIVE_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: SYSDATE
A date value to be served as the effective time of a newly created open
record. The same date value is also served as the expiration time to close
an existing open record.
Name: DEFAULT_EXPIRATION_TIME_OF_OPEN_RECORD
Type: STRING
Valid Values: N/A
Default: NULL
A date value to be served as the expiration time of a newly created open
record.
Name: DIMENSION_AWNAME
Type: STRING
Valid Values: N/A
Default: ''
AW Name which contains this Dimension.
Name: DIMENSION_ISAW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Flag to indicate whether storage is AW.
Name: LOADING_TYPE
Type: STRING
Valid Values: LOAD, REMOVE
Default: LOAD
The loading operation to be performed when this is a target. If LOAD is
specified, OWB will try to match between the input data and target data to
compute new data and existing data; it will then create new data, as well
as modify existing data onto target. If REMOVE is specified, OWB will try
to match between the input data and target data to compute existing data;
it will then remove existing data from target.
Name: SLOWLY_CHANGING_TYPE
Type: STRING
Valid Values: TYPE1, TYPE2, TYPE3
Default: TYPE2
The slowly changing type of this target.
Name: SURROGATE_IDENTIFIER_LOADING_POLICY
Type: STRING
Valid Values: N/A
Default: ''
The name of the sequence used to generate surrogate key values when loading
the dimension.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property enables you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRUNCATE_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
The truncate flag to indicate whether all existing dimension values should
be truncated before load begins (AW only).
Name: TYPE2_MATCH_CURRENT_ONLY
Type: STRING
Valid Values: NO, YES
Default: YES
If set to YES, only the current record will be used when performing the
selected operation (remove or extract) for type 2 dimension.
Properties for EXPAND_OBJECT_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for EXTERNAL_TABLE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DATA_COLLECTION_FREQUENCY
Type: STRING(16)
Valid Values: DAY, HOUR, MINUTE, MONTH, QUARTER, UNKNOWN, YEAR
Default: UNKNOWN
New Data Granularity
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: DIRECT
Type: BOOLEAN
Valid Values: true, false
Default: false
Directly swap source into target as a partition without first creating a
staging table.
Name: ENABLE_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable Constraints
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EVALUATE_CHECK_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: false
Evaluate check constraints
Name: EXCEPTIONS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Exceptions Table Name
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PEL_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
PEL Enabled
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: REPLACE_DATA
Type: BOOLEAN
Valid Values: true, false
Default: false
Replace existing data in target partition if there is any.
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property enables you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Properties for FILTER_OPERATOR:
Name: FILTER_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
The boolean filtering condition that identifies what data is to be
processed. Any row with a false condition will be ignored.
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for FLAT_FILE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by reconciliation for this item. Unlike other
operators, it is not needed for generation. By default it is the same name
as the item.
Name: CONCATENATE_RECORDS
Type: NUMBER
Valid Values: N/A
Default: 0
Number of Physical Records in a Logical Record.
Name: CONTINUATION_CHARACTER
Type: STRING
Valid Values: N/A
Default: ''
Character that indicates the record is continued on the next line.
Name: CONTINUATION_CHARACTER_ON_NEXT_LINE
Type: BOOLEAN
Valid Values: true, false
Default: FALSE
If there is a continuation character, is it at the start of the line.
Name: FIELD_ENCLOSURE_CHARACTERS
Type: STRING
Valid Values: N/A
Default: ''
Characters that wrap fields. Example ' or ".
Name: FIELD_NAMES_IN_THE_FIRST_ROW
Type: BOOLEAN
Valid Values: true, false
Default: FALSE
Indicates whether file contains a header row.
Name: FIELD_TERMINATION_CHARACTER
Type: STRING
Valid Values: N/A
Default: ,
Character that separates the fields of a delimited file.
Name: FILE_FORMAT
Type: STRING
Valid Values: DELIMITED, FIXED
Default: DELIMITED
File Format (Fixed or Delimited).
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: INSERT, NONE, UPDATE
Default: INSERT
The loading operation to be performed
Name: OUTPUT_AS_XML
Type: BOOLEAN
Valid Values: true, false
Default: false
Output data to file in XML format.
Name: RECORD_DELIMITER
Type: STRING
Valid Values: N/A
Default: ''
Character that indicates the end of the record.
Name: RECORD_SIZE
Type: NUMBER
Valid Values: N/A
Default: 0
Size of a fixed length record.
Name: RECORD_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
If this is a multi record file, this will indicate the length of the data
that identifies the type of record. It is used with the Record Type
Position.
Name: RECORD_TYPE_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
If this is a multi record file, this will indicate the position of the
field that identifies the type of record.
Name: SAMPLED_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The default name of the physical file to be used by sqlloader. If the file
was sampled, the default was set from sampled file name.
Name: SOURCE_DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The Location of the File Module of this Flat File at the time of
reconciliation. Stored as UOID.
Name: TARGET_DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access referenced entity.
Name: TARGET_DATA_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the target data file, including extension (file type). This name
should not include the file path. To specify where the target data file
will be created/appended, set the Target Data File Location.
Properties for ITERATOR_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for JOINER_OPERATOR:
Name: JOIN_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
The Join Condition for the join operator
Properties for KEY_LOOKUP_OPERATOR:
Name: BOUND_LEVEL
Type: STRING
Valid Values: N/A
Default: ''
The level name of the bound level, if this is a dimension lookup.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: CREATE_NO_MATCH_ROW
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, a row is created and the user-defined default values are used, in
the case where no lookup match is found. If false, no row is produced.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOOKUP_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
Key lookup condition based on the source inputs. This condition is used to
lookup a value in the bound table. If the condition is not met, the
default value expression will be returned. If a default expression is not
defined, null is used.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TYPE2_HISTORY_LOOKUP_DATE
Type: STRING
Valid Values: N/A
Default: ''
A date expression used when doing a lookup on a type 2 dimension level, to
specify the historical date for which to retrieve data. If blank, the most
current record is used.
Properties for LCRCAST_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Properties for MATCHMERGE_OPERATOR:
Name: MATCH_KEYS
Type: STRING
Valid Values: N/A
Default: ''
Ordered list of attributes that control the set of records to be matched at
any at any particular time.
Name: MATCH_NEW_RECORDS
Type: BOOLEAN
Valid Values: true, false
Default: false
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"MATCHMERGE.GENERAL.MATCH_NEW_RECORDS:DESCRIPTION"
Name: MATCH_NEW_RECORD_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"MATCHMERGE.GENERAL.MATCH_NEW_RECORD_CONDITION:DESCRIPTION"
Name: MERGED_PREFIX
Type: STRING
Valid Values: N/A
Default: ''
Set the prefix used for the merged attributes in the cross-reference group.
Properties for MATERIALIZED_VIEW_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, INSERT, INSERT_UPDATE,
NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property enables you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Properties for NAME_AND_ADDRESS_OPERATOR:
Name: ADDRESS_LINE_1
Type: STRING
Valid Values: N/A
Default: ''
Address line 1
Name: ADDRESS_LINE_2
Type: STRING
Valid Values: N/A
Default: ''
Address line 2
Name: ADDRESS_LINE_3
Type: STRING
Valid Values: N/A
Default: ''
Address line 3
Name: ADDRESS_LINE_4
Type: STRING
Valid Values: N/A
Default: ''
Address line 4
Name: DUAL_ADDRESS_ASSIGNMENT
Type: STRING
Valid Values: NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX,
NA_DUALADDR_STREET
Default: NA_DUALADDR_STREET
A dual address refers to two address lines for the same destination. For
example, a record contains both a street address and a P.O. Box; this is
common with business data. Select which of the two address lines should be
assigned in these cases.
Name: GENERATE_CASS_REPORT
Type: STRING
Valid Values: NA_NO, NA_YES
Default: NA_NO
Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS
report is a text file specified by the United States Postal Service. The
report is written to the [nas/bin/admin/reports] folder under the home
folder of the name/address server.
Name: LIST_NAME
Type: STRING
Valid Values: N/A
Default: ''
The list name is optional and provides a reference for tracking multiple
CASS reports.
Name: PARSING_TYPE
Type: STRING
Valid Values: NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY
Default: NA_NAMEANDADDRESS
Select a name-address parsing type to be performed on the input data
Name: PRIMARY_COUNTRY
Type: STRING
Valid Values: NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD,
NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE,
NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST,
NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND,
NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM,
NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR,
NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP,
NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF
Default: NA_USA
Select the primary parsing country which best represents the input data.
Input addresses having the same country as the primary parsing country will
only need to be parsed once. Input addresses having a different country
than the primary parsing country may be reparsed by a different parser. For
performance reasons, it is best to minimize the percentage of 2-pass parses
by selecting the optimal parser.
Name: PROCESSOR_NAME
Type: STRING
Valid Values: N/A
Default: ''
The processor name is the name of the organization submitting the CASS
report.
Properties for PIVOT_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: PIVOT_GROUP_SIZE
Type: NUMBER
Valid Values: 1 - 1000
Default: 2
A number specifying the pivot group size for the pivot operation. Pivot
group size determines the number of output rows that are produced from each
input row.
Properties for PLUGGABLE_MAPPING_OPERATOR:
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property enables you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Properties for POSTMAPPING_PROCESS_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: POSTMAPPING_PROCESS_RUN_CONDITION
Type: STRING(10)
Valid Values: ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING
Default: ON_SUCCESS
Indicates under what condition of the mapping the post-mapping process will
be run.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for PREMAPPING_PROCESS_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: MAPPING_RUN_CONDITION
Type: STRING(10)
Valid Values: ALWAYS, ON_ERROR, ON_SUCCESS
Default: ON_SUCCESS
Indicates under what condition of the pre-mapping process the mapping will
be run.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for QUEUE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Properties for SEQUENCE_OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for SET_OPERATION_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: SET_OPERATION
Type: STRING
Valid Values: INTERSECT, MINUS, UNION, UNIONALL
Default: UNION
Specifies the set operation that is to be performed by this operator.
Properties for SORTER_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Name: ORDER_BY_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
The Order By Clause
Properties for SPLITTER_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for TABLE_FUNCTION_OPERATOR:
Name: TABLE_FUNCTION_IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: TABLE_FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Table Function
Properties for TABLE_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: CONFLICT_RESOLUTION
Type: BOOLEAN
Valid Values: true, false
Default: true
Detect and resolve any conflicts that may arise during DML using the LCR
APIs
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DATA_COLLECTION_FREQUENCY
Type: STRING(16)
Valid Values: DAY, HOUR, MINUTE, MONTH, QUARTER, UNKNOWN, YEAR
Default: UNKNOWN
New Data Granularity
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: DIRECT
Type: BOOLEAN
Valid Values: true, false
Default: false
Directly swap source into target as a partition without first creating a
staging table.
Name: ENABLE_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable Constraints
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EVALUATE_CHECK_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: false
Evaluate check constraints
Name: EXCEPTIONS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Exceptions Table Name
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: JOINRANK
Type: FLOAT
Valid Values: N/A
Default: 0
Join Rank
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, INSERT, INSERT_UPDATE,
NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PEL_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
PEL Enabled
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: REPLACE_DATA
Type: BOOLEAN
Valid Values: true, false
Default: false
Replace existing data in target partition if there is any.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property enables you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Name: USE_LCR_API
Type: BOOLEAN
Valid Values: true, false
Default: true
Use LCR APIs if possible to perform the DML
Properties for TRANSFORMATION_OPERATOR:
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of the transformation to be called.
Name: IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, then the function is a target
Name: RETURN_TYPE
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: ROW-BASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: false
Indicates if this transformation must be used only Row Based mode. Some
transformations can be used in SQL mode as well as Row Based mode.
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Properties for UNPIVOT_OPERATOR:
Name: INLINEVIEW_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used on inline view when extracting using SQL
Properties for VIEW_OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: NO_CONSTRAINTS
This property is used by public API and scripting to influence how columns
are used for UPDATE or DELETE DMLs. If this property is set with the name
of a primary or unique key, all the columns in the key will be used for
matching during UPDATE or DELETE; and all the columns not in the key are
used for loading. The property can also be assigned the value "All
constraints" or "No constraints". If the DML type is INSERT,
TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name to be used by the code generator to identify this item. By default
it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING(128)
Valid Values: N/A
Default: ''
The database link used to access this entity during mapping.
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location used to access this entity during mapping.
Name: DEBUG_BOUND_NAME
Type: STRING
Valid Values: N/A
Default: ''
Physical name used to bind to a physical entity during a debug session
Name: DEBUG_DB_LOCATION
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"8i.MAPPING.ENTITY.DEBUGGERPARAMS.LOCATION:DESCRIPTION"
Name: ERROR_SELECT_FILTER
Type: STRING(3)
Valid Values: NO, YES
Default: YES
Rows selected from the error table will contain only errors created by this
operator in this map execution
Name: ERROR_SELECT_ROLL_UP
Type: STRING(3)
Valid Values: NO, YES
Default: YES
'Records selected from the error table will be rolled up by the error name,
so all errors generated by a particular input record will be rolled up into
a single record with the error names concatenated in the error name
attribute.
Name: ERROR_TABLE_NAME
Type: STRING(32)
Valid Values: N/A
Default: ''
The error table name of this target to log invalid records.
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: ''
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING(16)
Valid Values: CHECK_INSERT, DELETE, DELETE_INSERT, INSERT, INSERT_UPDATE,
NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: ALL_CONSTRAINTS
A property to indicate whether unique or primary key information on this
target will override the matching criteria obtained from Match by
constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Partition Name
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: NO, YES
Default: NO
A boolean value to indicate whether this is a primary source or not (only
used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: >= 0
Default: 0
Number of records to skip
Name: ROW_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Row count
Name: ROW_COUNT_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
Row count enabled
Name: SCHEMA
Type: STRING(30)
Valid Values: N/A
Default: ''
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: ''
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: ''
A condition on the rows in the target and if evaluated to true, that row
will participate in the update loading operation.
Name: TARGET_LOAD_ORDER
Type: STRING(65535)
Valid Values: N/A
Default: ''
The Target Load Order property enables you to determine the order in which
multiple targets within the same mapping get loaded. Warehouse Builder
determines a default order based on the FK relationships. However, using
the property you can overrule that default order.
Name: TEST_DATA_COLUMN_LIST
Type: STRING
Valid Values: N/A
Default: ''
Column list for test data VIEW for this source or target
Name: TEST_DATA_WHERE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
WHERE clause for test data VIEW for this source or target
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Name: TRUNCATE_ERROR_TABLE
Type: STRING(3)
Valid Values: NO, YES
Default: NO
If YES, then the error table will be truncated prior to use. This is
ignored if there are no active data rules applied to the object.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValue
A single property value. It can be a number, float, boolean or
single-quoted string.
operatorType
Type of a mapping operator. The following operator types are available:
ADVANCED_QUEUE, AGGREGATOR, ANYDATA_CAST, CONSTANT, CONSTRUCT_OBJECT, CUBE,
DATA_GENERATOR, DEDUPLICATOR, DIMENSION, EXPAND_OBJECT, EXPRESSION,
EXTERNAL_TABLE, FILTER, FLAT_FILE, INPUT_PARAMETER, INPUT_SIGNATURE,
ITERATOROPERATOR, JOINER, KEY_LOOKUP, LCRCAST, LCRSPLITTER, MATCHMERGE,
MATERIALIZED_VIEW, NAME_AND_ADDRESS, OUTPUT_PARAMETER, OUTPUT_SIGNATURE,
PIVOT, PLUGGABLE_MAPPING, POSTMAPPING_PROCESS, PREMAPPING_PROCESS,
SEQUENCE, SET_OPERATION, SORTER, SPLITTER, TABLE, TABLE_FUNCTION,
TRANSFORMATION, UNPIVOT, VIEW.
operatorName
Name of a mapping operator.
pluggableMapBottomUpLocator
Location of a child pluggable mapping within a mapping or another pluggable
mapping.
setBindingClause
Set the binding during the creation of a mapping operator or mapping
attribute.
groupDirection
Direction of a mapping group.
groupName
Name of a mapping group.
operatorBottomUpLocator
Location of a mapping operator.
attributeName
Name of a mapping attribute.
groupBottomUpLocator
Location of a mapping group.
childType
Type of a child that belongs to map, mapping operator, mapping group or
mapping attribute.
childName
Name of a child that belongs to map, mapping operator, mapping group or
mapping attribute.
childOwnerBottomUpLocator
Location of a child owner. A child owner can be a map, mapping operator,
mapping group, mapping attribute or a child.
groupToGroupConnectType
Connecting from a mapping group in one mapping operator to a mapping group
in another mapping operator.
attributeBottomUpLocator
Location of a mapping attribute.
attributesBottomUpLocator
Location of a list of mapping attributes.
pluggableMapName
Name of the pluggable map.
bindableLocator
Location of the object to be bound to a mapping operator or mapping
attribute.
mappableBottomUpLocator
Location of the object to be bound to a mapping mapping operator or mapping
attribute.
attributeNameList
A list of attribute names.
bindableType
Type of object bound to a mapping operator or mapping attribute.
bindableName
Name of the object bound to a mapping operator or mapping attribute.
Examples
OMBCREATE MAPPING 'MAP1'
OMBCREATE MAPPING 'MAP1'
SET PROPERTIES (business_name, description)
VALUES ('My map', 'Map to load customer look up table')
ADD VARIABLE 'LAST_CUST' SET PROPERTIES (SCALE, PRECISION) VALUES (10,20)
ADD TABLE OPERATOR 'CUST_SRC'
BOUND TO TABLE '../SRC_MODULE/CUST_SRC'
ADD TABLE OPERATOR 'CUST_LOOK_UP'
ADD CONNECTION FROM GROUP 'INOUTGRP1' OF OPERATOR 'CUST_SRC'
TO GROUP 'INOUTGRP1' OF OPERATOR 'CUST_LOOK_UP'
See Also
OMBCREATE, OMBALTER MAPPING, OMBRETRIEVE MAPPING, OMBDROP MAPPING
Purpose
To create a materialized view.
Prerequisites
In the context of an Oracle Module.
Syntax
createMaterializedViewCommand = OMBCREATE ( MATERIALIZED_VIEW
"QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET ( REF | REFERENCE
) "setReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) ] [
"addMaterializedViewSCOandDependentClause" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
addMaterializedViewSCOandDependentClause = ADD ( "addColumnClause" |
"addViewConstraintClause" | "addSCOClause" |
"addRelationalDependentClause" ) [
"addMaterializedViewSCOandDependentClause" ]
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addColumnClause = COLUMN "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ]
[ SET "setPropertiesClause" ]
addViewConstraintClause = "addUkPkClause" | "addFkClause"
addSCOClause = "addIndexClause" | "addIndexPartitionClause" |
"addIndexPartitionKeyClause" | "addPartitionClause" |
"addPartitionKeyClause" | "addSubpartitionClause" |
"addaddMaterializedViewSCOandDependentClauseClause" |
"addSubPartitionKeyClause" | "addIndexColumnClause"
addRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW ) "QUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
addUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ SET
"setUkPkPropertiesAndReferencesColumnsClauses" ]
addFkClause = FOREIGN_KEY "QUOTED_STRING" [ SET "setFkSubClauses" ]
addIndexClause = INDEX "QUOTED_STRING" [ SET
"setSCOConfigurationPropertiesClauses" ]
addIndexPartitionClause = INDEX_PARTITION "QUOTED_STRING" OF INDEX
"QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] (
"renameSCOConfigurationClause" [ SET
"setSCOConfigurationPropertiesClauses" ] | [ SET
"setSCOConfigurationPropertiesClauses" ] )
addIndexPartitionKeyClause = INDEX_PARTITION_KEY "QUOTED_STRING" OF INDEX
"QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ]
addPartitionClause = PARTITION "QUOTED_STRING" [ AT POSITION
"INTEGER_LITERAL" ] [ SET "setSCOConfigurationPropertiesClauses" ]
addPartitionKeyClause = PARTITION_KEY "QUOTED_STRING" [ SET
"setSCOConfigurationPropertiesClauses" ]
addSubpartitionClause = SUBPARTITION "QUOTED_STRING" OF PARTITION
"QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET
"setSCOConfigurationPropertiesClauses" ]
addaddMaterializedViewSCOandDependentClauseClause = TEMPLATE_SUBPARTITION
"QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET
"setSCOConfigurationPropertiesClauses" ]
addSubPartitionKeyClause = SUBPARTITION_KEY "QUOTED_STRING" [ SET
"setSCOConfigurationPropertiesClauses" ]
addIndexColumnClause = INDEX_COLUMN "QUOTED_STRING" OF INDEX
"QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ]
setUkPkPropertiesAndReferencesColumnsClauses = "setPropertiesClause" [ SET
( REF | REFERENCE ) "constraintColumnReferencesClause" ] | ( REF |
REFERENCE ) "constraintColumnReferencesClause"
setFkSubClauses = "setPropertiesClause" [ SET ( REF | REFERENCE )
"setFkReferencesClauses" ] | ( REF | REFERENCE )
"setFkReferencesClauses"
setSCOConfigurationPropertiesClauses = PROPERTIES "(" "propertyNameList"
")" VALUES "(" "propertyValueList" ")"
renameSCOConfigurationClause = RENAME TO "QUOTED_STRING"
constraintColumnReferencesClause = COLUMNS "(" "quotedNameList" ")"
setFkReferencesClauses = "constraintColumnReferencesClause" [ SET ( REF |
REFERENCE ) "constraintUkReferencesClause" ] |
"constraintUkReferencesClause" [ SET ( REF | REFERENCE )
"constraintColumnReferencesClause" ]
quotedNameList = "QUOTED_STRING" { "," "QUOTED_STRING" }
constraintUkReferencesClause = ( UNIQUE_KEY | PRIMARY_KEY )
"QUOTED_STRING" [ OF ( TABLE | VIEW ) "QUOTED_STRING" ]
Keywords And Parameters
createMaterializedViewCommand
This command creates a materialized view.
QUOTED_STRING
Specify the name of the materialized view to be created.
setPropertiesClause
Used to set properties (core, logical, physical, user-defined) for
materialized views (including partitions and subpartitions) and their
columns, indexes (including index partitions), unique keys, foreign keys,
and primary keys.
Note:
Constraints can be specified but will not be generated for either View or
Materialized View in this release.
Basic properties for VIEW, MATERIALIZED_VIEW:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the View, MaterializedView
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the View, MaterializedView
Name: VIEW_QUERY
Type: STRING(4000)
Valid Values: N/A
Default: ''
Sets the query definition in View and MaterializedView.
Basic properties for COLUMN:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the column
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the column
Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, SYS.XMLFORMAT,
TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE,
VARHCAR, VARCHAR2, XMLTYPE
Default: NUMBER
The datatype of a column
Name: LENGTH
Type: NUMBER
Valid Values:
Default: 1
The length of a number
Name: PRECISION
Type: NUMBER
Valid Values: 0 - 38
Default: 1
The precision of a number. Use 0 to specify floating-point numbers.
Name: SCALE
Type: NUMBER
Valid Values: -84 - 127
Default: 1
The scale of a number.
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Default value of the column
Name: NOT_NULL
Type: BOOLEAN
Valid Values: true, false
Default: false
Specify "true" to enforce Not Null restriction on a column.
Basic properties for PARTITION_KEY:
Name: TYPE
Type: STRING
Valid Values: RANGE, LIST, HASH, HASH BY QUANTITY
Default: (No default, must be one of the preceding choices)
Ask Oracle to partition the table rows according to a Hash Algorithm, lists
of values, or specified ranges.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH partitions the database should create on HASH BY
QUANTITY partitioning. For optimal load balancing you should specify a
number of partitions that is a power of 2. If you have multiple Partition
Keys, you only have to specify once.
Basic properties for PARTITION:
Name: VALUES_LESS_THAN
Type: STRING
Valid Values: N/A
Default: ''
Specify the noninclusive upper bound for the current RANGE partition. The
value list is a comma-delimited, ordered list of literal values
corresponding to the index partitioning column list. Always specify
MAXVALUE(s) as the value(s) of the last partition, and make sure you have
specified PARTITION_KEY(s) before you specify any PARTITION.
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
Specify a list of literal values for the current LIST partition. The value
list is a comma-delimited, ordered list of literal values corresponding to
the index partitioning column. Commas can be escaped using "" (for example
'1,2,3'). Always specify DEFAULT as the value of the last partition, and
make sure you have specified PARTITION_KEY(s) before you specify any
PARTITION.. Each LIST partition must have at least one value. No value,
including NULL, can appear in more than one partition.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH customized subpartitions the database should create
for a particular main RANGE partition (RANGE-HASH BY QUANTITY
partitioning). For optimal load balancing you should specify a number of
subpartitions that is a power of 2. If you have multiple Subpartition Keys,
you only have to specify once. Set it to 0 to reverse to the use of generic
template HASH_QUANTITY specified in SUBPARTITION_KEY.
Basic properties for SUBPARTITION_KEY:
Name: TYPE
Type: STRING
Valid Values: LIST, HASH, HASH BY QUANTITY
Default: (No default, must be one of the preceding choices)
For partition-level partitioning according to a Hash Algorithm or lists of
values. Each partition is further sorted into subpartitions.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH subpartitions the database should create on HASH BY
QUANTITY partitioning. For optimal load balancing you should specify a
number of subpartitions that is a power of 2. If you have multiple
Subpartition Keys, you only have to specify once.
Basic properties for SUBPARTITION:
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
Specify a list of literal values for the current LIST subpartition. The
value list is a comma-delimited, ordered list of literal values
corresponding to the index partitioning column. Always specify DEFAULT as
the value of the last subpartition, and make sure you have specified
SUBPARTITION_KEY(s) before you specify any SUBPARTITION. Each LIST
subpartition must have at least one value. No value, including NULL, can
appear in more than one subpartition.
Basic properties for TEMPLATE_SUBPARTITION:
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
In composite partitioning, template subpartitions are automatically applied
to those partitions without their subpartitions specified. Here for LIST
subpartitions only, specify a comma-delimited, ordered list of literal
values corresponding to the LIST subpartitioning column. Always specify
DEFAULT as the value of the last template LIST subpartition, and and make
sure you have specified SUBPARTITION_KEY(s) before you specify any
TEMPLATE_SUBPARTITION. Each LIST template subpartition must have at least
one value. No value, including NULL, can appear in more than one template
subpartition.
Basic properties for INDEX:
Name: INDEX_TYPE
Type: STRING
Valid Values: UNIQUE, NON-UNIQUE, BITMAP, FUNCTION-BASED
Default: (No default, must be one of the preceding choices)
Specify the type of an index. NORMAL can be used in place of NON-UNIQUE.
Name: LOCAL_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Specify if an index is Global or Local. The default is Global.
Specify Local so that the index is partitioned on the same columns, with
the same number of partitions and the same partition bounds as table.
Oracle Database automatically maintains local index partitioning as the
underlying table is repartitioned.
Name: COLUMN_EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
Specify an expression built from columns of table, constants, SQL
functions, and user-defined functions to create a FUNCTION-BASED index.
Basic properties for INDEX_PARTITION_KEY:
Name: TYPE
Type: STRING
Valid Values: RANGE, HASH, HASH BY QUANTITY
Default: (No default, must be one of the preceding choices)
Ask Oracle to partition the index rows according to a Hash Algorithm, lists
of values, or specified ranges. Hash index partitioning is supported
starting with Oracle Database 10g version.
Name: HASH_QUANTITY
Type: STRING
Valid Values: N/A
Default: '0'
Specify how many HASH index partitions the database should create based on
HASH BY QUANTITY partitioning. For optimal load balancing you should
specify a number of index partitions that is a power of 2. If you have
multiple index Partition Keys, you only have to specify once.
Basic properties for INDEX_PARTITION:
Name: VALUES_LESS_THAN
Type: STRING
Valid Values: N/A
Default: ''
Specify the noninclusive upper bound for the current RANGE partition in a
global index. The value list is a comma-delimited, ordered list of literal
values corresponding to the index partitioning column list. Always specify
MAXVALUE(s) as the value(s) of the last partition. No need to specify
VALUES_LESS_THAN for Local index.
Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: N/A
Default: ''
Specify a list of literal values for the current LIST partition in a global
index. The value list is a comma-delimited, ordered list of literal values
corresponding to the index partitioning column. Always specify DEFAULT as
the value of the last partition. Each LIST partition must have at least one
value. No value, including NULL, can appear in more than one partition. No
need to specify VALUES_EQUAL_TO for Local index.
Basic properties for CHECK_CONSTRAINTS:
Name: CHECK_CONDITION
Type: STRING
Valid Values: N/A
Default: ''
Specify a condition that each row in the table must satisfy.
Properties for MATERIALIZED_VIEW:
Name: BASE_TABLES
Type: STRING
Valid Values: N/A
Default: ''
Specify a comma separated list of base tables for generating materialized
view log.
Name: BUFFER_POOL
Type: STRING
Valid Values: , DEFAULT, KEEP, RECYCLE
Default: ''
Specify a default buffer pool (cache) for the database object. The default
is DEFAULT.
Name: BUILD
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE, PREBUILT
Default: ''
Specify IMMEDIATE to populate the view when it is created. Specify DEFERRED
to delays population until the next refresh operation. IMMEDIATE is the
default.
Name: CONSTRAINTS
Type: STRING
Valid Values: , ENFORCED, TRUSTED
Default: ''
Specify TRUSTED to let Oracle Database use dimension and constraint
information that has been declared trustworthy by the database
administrator but that has not been validated by the database. If the
dimension and constraint information is valid, then performance may
improve. However, if this information is invalid, then the refresh
procedure may corrupt the materialized view even though it returns a
success status. ENFORCED is the default.
Name: DEFAULTINDEXBUFFERPOOL
Type: STRING
Valid Values: , DEFAULT, KEEP, RECYCLE
Default: ''
Specify a default buffer pool (cache) for the database object. The default
is DEFAULT.
Name: DEFAULTINDEXFREELISTGROUPS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of groups of free lists for the database object you are
creating. The default is 1.
Name: DEFAULTINDEXFREELISTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of free lists for each of the free list groups for the
database object. The default is 1.
Name: DEFAULTINDEXINITIAL
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the first extent. Use K or M to specify size
in kilobytes or megabytes.
Name: DEFAULTINDEXINITRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the initial number (2-255) of concurrent transaction entries
allocated within each data block allocated to the database object. The
default is 2.
Name: DEFAULTINDEXMAXEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents, including the first, that Oracle can
allocate for the database object.
Name: DEFAULTINDEXMAXTRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the maximum number (1-255) of concurrent transactions that can
update a data block allocated to the database object.
Name: DEFAULTINDEXMINEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents to allocate when the object is created.
Name: DEFAULTINDEXNEXT
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the next extent to be allocated. Use K or M to
specify size in kilobytes or megabytes.
Name: DEFAULTINDEXPCTINCREASE
Type: STRING
Valid Values: N/A
Default: ''
Specify the percent by which the third and subsequent extents grow over the
preceding extent. The default is 50.
Name: DEFAULT_INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Specify tablespace for default index storage.
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: FOR_UPDATE
Type: STRING
Valid Values: , NO, YES
Default: ''
Specify YES (FOR UPDATE) to allow a subquery, primary key, object, or rowid
materialized view to be updated. When used in conjunction with Advanced
Replication, these updates will be propagated to the master. The default is
NO.
Name: FREELISTGROUPS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of groups of free lists for the database object you are
creating. The default is 1.
Name: FREELISTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of free lists for each of the free list groups for the
database object. The default is 1.
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: HASH_PARTITION_TABLESPACE_LIST
Type: STRING
Valid Values: N/A
Default: ''
A comma separated list of tablespaces to use for [sub]partition storage.
Name: INITIAL
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the first extent. Use K or M to specify size
in kilobytes or megabytes.
Name: INITRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the initial number (1-255) of concurrent transaction entries
allocated within each data block allocated to the database object. The
default is 1.
Name: LOGGING_MODE
Type: STRING
Valid Values: , LOGGING, NOLOGGING
Default: ''
Specify whether the creation of the table and of any indexes required
because of constraints, partition, or LOB storage characteristics will be
logged in the redo log file (LOGGING) or not (NOLOGGING). The default is
LOGGING.
Name: MAXEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents, including the first, that Oracle can
allocate for the database object.
Name: MAXTRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the maximum number (1-255) of concurrent transactions that can
update a data block allocated to the database object.
Name: MINEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents to allocate when the object is created.
Name: NEXT
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the next extent to be allocated. Use K or M to
specify size in kilobytes or megabytes.
Name: NEXTDATE
Type: STRING
Valid Values: N/A
Default: ''
Specify a datetime expression for calculating the interval between
automatic refreshes.
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: , NOPARALLEL, PARALLEL
Default: ''
Specify NOPARALLEL for serial execution. This is the default. Specify
PARALLEL if you want Oracle to select a degree of parallelism equal to the
number of CPUs available on all participating instances times the value of
the PARALLEL_THREADS_PER_CPU initialization parameter.
Name: PARALLEL_DEGREE
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of parallel threads used in the parallel operation.
Normally Oracle calculates the optimum degree of parallelism, so it is not
necessary for you to specify it.
Name: PCTFREE
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the percentage (0-99) of space in each
data block of the database object reserved for future updates to the rows
of the object. The default is 10.
Name: PCTINCREASE
Type: STRING
Valid Values: N/A
Default: ''
Specify the percent by which the third and subsequent extents grow over the
preceding extent. The default is 50.
Name: PCTUSED
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the minimum percentage (0-99) of used
space that Oracle maintains for each data block of the database object. The
default is 40.
Name: QUERY_REWRITE
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE to mark the materialized view eligible for query rewrite or
DISABLE to mark the materialized view ineligible for query rewrite. DISABLE
is the default.
Name: REFRESH
Type: STRING
Valid Values: , COMPLETE, FAST, FORCE, NEVER
Default: ''
Specify FAST to indicate the incremental refresh method. Specify COMPLETE
to indicate the complete refresh method, which is implemented by executing
the defining query of the materialized view. Specify FORCE to indicate that
when a refresh occurs, Oracle Database will perform a fast refresh if one
is possible or a complete refresh otherwise. FORCE is the default. Specify
NEVER to prevent the materialized view from being refreshed with any Oracle
Database refresh mechanism or packaged procedure.
Name: REFRESH_ON
Type: STRING
Valid Values: , COMMIT, DEMAND
Default: ''
Specify COMMIT to indicate that a fast refresh is to occur whenever the
database commits a transaction that operates on a master table of the
materialized view. Specify DEMAND to indicate that the materialized view
will be refreshed on demand by calling one of the three DBMS_MVIEW refresh
procedures. DEMAND is the default.
Name: ROLLBACK
Type: STRING
Valid Values: , DEFAULT, DEFAULT LOCAL, DEFAULT MASTER, NONE
Default: DEFAULT LOCAL
Specify DEFAULT for Oracle Database to choose automatically which rollback
segment to use. Specify DEFAULT MASTER for the remote rollback segment to
be used at the remote master site for the individual materialized view.
Specify DEFAULT LOCAL for the remote rollback segment to be used for the
local refresh group that contains the materialized view. DEFAULT LOCAL is
the default. Specify NONE to name both master and local rollback segments.
Name: ROLLBACKSEGMENTLOCAL
Type: STRING
Valid Values: N/A
Default: ''
Specify a named remote rollback segment to be used for the local refresh
group that contains the materialized view. Default is null. Ignore if
DEFAULT or DEFAULT LOCAL is specified for default rollback segment.
Name: ROLLBACKSEGMENTMASTER
Type: STRING
Valid Values: N/A
Default: ''
Specify a named remote rollback segment to be used at the remote master
site for the individual materialized view. Default is null. Ignore if
DEFAULT or DEFAULT MASTER is specified for default rollback segment.
Name: SHADOW_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Name: SHADOW_TABLE_NAME
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the shadow table name to specify the name of Shadow Table.
Name: STARTWITH
Type: STRING
Valid Values: N/A
Default: ''
Specify a datetime expression for the first automatic refresh time.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Name: USING_INDEX_MODE
Type: STRING
Valid Values: , USING_INDEX, USING_NO_INDEX
Default: ''
Specify USING_NO_INDEX to suppress the creation of the default index for
Materialized View. You can create an alternative index for a Materialized
View explicitly. The default is USING_INDEX.
Name: WITH
Type: STRING
Valid Values: , PRIMARY_KEY, ROWID
Default: ''
Specify PRIMARY KEY to create a primary key materialized view. Specify
ROWID to create a rowid materialized view. Rowid materialized views are
useful if the materialized view does not include all primary key columns of
the master tables. Rowid materialized views must be based on a single table
and meet other restrictions. PRIMARY KEY is the default.
Properties for UNIQUE_KEY:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.TABLE.CONSTRAINT.INDEXTABLESPACE:DESCRIPTION"
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
oracle.owb.scripting.help.OMBHelpGenerator(557): NLS Lookup error for key
"9i.TABLE.CONSTRAINT.USINGINDEX:DESCRIPTION"
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Properties for FOREIGN_KEY:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: ONDELETE
Type: STRING
Valid Values: , CASCADE, SET NULL
Default: ''
Specify CASCADE if you want Oracle to remove dependent foreign key values.
Specify SET NULL if you want Oracle to convert dependent foreign key values
to NULL.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Properties for CHECK_CONSTRAINT:
Name: DEFERRABLE
Type: STRING
Valid Values: , DEFERRABLE, NOT DEFERRABLE
Default: ''
Specify DEFERRABLE to indicate that in subsequent transactions you can use
the SET CONSTRAINT[S] clause to defer checking of this constraint until
after the transaction is committed. Specify NOT DEFERRABLE to indicate that
in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to
defer checking of this constraint until the transaction is committed. The
default is NOT DEFERRABLE.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: ENABLECONSTRAINT
Type: STRING
Valid Values: , DISABLE, ENABLE
Default: ''
Specify ENABLE if you want the constraint to be applied to the data in the
table. Specify DISABLE to disable the integrity constraint. The default is
ENABLE.
Name: EXCEPTIONSINTO
Type: STRING
Valid Values: N/A
Default: ''
Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the
table you specify must exist on your local database. If you create your own
exceptions table, then it must follow the format prescribed by one of the
two scripts supplied by Oracle. Do not use this property with NOVALIDATE
option.
Name: INITIALLY
Type: STRING
Valid Values: , DEFERRED, IMMEDIATE
Default: ''
Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a
DEFERRABLE constraint at the end of each subsequent SQL statement. Specify
(INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE
constraint at the end of subsequent transactions. The default is
(INITIALLY) IMMEDIATE.
Name: RELY
Type: STRING
Valid Values: , NORELY, RELY
Default: ''
Specify RELY to activate an existing constraint in NOVALIDATE mode for
query rewrite in an unenforced query rewrite integrity mode. The default is
NORELY.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: VALIDATECONSTRAINT
Type: STRING
Valid Values: , NOVALIDATE, VALIDATE
Default: ''
The behavior of VALIDATE and NOVALIDATE always depends on whether the
constraint is enabled or disabled, either explicitly or by default.
(ENABLE) VALIDATE specifies that all old and new data must compliy with the
constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on
the constrained data comply with the constraint. (DISABLE) VALIDATE
disables the constraint and drops the index on the constraint, but keeps
the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no
effort to maintain the constraint (because it is disabled) and cannot
guarantee that the constraint is true (because it is not being validated).
The default is NOVALIDATE.
Properties for INDEX:
Name: BUFFER_POOL
Type: STRING
Valid Values: , DEFAULT, KEEP, RECYCLE
Default: ''
Specify a default buffer pool (cache) for table or partition object. The
default is DEFAULT.
Name: COMPUTESTATISTICS
Type: STRING
Valid Values: , NO, YES
Default: ''
Specify YES to collect statistics at relatively little cost during the
creation of an index.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: FREELISTGROUPS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of groups of free lists for the database object you are
creating. The default is 1.
Name: FREELISTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of free lists for each of the free list groups for the
table, partition, cluster, or index. The default is 1.
Name: INDEXORDER
Type: STRING
Valid Values: , ASC, DESC
Default: ''
Use ASC or DESC to indicate whether the index should be created in
ascending or descending order. The Oracle default is ASC.
Name: INITIAL
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the first extent. Use K or M to specify size
in kilobytes or megabytes.
Name: INITRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the initial number (2-255) of concurrent transaction entries
allocated within each data block allocated to the database object. The
default is 2 for Index.
Name: KEYCOMPRESS
Type: STRING
Valid Values: , COMPRESS, NOCOMPRESS
Default: ''
Specify COMPRESS to enable key compression.
Name: KEYCOMPRESSPREFIXLENGTH
Type: STRING
Valid Values: N/A
Default: ''
Specify the prefix length (number of prefix columns to compress). For
unique indexes, the valid range of prefix length values is from 1 to the
number of key columns minus 1. The default prefix length is the number of
key columns minus 1. For nonunique indexes, the valid range of prefix
length values is from 1 to the number of key columns. The default prefix
length is the number of key columns. Oracle compresses only nonpartitioned
indexes that are nonunique or unique indexes of at least two columns. You
cannot specify COMPRESS for a bitmap index.
Name: LOGGING_MODE
Type: STRING
Valid Values: , LOGGING, NOLOGGING
Default: ''
Specify whether the creation of the table and of any indexes required
because of constraints, partition, or LOB storage characteristics will be
logged in the redo log file (LOGGING) or not (NOLOGGING). The default is
LOGGING.
Name: MAXEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents, including the first, that Oracle can
allocate for the object.
Name: MAXTRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the maximum number (2-255) of concurrent transactions that can
update a data block allocated to the database object.
Name: MINEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents to allocate when the object is created.
Name: NEXT
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the next extent to be allocated. Use K or M to
specify size in kilobytes or megabytes.
Name: ONLINE
Type: STRING
Valid Values: , NO, YES
Default: ''
Specify YES to indicate that DML operations on the table will be allowed
during creation of the index.
Name: OPTIMAL
Type: STRING
Valid Values: N/A
Default: ''
Specifies an optimal size in bytes for a rollback segment. Use K or M to
specify this size in kilobytes or megabytes. Specify NULL for no optimal
size for the rollback segment. The default is NULL.
Name: OVERFLOW
Type: STRING
Valid Values: N/A
Default: ''
Enter a comma separated list of Index tablespaces for overflow data. For
simple-partitoned object, it is used for HASH BY QUANTITY partition
overflow Index tablespaces. The number of Index tablespaces does not have
to equal the number of partitions. If the number of partitions is greater
than the number of Index tablespaces, then Oracle cycles through the names
of the Index tablespaces.
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: , NOPARALLEL, PARALLEL
Default: ''
Enables or disables parallel processing when the table is created. Also
enables or disables parallel processing or access. The default is PARALLEL.
Name: PARALLEL_DEGREE
Type: STRING
Valid Values: N/A
Default: ''
Enter degree of parallelism, which is the number of parallel threads used
in the parallel operation.
Name: PARTITION_TABLESPACE_LIST
Type: STRING
Valid Values: N/A
Default: ''
Enter a comma separated list of tablespaces for a locally partitioned
index. For simple-partitoned object, it is used for HASH BY QUANTITY
partition tablespaces. If specified, then individual local Hash index
partitions specified will be ignored for Local Hash or Range-Hash Index
partitioning.
Name: PCTFREE
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the percentage (0-99) of space in each
data block of the database object reserved for future updates to the rows
of the object. The default is 10.
Name: PCTINCREASE
Type: STRING
Valid Values: N/A
Default: ''
Specify the percent by which the third and subsequent extents grow over the
preceding extent. The default is 50.
Name: SORT
Type: STRING
Valid Values: , NOSORT, REVERSE, SORT
Default: ''
Specify NOSORT to indicate to Oracle that the rows are already stored in
the database in ascending order. Specify REVERSE to store the bytes of the
index block in reverse order, excluding the rowid.
Name: SUBSTITUTE_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
This is related to Streams Support. If this is true, deployment will result
only in creation of the key metadata. The constraint itself will not be
enforced. This will be done by creating a Streams substitute key.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Properties for PARTITION:
Name: BUFFER_POOL
Type: STRING
Valid Values: , DEFAULT, KEEP, RECYCLE
Default: ''
Specify a default buffer pool (cache) for table or partition object. The
default is DEFAULT.
Name: DATA_SEGMENT_COMPRESSION
Type: STRING
Valid Values: , COMPRESS, NOCOMPRESS
Default: ''
Use this clause to instruct Oracle whether to compress data segments to
reduce disk use. The default is NOCOMPRESS.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: FREELISTGROUPS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of groups of free lists for the database object you are
creating. The default is 1.
Name: FREELISTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the number of free lists for each of the free list groups for the
table, partition, cluster, or index.
Name: INITIAL
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the first extent. Use K or M to specify size
in kilobytes or megabytes.
Name: INITRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the initial number (1-255) of concurrent transaction entries
allocated within each data block allocated to the database object. The
default is 1 for Table and 2 for Index.
Name: LOGGING_MODE
Type: STRING
Valid Values: , LOGGING, NOLOGGING
Default: ''
Specify whether the creation of the table and of any indexes required
because of constraints, partition, or LOB storage characteristics will be
logged in the redo log file (LOGGING) or not (NOLOGGING). The default is
LOGGING.
Name: MAXEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents, including the first, that Oracle can
allocate for the object.
Name: MAXTRANS
Type: STRING
Valid Values: N/A
Default: ''
Specify the maximum number (1-255) of concurrent transactions that can
update a data block allocated to the database object.
Name: MINEXTENTS
Type: STRING
Valid Values: N/A
Default: ''
Specify the total number of extents to allocate when the object is created.
Name: NEXT
Type: STRING
Valid Values: N/A
Default: ''
Specify in bytes the size of the next extent to be allocated. Use K or M to
specify size in kilobytes or megabytes.
Name: OPTIMAL
Type: STRING
Valid Values: N/A
Default: ''
Specifies an optimal size in bytes for a rollback segment. Use K or M to
specify this size in kilobytes or megabytes. Specify NULL for no optimal
size for the rollback segment. The default is NULL.
Name: PCTFREE
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the percentage (0-99) of space in each
data block of the database object reserved for future updates to the rows
of the object. The default is 10.
Name: PCTINCREASE
Type: STRING
Valid Values: N/A
Default: ''
Specify the percent by which the third and subsequent extents grow over the
preceding extent. The default is 50.
Name: PCTUSED
Type: STRING
Valid Values: N/A
Default: ''
Specify a whole number representing the minimum percentage (0-99) of used
space that Oracle maintains for each data block of the database object. The
default is 40.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
addColumnClause
This clause adds a column.
When you create a table or alter a table to add a set of columns, the
position that you specify for a column must be either less than or equal to
the number of columns that you have listed up to that point in the command.
For example, the following OMBCREATE command does not add the specified
columns to the table:
OMBCREATE TABLE 'MY_TABLE' \
SET PROPERTIES (DESCRIPTION) VALUES ('TRIAL TABLE') \
ADD COLUMN 'C1' \
SET PROPERTIES (DATATYPE, PRECISION) VALUES ('NUMBER',10) \
ADD COLUMN 'C2' AT POSITION 3 \
SET PROPERTIES (DATATYPE, PRECISION) VALUES ('NUMBER',10) \
ADD COLUMN 'C3' AT POSITION 2 \
SET PROPERTIES (DATATYPE) VALUES ('VARCHAR2')
This is because at the point when you specify the position of the column
C2 as 3, you have added just two columns to the table.But the following
OMBALTER command adds the specified columns to the table. This is because
at the point when you specify the position of the column C2 as 2, you are
adding the second column to the table.
OMBCREATE TABLE 'MY_TABLE' \
SET PROPERTIES (DESCRIPTION) VALUES ('TRIAL TABLE') \
ADD COLUMN 'C1' \
SET PROPERTIES (DATATYPE, PRECISION) VALUES ('NUMBER',10) \
ADD COLUMN 'C2' AT POSITION 2 \
SET PROPERTIES (DATATYPE) VALUES ('VARCHAR2') \
ADD COLUMN 'C3' AT POSITION 1 \
SET PROPERTIES (DATATYPE, PRECISION) VALUES ('NUMBER',10)
In the preceding example, the order in which the columns are added are as
follows:
C1
C1, C2
C3, C1, C2
addViewConstraintClause
This clause adds the view's configuration clause.
addSCOClause
This clause will add SCOs.
addRelationalDependentClause
This clause adds referential dependencies to other relational objects.
propertyValue
This clause adds the property values.
addUkPkClause
This clause adds the adds unique key and primary keys.
QUOTED_STRING
name of the unique key or primary key.
addFkClause
This clause adds foreign key.
QUOTED_STRING
Name of the foreign key.
addIndexClause
This clause adds an index.
QUOTED_STRING
Name of the index.
addPartitionClause
This clause adds a partition.
QUOTED_STRING
Name of the partition.
addPartitionKeyClause
This clause adds a partition key.
QUOTED_STRING
Name of the partition key. This should be a column identifier.
addIndexColumnClause
This clause will add index column to a specified index.
QUOTED_STRING
This should be a column identifier of owning object (such as a table) of
the index.
setUkPkPropertiesAndReferencesColumnsClauses
This clause adds properties and references to columns.
setFkSubClauses
This clause set references to a foreign key.
setSCOConfigurationPropertiesClauses
Set the configuration properties for the following:
- Partition, Subpartition, and Template Subpartition: All refer to
configuration properties of Partition.
- Index, and Index Partition: For Index Partition, refer to configuration
properties of Partition.
renameSCOConfigurationClause
This clause renames configuration objects.
constraintColumnReferencesClause
This clause provides names of all columns.
setFkReferencesClauses
This clause sets foreign key references.
quotedNameList
This clause gives column names.
constraintUkReferencesClause
The first QUOTED_STRING denotes the UniqueKey or Primay key name, and the
latter denotes the table's or view's name.
Examples
OMBCREATE MATERIALIZED_VIEW 'NEW_MATERIALIZED_VIEW' SET PROPERTIES
(DESCRIPTION, BUSINESS_NAME) VALUES ('this is a new materialized view',
'New MaterializedView')
This will create a materialized view named "NEW_VIEW", its description is
"this is a new materialized view", and business name is "New
MaterializedView".
See Also
OMBCREATE, OMBALTER MATERIALIZED_VIEW, OMBDROP MATERIALIZED_VIEW, OMBRETRIEVE MATERIALIZED_VIEW
Purpose
Create a metadataloader action plan.
Prerequisites
Connection must be established to the repository.
Syntax
createMDLActionPlanCommand = ( OMBCREATE TRANSIENT MDL_ACTION_PLAN
"QUOTED_STRING" { "addActionClause" } )
addActionClause = ADD ACTION "QUOTED_STRING" "setReferenceClause"
setReferenceClause = SET ( REF | REFERENCE ) ( "referenceValueClause" )
referenceValueClause = "objectTypeValue" "QUOTED_STRING" [ SET ( REF |
REFERENCE ) "referenceValueClause" ]
objectTypeValue = ( PROJECT | ORACLE_MODULE | TABLE | VIEW | SEQUENCE |
MATERIALIZED_VIEW | FUNCTION | PROCEDURE | PACKAGE | DIMENSION | CUBE
| ADVANCED_QUEUE | STREAMS_QUEUE | MAPPING | REAL_TIME_MAPPING |
PROCESS_FLOW_MODULE | PROCESS_FLOW_PACKAGE | PROCESS_FLOW | SAP_MODULE
| CMI_MODULE | GATEWAY_MODULE | EXTERNAL_TABLE | FLAT_FILE_MODULE |
FLAT_FILE | BUSINESS_DEFINITION_MODULE | BUSINESS_PRESENTATION_MODULE
| ITEM_FOLDER | LIST_OF_VALUES | DRILL_TO_DETAIL |
ALTERNATIVE_SORT_ORDER | DRILL_PATH | BUSINESS_AREA |
PRESENTATION_TEMPLATE | LOCATION | CONNECTOR | CONTROL_CENTER |
CONFIGURATION | COLLECTION | SNAPSHOT | ROLE | USER | ICONSET |
TRANSFORMATION_MODULE | CALENDAR_MODULE | CALENDAR_FOLDER | CALENDAR |
EXPERT_MODULE | EXPERT | DATA_RULE_MODULE | DATA_RULE | DATA_AUDITOR
| STREAMS_CAPTURE_PROCESS | QUEUE_TABLE | QUEUE_PROPAGATION |
OBJECT_TYPE | NESTED_TABLE | VARYING_ARRAY | DEPLOYMENT | DATA_PROFILE
| PROFILE_REFERENCE | PLSQL_TABLE_TYPE | PLSQL_RECORD_TYPE |
PLSQL_REF_CURSOR_TYPE | PLUGGABLE_MAPPING | PLUGGABLE_MAPPING_FOLDER |
CMI_DEFINITION | ACTIVITY_TEMPLATE | ACTIVITY_TEMPLATE_FOLDER |
TRANSPORTABLE_MODULE )
Keywords And Parameters
createMDLActionPlanCommand
Create a metadata loader action plan.
QUOTED_STRING
Name of the action plan in a single-quoted string. It is case-insensitive.
addActionClause
Add an action to an action plan.
QUOTED_STRING
Name of the action in a single-quoted string. It is case-insensitive.
Must be unquie within an action plan.
setReferenceClause
Specify the object type and the absolute path name of an object.
referenceValueClause
Specify a first-class object type and the absolute path name of an object.
QUOTED_STRING
Absolute path name of an object (for example '/MY_PROJECT/MODULE_X/TABLE_Y').
objectTypeValue
The first-class object type that is allowed to be specified in the
referenceValueClause.
Examples
OMBCREATE TRANSIENT MDL_ACTION_PLAN 'MY_ACTION_PLAN'
OMBCREATE TRANSIENT MDL_ACTION_PLAN 'MY_PROJECT_ACTION_PLAN'
ADD ACTION 'MY_PROJECT'
SET REFERENCE PROJECT '/MY_PROJECT'
OMBCREATE TRANSIENT MDL_ACTION_PLAN 'GRANULAR_OBJECTS_ACTION_PLAN'
ADD ACTION 'GRANULAR_OBJS'
SET REFERENCE TABLE '/MY_PROJECT/DW/TABLE_1'
SET REFERENCE VIEW '/MY_PROJECT/DW/.*'
SET REFERENCE DIMENSION '/MY_PROJECT/DW/D.*'
SET REFERENCE MAPPING '/MY_PROJECT/DW/[M,P,S].*'
OMBCREATE TRANSIENT MDL_ACTION_PLAN 'MULTI_PROJECT_ACTION_PLAN'
ADD ACTION 'MULTI_PROJ'
SET REFERENCE PROJECT '/PUBLIC_PROJECT'
SET REFERENCE PROJECT '/MY_PROJECT'
SET REFERENCE PROJECT '/ABC_PROJECT'
OMBCREATE TRANSIENT MDL_ACTION_PLAN 'ADMIN_ACTION_PLAN'
ADD ACTION 'ADMIN'
SET REFERENCE USER '.*'
SET REFERENCE ROLE 'S.*'
SET REFERENCE ICONSET 'ICONSET_1'
SET REFERENCE CMI_DEFINITION 'CMI_DEF1'
OMBCREATE TRANSIENT MDL_ACTION_PLAN 'SNAPSHOT_ACTION_PLAN'
ADD ACTION 'SNAPSHOTS'
SET REFERENCE SNAPSHOT 'SNAPSHOT_MY_PROJECT'
See Also
OMBALTER MDL_ACTION_PLAN, OMBDROP MDL_ACTION_PLAN, OMBRETRIEVE MDL_ACTION_PLAN, OMUEXPORT MDL_FILE
Purpose
Create a data mining model in an Oracle Module
Prerequisites
Should be in Oracle Module context
Syntax
createMiningModelCommand = OMBCREATE MINING_MODEL "miningModelName" [
"miningFunctionAndAlgorithmClause" ]
"createMiningMapOperatorOwnerDetailClause"
miningModelName = "QUOTED_STRING"
miningFunctionAndAlgorithmClause = FOR MINING_FUNCTION "QUOTED_STRING" [
USING MINING_ALGORITHM "QUOTED_STRING" ]
createMiningMapOperatorOwnerDetailClause = [
"setMiningModelAndMapPropertiesClause" ]
"createOperatorOwnerDescendantsClause"
setMiningModelAndMapPropertiesClause = ( SET "setPropertiesClause" |
"setMiningMapPropertiesClause" )
createOperatorOwnerDescendantsClause = { ADD ( "addOperatorClause" |
"addGroupClause" | "addAttributeClause" | "addChildClause" |
"addConnectionClause" ) }
setPropertiesClause = PROPERTIES "propertyKeyList" VALUES
"propertyValueList"
setMiningMapPropertiesClause = SET MINING_BUILD_MAP PROPERTIES
"propertyKeyList" VALUES "propertyValueList"
addOperatorClause = "operatorType" OPERATOR "operatorName" [
"pluggableMapBottomUpLocator" ] [ SET "setPropertiesClause" ] [
"setBindingClause" ]
addGroupClause = "groupDirection" GROUP "groupName" OF
"operatorBottomUpLocator" [ SET "setPropertiesClause" ]
addAttributeClause = ATTRIBUTE "attributeName" OF "groupBottomUpLocator" [
SET "setPropertiesClause" ]
addChildClause = "childType" "childName" "childOwnerBottomUpLocator" [ SET
"setPropertiesClause" ]
addConnectionClause = CONNECTION FROM ( "groupBottomUpLocator" TO
"groupBottomUpLocator" [ "groupToGroupConnectType" ] |
"attributeBottomUpLocator" TO ( "attributeBottomUpLocator" |
"attributesBottomUpLocator" | "groupBottomUpLocator" ) |
"attributesBottomUpLocator" TO ( "attributesBottomUpLocator" |
"groupBottomUpLocator" ) )
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")"
operatorType = PLUGGABLE_MAPPING | "UNQUOTED_STRING"
operatorName = "QUOTED_STRING"
pluggableMapBottomUpLocator = ( OF PLUGGABLE_MAPPING "pluggableMapName" [
"pluggableMapBottomUpLocator" ] )
setBindingClause = BOUND TO "bindableLocator"
groupDirection = INPUT | OUTPUT | INPUT_OUTPUT
groupName = "QUOTED_STRING"
operatorBottomUpLocator = OPERATOR "operatorName" [
"pluggableMapBottomUpLocator" ]
attributeName = "QUOTED_STRING"
groupBottomUpLocator = GROUP "groupName" OF "operatorBottomUpLocator"
childType = "UNQUOTED_STRING"
childName = "QUOTED_STRING"
childOwnerBottomUpLocator = { OF "childType" "childName" } [ OF
"mappableBottomUpLocator" ]
groupToGroupConnectType = COPY ALL | BY ( NAME [ IGNORE ( SPECIAL_CHARS
"QUOTED_STRING" | SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX
"QUOTED_STRING" | TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX
"QUOTED_STRING" ) { "," IGNORE ( SPECIAL_CHARS "QUOTED_STRING" |
SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX "QUOTED_STRING" |
TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX "QUOTED_STRING" ) } ] |
POSITION )
attributeBottomUpLocator = ATTRIBUTE "attributeName" OF
"groupBottomUpLocator"
attributesBottomUpLocator = ATTRIBUTES "attributeNameList" OF
"groupBottomUpLocator"
propertyKey = "UNQUOTED_STRING"
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
pluggableMapName = "QUOTED_STRING"
bindableLocator = "bindableType" "bindableName" [ OF "bindableType"
"bindableName" ]
mappableBottomUpLocator = "operatorBottomUpLocator" |
"groupBottomUpLocator" | "attributeBottomUpLocator"
attributeNameList = "(" "attributeName" { "," "attributeName" } ")"
bindableType = PLUGGABLE_MAPPING | MINING_MODEL | OBJECT_TYPE |
"UNQUOTED_STRING"
bindableName = "QUOTED_STRING"
Keywords And Parameters
createMiningModelCommand
Create a data mining model in an Oracle Module, and specify the mapping
that builds the mining model
createOperatorOwnerDescendantsClause
Create the desired child objects of a mapping or a pluggable mapping.
setPropertiesClause
Describe the keys of properties for the map or objects in the map.
addOperatorClause
Adds a mapping operator to a map. When you add an operator, Warehouse
Builder creates default groups and parameters for the operator. Please see
the appendix section of the Scripting Reference.
The following is an example for creating a child object under a mapping
(which is not an operator)
OMBALTER MAPPING 'M1' ADD SOURCE_DATA_FILE 'FILE1'
The following is an example for creating an operator:
OMBALTER MAPPING 'M1' ADD TABLE OPERATOR 'T1'
In the second example, when user forgets to type "OPERATOR" "GROUP"
"ATTRIBUTE" key word, instead of complaining the keywords are missing,
OMBPlus will complain about error getting child objects. Here is an
example:
OMB+> OMBALTER MAPPING 'M1' ADD TABLE 'T1'
OMB02932: Error getting child objects of type TABLE in M1
TO A USER: it looks like OMBPlus should complain they forget to type a
keyword.
TO OMBPLUS: the syntax is actually for creating a non-operator child object
under the mapping. Therefore, it goes and tries to find type definition for
non-operator child object "TABLE" and cannot find it. Therefore the
exception is thrown.
addGroupClause
Add a mapping group to a mapping operator.
addAttributeClause
Add a mapping attribute to a mapping group.
addChildClause
Add a child to a mapping, mapping operator, mapping group or mapping
attribute.
addConnectionClause
Add connections between mapping groups or mapping attributes.
propertyKeyList
The list of property keys.
propertyValueList
A list of property values.
operatorType
Type of a mapping operator. The following operator types are available:
ADVANCED_QUEUE, AGGREGATOR, ANYDATA_CAST, CONSTANT, CUBE, DATA_GENERATOR,
DEDUPLICATOR, DIMENSION, EXPRESSION, EXTERNAL_PROCESS, EXTERNAL_TABLE,
FILTER, FLAT_FILE, INPUT_PARAMETER, JOINER, KEY_LOOKUP, LCRCAST,
LCRSPLITTER, MATCHMERGE, MATERIALIZED_VIEW, NAME_AND_ADDRESS,
OUTPUT_PARAMETER, PIVOT, POSTMAPPING_PROCESS, PREMAPPING_PROCESS, SEQUENCE,
SET_OPERATION, SORTER, SPLITTER, TABLE, TRANSFORMATION, UNPIVOT, VIEW.
operatorName
Name of a mapping operator.
pluggableMapBottomUpLocator
Location of a child pluggable mapping within a mapping or another pluggable
mapping.
setBindingClause
Set the binding during the creation of a mapping operator or mapping
attribute.
groupDirection
Direction of a mapping group.
groupName
Name of a mapping group.
operatorBottomUpLocator
Location of a mapping operator.
attributeName
Name of a mapping attribute.
groupBottomUpLocator
Location of a mapping group.
childType
Type of a child that belongs to map, mapping operator, mapping group or
mapping attribute.
childName
Name of a child that belongs to map, mapping operator, mapping group or
mapping attribute.
childOwnerBottomUpLocator
Location of a child owner. A child owner can be a map, mapping operator,
mapping group, mapping attribute or a child.
groupToGroupConnectType
Connecting from a mapping group in one mapping operator to a mapping group
in another mapping operator.
attributeBottomUpLocator
Location of a mapping attribute.
attributesBottomUpLocator
Location of a list of mapping attributes.
propertyKey
A property key for an object.
Basic properties for Mining Model:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the mining model
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the mining model
Name: ALGO_NAME
Type: STRING(200)
Valid Values: NAIVE_BAYES, ADAPTIVE_BAYES_NETWORK, SUPPORT_VECTOR_MACHINES,
KMEANS, PREDICTOR_VARIANCE, NONNEGATIVE_MATRIX_FACTORIZATION
Default:'Each mining function has a corresponding default'
Description: Name of the algorithm for the mining function
Properties for CLASSIFICATION mining function
Name: PRIORS_TABLE_NAME
Type: String
The name of the prior probabilities table
Settings for Naive Bayes algorithm:
Name: SINGLETON_THRESHOLD
Type: float
Valid Values: 0 .. 1
Default: '0.01'
Singleton Threshold for Naive Bayes Alogrithm
Name: PAIRWISE_THRESHOLD
Type: float
Valid Values: 0 .. 1
Default: '0.01'
Pairwise Threshold for Naive Bayes Alogrithm
Settings for the Adaptive Naye Bayes algorithm
Name: MODEL_TYPE
Type: String
Default: 'MULTI_FEATURE'
The model type for the Adaptive Bayes Network Algorithm
Name: MAX_NB_PREDICTORS
Type: Integer
Valid Values: 1 ..
Default: '10'
Maximum Naive Bayes Predictors
Name: MAX_PREDICTORS
Type: Integer
Valid Values: 1 ..
Default: '25'
Maximum Predictors
Name: MAX_BUILD_MINUTES
Type: Integer
Valid Values: 0 ..
Default: '0'
Maximum time (in minutes) allowed to build this model
Settings for the Support Vector Machines Algorithm for Adaptive Naive Bayes
Name: KERNEL_FUNCTION
Type: String
Valid Values: LINEAR,GAUSSIAN
Default: 'LINEAR'
Kernel function
Name: KERNEL_CACHE
Type: INTEGER
Valid Values: 1 ..
Default: '500000'
Value of the kernel cache for the SVM algorithm
Name: EPSILON
Type: float
Default: '0.1'
Value of the kernel cache for the SVM algorithm
Name: CONVTOLERANCE
Type: float
Valid Values: 0 ..
Default: '0.001'
Value of the convergence tolerance
Name: STDDEV
Type: float
Valid Values: 0 ..
Standard deviation for the SVM algorithm
Name: CFACTOR
Type: float
Complexity factor for the SVM algorithm
Name: TARGETTYPE
Type: String
Valid Values: SVMS_SINGLE_TARGET,SVMS_MULTI_TARGET
Default: 'SVMS_SINGLE_TARGET'
Target Type for the SVM algorithm
Properties for CLUSTERING function
Name: NUM_CLUSTERS
Type: Integer
Valid Values: 1 ..
Default: '10'
Properties for MINING_MODEL:
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Name: SETTINGS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: ''
Name of table which stores the settings for model build.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyValue
A single property value. It can be a number, float, boolean or
single-quoted string.
pluggableMapName
Name of the pluggable map.
bindableLocator
Location of the object to be bound to a mapping operator or mapping
attribute.
mappableBottomUpLocator
Location of the object to be bound to a mapping mapping operator or mapping
attribute.
attributeNameList
A list of attribute names.
bindableType
Type of object bound to a mapping operator or mapping attribute.
bindableName
Name of the object bound to a mapping operator or mapping attribute.
Examples
OMBCREATE MINING_MODEL 'MODEL1'
OMBCREATE MINING_MODEL 'MODEL1'
FOR MINING_FUNCTION 'CLASSIFICATION'
USING MINING_ALGORITHM 'algo_adaptive_bayes_nextwork'
See Also
OMBCREATE, OMBALTER MINING_MODEL, OMBRETRIEVE MINING_MODEL, OMBDROP MINING_MODEL
Purpose
To create an Nested Table (or NestedTable)
Prerequisites
Should be in the context of an Oracle Module
Syntax
createNestedTableCommand = OMBCREATE ( NESTED_TABLE "QUOTED_STRING" [ SET
( "setPropertiesClause" [ SET ( REF | REFERENCE )
"setReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createNestedTableCommand
Creates a Nested Table with the given name.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for Nested Table .
Valid properties are as shown:
Basic properties for NESTED_TABLE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Nested Table
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Nested Table
Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, SYS.XMLFORMAT,
TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE,
VARHCAR, VARCHAR2, XMLTYPE
Default: ''
Datatype of the Base Element of the Nested Table
Properties for NESTED_TABLE:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
Examples
OMBCREATE NESTED_TABLE 'NEW_NESTED_TABLE' SET PROPERTIES (DATATYPE) VALUES
('NUMBER')
This will create a NestedTable named 'NEW_NESTED_TABLE' with its base
element type as 'NUMBER' .
See Also
OMBCREATE, OMBALTER NESTED_TABLE, OMBDROP NESTED_TABLE
Purpose
To create an Object Type.
Prerequisites
Should be in the context of an Oracle Module.
Syntax
createObjectTypeCommand = OMBCREATE ( OBJECT_TYPE "QUOTED_STRING" [ SET (
"setPropertiesClause" [ SET ( REF | REFERENCE )
"setReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) ] [ "addObjectAttributesClause" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
addObjectAttributesClause = "addAttributeClause"+
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addAttributeClause = ADD OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING" [ AT
POSITION "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createObjectTypeCommand
Creates an Object Type with the given name.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for Object Type or
its Attributes. Valid properties are as shown:
Basic properties for OBJECT_TYPE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Object Type
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Object Type
Basic properties for OBJECT_TYPE_ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Attribute
Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, SYS.XMLFORMAT,
TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE,
VARHCAR, VARCHAR2, XMLTYPE
Default: ''
Datatype of the Attribute
Properties for OBJECT_TYPE:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
addObjectAttributesClause
Adds one or more Attributes in this Object Type.
propertyNameList
The list of properties.
propertyValueList
The list of property values.
addAttributeClause
Adds an Attribute with the given name and properties.
propertyValue
This clause adds the property values.
Examples
OMBCREATE OBJECT_TYPE 'NEW_OBJECT_TYPE' SET PROPERTIES (DESCRIPTION) VALUES
('this is an object type') ADD OBJECT_TYPE_ATTRIBUTE 'ATTR' SET PROPERTIES
(DATATYPE) VALUES ('VARCHAR2')
This will create an Object Type named "NEW_OBJECT_TYPE", its description
is "this is an object type" and an Attribute 'ATTR' of Varchar2 type.
See Also
OMBCREATE, OMBALTER OBJECT_TYPE, OMBDROP OBJECT_TYPE
Purpose
To create an Oracle module.
Prerequisites
Should be in the context of project.
Syntax
createOracleModuleCommand = OMBCREATE ( ORACLE_MODULE "QUOTED_STRING" [
SET ( "setPropertiesClause" [ SET
"setReferenceClauseForDataMetadataModule" ] |
"setReferenceClauseForDataMetadataModule" ) ] [
"addModuleReferenceLocationClause" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceClauseForDataMetadataModule = ( "setReferenceLocationClause" [
SET "setReferenceMetadataLocationOrIconSetClause" ] |
"setReferenceMetadataLocationOrIconSetClause" )
addModuleReferenceLocationClause = "addReferenceLocationClause" {
"addReferenceLocationClause" }
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
setReferenceMetadataLocationOrIconSetClause = (
"setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
] | "setReferenceIconSetClause" )
addReferenceLocationClause = ADD ( 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"
Keywords And Parameters
createOracleModuleCommand
This command creates an Oracle module
QUOTED_STRING
Name of the Oracle module to be created.
setPropertiesClause
Associate a set of properties with an Oracle module.
Basic properties for ORACLE_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of an Oracle Module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of an Oracle Module
Name: MODULE_TYPE
Type: STRING
Valid Values: N/A
Default: N/A
Type of oracle module. Supported values are: 'WAREHOUSE_TARGET',
'DATA_SOURCE'.By default, it is 'WAREHOUSE_TARGET'.
Properties for ORACLE_MODULE:
Name: ABAP_DIRECTORY
Type: STRING
Valid Values: N/A
Default: abap\
Location where SAP data is dumped as flat files
Name: ABAP_EXTENSION
Type: STRING
Valid Values: N/A
Default: .abap
File name extension for ABAP scripts
Name: ABAP_RUN_PARAMETER_FILE
Type: STRING
Valid Values: N/A
Default: _run.ini
Run Parameter File Suffix for the parameter script in a ABAP job.
Name: ABAP_SPOOL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: abap\log\
Location where ABAP scripts are buffered during script generation
processing.
Name: APPLICATION_SHORT_NAME
Type: STRING
Valid Values: N/A
Default: WB
Application Short Name
Name: ARCHIVE_DIRECTORY
Type: STRING
Valid Values: N/A
Default: archive\
Archive Directory
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
If this is a source module, this value indicates the location from which
data will be read. If this is a target warehouse module, this value
indicates the location where generated code will be deployed to and/or
where data will be written to.
Name: DDL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: ddl\
Location where scripts for database objects for the target schema are
stored.
Name: DDL_EXTENSION
Type: STRING
Valid Values: N/A
Default: .ddl
File name extension for DDL scripts.
Name: DDL_SPOOL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: ddl\log\
Location where DDL scripts are buffered during script generation
processing.
Name: DEFAULT_INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Default name of tablespace to install indexes into.
Name: DEFAULT_OBJECT_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Default name of tablespace to install objects into.
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: END_OF_LINE
Type: STRING
Valid Values: N/A
Default: \r\n
End of Line
Name: INPUT_DIRECTORY
Type: STRING
Valid Values: N/A
Default: input\
Input Directory
Name: INVALID_DIRECTORY
Type: STRING
Valid Values: N/A
Default: invalid\
Directory for SQL*Loader errors and rejected records
Name: LIB_DIRECTORY
Type: STRING
Valid Values: N/A
Default: lib\
LIB Directory
Name: LIB_EXTENSION
Type: STRING
Valid Values: N/A
Default: .lib
LIB Extension
Name: LIB_SPOOL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: lib\log\
LIB Spool Directory
Name: LOADER_DIRECTORY
Type: STRING
Valid Values: N/A
Default: ctl\
Location where control files are stored.
Name: LOADER_EXTENSION
Type: STRING
Valid Values: N/A
Default: .ctl
Suffix for the loader scripts
Name: LOADER_RUN_PARAMETER_FILE
Type: STRING
Valid Values: N/A
Default: _run.ini
Suffix for the parameter initialization file.
Name: LOG_DIRECTORY
Type: STRING
Valid Values: N/A
Default: log\
Log Directory for the SQL*Loader
Name: MAIN_APPLICATION_SHORT_NAME
Type: STRING
Valid Values: N/A
Default: ora
Main Application Short Name
Name: PLSQL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: pls\
Location where PL/SQL scripts are stored.
Name: PLSQL_EXTENSION
Type: STRING
Valid Values: N/A
Default: .pls
File name extension for PL/SQL scripts.
Name: PLSQL_GENERATION_MODE
Type: STRING
Valid Values: Default, Oracle Database 10g, Oracle Database 10gR2, Oracle Database 8i, Oracle Database 9i
Default: Default
Generation mode controls validation and generation for version specific
features.
Name: PLSQL_RUN_PARAMETER_FILE
Type: STRING
Valid Values: N/A
Default: _run.ini
Suffix for the parameter script in a PL/SQL job.
Name: PLSQL_SPOOL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: pls\log\
Location where PL/SQL scripts are buffered during script generation
processing.
Name: RECEIVE_DIRECTORY
Type: STRING
Valid Values: N/A
Default: receive\
Receive Directory
Name: SORT_DIRECTORY
Type: STRING
Valid Values: N/A
Default: sort\
Sort Directory
Name: STREAMS_ADMINISTRATOR_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
The location corresponding to the Streams Administrator
Name: TCL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: tcl\
Location for TCL scripts that are generated after registration with Oracle
Enterprise Manager
Name: TOP_DIRECTORY
Type: STRING
Valid Values: N/A
Default: ..\..\codegen\
Top Directory where generated code will get stored
Name: WORK_DIRECTORY
Type: STRING
Valid Values: N/A
Default: work\
Work Directory
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
setReferenceClauseForDataMetadataModule
Set location and/or icon set for the Oracle module.
addModuleReferenceLocationClause
Add runtime locations to the Oracle module.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
setReferenceLocationClause
Set a runtime location to the Oracle module.
setReferenceMetadataLocationOrIconSetClause
Set metadata location and/or icon set for the Oracle module.
addReferenceLocationClause
Add a runtime location to the Oracle module.
propertyValue
Value of a property.
setReferenceMetadataLocationClause
Set metadata location for the Oracle module.
setReferenceIconSetClause
Set icon set for the Oracle module.
Examples
OMBCREATE ORACLE_MODULE 'src_module' SET PROPERTIES (DESCRIPTION,
BUSINESS_NAME) VALUES ('this is an Oracle module', 'source module')
This will create an Oracle module named "src_module", its description is
"this is an Oracle module", and business name is "source module".
See Also
OMBCREATE, OMBALTER ORACLE_MODULE, OMBDROP ORACLE_MODULE
Purpose
To create a Package.
Prerequisites
Should be in the context of a Oracle Module or Transformation Module.
A Transformation Module may be WB_CUSTOM_TRANS for Public Transformations.
WB_CUSTOM_TRANS may by modified by an administrator.
WB_CUSTOM_TRANS is not dependent on any project.
Syntax
createPackageCommand = OMBCREATE ( PACKAGE "QUOTED_STRING" ( [ SET (
"setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
"setReferenceIconSetClause" ) ] ) { ADD "addRelationalDependentClause"
} )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
addRelationalDependentClause = ( REFERENCE | REF ) ( TABLE | VIEW |
MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
"QUOTED_STRING"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createPackageCommand
This command creates a Package
QUOTED_STRING
Name of the Package to be created.
setPropertiesClause
Used to set properties (core, user-defined) for packages. Valid properties
are as shown:
Basic properties for PACKAGE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Package
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Package
Properties for PACKAGE:
Name: AUTHID
Type: STRING
Valid Values: Current_User, Definer, None
Default: None
Generate the package with selected AUTHID option. Function will be executed
with the permissions defined by the AUTHID clause rather than the function
owner's permissions.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for
those object marked as Deployable = true
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
addRelationalDependentClause
This clause adds referential dependencies to other relational objects.
propertyNameList
Comma separated list of property names. Property names are unquoted.
propertyValueList
Comma separated list of property values.
propertyValue
Value of a property.
Examples
OMBCREATE PACKAGE 'pkg' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES
('this is a Package', 'package')
This will create a Package named "pkg", its description is "this is a
Package", and business name is "package".
See Also
OMBCREATE, OMBALTER PACKAGE, OMBDROP PACKAGE
Purpose
To create a PLSQL Record Type.
Prerequisites
Should be in the context of a Package.
Syntax
createPlSqlRecordTypeCommand = OMBCREATE ( PLSQL_RECORD_TYPE
"QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET ( REF | REFERENCE
) "setReferenceIconSetClause" ] | ( REF | REFERENCE )
"setReferenceIconSetClause" ) ] [ "addPlSqlRecordAttributesClause" ] )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
setReferenceIconSetClause = ICONSET "QUOTED_STRING"
addPlSqlRecordAttributesClause = "addRecordTypeAttributeClause"+
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
addRecordTypeAttributeClause = ADD ATTRIBUTE "QUOTED_STRING" [ SET
"setPropertiesClause" ]
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createPlSqlRecordTypeCommand
Creates an PLSQL Record Type with the given name.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for PLSQL Record
Type or its Attributes. Valid properties are as shown:
Basic properties for PLSQL_RECORD_TYPE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the PLSQL Record Type
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the PLSQL Record Type
Basic properties for ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Attribute
Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB,
NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, SYS.XMLFORMAT,
TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE,
VARHCAR, VARCHAR2, XMLTYPE
Default: ''
Datatype of the Attribute
Properties for PLSQL_RECORD_TYPE:
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Properties for ATTRIBUTE:
Name: ADDRESS_TYPE
Type: STRING
Valid Values: NA_ADDRTYPE_DUAL, NA_ADDRTYPE_NORMAL
Default: NA_ADDRTYPE_NORMAL
You can designate an address type as Normal or Dual. For example, a dual
address occurs when a record contains both a street address and a P.O. Box;
this is common with business data. A normal address contains only one type
of address.
Name: ATTRIBUTE_ROLE
Type: STRING
Valid Values: END_DATE, LOOKUP_ACTIVE_DATE, MEASURE, NATURAL_KEY, NONE,
PARENT_NATURAL_KEY, PARENT_REF_KEY, PARENT_SURROGATE_KEY, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: BINDING_COLUMN_NAME
Type: STRING
Valid Values: N/A
Default: ''
The binding column name for this attribute
Name: DATA_TYPE
Type: STRING
Valid Values: N/A
Default: ''
The data type of the attribute
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The Default Value for the function input parameter
Name: DIMENSION_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The dimension attribute referenced to by this level attribute.
Name: EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
The output expression for the attribute
Name: FIELD_DATA_TYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE,
FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER
EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH,
LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH
LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARGRAPHIC,
VARRAW, VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
SQL Data Type of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Field Length of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Field Precision of the field in the file to which this operator is bound.
Name: FIELD_DATA_TYPE_SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Field Scale of the field in the file to which this operator is bound.
Name: FIELD_DEFAULTIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is blank or zero,
based on the datatype.
Name: FIELD_END_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The ending position of the field in the file
Name: FIELD_MASK
Type: STRING
Valid Values: N/A
Default: ''
The mask for the field
Name: FIELD_NULLIF_VALUE
Type: STRING
Valid Values: N/A
Default: ''
The expression that indicates the value of the field is null
Name: FIELD_START_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The starting position of the field in the file
Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data fractional seconds precision value of the attribute
Name: FUNCTION_RETURN
Type: BOOLEAN
Valid Values: true, false
Default: false
Specifies whether this output is the return value of this function
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this input attribute is a part of the
unpivot group key.
Name: INPUT_ROLE
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_CITY, NA_COUNTRYCODE,
NA_COUNTRYNAME, NA_FIRMNAME, NA_FIRSTNAME, NA_FIRSTPARTNAME, NA_LASTLINE,
NA_LASTLINE_2, NA_LASTNAME, NA_LASTPARTNAME, NA_LINE1, NA_LINE10, NA_LINE2,
NA_LINE3, NA_LINE4, NA_LINE5, NA_LINE6, NA_LINE7, NA_LINE8, NA_LINE9,
NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_NEIGHBORHOOD, NA_NONE,
NA_PASSTHRU, NA_PERSON, NA_PERSON2, NA_PERSON3, NA_POSTALCODE, NA_POSTNAME,
NA_PRENAME, NA_PRIMARYADDRESS, NA_SECONDARYADDRESS, NA_STATE
Default: NA_NONE
Assigns a name-address input role to the selected input attribute
Name: INSTANCE
Type: STRING
Valid Values: NA_INSTANCE_FIFTH, NA_INSTANCE_FIRST, NA_INSTANCE_FOURTH,
NA_INSTANCE_SECOND, NA_INSTANCE_SIXTH, NA_INSTANCE_THIRD
Default: NA_INSTANCE_FIRST
The instance option is used when an address contains multiple names, you
can specify which name in the group should be used. In addition, you can
use this option to assign an address type to a miscellaneous address
component.
Name: IS_CAST_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: IS_OPTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: false
If true, the input is not required to be connected
Name: IS_PREDEFINED_CONSTANT
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
The data length value of the attribute
Name: LEVEL_ATTRIBUTE_COLNAME_NAME
Type: STRING
Valid Values: N/A
Default: ''
Column name in the AW staging table and source view for this attribute.
Name: LEVEL_ATTRIBUTE_LEVEL_INDICATOR_COLNAME
Type: STRING
Valid Values: N/A
Default: ''
Level indicating columns name. This level will contain the name of the name
of the level this parent reference belongs to. This is relavant only for
skip level hierarchies.
Name: LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the Level Attribute.
Name: LEVEL_RELATIONSHIP_NAME
Type: STRING
Valid Values: N/A
Default: ''
The level relationship name associated to this attribute.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will particiate in the
update load operation.
Name: LOOKUP_ATTRIBUTE_ROLE
Type: STRING
Valid Values: DIMENSION_KEY, END_DATE, NATURAL_KEY, NONE, PREV_VALUE,
START_DATE, SURROGATE_KEY, TRIGGER
Default: NONE
The type of role to indicate how this attribute will be used in history
logging. History As Previous Value indicates that this attribute will be
used to keep previous value. Surrogate Identifier indicates that this
attribute will be used to keep the surrogate identifier. Natural Identifier
indicates that this attribute will be used to keep the natural identifier.
Effective Time indicates that this attribute will be used as the effective
time of the version. Expiration Time indicates that this attribute will be
used as the expiration time of the version. Trigger indicates that this
attribute will be used to trigger history logging. If none is specified,
this attribute will be used to keep current value.
Name: MATCHING_ROW
Type: NUMBER
Valid Values: 1 - 1000
Default: 1
An positive integer to indicate from which row within the unpivot group
this output attribute obtains its data.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING(3)
Valid Values: NO, YES
Default: YES
A boolean value to indicate whether this attribute will be used to
construct the matching criteria between the incoming data and the existing
data on the target during the update load operation.
Name: MERGE_ATTR
Type: STRING
Valid Values: N/A
Default: ''
Related merge attribute
Name: OUTPUT_COMPONENT
Type: STRING
Valid Values: NA_ADDRESS, NA_ADDRESS2, NA_ADDRESSCORRECTED, NA_ADDRESSTYPE,
NA_AUTO_ZONE_IND, NA_BOXNAME, NA_BOXNUMBER, NA_BUILDINGNAME, NA_CART,
NA_CBSA_CODE, NA_CBSA_DESC, NA_CENSUSID, NA_CHECKDIGIT, NA_CITY,
NA_CITYCORRECTED, NA_CITYMATCH, NA_CITYWARNING, NA_CITY_ABBREV,
NA_CITY_ABBREV_2, NA_CITY_ALTERNATE, NA_COMPLEX, NA_COUNTRYCODE,
NA_COUNTRYCODE3, NA_COUNTRYNAME, NA_COUNTYNAME, NA_DELIVERYBEATCODE,
NA_DELIVERYOFFICECODE, NA_DELIVERYPOINT, NA_EMAIL, NA_EXTRA_1, NA_EXTRA_10,
NA_EXTRA_11, NA_EXTRA_12, NA_EXTRA_13, NA_EXTRA_14, NA_EXTRA_15,
NA_EXTRA_16, NA_EXTRA_17, NA_EXTRA_18, NA_EXTRA_19, NA_EXTRA_2,
NA_EXTRA_20, NA_EXTRA_3, NA_EXTRA_4, NA_EXTRA_5, NA_EXTRA_6, NA_EXTRA_7,
NA_EXTRA_8, NA_EXTRA_9, NA_FIPS, NA_FIPSCOUNTY, NA_FIPS_PLACE_CODE,
NA_FIRMCOUNT, NA_FIRMNAME, NA_FIRM_LOC, NA_FIRSTNAME, NA_FIRSTNAMESTD,
NA_GENDER, NA_GEO_MATCH_PREC, NA_INSTALLATIONNAME, NA_INSTALLATIONTYPE,
NA_ISADDRESSVERIFIABLE, NA_ISFOUND, NA_ISGOODADDRESS, NA_ISGOODGROUP,
NA_ISGOODNAME, NA_ISPARSED, NA_LACS, NA_LASTLINE, NA_LASTLINE_2,
NA_LASTNAME, NA_LATITUDE, NA_LOCALITYCODE, NA_LOCALITYNAME, NA_LOCALITY_2,
NA_LOCALITY_3, NA_LOCALITY_4, NA_LONGITUDE, NA_LOT, NA_LOT_ORDER, NA_MCD,
NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME2STD, NA_MIDDLENAME3,
NA_MIDDLENAME3STD, NA_MIDDLENAMESTD, NA_MISCADDRESS, NA_MSA,
NA_NAMEDESIGNATOR, NA_NAMEWARNING, NA_NAME_FIRM_EXTRA, NA_NEIGHBORHOOD,
NA_NONAMBIGUOUSMATCH, NA_NONE, NA_NP_SEC_ADDR, NA_NP_UNIT_DESIG,
NA_NP_UNIT_NBR, NA_OTHERPOSTNAME, NA_PARSESTATUS, NA_PARSESTATUSDESC,
NA_PARSINGCOUNTRY, NA_PASSTHRU, NA_PERSON, NA_PERSONCOUNT, NA_PHONE,
NA_POSTALCODE, NA_POSTALCODECORRECTED, NA_POSTALCODEFORMATTED,
NA_POSTDIRECTIONAL, NA_POSTNAME, NA_PREDIRECTIONAL, NA_PRENAME,
NA_PRIMARYADDRESS, NA_PRIM_NAME_2, NA_RELATIONSHIP, NA_ROUTENAME,
NA_ROUTENUMBER, NA_SECONDARYADDRESS, NA_SSN, NA_STATE,
NA_STREETCOMPCORRECTED, NA_STREETCOMPMATCH, NA_STREETCORRECTED,
NA_STREETNAME, NA_STREETNAMEMATCH, NA_STREETNUMBER, NA_STREETNUMBERMATCH,
NA_STREETTYPE, NA_STREETWARNING, NA_TITLE, NA_UNITDESIGNATOR,
NA_UNITNUMBER, NA_URBANIZATIONNAME, NA_URBAN_IND, NA_ZIP4, NA_ZIP5
Default: NA_NONE
Assigns a Name and Address output component to the selected output
attribute.
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
The position of the argument in the table function signature corresponding
to this parmater
Name: PIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: ''
A comma-delimited expression that gives the input attribute to be used for
each output row in the pivot group.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
The data precision value of the attribute
Name: REFERENCED_LEVEL_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level attribute associated to this attribute.
Name: REFERENCED_LEVEL_NAME
Type: STRING
Valid Values: N/A
Default: ''
The bound name of the parent level group associated to this attribute.
Name: REFERENCING_TYPE
Type: STRING
Valid Values: LOOKUP_KEY, NONE, REFERENCE_KEY_ALL, REFERENCE_KEY_ONLY
Default: NONE
The type of reference to indicate how this attribute participates in
resolving existing level relationships and level implementations. If Lookup
Reference Attribute is specified, this attribute will be used as lookup
attribute upon parent level to resolve level implementations during
loading. If Level Relationship Attribute (Snowflake) is specified, this
attribute will be directly used as level relationship attribute and no
lookup upon parent level would be performed during loading. If Level
Relationship Attribute (Star) is specified, this attribute will be directly
used as level relationship attribute, as well as lookup attribute upon
parent level to resolve level implementations during loading. If none is
specified, this attribute does not participate in any level relationship.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
The data scale value of the attribute
Name: SKIP_LEVEL_DIMENSION
Type: STRING
Valid Values: NO, YES
Default: NO
Indicates whether this level has a skip level parent.
Name: TYPE_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The name of the field of the PLS Record or attribute of the Object Type or
column of the ROWTYPE that corresponds to this attribute. This property is
not applicable if the return type is TABLE of SCALAR.
Name: UNPIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: NULL
An expression that gives the input attribute to be used as the output of
this attribute.
Name: UPDATE_OPERATION
Type: STRING(3)
Valid Values: +=, -=, =, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data
and the existing data on the target during the update load operation.
Name: VALUETYPE
Type: STRING
Valid Values: NEW, NEW_OLD, OLD
Default: NEW_OLD
Specifies the value type of this attribute
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
addPlSqlRecordAttributesClause
Adds one or more Attributes in this PLSQL Record Type.
propertyNameList
The list of properties.
propertyValueList
The list of property values.
addRecordTypeAttributeClause
Adds an attribute to this PLSQL Record Type
propertyValue
This clause adds the property values.
Examples
OMBCREATE PLSQL_RECORD_TYPE 'NEW_PLSQL_RECORD_TYPE' SET PROPERTIES
(DESCRIPTION) VALUES ('this is a plsql record type') ADD ATTRIBUTE 'ATTR'
SET PROPERTIES (DATATYPE) VALUES ('VARCHAR2')
This will create a PLSQL Record Type named "NEW_PLSQL_RECORD_TYPE", its
description is "this is a plsql record type" and an Attribute 'ATTR' of
Varchar2 type.
See Also
OMBCREATE, OMBALTER PLSQL_RECORD_TYPE, OMBDROP PLSQL_RECORD_TYPE
Purpose
To create a PLSQL Ref-Cursor Type.
Prerequisites
Should be in the context of a Package.
Syntax
createPlSqlRefCursorTypeCommand = OMBCREATE ( PLSQL_REF_CURSOR_TYPE
"QUOTED_STRING" SET "setPropertiesClause" )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createPlSqlRefCursorTypeCommand
Creates a PL/SQL Ref-Cursor Type with the given name.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for Ref-Cursor Type
Valid properties are as shown:
Basic properties for PLSQL_REF_CURSOR_TYPE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Ref-Cursor Type
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Ref-Cursor Type
Name: RETURN_TYPE
Type: STRING(20)
Valid Values: N/A
Default: ''
Return type of the Ref-Cursor Type. This should be a PLSQL Record Type.
Properties for PLSQL_REF_CURSOR_TYPE:
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Properties for PLSQL_REF_CURSOR_TYPE:
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
Examples
OMBCREATE PLSQL_REF_CURSOR_TYPE 'NEW_REF_CURSOR_TYPE' SET PROPERTIES
(DESCRIPTION) VALUES ('this is a ref-cursor type')
See Also
OMBCREATE, OMBALTER PLSQL_REF_CURSOR_TYPE, OMBDROP PLSQL_REF_CURSOR_TYPE
Purpose
To create a PLSQL Table Type.
Prerequisites
Should be in the context of a Package.
Syntax
createPlSqlTableTypeCommand = OMBCREATE ( PLSQL_TABLE_TYPE "QUOTED_STRING"
SET "setPropertiesClause" )
setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "("
"propertyValueList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
propertyValueList = "propertyValue" { "," "propertyValue" }
propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" |
"FLOATING_POINT_LITERAL" )
Keywords And Parameters
createPlSqlTableTypeCommand
Creates a PL/SQL Table Type with the given name.
setPropertiesClause
Sets properties (core, logical, physical, user-defined) for Table Type
Valid properties are as shown:
Basic properties for PLSQL_TABLE_TYPE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Table Type
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Table Type
Name: RETURN_TYPE
Type: STRING(20)
Valid Values: NUMBER, VARCHAR2, VARCHAR, DATE, FLOAT
Default: ''
Return type of the Table Type. This can be a scalar type or a PLSQL Record
Type.
Properties for PLSQL_TABLE_TYPE:
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Properties for PLSQL_TABLE_TYPE:
Name: GENERATION_COMMENTS
Type: STRING
Valid Values: N/A
Default: ''
Enter additional comments for the generated code.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
propertyValueList
The list of property values.
propertyValue
This clause adds the property values.
Examples
OMBCREATE PLSQL_TABLE_TYPE 'NEW_TABLE_TYPE' SET PROPERTIES (DESCRIPTION)
VALUES ('this is a table type')
See Also
OMBCREATE, OMBALTER PLSQL_TABLE_TYPE, OMBDROP PLSQL_TABLE_TYPE
|
 Copyright © 2000, 2006, Oracle. All rights reserved. Legal Notices |
|