| 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 OMBRETRIEVE in alphabetical order, concluding with the command OMBRETRIEVE LOCATION. Subsequent commands associated with OMBRETRIEVE are contained in the next chapter.
Purpose
Retrieve metadata of a component.
Prerequisites
Can be in any context. Component to retrieve can be specified by either
absolute or relative path.
Syntax
retrieveCommand = OMBRETRIEVE "fco_type" "fco_name" { "sco_type"
"sco_name" } ( "getPropertiesClause" | "getSCOClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getSCOClause = GET [ ( REF | REFERENCE ) [ "qualifier" ] ] "sco_type" [ AT
POSITION "pos" ]
propertyNameList = "propertyName" { "," "propertyName" }
propertyName = "UNQUOTED_STRING"
Keywords And Parameters
retrieveCommand
Specify the component from which to retrieve metadata.
fco_type
The type of the component.
fco_name
The physical name of the component in single quotes.
getPropertiesClause
Retrieve properties of an object.
getSCOClause
Retrieve a list of child object names of a given type.
qualifier
Specify which reference to set, if there are more than one pointing to the
same type.
propertyNameList
A list of property names.
propertyName
An unquoted string representing the name of a property.
Examples
This is an example for retrieving the description a table:
OMBRETRIEVE TABLE 'T1' GET PROPERTIES (DESCRIPTION)
The following statement retrieves the datatype and length of a view column:
OMBRETRIEVE VIEW 'V1' COLUMN 'COL1'
GET PROPERTIES (DATATYPE, LENGTH)
See Also
OMBCREATE, OMBALTER
Purpose
To retrieve the details of an activity template.
Prerequisites
Should be in the context of an Activity Template Folder.
Syntax
parseRetrieveTemplateCommand = OMBRETRIEVE ACTIVITY_TEMPLATE
"QUOTED_STRING" ( "getParameterPropertiesClause" |
"getTemplatePropertiesClause" )
getParameterPropertiesClause = PARAMETER "QUOTED_STRING" GET PROPERTIES
"propertyKeyList"
getTemplatePropertiesClause = ( GET ( ( PROPERTIES "propertyKeyList" ) |
PARAMETERS | ( ( REFERENCE | REF ) [ "getReferenceIconSetClause" ] ) )
)
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
getReferenceIconSetClause = ICONSET
propertyKey = "UNQUOTED_STRING"
Examples
retrieveActivityTemplateCommandExampleTag??
See Also
OMBDROP, OMBCREATE ACTIVITY_TEMPLATE, OMBALTER ACTIVITY_TEMPLATE
Purpose
To retrieve the details of an activity template folder.
Prerequisites
Should be in the context of a Project.
Syntax
parseRetrieveTemplateFolderCommand = OMBRETRIEVE ACTIVITY_TEMPLATE_FOLDER
"QUOTED_STRING" "getTemplateFolderPropertiesClause"
getTemplateFolderPropertiesClause = ( GET ( ( PROPERTIES "propertyKeyList"
) | ( ( REFERENCE | REF ) "getReferenceIconSetClause" ) ) )
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
getReferenceIconSetClause = ICONSET
propertyKey = "UNQUOTED_STRING"
Examples
OMBRETRIEVE ACTIVITY_TEMPLATE 'FOLDR1' GET PROPERTIES (BUSINESS_NAME)
See Also
OMBDROP, OMBCREATE ACTIVITY_TEMPLATE_FOLDER, OMBALTER ACTIVITY_TEMPLATE_FOLDER
Purpose
Retrieve details of the Advanced Queue.
Prerequisites
Should be in the context of an Oracle Module.
Syntax
retrieveAQCommand = OMBRETRIEVE ADVANCED_QUEUE "QUOTED_STRING" GET (
"getPropertiesClause" | "getReferenceIconSetClause" )
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveAQCommand
Retrieves the details of the Advanced Queue with the given name.
getPropertiesClause
Retrieves the values of the given Properties for the Advanced Queue with
the given name.
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
getReferenceIconSetClause
Get the Icon Set.
propertyNameList
The list of properties.
Examples
OMBRETRIEVE ADVANCED_QUEUE 'SOME_ADVANCED_QUEUE' GET PROPERTIES
(MAX_RETRIES, RETRY_DELAY, RETENTION_TIME, ENQUEUE_ENABLED,
DEQUEUE_ENABLED, QTABLE)
This will retrieve the Advanced Queue "SOME_ADVANCED_QUEUE"'s properties.
See Also
OMBRETRIEVE, OMBALTER ADVANCED_QUEUE, OMBCREATE ADVANCED_QUEUE, OMBDROP ADVANCED_QUEUE
Purpose
Retrieve details of an Alternative Sort Order.
Prerequisites
Should be in the context of a Business Definition Module or use the full
path.
Syntax
retrieveAlternativeSortOrderCommand = OMBRETRIEVE ALTERNATIVE_SORT_ORDER
"QUOTED_STRING" "retrieveAlternativeSortOrderClauseDetails"
retrieveAlternativeSortOrderClauseDetails = GET (
"getPropertiesClauseforLOVandD2D" | "getReferenceIconSetClause" | (
REF | REFERENCE ) DEFINING ITEM | ( REF | REFERENCE ) ORDERED ITEM | (
REF | REFERENCE ) ITEMS | DEPENDENTS )
getPropertiesClauseforLOVandD2D = PROPERTIES "("
"propertyNameListforLOVandD2D" ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
propertyNameListforLOVandD2D = ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
"," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }
Keywords And Parameters
retrieveAlternativeSortOrderCommand
Retrieves the alternative sort order.
QUOTED_STRING
name of the alternative sort order.
retrieveAlternativeSortOrderClauseDetails
This clause retrieves the contents of an alternative sort order.
GET
This clause retrieves the following
REF DEFINING ITEM retrieves the Item that holds the individual values for
this alternative sort order.
REF ORDERED ITEM retrieves the Item that holds the order of the values for
this alternative sort order.
REF ITEMS retrieves the list of Items that use this alternative sort order.
DEPENDENTS retrieves a list of Item Folders that the alternative sort order
depends on.
(This will return the Item Folder containing any Values and Order Items).
getPropertiesClauseforLOVandD2D
This clause gets the properties of the object.
Basic properties for ALTERNATIVE_SORT_ORDER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the alternative sort order
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the alternative sort order
Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the alternative sort order enables drilling between the item
folders containing the items that use the alternative sort order
Name: RETRIEVE_VALUES_GROUP_SIZE
Type: Number
Valid Values: N/A
Default: '100'
The number of rows to be fetched from the database at a time
Name: CACHE_VALUES
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the list of values should be cached in memory
Name: REQUIRE_SEARCH
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether search criteria should be requested
Name: SHOW_IN_NAVIGATOR
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be shown in the item navigator
Name: SORTED_DISTINCT
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be displayed sorted with duplicates hidden
Properties for ALTERNATIVE_SORT_ORDER:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts
to create an object only for those objects marked as Deployable = true
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getReferenceIconSetClause
Get specified Icon Set.
propertyNameListforLOVandD2D
This is the list of property names.
Examples
OMBRETRIEVE ALTERNATIVE_SORT_ORDER 'COLORS' GET PROPERTIES(DESCRIPTION)
See Also
OMBALTER ALTERNATIVE_SORT_ORDER, OMBCREATE ALTERNATIVE_SORT_ORDER
Purpose
To retrieve a profile action plan.
Prerequisites
An action plan for profiling must already exist.
Syntax
RetrieveActionPlanCommand = ( OMBRETRIEVE ( ( DEPLOYMENT_ACTION_PLAN |
ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" ) ( "getActionsClause"
| "retrieveActionClause" )
getActionsClause = GET ACTIONS
retrieveActionClause = ACTION "QUOTED_STRING" ( GET (
"getPropertiesClause" | "getReferenceClause" ) )
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceClause = ( REF | REFERENCE )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
RetrieveActionPlanCommand
Retrieve a profile action plan
getActionsClause
Get a list of actions from an action plan.
retrieveActionClause
Retrieve a set of properties or the associated object of an action.
QUOTED_STRING
Action name
getPropertiesClause
Retrieve a set of properties that is associated with an action.
getReferenceClause
Retrieve the object associated with an action.
propertyNameList
Comma separated list of property names. Property names are unquoted.
Examples
OMBRETRIEVE ANALYZE_ACTION_PLAN 'ANALYZE_PLAN' GET ACTIONS
See Also
OMBCREATE ANALYZE_ACTION_PLAN, OMBPROFILE
Purpose
Retrieve details of a Business Area.
Prerequisites
Should be in the context of a Business Definition Module or use the full
path.
Syntax
retrieveBusinessAreaCommand = OMBRETRIEVE BUSINESS_AREA "QUOTED_STRING"
"retrieveBusinessAreaClause"
retrieveBusinessAreaClause = GET ( "getPropertiesClause" |
"getReferenceIconSetClause" | "getBASCOClause" )
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
getBASCOClause = ITEM_FOLDERS
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveBusinessAreaCommand
To retrieve a business area.
QUOTED_STRING
name of the business area.
retrieveBusinessAreaClause
Retrieves the contents of the business area.
getPropertiesClause
Retrieves the properties of the object.
Basic properties for BUSINESS_AREA:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the business area
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the business area
Properties for BUSINESS_AREA:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts
to create an object only for those objects marked as Deployable = true
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getReferenceIconSetClause
Get specified Icon Set.
getBASCOClause
Retrieves the shortcuts from the business area.
propertyNameList
This is the list of property names.
Examples
OMBRETRIEVE BUSINESS_AREA 'SALES' GET PROPERTIES(DESCRIPTION)
See Also
OMBALTER BUSINESS_AREA, OMBCREATE BUSINESS_AREA
Purpose
Retrieve details of the business definition module.
Prerequisites
Should be in the context of a project or use the full path.
Syntax
retrieveEULModuleCommand = OMBRETRIEVE BUSINESS_DEFINITION_MODULE
"QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause"
| "getReferenceDefaultLocationClause" | "getReferenceIconSetClause" |
"getReferenceLocationsClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceLocationClause = GET ( REF | REFERENCE ) LOCATION
getReferenceDefaultLocationClause = GET ( REF | REFERENCE ) DEFAULT
LOCATION
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
getReferenceLocationsClause = GET ( REF | REFERENCE ) LOCATIONS
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveEULModuleCommand
This command retrieves the details of a business definition module.
QUOTED_STRING
Name of the existing business definition module or path to the business
definition module.
getPropertiesClause
Retrieve a set of properties associated 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
getReferenceLocationClause
Retrieve the location set for the business definition module.
getReferenceDefaultLocationClause
Retrieve the default runtime location referenced by this business
definition module.
getReferenceIconSetClause
Retrieve the icon set referenced by this business definition module.
getReferenceLocationsClause
Retrieve the runtime locations referenced by this business definition
module.
propertyNameList
Comma-delimited list of property names. Property names are not in quotes.
Examples
OMBRETRIEVE BUSINESS_DEFINITION_MODULE 'src_module' GET PROPERTIES
(DESCRIPTION, BUSINESS_NAME)
This will retrieve the business definition module "src_module"'s
description and business name.
See Also
OMBRETRIEVE
Purpose
Retrieve details of the presentation module.
Prerequisites
Should be in the context of a project or use the full path.
Syntax
retrieveReportModuleCommand = OMBRETRIEVE BUSINESS_PRESENTATION_MODULE
"QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause"
| "getReferenceDefaultLocationClause" | "getReferenceIconSetClause" |
"getReferenceLocationsClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceLocationClause = GET ( REF | REFERENCE ) LOCATION
getReferenceDefaultLocationClause = GET ( REF | REFERENCE ) DEFAULT
LOCATION
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
getReferenceLocationsClause = GET ( REF | REFERENCE ) LOCATIONS
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveReportModuleCommand
This command retrieves the details of a presentation module.
QUOTED_STRING
Name of the existing presentation module or path to the presentation
module.
getPropertiesClause
Retrieve a set of properties associated 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
getReferenceLocationClause
Retrieve the location set for the presentation module.
getReferenceDefaultLocationClause
Retrieve the default runtime location referenced by this business
presentation module.
getReferenceIconSetClause
Retrieve the icon set referenced by this business presentation module.
getReferenceLocationsClause
Retrieve the runtime locations referenced by this business presentation
module.
propertyNameList
Comma-delimited list of property names. Property names are not in quotes.
Examples
OMBRETRIEVE BUSINESS_PRESENTATION_MODULE 'salesrep_module' GET PROPERTIES
(DESCRIPTION, BUSINESS_NAME)
This will retrieve the presentation module "salesrep_module"'s description
and business name.
See Also
OMBRETRIEVE
Purpose
Retrieve details of a Calendar.
Prerequisites
Should be in the context of a CalendarModule
Syntax
retrieveCalendarClause = OMBRETRIEVE CALENDAR "QUOTED_STRING" ( ( GET (
"getCalendarPropertiesClause" | "getReferenceIconSetClause" ) ) |
"getSchedulePropertiesClause" )
getCalendarPropertiesClause = ( PROPERTIES "propertyKeyList" ) | SCHEDULES
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
getSchedulePropertiesClause = SCHEDULE "QUOTED_STRING" GET PROPERTIES
"propertyKeyList"
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyKey = "UNQUOTED_STRING"
Examples
OMBRETREIEVE CALENDAR 'CAL1' GET PROPERTIES (BUSINESS_NAME, DESCRIPTION)
OMBRETRIEVE CALENDAR 'CAL1' SCHEDULE 'LOCALWINDOW' GET PROPERTIES
(TIMEZONE)
OMBRETRIEVE CALENDAR 'CAL1' SCHEDULE 'LOCALWINDOW' GET PROPERTIES
(PREVIEW_DATES)
See Also
OMBDROP, OMBCREATE CALENDAR_MODULE, OMBALTER CALENDAR_MODULE
Purpose
Retrieve details of a Calendar Module.
Prerequisites
Should be in the context of a Project
Syntax
retrieveCalendarClause = OMBRETRIEVE CALENDAR "QUOTED_STRING" ( ( GET (
"getCalendarPropertiesClause" | "getReferenceIconSetClause" ) ) |
"getSchedulePropertiesClause" )
getCalendarPropertiesClause = ( PROPERTIES "propertyKeyList" ) | SCHEDULES
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
getSchedulePropertiesClause = SCHEDULE "QUOTED_STRING" GET PROPERTIES
"propertyKeyList"
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
propertyKey = "UNQUOTED_STRING"
Examples
OMBRETREIEVE CALENDAR_MODULE 'CALMOD1' GET PROPERTIES (BUSINESS_NAME,
DESCRIPTION)
See Also
OMBDROP, OMBCREATE CALENDAR_MODULE, OMBALTER CALENDAR_MODULE
Purpose
This command is used to retrieve details about the change data capture.
Prerequisites
This command can only be executed in the context of a change data capture
and operates only on already existing change data captures.
Syntax
retrieveChangeSetCommand = OMBRETRIEVE ( CHANGE_DATA_CAPTURE
"QUOTED_STRING" ) GET ( CHANGESET_TYPE | PROPERTIES "("
"propertyNameList" ")" | CAPTURE ( OBJECTS | TABLES | VIEWS |
MATERIALIZED_VIEWS ) | CAPTURE ( TABLE | VIEW | MATERIALIZED_VIEW )
"QUOTED_STRING" "getCaptureObjectDetailsClause" )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
getCaptureObjectDetailsClause = ( "getCaptureColumnsClause" |
"getChangeSpecClause" | "getRowIdentifierClause" |
"getTxnIdentifierClause" | "getSpecialCaptureColumnsClause" )
getCaptureColumnsClause = COLUMNS
getChangeSpecClause = ( CAPTURED OPERATIONS ) | ( INSERT CHANGE_COLUMN ) |
( UPDATE CHANGE_COLUMN ) | ( DELETE CHANGE_COLUMN ) | ( INSERT
CHANGE_EXPRESSION ) | ( UPDATE CHANGE_EXPRESSION ) | ( DELETE
CHANGE_EXPRESSION )
getRowIdentifierClause = ROW_IDENTIFIER_COLUMNS
getTxnIdentifierClause = TXN_IDENTIFIER_COLUMNS
getSpecialCaptureColumnsClause = CAPTURE ( OLD_VALUES | USER_NAME )
Examples
OMBRETRIEVE CHANGE_DATA_CAPTURE 'EMPLOYEE_CHANGES' GET CAPTURE TABLES
This retrieves a list of the tables whose changes are captured by this
change data capture.
See Also
OMBRETRIEVE
Purpose
Retrieve details of the CMI definition.
Prerequisites
Should be in the root context.
Syntax
retrieveMIVDefinitionCommand = OMBRETRIEVE CMI_DEFINITION "QUOTED_STRING"
"getPropertiesClause"
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveMIVDefinitionCommand
This command retrieves the details of an CMI Definition
QUOTED_STRING
Name of the existing CMI definition or path to the CMI definition.
getPropertiesClause
Retrieve a set of properties that is associated with an CMI Definition.
Properties for CMI_DEFINITION:
Name: LOCATION_UOID
Type: STRING
Valid Values: N/A
Default: ''
Location Warehouse Builder should use to retrieve the data.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
Comma separated list of property names. Property names are unquoted.
Examples
OMBRETRIEVE CMI_DEFINITION 'src_definition' GET PROPERTIES (DESCRIPTION,
BUSINESS_NAME)
This will retrieve the CMI definition "src_definition"'s description and
business name.
See Also
OMBRETRIEVE
Purpose
Retrieve details of the CMI module.
Prerequisites
Should be in the context of project.
Syntax
retrieveMIVModuleCommand = OMBRETRIEVE CMI_MODULE "QUOTED_STRING" (
"getPropertiesClause" | "getReferenceLocationClause" |
"getReferenceDefaultLocationClause" |
"getReferenceMetadataLocationClause" | "getReferenceIconSetClause" |
"getReferenceLocationsClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceLocationClause = GET ( REF | REFERENCE ) LOCATION
getReferenceDefaultLocationClause = GET ( REF | REFERENCE ) DEFAULT
LOCATION
getReferenceMetadataLocationClause = GET ( REF | REFERENCE )
METADATA_LOCATION
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
getReferenceLocationsClause = GET ( REF | REFERENCE ) LOCATIONS
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveMIVModuleCommand
This command retrieves the details of an CMI Module
QUOTED_STRING
Name of the existing CMI module or path to the CMI module.
getPropertiesClause
Retrieve a set of properties that is associated 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
getReferenceLocationClause
Retrieve the name of the runtime location referenced by this CMI module.
getReferenceDefaultLocationClause
Retrieve the default runtime location referenced by this CMI module.
getReferenceMetadataLocationClause
Retrieve the metadata location referenced by this CMI module.
getReferenceIconSetClause
Retrieve the icon set referenced by this CMI module.
getReferenceLocationsClause
Retrieve the runtime locations referenced by this CMI module.
propertyNameList
Comma separated list of property names. Property names are unquoted.
Examples
OMBRETRIEVE CMI_MODULE 'src_module' GET PROPERTIES (DESCRIPTION,
BUSINESS_NAME)
This will retrieve the CMI module "src_module"'s description and business
name.
See Also
OMBRETRIEVE
Purpose
Retrieve details of the collection, including its shortcuts.
Prerequisites
Should be in the context of a project, before retrieving a collection.
Syntax
retrieveCollectionCommand = OMBRETRIEVE COLLECTION "QUOTED_STRING" ( GET (
( "referencesClause" | "propertiesClause" ) ) |
"getReferenceIconSetClause" )+
referencesClause = ( ALL | TABLE | VIEW | PACKAGE | DIMENSION |
MATERIALIZED_VIEW | SEQUENCE | CUBE | ADVANCED_QUEUE | STREAMS_QUEUE |
QUEUE_TABLE | EXTERNAL_TABLE | VARYING_ARRAY | OBJECT_TYPE |
NESTED_TABLE | MAPPING | COLLECTION | ORACLE_MODULE | PROCESS_FLOW |
PROCESS_FLOW_PACKAGE | PROCESS_FLOW_MODULE | SAP_MODULE | CMI_MODULE |
FUNCTION | PROCEDURE | FLAT_FILE_MODULE | FLAT_FILE |
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 ) REFERENCES
propertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveCollectionCommand
Retrieve details regarding a collection of objects.
referencesClause
Specify the type of references to retrieve from the collection.
propertiesClause
Retrieve values for a number of properties.
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
propertyNameList
Comma separated list of property names to retrieve values. Property names
are unquoted.
Examples
OMBRETRIEVE COLLECTION 'Purchasing Warehouse' GET TABLE REFERENCES
See Also
OMBLIST
Purpose
Retrieve details of the Configuration.
Prerequisites
Should be in the context of a project.
Syntax
retrieveConfigurationCommand = OMBRETRIEVE CONFIGURATION "QUOTED_STRING" (
"getPropertiesClause" | "getReferenceIconSetClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveConfigurationCommand
This command retrieves the details of a Configuration.
getPropertiesClause
Retrieve a set of properties that is associated 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
getReferenceIconSetClause
Retrieve the Icon Set associated with a Configuration.
propertyNameList
Comma separated list of property names. Property names are unquoted.
Examples
OMBRETRIEVE CONFIGURATION 'QA_CONFIGURATION' GET PROPERTIES (DESCRIPTION,
BUSINESS_NAME)
This will retrieve the Configuration description and business name.
See Also
OMBLIST
Purpose
Retrieve details from a connector.
Prerequisites
Can be in any context; the name is a name of the connector's owning
location and a connector name separated by slash.
Syntax
retrieveConnectorCommand = OMBRETRIEVE CONNECTOR "QUOTED_STRING" (
"getPropertiesClause" | "getReferencedLocationClause" |
"getReferenceIconSetClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferencedLocationClause = GET ( REF | REFERENCE ) LOCATION
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveConnectorCommand
Retrieve details from the named connector.
getPropertiesClause
Get properties of the connector.
getReferencedLocationClause
Get the name of the location which the connector references.
getReferenceIconSetClause
Get the refrenced 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
Examples
OMBRETRIEVE CONNECTOR 'A_LOCATION/A_CONNECTOR' GET PROPERTIES (DESCRIPTION,
BUSINESS_NAME)
This will retrieve the connector "A_CONNECTOR"'s description, and a
business name.
OMBRETRIEVE CONNECTOR 'A_LOCATION/A_CONNECTOR' GET REF LOCATION
This will retrieve the A_CONNECTOR referenced location.
See Also
OMBRETRIEVE
Purpose
Retrieve details from a control center.
Prerequisites
Can be in any context.
Syntax
retrieveControlCenterCommand = OMBRETRIEVE CONTROL_CENTER "QUOTED_STRING"
( "retrieveControlCenterClause" | "getReferenceIconSetClause" |
"retrieveReferenceLocationClause" )
retrieveControlCenterClause = "getPropertiesClause" | GET
"getReferenceLocationsClause"
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
retrieveReferenceLocationClause = GET ( REFERENCE | REF ) LOCATION
"QUOTED_STRING" "getPropertiesClause"
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceLocationsClause = ( REFERENCE | REF ) LOCATIONS
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveControlCenterCommand
Retrieve details from a control center.
getReferenceIconSetClause
Retrieve the icon set from a control center.
retrieveReferenceLocationClause
Get the specified properties of the referenced location.
getPropertiesClause
Get the specified properties of the control center.
getReferenceLocationsClause
Get the list of all referenced locations of this control center.
propertyNameList
The names of the properties whose values you want to retrieve.
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
Examples
OMBRETRIEVE CONTROL_CENTER 'MY_CONNECTION' GET PROPERTIES (DESCRIPTION,
BUSINESS_NAME)
This will retrieve the control center "MY_CONNECTION"'s description and
business name.
See Also
OMBRETRIEVE
Purpose
To retrieve properties of a correction map action plan.
Prerequisites
In the context of a data profile.
Syntax
RetrieveActionPlanCommand = ( OMBRETRIEVE ( ( DEPLOYMENT_ACTION_PLAN |
ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" ) ( "getActionsClause"
| "retrieveActionClause" )
getActionsClause = GET ACTIONS
retrieveActionClause = ACTION "QUOTED_STRING" ( GET (
"getPropertiesClause" | "getReferenceClause" ) )
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceClause = ( REF | REFERENCE )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
RetrieveActionPlanCommand
Retrieve correction maps action plan.
QUOTED_STRING
Action plan name.
getActionsClause
Get a list of actions from an action plan.
retrieveActionClause
Retrieve a set of properties or the associated object of an action.
getPropertiesClause
Retrieve a set of properties that is associated with an action.
getReferenceClause
Retrieve the object associated with an action.
propertyNameList
Comma separated list of property names. Property names are unquoted.
Examples
OMBRETRIEVE CORRECTION_MAPS_ACTION_PLAN 'CORRECT_INV_LOC_MAP' GET ACTIONS
OMBRETRIEVE CORRECTION_MAPS_ACTION_PLAN 'CORRECT_INV_LOC_MAP' ACTION
'UK_LOC_U' GET REFERENCE
OMBRETRIEVE CORRECTION_MAPS_ACTION_PLAN 'CORRECT_INV_LOC_MAP' ACTION
'UK_LOC_U' GET PROPERTIES (DATA_RULE_USAGE_NAME, ERROR_HANDLING_STRATEGY,
CORRECTION_STRATEGY)
See Also
OMBCREATE CORRECTION_MAPS_ACTION_PLAN, OMBPROFILE
Purpose
To retrieve properties of a correction schema action plan.
Prerequisites
In the context of a data profile.
Syntax
RetrieveActionPlanCommand = ( OMBRETRIEVE ( ( DEPLOYMENT_ACTION_PLAN |
ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" ) ( "getActionsClause"
| "retrieveActionClause" )
getActionsClause = GET ACTIONS
retrieveActionClause = ACTION "QUOTED_STRING" ( GET (
"getPropertiesClause" | "getReferenceClause" ) )
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceClause = ( REF | REFERENCE )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
getActionsClause
Get a list of actions from an action plan.
retrieveActionClause
Retrieve a set of properties or the associated object of an action.
QUOTED_STRING
Action name
getPropertiesClause
Retrieve a set of properties that is associated with an action.
getReferenceClause
Retrieve the object associated with an action.
propertyNameList
Comma separated list of property names. Property names are unquoted.
Examples
OMBRETRIEVE CORRECTION_SCHEMA_ACTION_PLAN 'CORRECT_INV_LOC' GET ACTIONS
OMBRETRIEVE CORRECTION_SCHEMA_ACTION_PLAN 'CORRECT_INV_LOC' ACTION
'GEN_INV' GET REFERENCE
See Also
OMBCREATE CORRECTION_SCHEMA_ACTION_PLAN, OMBPROFILE
Purpose
This command retrieves a Cube.
Prerequisites
Should be in Oracle Module context.
Syntax
retrieveCubeCommand = OMBRETRIEVE CUBE "cubeName" ( GET ( PROPERTIES
"propertyKeyList" | "getReferenceIconSetClause" | MEASURES |
COMPOSITE_DIMENSION | DIMENSION_USES | IMPLEMENTED_OBJECT | PARTITION
( LEVEL | HIERARCHY ) ) | GET AGGREGATE_FUNCTION | "measureLocator"
GET ( PROPERTIES "propertyKeyList" | IMPLEMENTED_OBJECT |
AGGREGATE_FUNCTIONS FOR DIMENSIONS "dimensionList" | PRECOMPUTE_LEVELS
FOR DIMENSIONS "dimensionList" | CALCULATED_EXPRESSION ) |
"dimensionUseLocator" GET ( PROPERTIES "propertyKeyList" | ( REF |
REFERENCE ) ( DIMENSION | LEVEL | ROLE ) | IMPLEMENTED_OBJECT |
DIMENSION_USE_POSITION ) | "compositeDimensionLocator" GET ( REF |
REFERENCE ) DIMENSIONS )
cubeName = "QUOTED_STRING"
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
measureLocator = MEASURE "measureName"
dimensionList = "(" "dimension" { "," "dimension" } ")"
dimensionUseLocator = DIMENSION_USE "dimensionUseName"
compositeDimensionLocator = COMPOSITE_DIMENSION "compositeDimensionName"
propertyKey = "UNQUOTED_STRING"
measureName = "QUOTED_STRING"
dimension = "QUOTED_STRING"
dimensionUseName = "QUOTED_STRING"
compositeDimensionName = "QUOTED_STRING"
Examples
See Also
OMBRETRIEVE, OMBCREATE CUBE, OMBALTER CUBE, OMBDROP CUBE
Purpose
Retrieve data auditor details such as the number of operators.
Prerequisites
The current context must be in an Oracle Module.
Syntax
retrieveDataAuditorCommand = OMBRETRIEVE DATA_AUDITOR "dataAuditorName"
"getDataAuditorDetailClause"
dataAuditorName = "QUOTED_STRING"
getDataAuditorDetailClause = GET ( PROPERTIES "propertyKeyList" |
"getReferenceIconSetClause" | [ "operatorType" ] OPERATORS |
"childType" ) | "getChildDetailClause" | "operatorLocator"
"getOperatorDetailClause"
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
operatorType = "UNQUOTED_STRING"
childType = "UNQUOTED_STRING"
getChildDetailClause = ( "childType" "childName" )+ GET ( PROPERTIES
"propertyKeyList" | "childType" )
operatorLocator = OPERATOR "operatorName"
getOperatorDetailClause = GET ( PROPERTIES "propertyKeyList" |
BOUND_OBJECT | "childType" ) | "getChildDetailClause"
propertyKey = "UNQUOTED_STRING"
childName = "QUOTED_STRING"
operatorName = "QUOTED_STRING"
Keywords And Parameters
retrieveDataAuditorCommand
Retrieve the detail of a data auditor such as how many operators are there.
dataAuditorName
Name of data auditor.
getDataAuditorDetailClause
Get properties or operators from the data auditor.
propertyKeyList
The list of property keys.
getReferenceIconSetClause
Retrieve the icon set referenced by the data auditor.
operatorType
Type of a mapping operator. The following operator types are available:
CUBE, DIMENSION, MATERIALIZED_VIEW, TABLE, VIEW.
childType
Type of a child that belongs to data auditor or operator
getChildDetailClause
Get the desired detail of a child object that belongs to the data auditor
or operator.
operatorLocator
Locate operator.
getOperatorDetailClause
Get the desired detail of a data auditor 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
childName
Name of a child that belongs to data auditor, operator.
operatorName
Name of an operator.
Examples
OMBRETRIEVE DATA_AUDITOR 'MAP1' GET OPERATORS
OMBRETRIEVE DATA_AUDITOR 'MAP1' OPERATOR 'SRC1'
GET PROPERTIES (BUSINESS_NAME, DESCRIPTION)
See Also
OMBRETRIEVE, OMBCREATE DATA_AUDITOR, OMBALTER DATA_AUDITOR, OMBDROP DATA_AUDITOR
Purpose
Retrieve details of the Data Profile.
Prerequisites
Should be in the context of project.
Syntax
retrieveDataProfileCommand = OMBRETRIEVE DATA_PROFILE "QUOTED_STRING" (
"getPropertiesClause" | "getReferenceLocationClause" |
"getReferenceIconSetClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceLocationClause = GET ( REF | REFERENCE ) LOCATION
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveDataProfileCommand
This command retrieves the details of a Data Profile
QUOTED_STRING
Name of the existing Data Profile or path to the Data Profile.
getPropertiesClause
Retrieve a set of properties that is associated with a Data Profile.
Properties for DATA_PROFILE:
Name: ABAP_DIRECTORY
Type: STRING
Valid Values: N/A
Default: /tmp
Location where SAP data is dumped as flat files
Name: CALCULATE_COMMON_FORMATS
Type: BOOLEAN
Valid Values: true, false
Default: false
Setting this to true will enable common format discovery for all the
columns in this profile.
Name: CALCULATE_DATATYPES
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable data type discovery for all the columns in
this profile.
Name: CALCULATE_DATA_RULES
Type: BOOLEAN
Valid Values: true, false
Default: false
Setting this to true will enable data rule profiling for the selected
table.
Name: CALCULATE_DOMAINS
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable domain discovery.
Name: CALCULATE_FD
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable functional dependency discovery.
Name: CALCULATE_FK
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable foreign key discovery.
Name: CALCULATE_PATTERNS
Type: BOOLEAN
Valid Values: true, false
Default: false
Setting this to true will enable pattern discovery.
Name: CALCULATE_REDUNDANT_COLUMNS
Type: BOOLEAN
Valid Values: true, false
Default: false
Setting this to true will enable redundant column discovery.
Name: CALCULATE_UK
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable unique key discovery.
Name: COPY_DATA
Type: BOOLEAN
Valid Values: true, false
Default: true
Setting this to true will enable copying of data from source to profile
workspace.
Name: DOMAIN_MAX_COUNT
Type: NUMBER
Valid Values: N/A
Default: 100
The maximum number of distinct values in a column in order for that column
to be discovered as possibly being defined by a domain. Domain Discovery
of a column occurs if the number of distinct values in that column is at or
below the Max Distinct Values Count property, AND, the number of distinct
values as a percentage of total rows is at or below the Max Distinct Values
Percent property.
Name: DOMAIN_MAX_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 50
The maximum number of distinct values in a column, expressed as a
percentage of the total number of rows in the table, in order for that
column to be discovered as possibly being defined by a domain. Domain
Discovery of a column occurs if the number of distinct values in that
column is at or below the Max Distinct Values Count property, AND, the
number of distinct values as a percentage of total rows is at or below the
Max Distinct Values Percent property.
Name: DOMAIN_MIN_COUNT
Type: NUMBER
Valid Values: N/A
Default: 2
The minimum number of rows for the given distinct value in order for that
distinct value to be considered as compliant with the domain. Domain Value
Compliance for a value occurs if the number of rows with that value is at
or above the Min Rows Count property, AND, the number of rows with that
value as a percentage of total rows is at or above the Min Rows Percent
property.
Name: DOMAIN_MIN_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 1
The minimum number of rows, expressed as a percentage of the total number
of rows, for the given distinct value in order for that distinct value to
be considered as compliant with the domain. Domain Value Compliance for a
value occurs if the number of rows with that value is at or above the Min
Rows Count property, AND, the number of rows with that value as a
percentage of total rows is at or above the Min Rows Percent property.
Name: FD_MIN_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 100
This is the minimum percentage of rows that need to satisfy a functional
dependency relationship.
Name: FD_UK_FK_LHS_COUNT
Type: NUMBER
Valid Values: N/A
Default: 1
This is the maximum number of attributes for unique key and functional
dependency profiling.
Name: FK_MIN_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 75
This is the minimum percentage of rows that need to satisfy a foreign key
relationship.
Name: MAX_NUM_PATTERNS
Type: NUMBER
Valid Values: N/A
Default: 10
This tells the profiler to get the top-N patterns for the attribute.
Name: NULL_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 10
If the percentage of null values in a column is less than this threshold
percent, then that column will be discovered as a possible Not Null column.
Name: NULL_VALUE
Type: STRING
Valid Values: N/A
Default: null
This value will be considered as the null value when profiling. Please
enclose the value in single quotes. An unqouted null (the current default
value) will be considered a database null.
Name: REDUNDANT_MIN_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 75
This is the minimum percentage of rows that are redundant with respect to a
foreign key-unique key pair.
Name: SAMPLE_RATE
Type: NUMBER
Valid Values: 0 - 100
Default: 100
This value will be the percent of total rows that will be randomly selected
during loading.
Name: UK_MIN_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 75
This is the minimum percentage of rows that need to satisfy a unique key
relationship.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getReferenceLocationClause
Retrieve the location that is set to the Data Profile.
getReferenceIconSetClause
Retrieve the icon set referenced by this Data Profile.
propertyNameList
Comma separated list of property names. Property names are unquoted.
Examples
OMBRETRIEVE DATA_PROFILE 'src_profile' GET PROPERTIES (DESCRIPTION,
BUSINESS_NAME)
This will retrieve the Data Profile "src_profile"'s description and
business name.
See Also
OMBRETRIEVE
Purpose
Retrieve data rule details such as the data rule type.
Prerequisites
The current context of scripting must be a data rule module.
Syntax
retrieveDataRuleCommand = OMBRETRIEVE DATA_RULE "QUOTED_STRING"
"retrieveDataRuleClause"
retrieveDataRuleClause = GET ( "getPropertiesClause" |
"getReferenceIconSetClause" | "getGroupsClause" |
"getDomainValuesClause" ) | GROUP "retrieveGroupClause"
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
getGroupsClause = GROUPS
getDomainValuesClause = DOMAIN_VALUES
retrieveGroupClause = "QUOTED_STRING" ( GET ( "getGroupPropertiesClause" |
"getAttributesClause" ) | "retrieveAttributeClause" )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
getGroupPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getAttributesClause = ATTRIBUTES
retrieveAttributeClause = ATTRIBUTE "QUOTED_STRING"
"getAttributePropertiesClause"
getAttributePropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
Keywords And Parameters
retrieveDataRuleCommand
Retreive a data rule
QUOTED_STRING
Data rule name.
retrieveDataRuleClause
Gets the groups, domain values or properties of a data rule.
getPropertiesClause
This clause retrieves all the properties.
Properties for DATA_RULE:
Name: ATTR_VALUE_CLAUSE
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: DUAL_ADDRESS_ASSIGNMENT
Type: STRING
Valid Values: NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX,
NA_DUALADDR_STREET
Default: NA_DUALADDR_STREET
Description not available.
Name: FUNCTIONAL_DEP_THRESHOLD
Type: NUMBER
Valid Values: N/A
Default: 0
Description not available.
Name: IGNORE_NULLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Description not available.
Name: LOCAL_MAX_COUNT
Type: STRING
Valid Values: N/A
Default: n
Description not available.
Name: LOCAL_MIN_COUNT
Type: STRING
Valid Values: N/A
Default: 1
Description not available.
Name: MAX_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: MIN_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: NAMEADDR_PASS_CONDITION
Type: STRING
Valid Values: PASS_PARSED, PASS_POSTALMATCHED_AVAIL
Default: PASS_PARSED
Description not available.
Name: PARSING_TYPE
Type: STRING
Valid Values: NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY
Default: NA_NAMEANDADDRESS
Description not available.
Name: PRIMARY_COUNTRY
Type: STRING
Valid Values: NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD,
NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE,
NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST,
NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND,
NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM,
NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR,
NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP,
NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF
Default: NA_USA
Description not available.
Name: REMOTE_MAX_COUNT
Type: STRING
Valid Values: N/A
Default: n
Description not available.
Name: REMOTE_MIN_COUNT
Type: STRING
Valid Values: N/A
Default: ''
Description not available.
Name: RULE_TYPE
Type: STRING
Valid Values: , ATTR_VALUE_RULE, DOMAIN_FORMAT_DATE_RULE,
DOMAIN_FORMAT_EMAIL_RULE, DOMAIN_FORMAT_IP_RULE, DOMAIN_FORMAT_NUMBER_RULE,
DOMAIN_FORMAT_SSN_RULE, DOMAIN_FORMAT_TELEPHONE_RULE,
DOMAIN_FORMAT_URL_RULE, DOMAIN_LIST_RULE, DOMAIN_NO_NULL_RULE,
DOMAIN_PATTERN_LIST_RULE, DOMAIN_RANGE_RULE, FUNCTIONAL_DEP_RULE,
IDENTITY_RULE, NAMEADDRESS_RULE, REFERENCE_RULE, SET_RULE
Default: ''
Description not available.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getReferenceIconSetClause
Retrieve the icon set referenced by the data rule.
getGroupsClause
Retrieves all the groups of a data rule.
getDomainValuesClause
Retreives all the domain values.
retrieveGroupClause
Retrieve a data rule group.
QUOTED_STRING
Group name.
propertyNameList
Comma separated list of property names. Property names are unquoted.
getGroupPropertiesClause
This clause retrieves all the properties of the data rule group.
getAttributesClause
Retrieves all the attributes of a data rule group.
retrieveAttributeClause
Retrieve a data rule group attribute.
QUOTED_STRING
Attribute name.
getAttributePropertiesClause
This clause retrieves all the properties of the data rule group attribute.
Examples
OMBRETRIEVE DATA_RULE 'STATE_NAME' GET PROPERTIES(RULE_TYPE)
OMBRETRIEVE DATA_RULE 'STATE_NAME' GET GROUPS
OMBRETRIEVE DATA_RULE 'STATE_NAME' GROUP 'THIS' GET ATTRIBUTES
OMBRETRIEVE DATA_RULE 'STATE_NAME' GET DOMAIN_VALUES
OMBRETRIEVE DATA_RULE 'REFERENCE' GET PROPERTIES (RULE_TYPE,
LOCAL_MIN_COUNT, REMOTE_MIN_COUNT)
OMBRETRIEVE DATA_RULE 'STATE_NAME' GROUP 'THIS' ATTRIBUTE 'VALUE' GET
PROPERTIES(DATATYPE)
See Also
OMBRETRIEVE
Purpose
Retrieve details of the data rule module.
Prerequisites
Should be in the context of project.
Syntax
retrieveDataRuleModuleCommand = OMBRETRIEVE DATA_RULE_MODULE
"QUOTED_STRING" ( "getPropertiesClause" | "getReferenceIconSetClause"
)
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveDataRuleModuleCommand
Retrieve the data rule module.
QUOTED_STRING
Data rule module name.
getPropertiesClause
This clause retrieves all the properties.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getReferenceIconSetClause
Retrieve the icon set referenced by the data rule module.
propertyNameList
Comma separated list of property names. Property names are unquoted.
Examples
OMBRETRIEVE DATA_RULE_MODULE 'br_module' GET PROPERTIES (DESCRIPTION)
See Also
OMBRETRIEVE
Purpose
Retrieve details of the Deployment.
Prerequisites
Should be in the context of a Configuration.
Syntax
retrieveDeploymentCommand = OMBRETRIEVE DEPLOYMENT "QUOTED_STRING" (
"getPropertiesClause" | "getReferencedControlCenterClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferencedControlCenterClause = GET ( REF | REFERENCE ) CONTROL_CENTER
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveDeploymentCommand
This command retrieves the details of a Deployment.
getPropertiesClause
Retrieve a set of properties that is associated with a Deployment.
propertyNameList
Comma separated list of property names. Property names are unquoted.
Examples
OMBRETRIEVE DEPLOYMENT 'QA_DEPLOYMENT' GET REF CONTROL_CENTER
This will retrieve a name of the referenced Control Center.
See Also
OMBLIST
Purpose
Retrieve the details of an existing deployment action plan.
Prerequisites
There must be a current working project.
Syntax
RetrieveActionPlanCommand = ( OMBRETRIEVE ( ( DEPLOYMENT_ACTION_PLAN |
ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" ) ( "getActionsClause"
| "retrieveActionClause" )
getActionsClause = GET ACTIONS
retrieveActionClause = ACTION "QUOTED_STRING" ( GET (
"getPropertiesClause" | "getReferenceClause" ) )
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceClause = ( REF | REFERENCE )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
RetrieveActionPlanCommand
Retrieve the details of an existing deployment action plan.
getActionsClause
Get a list of actions from an action plan.
retrieveActionClause
Retrieve a set of properties or the associated object of an action.
getPropertiesClause
Retrieve a set of properties that is associated with an action.
PROPERTIES
The only valid property is OPERATION, which specifies the type of action to
be taken.
getReferenceClause
Retrieve the object associated with an action.
propertyNameList
Comma separated list of property names. Property names are unquoted.
Examples
OMBRETRIEVE DEPLOYMENT_ACTION_PLAN 'MY_PLAN' GET ACTIONS
OMBRETRIEVE DEPLOYMENT_ACTION_PLAN 'MY_PLAN' ACTION 'MY_VIEW_CREATE'
GET PROPERTIES (OPERATION)
OMBRETRIEVE DEPLOYMENT_ACTION_PLAN 'MY_PLAN' ACTION 'MY_TABLE_DEPLOY'
GET REFERENCE
See Also
OMBCREATE DEPLOYMENT_ACTION_PLAN, OMBDEPLOY
Purpose
This command retrieves a dimension.
Prerequisites
Should be in Oracle Module context.
Syntax
retrieveDimensionCommand = OMBRETRIEVE DIMENSION "dimensionName" ( GET (
PROPERTIES "propertyKeyList" | "getReferenceIconSetClause" |
DIMENSION_ATTRIBUTES | LEVELS | HIERARCHIES | DIMENSION_ROLES | ( REF
| REFERENCE ) SEQUENCE | DIMENSION_KEY COLUMN | SURROGATE_KEY |
PARENT_KEY | BUSINESS_KEYS ) | "dimensionAttributeDetailClause" |
"levelDetailClause" | "hierarchyDetailClause" | "roleDetailClause" )
dimensionName = "QUOTED_STRING"
propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")"
getReferenceIconSetClause = ( REFERENCE | REF ) ICONSET
dimensionAttributeDetailClause = "dimensionAttributeLocator" GET
PROPERTIES "propertyKeyList"
levelDetailClause = "levelLocator" ( GET ( PROPERTIES "propertyKeyList" |
LEVEL_ATTRIBUTES | IMPLEMENTED_OBJECT ) | "levelAttributeDetailClause"
| "levelRelationshipDetailClause" |
"skipLevelRelationshipDetailClause" )
hierarchyDetailClause = "hierarchyLocator" GET ( PROPERTIES
"propertyKeyList" | ( REF | REFERENCE ) LEVELS )
roleDetailClause = "roleLocator" ( GET ( PROPERTIES "propertyKeyList" ) )
propertyKey = "UNQUOTED_STRING"
dimensionAttributeLocator = DIMENSION_ATTRIBUTE "dimensionAttributeName"
levelLocator = LEVEL "levelName"
levelAttributeDetailClause = "levelAttributeLocator" GET ( PROPERTIES
"propertyKeyList" | ( REF | REFERENCE ) ( DIMENSION_ATTRIBUTE |
TYPE_THREE_SCD_PREVIOUS LEVEL_ATTRIBUTE | TYPE_THREE_SCD_CURRENT
LEVEL_ATTRIBUTE ) | IMPLEMENTED COLUMN )
levelRelationshipDetailClause = LEVEL_RELATIONSHIP IN "hierarchyLocator"
GET IMPLEMENTED COLUMN
skipLevelRelationshipDetailClause = SKIP_LEVEL_RELATIONSHIP IN
"hierarchyLocator" GET ( PARENT LEVEL | IMPLEMENTED COLUMN )
hierarchyLocator = HIERARCHY "hierarchyName"
roleLocator = DIMENSION_ROLE "roleName"
dimensionAttributeName = "QUOTED_STRING"
levelName = "QUOTED_STRING"
levelAttributeLocator = LEVEL_ATTRIBUTE "levelAttributeName"
hierarchyName = "QUOTED_STRING"
roleName = "QUOTED_STRING"
levelAttributeName = "QUOTED_STRING"
Examples
OMBRETRIEVE DIMENSION 'DIM' GET LEVELS
See Also
OMBRETRIEVE, OMBCREATE DIMENSION, OMBALTER DIMENSION, OMBDROP DIMENSION
Purpose
Retrieve details of a Drill Path.
Prerequisites
Should be in the context of a Business Definition Module or use the full
path.
Syntax
retrieveDrillPathCommand = OMBRETRIEVE DRILL_PATH "QUOTED_STRING"
"retrieveDrillPathClauseDetails"
retrieveDrillPathClauseDetails = ( "retrieveDrillLevelClause" | GET (
"getPropertiesClause" | "getReferenceIconSetClause" | DRILL_LEVELS | (
REF | REFERENCE ) HIERARCHY | ( REF | REFERENCE ) DIMENSION | ( REF |
REFERENCE ) ROLE | DEPENDENTS ) )
retrieveDrillLevelClause = DRILL_LEVEL "QUOTED_STRING" ( GET (
"getPropertiesClause" | ( REF | REFERENCE ) ITEMS | ( REF | REFERENCE
) USING JOINS | ( REF | REFERENCE ) LEVEL | CHILDREN | PARENT ) )
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveDrillPathCommand
Retrieves the drill path.
QUOTED_STRING
name of the drill path.
retrieveDrillPathClauseDetails
This clause retrieves the contents of a drill path.
retrieveDrillLevelClause
Retrieves a specific drill level.
QUOTED_STRING
name of the drill level.
GET
For drill level this clause retrieves the following
REF ITEMS retrieves the list of Items referenced by this Drill Level.
REF USING JOINS retrieves the list of Joins used to join the Item Folder
containing Items in this Drill Level to the Item Folder containing Items in
the parent Drill Level.
REF LEVEL retrieves the dimensional Level corresponding to the Drill Level.
CHILDREN retrieves the child Drill Levels.
getPropertiesClause
Retrieves the properties of the object.
Basic properties for DRILL_PATH:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the drill path
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the drill path
Basic properties for DRILL_LEVEL:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the drill level
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the drill level
Properties for DRILL_PATH:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts
to create an object only for those objects marked as Deployable = true
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getReferenceIconSetClause
Get specified Icon Set.
propertyNameList
This is the list of property names.
Examples
OMBRETRIEVE DRILL_PATH 'PRODUCT_ROLLUP' GET PROPERTIES(DESCRIPTION)
See Also
OMBALTER DRILL_PATH, OMBCREATE DRILL_PATH
Purpose
Retrieve details of a Drill to Detail.
Prerequisites
Should be in the context of a Business Definition Module or use the full
path.
Syntax
retrieveDrillToDetailCommand = OMBRETRIEVE DRILL_TO_DETAIL "QUOTED_STRING"
"retrieveDrillToDetailClauseDetails"
retrieveDrillToDetailClauseDetails = GET ( "getPropertiesClause" |
"getReferenceIconSetClause" | ( REF | REFERENCE ) ITEMS )
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveDrillToDetailCommand
Retrieves the drill to detail.
QUOTED_STRING
name of the drill to detail.
retrieveDrillToDetailClauseDetails
This clause retrieves the contents of a drill to detail.
GET
This clause retrieves the following
REF ITEMS retrieves the list of Items that use this drill to detail.
getPropertiesClause
Retrieves the properties of the object.
Basic properties for DRILL_TO_DETAIL:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the drill to detail
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the drill to detail
Properties for DRILL_TO_DETAIL:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts
to create an object only for those objects marked as Deployable = true
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getReferenceIconSetClause
Get specified Icon Set.
propertyNameList
This is the list of property names.
Examples
OMBRETRIEVE DRILL_TO_DETAIL 'COLORS' GET PROPERTIES(DESCRIPTION)
See Also
OMBALTER DRILL_TO_DETAIL, OMBCREATE DRILL_TO_DETAIL
Purpose
To retrieve metadata on an expert.
Prerequisites
In the context of an expert module.
Syntax
retrieveExpertCommand = OMBRETRIEVE EXPERT "QUOTED_STRING" (
"retrieveExpertClause" | "retrieveTaskClause" |
"retrieveTransitionClause" | "retrieveParameterClause" |
"retrieveVariableClause" )
retrieveExpertClause = GET ( "getPropertiesClause" |
"getReferenceIconSetClause" | "getExpertSCOClauses" )
retrieveTaskClause = TASK "QUOTED_STRING" ( GET ( "getPropertiesClause" |
"getReferenceIconSetClause" | PARAMETERS | INCOMING TRANSITIONS |
OUTGOING TRANSITIONS | ( REF | REFERENCE ) EXPERT ) |
"retrieveParameterClause" )
retrieveTransitionClause = TRANSITION "QUOTED_STRING" GET (
"getPropertiesClause" | SOURCE TASK | DESTINATION TASK )
retrieveParameterClause = PARAMETER "QUOTED_STRING" GET (
"getPropertiesClause" | "getBindingClause" )
retrieveVariableClause = VARIABLE "QUOTED_STRING" GET
"getPropertiesClause"
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
getExpertSCOClauses = ( TASKS | "TASK_TYPE" TASKS | NESTED_EXPERT TASKS |
TRANSITIONS | PARAMETERS | VARIABLES )
getBindingClause = BOUND ( VARIABLE | PARAMETER )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveExpertCommand
Retrieve definition of the expert.
retrieveExpertClause
Retrieve either the properties or the child object definitions for the
expert.
retrieveTaskClause
Retrieve definition of a task.
retrieveTransitionClause
Retrieve definition of a transition.
retrieveParameterClause
Retrieve definition of an expert or a task parameter.
retrieveVariableClause
Retrieve definition of a variable.
getPropertiesClause
Get the values of the specified properties.
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
getReferenceIconSetClause
Retrieve the icon set referenced by this expert module.
getExpertSCOClauses
Get a list of child object of the specified type for the expert.
getBindingClause
Get the bound variable or parameter.
propertyNameList
The list of property names.
Examples
This command will retrieve the properties for the expert EXP1:
OMBRETRIEVE EXPERT 'EXP1' GET PROPERTIES (BUSINESS_NAME, DESCRIPTION)
This command will retrieve the description properties on task 'MY_TASK':
OMBRETRIEVE EXPERT 'EXP1' TASK 'MY_TASK' GET PROPERTIES (DESCRIPTION)
See Also
OMBRETRIEVE, OMBCREATE EXPERT, OMBALTER EXPERT, OMBDROP EXPERT
Purpose
To retrieve metadata on an expert module.
Prerequisites
In the context of a project.
Syntax
retrieveExpertModuleCommand = OMBRETRIEVE EXPERT_MODULE "QUOTED_STRING" (
"getPropertiesClause" | "getReferenceIconSetClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveExpertModuleCommand
Retrieve definition of an expert module.
getPropertiesClause
Get the values of the specified properties.
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
getReferenceIconSetClause
Retrieve the icon set referenced by this expert module.
propertyNameList
The list of property names to get.
Examples
This command will retrieve the properties for the expert module EM1:
OMBRETRIEVE EXPERT_MODULE 'EM1' GET PROPERTIES (BUSINESS_NAME, DESCRIPTION)
See Also
OMBRETRIEVE
Purpose
Retrieve details of an external table.
Prerequisites
Should be in the context of an Oracle module.
Syntax
retrieveExternalTableCommand = OMBRETRIEVE EXTERNAL_TABLE "QUOTED_STRING"
( "retrieveExternalTableClause" | "retrieveExternalTableColumnClause"
| "retrieveExternalTableDatafileClause" |
"retrieveDataRuleUsageClause" )
retrieveExternalTableClause = GET ( "getPropertiesClause" |
"getReferenceIconSetClause" | "getExternalTableObjectsClause" )
retrieveExternalTableColumnClause = COLUMN "QUOTED_STRING" GET (
"getPropertiesClause" | FIELD )
retrieveExternalTableDatafileClause = DATA_FILE "QUOTED_STRING" GET
"getPropertiesClause"
retrieveDataRuleUsageClause = DATA_RULE_USAGE "QUOTED_STRING" ( GET (
"getPropertiesClause" | GROUPS ) | GROUP "QUOTED_STRING" ( GET (
"getPropertiesClause" | ATTRIBUTES | REF ( TABLE | VIEW |
MATERIALIZED_VIEW | EXTERNAL_TABLE ) ) | ATTRIBUTE "QUOTED_STRING" (
GET ( "getPropertiesClause" | REF COLUMN ) ) ) )
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
getExternalTableObjectsClause = COLUMNS | FLAT_FILE | RECORD |
DEFAULT_LOCATION | DATA_FILES | COLUMN AT POSITION "INTEGER_LITERAL" |
DATA_RULE_USAGES
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveExternalTableCommand
Retrieve details from an external table.
QUOTED_STRING
The name of the external table.
retrieveExternalTableClause
Retrieve details from an external table.
retrieveExternalTableColumnClause
Retrieve details from an external table column.
retrieveExternalTableDatafileClause
Retrieve details from one of the external table's data files.
retrieveDataRuleUsageClause
This clause retrieves the data rule usages.
QUOTED_STRING
Name of data rule usage, group or attribute.
GROUPS
Retrieve the names of all relation groups in the data rule usage.
ATTRIBUTES
Retrieve the names of all attributes in a data rule usage group.
TABLE
Table name associated withthe data rule usage group.
VIEW
View name associated withthe data rule usage group.
MATERIALIZED_VIEW
Materialized view name associated with the data rule usage group.
EXTERNAL_TABLE
External table name associated with the data rule usage group.
COLUMN
Column name associated with the data rule usage group attribute.
getPropertiesClause
Retrieve specified properties.
getExternalTableObjectsClause
Retrieve a record reference, flat file reference, columns, or data files.
propertyNameList
The names of the properties whose values you want to retrieve.
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.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
Examples
OMBRETRIEVE EXTERNAL_TABLE 'SRC_TABLE' GET PROPERTIES (DESCRIPTION,
BUSINESS_NAME)
This will retrieve the external table "SRC_TABLE"'s description and
business name.
See Also
OMBRETRIEVE, OMBCREATE EXTERNAL_TABLE, OMBALTER EXTERNAL_TABLE, OMBDROP EXTERNAL_TABLE
Purpose
Retrieve details of a flat file.
Prerequisites
Create and change context to a flat file module.
Syntax
retrieveFlatFileCommand = OMBRETRIEVE FLAT_FILE "QUOTED_STRING" (
"retrieveFlatFileClause" | "retrieveFlatFileObjectsClause" )
retrieveFlatFileClause = GET ( "getPropertiesClause" | "getRecordsClause"
| "getReferenceIconSetClause" )
retrieveFlatFileObjectsClause = RECORD "QUOTED_STRING" ( ( GET
"getPropertiesClause" ) | "getFieldsClause" | "retrieveFieldClause" )
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getRecordsClause = RECORDS
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
getFieldsClause = GET FIELDS
retrieveFieldClause = "getFieldByNameClause" | "getFieldAtPositionClause"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
getFieldByNameClause = FIELD "QUOTED_STRING" GET "getPropertiesClause"
getFieldAtPositionClause = GET FIELD AT POSITION "INTEGER_LITERAL"
Keywords And Parameters
retrieveFlatFileCommand
Retrieve the details of a flat file.
QUOTED_STRING
The name of a flat file in quotes.
retrieveFlatFileClause
Retrieve properties of the flat file.
retrieveFlatFileObjectsClause
Retrieve details of the flat file's records and fields.
getPropertiesClause
Retrieve specified properties from the flat file, record, or field.
getRecordsClause
Retrieve a list of records from the flat file.
getFieldsClause
Retrieve a list of fields from the record.
retrieveFieldClause
Identify a specific field to retrieve properties from.
propertyNameList
The names of the properties whose values you want to retrieve.
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
getFieldByNameClause
Identify a specific field by its name.
getFieldAtPositionClause
Identify a specific field by its position in the record.
Examples
OMBRETRIEVE FLAT_FILE 'SRC_FILE' GET PROPERTIES (DESCRIPTION,
BUSINESS_NAME)
This will retrieve the flat file "SRC_FILE"'s description and business
name.
OMBRETRIEVE FLAT_FILE 'SRC_FILE_2' GET RECORDS
This will retrieve the records of the flat file "SRC_FILE_2".
OMBRETRIEVE FLAT_FILE 'SRC_FILE_3' RECORD 'EMPLOYEE' GET FIELDS
This will retrieve the fields of the "EMPLOYEE" record.
OMBRETRIEVE FLAT_FILE 'TARGET_FILE' RECORD 'TARGET_FILE' GET FIELD AT
POSITION 3 GET PROPERTIES (UOID)
This will retrieve the UOID of the third field in the single record flat
file "TARGET_FILE".
See Also
OMBRETRIEVE
Purpose
Retrieve details from a flat file module.
Prerequisites
Should be in the context of a project.
Syntax
retrieveFlatFileModuleCommand = OMBRETRIEVE FLAT_FILE_MODULE
"QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause"
| "getReferenceDefaultLocationClause" |
"getReferenceMetadataLocationClause" | "getReferenceIconSetClause" |
"getReferenceLocationsClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceLocationClause = GET ( REF | REFERENCE ) LOCATION
getReferenceDefaultLocationClause = GET ( REF | REFERENCE ) DEFAULT
LOCATION
getReferenceMetadataLocationClause = GET ( REF | REFERENCE )
METADATA_LOCATION
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
getReferenceLocationsClause = GET ( REF | REFERENCE ) LOCATIONS
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveFlatFileModuleCommand
Retrieve details from a flat file module.
QUOTED_STRING
The name of the flat file module to retrieve details from.
getPropertiesClause
Retrieve specified property values from the flat file module.
getReferenceLocationClause
Retrieve the name of the runtime location referenced by this flat file
module.
getReferenceDefaultLocationClause
Retrieve the default runtime location referenced by this flat file module.
getReferenceIconSetClause
Retrieve the icon set referenced by this flat file module.
getReferenceLocationsClause
Retrieve the runtime locations referenced by this flat file module.
propertyNameList
The names of the properties whose values you want to retrieve.
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.
Examples
OMBRETRIEVE FLAT_FILE_MODULE 'src_module' GET PROPERTIES (DESCRIPTION,
BUSINESS_NAME)
This will retrieve the flat file module "src_module"'s description and
business name.
See Also
OMBRETRIEVE
Purpose
Retrieve details of the 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
or WB_PREDEFINED_TRANS for Predefined Transformations.
WB_CUSTOM_TRANS may by modified by an administrator. WB_PREDEFINED_TRANS
may not be modified.
WB_CUSTOM_TRANS and WB_PREDEFINED_TRANS are not dependent on any project.
Syntax
retrieveFunctionCommand = OMBRETRIEVE FUNCTION "QUOTED_STRING" (
"getPropertiesClause" | "getFuncProcParameterClause" |
"getFuncProcParameterPositionClause" | "getFuncProcSignatureClause" |
"retrieveFuncProcParameterClause" | "getRelationalDependentsClause" |
"getReferenceIconSetClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getFuncProcParameterClause = GET PARAMETERS
getFuncProcParameterPositionClause = GET PARAMETER AT POSITION
"INTEGER_LITERAL"
getFuncProcSignatureClause = GET SIGNATURE
retrieveFuncProcParameterClause = PARAMETER "QUOTED_STRING"
"getPropertiesClause"
getRelationalDependentsClause = GET ( REF | REFERENCE ) ( TABLES | VIEWS |
MATERIALIZED_VIEWS | SEQUENCES | FUNCTIONS | PROCEDURES | PACKAGES )
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveFunctionCommand
This command retrieves the details of a Function
QUOTED_STRING
Name of the existing Function or path to the Function.
getPropertiesClause
Used to get 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
getFuncProcParameterClause
Get all the parameter names of the Function
getFuncProcParameterPositionClause
Get the parameter position of Function
getFuncProcSignatureClause
Get the complete signature of the Function which includes parameter names,
datatype, in/out type and default values
retrieveFuncProcParameterClause
Get the parameter information such as datatype, default value, in/out type
and position
QUOTED_STRING
Name of the existing Parameter
getRelationalDependentsClause
This clause retrieves referential dependencies to other relational objects.
propertyNameList
Comma separated list of property names. Property names are unquoted.
Examples
OMBRETRIEVE FUNCTION 'func' GET PROPERTIES (DESCRIPTION, UOID,
BUSINESS_NAME, RETURN_TYPE, IMPLEMENTATION, IS_DETERMINISTIC,
IS_PARALLEL_ENABLE, IS_IMPORTED)
This will retrieve the Function "func's description, uoid, business name,
return type, implementation, and boolean values of deterministic
parallel_enable and imported.
If Packaged Function is overloaded, first find the Signature by using
OMBLIST command, and then use OMBRETRIEVE command using appropriate
signature.
Example, if OMBLIST FUNCTIONS gives following two signatures,
FUNC_1 (NUMBER) RETURN NUMBER
FUNC_1 (VARCHAR2, NUMBER) RETURN NUMBER
The OMBRETRIEVE Syntax to retrieve the first one will be as follows
OMBRETRIEVE FUNCTION 'FUNC_1 \(NUMBER\) RETURN NUMBER' GET PROPERTIES
(DESCRIPTION, BUSINESS_NAME)
See Also
OMBRETRIEVE
Purpose
Retrieve details of a gateway module.
Prerequisites
Should be in the context of project.
Syntax
retrieveGatewayModuleCommand = OMBRETRIEVE GATEWAY_MODULE "QUOTED_STRING"
( "getPropertiesClause" | "getReferenceLocationClause" |
"getReferenceDefaultLocationClause" |
"getReferenceMetadataLocationClause" | "getReferenceIconSetClause" |
"getReferenceLocationsClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceLocationClause = GET ( REF | REFERENCE ) LOCATION
getReferenceDefaultLocationClause = GET ( REF | REFERENCE ) DEFAULT
LOCATION
getReferenceMetadataLocationClause = GET ( REF | REFERENCE )
METADATA_LOCATION
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
getReferenceLocationsClause = GET ( REF | REFERENCE ) LOCATIONS
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveGatewayModuleCommand
Specify the gateway module from which to retrieve details.
getPropertiesClause
Retrieve the properties of a gateway module.
Basic properties for GATEWAY_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the gateway module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the gateway module
Name: GATEWAY_TYPE
Type: STRING
Valid Values: N/A
Default: N/A
Type of gateway module
getReferenceLocationClause
Retrieve the name of the runtime location referenced by this gateway
module.
getReferenceDefaultLocationClause
Retrieve the default runtime location referenced by this gateway module.
getReferenceIconSetClause
Retrieve the icon set referenced by this gateway module.
getReferenceLocationsClause
Retrieve the runtime locations referenced by this gateway module.
propertyNameList
A list of property names.
Examples
The following line retrieves the description of a gateway module:
OMBRETRIEVE GATEWAY_MODULE 'db2_module' GET PROPERTIES(DESCRIPTION)
See Also
OMBRETRIEVE
Purpose
To retrieve the properties of an iconset.
Prerequisites
Any context.
Syntax
retrieveIconSetCommand = OMBRETRIEVE ICONSET "QUOTED_STRING" GET
"getPropertiesClause"
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveIconSetCommand
This command retrieves the properties of an iconset.
QUOTED_STRING
The name of the iconset to retrive.
getPropertiesClause
This clause gets the values for a list of properties.
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.
Examples
OMBRETRIEVE ICONSET 'ICON1' GET PROPERTIES (DESCRIPTION, BELONGS_TO_GROUP)
See Also
OMBCREATE ICONSET, OMBALTER ICONSET, OMBDROP ICONSET, OMBLIST ICONSETS
Purpose
To display the details of a transient import action plan.
Prerequisites
In the context of a project.
Syntax
retrieveImportActionPlanCommand = OMBRETRIEVE ( IMPORT_ACTION_PLAN )
"QUOTED_STRING" ( "getActionsClause" | "retrieveActionClause" )
getActionsClause = GET ACTIONS
retrieveActionClause = ACTION "QUOTED_STRING" GET ( "getPropertiesClause"
| "getRefSourceOrTargetClause" )
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getRefSourceOrTargetClause = ( REF | REFERENCE ) ( SOURCE | TARGET )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveImportActionPlanCommand
This command is for displaying details in an import action plan.
QUOTED_STRING
The name of the import action plan to be accessed.
getActionsClause
For listing actions in the import action plan.
retrieveActionClause
For displaying information of an action in the import action plan.
QUOTED_STRING
The name of the action to be accessed.
getPropertiesClause
For retrieving properties associated with the action. For the current
release, there are no predefined properties for import actions.
Examples
OMBRETRIEVE IMPORT_ACTION_PLAN 'PLAN1' GET ACTIONS
This command will list all the actions defined in action plan PLAN1.
OMBRETRIEVE IMPORT_ACTION_PLAN 'PLAN1' ACTION 'A1' GET REF SOURCE
This command will retrieve the set of items to be imported from source. A
list is returned, which contains alternating type names and item names,
for example, {TABLE SCOTT.T1 VIEW SCOTT2.V1}.
OMBRETRIEVE IMPORT_ACTION_PLAN 'PLAN1' ACTION 'A1' GET REF TARGET
The path of the target for import action A1 is retrieved. An example return
value is TRANSPORTABLE_MODULE: /MY_PROJECT/TM101.
See Also
OMBCREATE IMPORT_ACTION_PLAN, OMBIMPORT
Purpose
Retrieve details of an item folder.
Prerequisites
Should be in the context of a Business Definition Module or use the full
path.
Syntax
retrieveItemFolderCommand = OMBRETRIEVE ITEM_FOLDER "QUOTED_STRING" (
"retrieveItemFolderClause" | "retrieveItemFolderItemClause" |
"retrieveItemFolderJoinClause" | "retrieveItemFolderConditionClause" )
retrieveItemFolderClause = GET ( "getPropertiesClause" |
"getReferenceIconSetClause" | "getItemFolderSCOClause" )
retrieveItemFolderItemClause = ITEM "QUOTED_STRING" GET (
"getPropertiesClause" | SOURCE_OBJECTS | ( REF | REFERENCE ) DEFINING
LISTS_OF_VALUES | ( REF | REFERENCE ) DEFINING ALTERNATIVE_SORT_ORDERS
| ( REF | REFERENCE ) ORDERED ALTERNATIVE_SORT_ORDERS | ( REF |
REFERENCE ) LIST_OF_VALUES | ( REF | REFERENCE ) DRILL_TO_DETAIL | (
REF | REFERENCE ) ALTERNATIVE_SORT_ORDER | ( REF | REFERENCE )
DRILL_LEVELS | ( REF | REFERENCE ) LOCAL JOINS | ( REF | REFERENCE )
REMOTE JOINS )
retrieveItemFolderJoinClause = JOIN "QUOTED_STRING" (
"retrieveItemFolderJoinComponentClause" | GET ( "getPropertiesClause"
| JOIN_COMPONENTS | ( REF | REFERENCE ) FOREIGN_KEY | ( REF |
REFERENCE ) ITEM_FOLDERS ) )
retrieveItemFolderConditionClause = CONDITION "QUOTED_STRING" GET
"getPropertiesClause"
getPropertiesClause = PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
getItemFolderSCOClause = ITEMS | JOINS | CONDITIONS | SOURCE_OBJECTS | (
REF | REFERENCE ) USING JOINS | ( REF | REFERENCE ) BUSINESS_AREAS | (
REF | REFERENCE ) ROLE | ( REF | REFERENCE ) LEVEL | DEPENDENTS
retrieveItemFolderJoinComponentClause = JOIN_COMPONENT "QUOTED_STRING" GET
( "getPropertiesClause" | ( REF | REFERENCE ) LOCAL ITEM | ( REF |
REFERENCE ) REMOTE ITEM )
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveItemFolderCommand
To retrieve an item folder.
QUOTED_STRING
name of the item folder.
retrieveItemFolderClause
This clause retrieves the contents of an item folder.
GET
For an item folder, this clause retrieves the following
ITEMS retrieves the items in the item folder.
JOINS retrieves the joins in the item folder.
CONDITIONS retrieves the conditions in the item folder.
SOURCE_OBJECTS retrieves the objects the item folder is based on.
REF USING JOINS retrieves the join usages for the item folder.
REF BUSINESS_AREAS retrieves the business areas the item folder belongs to.
REF ROLE retrieves the dimension use reference for the item folder.
REF LEVEL retrieves the level reference for the item folder.
DEPENDENTS retrieves the dependents for the item folder.
retrieveItemFolderItemClause
Retrieves a specific item.
QUOTED_STRING
name of the item.
GET
For an item, this clause retrieves the following
SOURCE_OBJECT retrieves the object that the item is based on.
In the case of a complex item (that is, an expression) the list of items
referenced by the current item
REF LIST_OF_VALUES retrieves the List of Values associated with the item.
REF DRILL_TO_DETAIL retrieves the Drill to Detail associated with the item.
REF ALTERNATIVE_SORT_ORDER retrieves the Alternative Sort Order associated
with the item.
REF DEFINING LISTS_OF_VALUES retrieves a list of Lists of Values that use
this Item to define their values.
REF DEFINING ALTERNATIVE_SORT_ORDERS retrieves a list of Alternative Sort
Orders that use this Item to define their values.
REF ORDERED ALTERNATIVE_SORT_ORDERS retrieves a list of Alternative Sort
Orders that use this Item to define their order.
REF DRILL LEVELS retrieves the list of Drill Levels that reference this
Item.
REF LOCAL JOINS retrieves the list of Join Components that reference this
Item as their local Item.
REF REMOTE JOINS retrieves the list of Join Components that reference this
Item as their remote Item.
retrieveItemFolderJoinClause
Retrieves a specific join.
QUOTED_STRING
name of the join.
GET
For join this clause retrieves the following
JOIN_COMPONENTS retrieves the list of Join Components of this Join.
REF FOREIGN KEY retrieves the foreign key associated with this join.
REF ITEM_FOLDERS retrieves the list of complex Item Folders that use this
Join to join their component Item Folders.
retrieveItemFolderConditionClause
Retrieves a specific condition.
QUOTED_STRING
name of the condition.
getPropertiesClause
Retrieves the properties of the object.
Basic properties for ITEM_FOLDER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the item folder
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the item folder
Name: EXTERNAL_TABLE_NAME
Type: STRING(255)
Valid Values: N/A
Default: ''
The physical name for the corresponding table or view. This is
automatically set if the Folder is associated with a Table
Name: VISIBLE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the item folder should be visible to the user
Name: FOLDER_TYPE
Type: STRING(40)
Valid Values: SIMPLE, COMPLEX
Default: ''
The type of item folder
Basic properties for ITEM:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the item
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the item
Name: ALIGNMENT
Type: STRING(40)
Valid Values: GENERAL, LEFT, CENTER, RIGHT
Default: 'GENERAL'
The default alignment for displaying the item
Name: DISPLAY_CASE
Type: STRING(40)
Valid Values: GENERAL, LOWER, UPPER, INITCAPPED
Default: 'GENERAL'
How alphabetic characters should be displayed
Name: CASE_STORAGE
Type: STRING(40)
Valid Values: GENERAL, LOWER, UPPER, MIXED
Default: 'GENERAL'
How alphabetic characters are stored
Name: CONTENT_TYPE
Type: STRING(40)
Valid Values: No Value or FILE. For datatypes such as BLOB, it may contain
a file extension such as DOC, AVI, WAV, JPG
Default: ''
Details on whether the Item contains a file name or should be processed by
an external application
Name: DEFAULT_AGGREGATE
Type: STRING(255)
Valid Values: Detail, AVG, COUNT, MAX, MIN, SUM
Default: 'SUM' when the datatype is Numeric, 'Detail' otherwise
Name of the default rollup function for the item
Name: DEFAULT_POSITION
Type: STRING(40)
Valid Values: MEASURE, TOP OR SIDE, TOP, SIDE, PAGE
Default: 'MEASURE' when the datatype is NUMBER or FLOAT, 'TOP OR SIDE'
otherwise
Default position for the item
Name: REPLACE_NULL_WITH
Type: STRING(255)
Valid Values: N/A
Default: ''
The value to be displayed for null values
Name: FORMULA
Type: STRING
Valid Values: N/A
Default: ''
The text of the derivation expression for a derived item
Name: EXTERNAL_COLUMN_NAME
Type: STRING(255)
Valid Values: N/A
Default: ''
The external name of the corresponding column. This is automatically set
if the Item is is associated with a Column
Name: FORMAT_MASK
Type: STRING(255)
Valid Values: N/A
Default: ''
The display format mask for the item
Name: HEADING
Type: STRING(255)
Valid Values: N/A
Default: ''
The displayed heading text for the item
Name: DATATYPE
Type: STRING(40)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT,
INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH
NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.ROW_LCR, TIMESTAMP,
TIMESTAMP WITH LOCAL TIME ZONE
TIMESTAMP WITH TIME ZONE, UNSPECIFIED, VARCHAR, VARCHAR2, XMLTYPE,
SYS.XMLFORMAT, BLAST_ALIGN_PLSQLRECORDTYPE
SYS.LCR$_ROW_RECORD, BLAST_SQL_TABLE_OF_NUMBERS, SYS.XMLSEQUENCETYPE,
SYS_REFCURSOR, BLAST_MATCH_PLSQLRECORDTYPE
Default: 'VARCHAR2'
The datatype for the item
Name: VISIBLE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the item should be visible to the user
Name: MAX_CHAR_FETCHED
Type: Number
Valid Values: N/A
Default: ''
The maximum number of characters fetched for an item
Name: DEFAULT_WIDTH
Type: Number
Valid Values: N/A
Default: ''
The default number of characters to display
Name: WORD_WRAP
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether wordwrap is allowed in the display
Basic properties for JOIN:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the join
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the join
Name: OUTER_JOIN_ON_MASTER
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether detail rows with no related master row should be included in the
join
Name: OUTER_JOIN_ON_DETAIL
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether master rows with no related detail rows should be included in the
join
Name: EXTERNAL_KEY_NAME
Type: STRING(255)
Valid Values: N/A
Default: ''
The external name of the corresponding foreign key. This is automatically
set if the Join is is associated with a Foreign Key
Name: DETAIL_ALWAYS_HAS_MASTER
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether every detail row must reference a unique master row
Name: ONE_TO_ONE
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether a master row only ever has a single detail row
Basic properties for JOIN_COMPONENT:
Name: JOIN_OPERATOR
Type: STRING(200)
Valid Values: =, <>, <, <=, > or >=
Default: ''
Business name of the join
Basic properties for CONDITION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the condition
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the condition
Name: MATCH_CASE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the case of alphabetic characters must match exactly
Name: FORMULA
Type: STRING
Valid Values: N/A
Default: ''
The expression for the condition
Name: MANDATORY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the Condition is optional or mandatory
Properties for ITEM_FOLDER:
Name: DB_LOCATION
Type: STRING
Valid Values: N/A
Default: ''
Location for the referenced database object
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts
to create an object only for those objects marked as Deployable = true
Name: OPTIMIZER_HINT
Type: STRING
Valid Values: N/A
Default: ''
Optimizer Hint to be added when this Item Folder is used in a query
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getReferenceIconSetClause
Get specified Icon Set.
getItemFolderSCOClause
Retrieves the contents of the item folder.
retrieveItemFolderJoinComponentClause
Retrieves the join components.
QUOTED_STRING
name of the condition.
GET
For join component this clause retrieves the following
REF LOCAL ITEM retrieves the local item used in the join.
REF REMOTE ITEM retrieves the remote item used in the join.
propertyNameList
This is the list of property names.
Examples
OMBRETRIEVE ITEM_FOLDER 'COST' GET PROPERTIES(DESCRIPTION)
See Also
OMBALTER ITEM_FOLDER, OMBCREATE ITEM_FOLDER
Purpose
Retrieve details of a List Of Values.
Prerequisites
Should be in the context of a Business Definition Module or use the full
path.
Syntax
retrieveListOfValuesCommand = OMBRETRIEVE LIST_OF_VALUES "QUOTED_STRING"
"retrieveListOfValuesClauseDetails"
retrieveListOfValuesClauseDetails = GET (
"getPropertiesClauseforLOVandD2D" | "getReferenceIconSetClause" | (
REF | REFERENCE ) DEFINING ITEM | ( REF | REFERENCE ) ITEMS |
DEPENDENTS )
getPropertiesClauseforLOVandD2D = PROPERTIES "("
"propertyNameListforLOVandD2D" ")"
getReferenceIconSetClause = ( REF | REFERENCE ) ICONSET
propertyNameListforLOVandD2D = ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
"," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }
Keywords And Parameters
retrieveListOfValuesCommand
Retrieves the list of values.
QUOTED_STRING
name of the list of values.
retrieveListOfValuesClauseDetails
This clause retrieves the contents of a list of values.
GET
This clause retrieves the following
REF DEFINING ITEM retrieves the Item that holds the individual values for
this list of values.
REF ITEMS retrieves the list of Items that use this list of values.
DEPENDENTS retrieves a list of Item Folders that the list of values depends
on.
(This will return the Item Folder containing the Values Item).
getPropertiesClauseforLOVandD2D
This clause gets the properties of the object.
Basic properties for LIST_OF_VALUES:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the list of values
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the list of values
Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the list of values enables drilling between the item folders
containing the items that use the list of values
Name: RETRIEVE_VALUES_GROUP_SIZE
Type: Number
Valid Values: N/A
Default: '100'
The number of rows to be fetched from the database at a time
Name: CACHE_VALUES
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the list of values should be cached in memory
Name: REQUIRE_SEARCH
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether search criteria should be requested
Name: SHOW_IN_NAVIGATOR
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be shown in the item navigator
Name: SORTED_DISTINCT
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be displayed sorted with duplicates hidden
Properties for LIST_OF_VALUES:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts
to create an object only for those objects marked as Deployable = true
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getReferenceIconSetClause
Get specified Icon Set.
propertyNameListforLOVandD2D
This is the list of property names.
Examples
OMBRETRIEVE LIST_OF_VALUES 'COLORS' GET PROPERTIES(DESCRIPTION)
See Also
OMBALTER LIST_OF_VALUES, OMBCREATE LIST_OF_VALUES
Purpose
Retrieve details of the location.
Prerequisites
Can be in any context.
Syntax
retrieveLocationCommand = OMBRETRIEVE LOCATION "QUOTED_STRING" (
"getPropertiesClause" | "getReferenceIconSetClause" )
getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")"
getReferenceIconSetClause = GET ( REF | REFERENCE ) ICONSET
propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
Keywords And Parameters
retrieveLocationCommand
Retrieve details of the named location.
getPropertiesClause
Get specified properties of the location.
getReferenceIconSetClause
Get specified Icon Set.
propertyNameList
The names of the properties whose values you want to retrieve.
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
Examples
OMBRETRIEVE LOCATION 'A_LOCATION' GET PROPERTIES (TYPE, VERSION, HOST,
PORT, SERVICE_NAME, DESCRIPTION, BUSINESS_NAME)
This will retrieve the location "A_LOCATION"'s type, version, host, port,
service name, description, and business name.
See Also
OMBRETRIEVE
|
 Copyright © 2000, 2006, Oracle. All rights reserved. Legal Notices |
|