| Oracle® Warehouse Builder Scripting Reference 10g Release 1 (10.1) Part Number B12152-01 |
|
|
View PDF |
| Oracle® Warehouse Builder Scripting Reference 10g Release 1 (10.1) Part Number B12152-01 |
|
|
View PDF |
This chapter contains the following topics:
OMBRETRIEVE - Retrieve metadata of a component.
Can be in any context. Component to retrieve can be specified by either absolute or relative path.
Syntax Diagrams
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";
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.
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)
OMBCREATE, OMBALTER
OMBRETRIEVE ADVANCED_QUEUE - Retrieve details of the Advanced Queue.
Should be in the context of an Oracle Module.
Syntax Diagrams
retrieveAQCommand = OMBRETRIEVE ADVANCED_QUEUE "QUOTED_STRING" ( GET "getPropertiesClause" );getPropertiesClause = PROPERTIES "(" "propertyNameList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
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: PAYLOAD_TYPE
Type: STRING(4000)
Valid Values: N/A
Default: ''
PayLoad Type of the Advanced Queue. This has to be the name of an Object Type(OBJECT_TYPE) 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: GENERATE_ADVANCED_QUEUE
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate the code to create the Advanced Queue.
Name: GENERATE_OBJECT_TYPE
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate a script to create the Object Type.
Name: GENERATE_QUEUE_TABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate code to create the queue table that will persist the messages of this Advanced Queue.
Name: GENERATE_TEMPORARY_TABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Generate the code to create the temporary table.
Name: QUEUE_TABLE_NAME
Type: STRING(30)
Valid Values: N/A
Default: ''
The name of the queue table that is used to persist the messages in this Advanced Queue.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
propertyNameList
The list of properties.
OMBRETRIEVE ADVANCED_QUEUE 'SOME_ADVANCED_QUEUE' GET PROPERTIES (TABLESPACE, QUEUE_TABLE_NAME) This will retrieve the Advanced Queue "SOME_ADVANCED_QUEUE"'s properties TableSpace and Queue Table name.
OMBRETRIEVE, OMBALTER ADVANCED_QUEUE, OMBCREATE ADVANCED_QUEUE, OMBDROP ADVANCED_QUEUE
OMBRETRIEVE COLLECTION - Retrieve details of the collection, including its shortcuts.
Should be in the context of a project, before retrieving a collection.
Syntax Diagrams
retrieveCollectionCommand = OMBRETRIEVE COLLECTION "QUOTED_STRING" GET ( ( "referencesClause" | "propertiesClause" ) );referencesClause = ( ALL | TABLE | VIEW | PACKAGE | DIMENSION_TABLE | MATERIALIZED_VIEW | SEQUENCE | CUBE_TABLE | ADVANCED_QUEUE | EXTERNAL_TABLE | MAPPING | COLLECTION | ORACLE_MODULE | PROCESS_FLOW | PROCESS_FLOW_PACKAGE | PROCESS_FLOW_MODULE | SAP_MODULE | FUNCTION | PROCEDURE | FLAT_FILE_MODULE | FLAT_FILE | INTELLIGENCE_MODULE | REPORT_MODULE | REPORT | REPORT_GROUP | QUERY_OBJECT | BUSINESS_AREA | GATEWAY_MODULE | LOCATION | RUNTIME_REPOSITORY_CONNECTION | CONNECTOR | IO_FUNCTION ) REFERENCES;propertiesClause = PROPERTIES "(" "propertyNameList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
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.
OMBRETRIEVE COLLECTION 'Purchasing Warehouse' GET TABLE REFERENCES
OMBLIST
OMBRETRIEVE CONNECTOR - Retrieve details from a connector.
Should be in the context of the connector's owning location.
Syntax Diagrams
retrieveConnectorCommand = OMBRETRIEVE CONNECTOR "QUOTED_STRING" ( ( "getPropertiesClause" [ GET ( REFERENCE | REF ) "getReferencedLocationClause" ] ) | GET ( REFERENCE | REF ) "getReferencedLocationClause" );getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";getReferencedLocationClause = LOCATION;propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveConnectorCommand
Retrieve details from the named connector.
getPropertiesClause
Get properties of the connector.
getReferencedLocationClause
Get the name of the location which the connector references.
propertyNameList
The names of the properties whose values you want to set.
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
OMBRETRIEVE CONNECTOR 'A_CONNECTOR' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME) This will retrieve the connector "A_CONNECTOR"'s description, uoid, and business name.
OMBRETRIEVE
OMBRETRIEVE CUBE_TABLE - This command retrieves a cube.
Should be in Oracle Module context.
Syntax Diagrams
OMBRetrieveCube = OMBRETRIEVE CUBE_TABLE "cube_retrieve";cube_retrieve = "name" ( "cube_desrcibe_getCube_properties_clause" | "cube_retrieve_measure_clause" | "cube_retrieve_dimensionUse_clause" | "cube_retrieve_index_clause" | "cube_retrieve_indexColumn_clause" | "cube_retrieve_partition_clause" | "cube_retrieve_partitionKey_clause" );name = ( "QUOTED_STRING" );cube_desrcibe_getCube_properties_clause = GET ( MEASURES | DIMENSION_USES | ( INDEXES | PARTITIONS | PARTITION_KEYS | COLUMNS ) | ( PROPERTIES "(" ( "simple_property" { "," "simple_property" } ) ")" ) );cube_retrieve_measure_clause = MEASURE "name" GET "retrieve_get_properties_clause";cube_retrieve_dimensionUse_clause = DIMENSION_USE "name" GET ( LEVEL | DIMENSION_TABLE | "retrieve_get_properties_clause" );cube_retrieve_index_clause = INDEX "name" GET ( "retrieve_get_properties_clause" | INDEX_COLUMNS );cube_retrieve_indexColumn_clause = INDEX "name" INDEX_COLUMN "name" GET "retrieve_get_properties_clause";cube_retrieve_partition_clause = PARTITION "name" GET "retrieve_get_properties_clause";cube_retrieve_partitionKey_clause = PARTITION_KEY "name" GET "retrieve_get_properties_clause";simple_property = "UNQUOTED_STRING";retrieve_get_properties_clause = PROPERTIES "(" ( "simple_property" { "," "simple_property" } ) ")";
OMBRetrieveCube
This command retrieves properties of a cube_table.
cube_retrieve
This clause retrieves the properties of a cube_table, measures, dimensionUses, index, indexColumn, partition, partitionKey.
name
The name has to be a quoted string or an integer, or a decimal number.
cube_desrcibe_getCube_properties_clause
gets all measures, dimensionUses, partition, partitionKeys etc.
cube_retrieve_measure_clause
This clause gets the measure properties.
cube_retrieve_dimensionUse_clause
This clause retrieves dimensionUses and its properties.
cube_retrieve_index_clause
Get the index properties or IndexColumns.
cube_retrieve_indexColumn_clause
Get the IndexColumn property.
cube_retrieve_partition_clause
Get the partition property.
cube_retrieve_partitionKey_clause
Get the partitionKey property.
simple_property
gets the simple property.
UNQUOTED_STRING
Name of the simple property.
retrieve_get_properties_clause
Get the simple properties.
Basic properties for TABLE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the table
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the table
Name: UOID
Type: STRING
Valid Values: N/A
Default: N/A
Basic properties for INDEX, PARTITION, PARTITION_KEY, INDEX_COLUMN:
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Index, Partition, PartitionKey, IndexColumn
Properties for CUBE_TABLE:
Name: ANALYZE_TABLE_ESTIMATE_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 99
Value represents the sample size as a percentage of total rows. When set to a nonzero value, Builder generates a DDL script to analyze the table.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true
Name: HASH_PARTITION_TABLESPACE_LIST
Type: STRING
Valid Values: N/A
Default: ''
A comma separated list of tablespaces to use for [sub]partition storage.
Name: HASH_SUBPARTITION_NUMBER
Type: NUMBER
Valid Values: 2 - 63999
Default: 2
To create Hash partition, specify the number of Hash subpartition.
Name: LOGGING_MODE
Type: STRING
Valid Values: NOLOGGING, LOGGING
Default: LOGGING
Recovery requirements for a data warehouse : Logging or not logging to Redo Log File.
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: NOPARALLEL, PARALLEL
Default: PARALLEL
Enables or disables parallel processing when the table is created. Also enables or disables parallel processing or access.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Properties for INDEX:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true
Name: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: INDEX_TYPE
Type: STRING
Valid Values: BITMAP, UNIQUE, NO_INDEX
Default: UNIQUE
The types of Indexes created on Dimension are BITMAP, UNIQUE or a non-specific index.
Name: LOCAL_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
A local index is constructed so that it reflects the structure of the underlying table. It is equipartitioned with the underlying table, meaning that it is partitioned on the same columns as the underlying table, creates the same number of partitions or subpartitions, and gives them the same partition bounds as corresponding partitions of the underlying table.
Name: LOGGING_MODE
Type: STRING
Valid Values: NOLOGGING, LOGGING
Default: LOGGING
Recovery requirements for a data warehouse : Logging or not logging to Redo Log File.
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: NOPARALLEL, PARALLEL
Default: PARALLEL
Enables or disables parallel processing when the table is created. Also enables or disables parallel processing or access.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Properties for PARTITION:
Name: DATE_LESS_THAN
Type: STRING
Valid Values: N/A
Default: TO_DATE('01-JAN-1999', 'DD-MON-YYYY')
Value that represents upper bound of partition stored in warehouse key column for the Days Dimension.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: EMPTY_STRING
Use the Tablespace parameter to specify the name of tablespace.
Name: VALUES_LESS_THAN
Type: STRING
Valid Values: N/A
Default: TO_DATE('01-JAN-1999', 'DD-MON-YYYY')
Noninclusive upper bound for the current partition. Type a comma separated list in the same order as the columns in range partitioned key.
Name: VALUE_LESS_THAN
Type: STRING
Valid Values: N/A
Default: ''
Noninclusive upper bound for the current partition. Type a comma separated list in the same order as the columns in range partitioned key.
Properties for PARTITION_KEY:
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: TYPE
Type: STRING
Valid Values: HASH, RANGE
Default: RANGE
Oracle partitions the storage space and stores rows according to a Hash Algorithm or specified ranges.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
OMBRETRIEVE CUBE_TABLE 'CUBE1' GET MEASURES OMBRETRIEVE CUBE_TABLE 'CUBE1' GET DIMENSION_USES
OMBCREATE CUBE_TABLE, OMBDROP CUBE_TABLE, OMBALTER CUBE_TABLE
OMBRETRIEVE DEPLOYMENT_ACTION_PLAN - Retrieve the details of an existing deployment action plan.
There must be a current working project.
Syntax Diagrams
RetrieveActionPlanCommand = OMBRETRIEVE ( DEPLOYMENT_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" };
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.
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
OMBCREATE DEPLOYMENT_ACTION_PLAN, OMBDEPLOY
OMBRETRIEVE EXTERNAL_TABLE - Retrieve details of an external table.
Should be in the context of an Oracle module.
Syntax Diagrams
retrieveExternalTableCommand = OMBRETRIEVE EXTERNAL_TABLE "QUOTED_STRING" ( "retrieveExternalTableClause" | "retrieveExternalTableColumnClause" | "retrieveExternalTableDatafileClause" );retrieveExternalTableClause = GET ( "getPropertiesClause" | "getExternalTableObjectsClause" );retrieveExternalTableColumnClause = COLUMN "QUOTED_STRING" GET ( "getPropertiesClause" | FIELD );retrieveExternalTableDatafileClause = DATA_FILE "QUOTED_STRING" GET "getPropertiesClause";getPropertiesClause = PROPERTIES "(" "propertyNameList" ")";getExternalTableObjectsClause = COLUMNS | FLAT_FILE | RECORD | DEFAULT_LOCATION | DATA_FILES | COLUMN AT POSITION "INTEGER_LITERAL";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
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.
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.
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: 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: 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: STRING_SIZES_IN
Type: STRING
Valid Values: CHARACTERS, BYTES
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: LEFT, NONE, SQL*LOADER, BOTH, RIGHT
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
OMBRETRIEVE EXTERNAL_TABLE 'SRC_TABLE' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME) This will retrieve the external table "SRC_TABLE"'s description, uoid, and business name.
OMBRETRIEVE
OMBRETRIEVE FLAT_FILE - Retrieve details of a flat file.
Create and change context to a flat file module.
Syntax Diagrams
retrieveFlatFileCommand = OMBRETRIEVE FLAT_FILE "QUOTED_STRING" ( "retrieveFlatFileClause" | "retrieveFlatFileObjectsClause" );retrieveFlatFileClause = GET ( "getPropertiesClause" | "getRecordsClause" );retrieveFlatFileObjectsClause = RECORD "QUOTED_STRING" ( ( GET "getPropertiesClause" ) | "getFieldsClause" | "retrieveFieldClause" );getPropertiesClause = PROPERTIES "(" "propertyNameList" ")";getRecordsClause = RECORDS;getFieldsClause = GET FIELDS;retrieveFieldClause = "getFieldByNameClause" | "getFieldAtPositionClause";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };getFieldByNameClause = FIELD "QUOTED_STRING" GET "getPropertiesClause";getFieldAtPositionClause = GET FIELD AT POSITION "INTEGER_LITERAL";
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. (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: 1
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 1) 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 1) 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.
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.
Properties for FIELD:
Name: DATATYPE
Type: STRING
Valid Values: CHAR, DATE, DECIMAL EXTERNAL, FLOAT EXTERNAL, INTEGER EXTERNAL, ZONED EXTERNAL, ZONED
Default: CHAR
This is the SQL*Loader data type for the field.
Name: LENGTH
Type: NUMBER
Valid Values: 1+
Default: 1
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: 0+
Default: 0
The starting position of a field for a fixed length file.
Name: SQL_DATATYPE
Type: STRING
Valid Values: CHAR, DATE, FLOAT, NUMBER, VARCHAR, VARCHAR2, DEFAULT
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: for 'CHAR' : 1 - 2000 for 'VARCHAR' and 'VARCHAR2' : 1 - 4000
Default: Depends on Sql data type.
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.
getFieldByNameClause
Identify a specific field by its name.
getFieldAtPositionClause
Identify a specific field by its position in the record.
OMBRETRIEVE FLAT_FILE 'SRC_FILE' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME) This will retrieve the flat file "SRC_FILE"'s description, uoid, 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".
OMBRETRIEVE
OMBRETRIEVE FLAT_FILE_MODULE - Retrieve details from a flat file module.
Should be in the context of a project.
Syntax Diagrams
retrieveFlatFileModuleCommand = OMBRETRIEVE FLAT_FILE_MODULE "QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause" );getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";getReferenceLocationClause = GET ( REF | REFERENCE ) LOCATION;propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
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 flat file module's location.
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.
Name: UOID
Type: STRING(40)
Valid Values: N/A
Default: N/A
UOID of the flat file module.
OMBRETRIEVE FLAT_FILE_MODULE 'src_module' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME) This will retrieve the flat file module "src_module"'s description, uoid, and business name.
OMBRETRIEVE
OMBRETRIEVE FUNCTION - Retrieve details of the Function.
Should be in the context of a Oracle Module or Package or Transformation Module.
Syntax Diagrams
retrieveFunctionCommand = OMBRETRIEVE FUNCTION "QUOTED_STRING" ( "getPropertiesClause" | "getFuncProcParameterClause" | "getFuncProcParameterPositionClause" | "getFuncProcSignatureClause" | "retrieveFuncProcParameterClause" );getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";getFuncProcParameterClause = GET PARAMETERS;getFuncProcParameterPositionClause = GET PARAMETER AT POSITION "INTEGER_LITERAL";getFuncProcSignatureClause = GET SIGNATURE;retrieveFuncProcParameterClause = PARAMETER "QUOTED_STRING" "getPropertiesClause";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
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 shown below:
Basic properties for FUNCTION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Function
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Function
Name: RETURN_TYPE
Type: STRING
Valid Values: PLS_INTEGER, BINARY_INTEGER, BOOLEAN, NUMBER, FLOAT, CHAR, VARCHAR, VARCHAR2, DATE
Default: NUMBER
Set the Return Type for Function
Name: IMPLEMENTATION
Type: STRING
Valid Values: N/A
Default: ''
Set the code for Function which is included global variable declaration and code between BEGIN and END.
Name: IS_DETERMINISTIC
Type: BOOLEAN
Valid Values: true, false
Default: false
This setting helps the optimizer avoid redundant function calls.
Name: IS_PARALLEL_ENABLE
Type: BOOLEAN
Valid Values: true, false
Default: false
This option sets flag to a stored function can be used safely in the slave sessions of parallel DML evaluations.
Basic properties for PARAMETER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Parameter
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Parameter
Name: DATATYPE
Type: STRING
Valid Values: PLS_INTEGER, BINARY_INTEGER, BOOLEAN, NUMBER, FLOAT, CHAR, VARCHAR, VARCHAR2, DATE
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: None, Current_User, Definer
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
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
propertyNameList
Comma separated list of property names. Property names are unquoted.
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
to retrieve the first one will be as follows OMBRETRIEVE FUNCTION 'FUNC_1 \(NUMBER\) RETURN NUMBER' GET PROPERTIES (DESCRIPTION, BUSINESS_NAME)
OMBRETRIEVE
OMBRETRIEVE GATEWAY_MODULE - Retrieve details of a gateway module.
Can be in any context. Use absolute/relative path notation to locate a gateway module.
Syntax Diagrams
retrieveGatewayModuleCommand = OMBRETRIEVE GATEWAY_MODULE "QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause" );getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";getReferenceLocationClause = GET ( REF | REFERENCE ) LOCATION;propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
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: UOID
Type: STRING
Valid Values: N/A
Default: N/A
Universal object identifier
Name: GATEWAY_TYPE
Type: STRING
Valid Values: N/A
Default: N/A
Type of gateway module
getReferenceLocationClause
Retrieve the name of the location referenced by this gateway module.
propertyNameList
A list of property names.
The following line retrieves the description of a gateway module:
OMBRETRIEVE GATEWAY_MODULE 'INFX1' GET PROPERTIES(DESCRIPTION)
OMBRETRIEVE
OMBRETRIEVE LOCATION - Retrieve details of the location.
Should be in the context of a project.
Syntax Diagrams
retrieveLocationCommand = OMBRETRIEVE LOCATION "QUOTED_STRING" "getPropertiesClause";getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveLocationCommand
Retrieve details of the named location.
getPropertiesClause
Get specified properties of the location.
propertyNameList
The names of the properties whose values you want to retrieve.
Properties for LOCATION:
Name: TYPE
Type: STRING
Valid Values: 'Oracle Gateway', 'File System', 'Oracle Database', 'OEM Agent', 'Oracle Workflow', 'SAP'
Default: N/A
The type of system the location represents.
Name: VERSION
Type: STRING
Valid Values:
for 'Oracle Gateway' : '0'
for 'File System' : '0'
for 'Oracle Database' : '9.2','9.0','8.1','8.0','7.3.4'
for 'OEM Agent' : '9.2','9.0'
for 'Oracle Workflow' : '2.6'
for 'SAP' : '4.x','3.x'
Default: N/A
The version of the system(s) the location represents.
Basic properties for LOCATION:
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.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
OMBRETRIEVE LOCATION 'A_LOCATION' GET PROPERTIES (TYPE, VERSION, DESCRIPTION, UOID, BUSINESS_NAME) This will retrieve the location "A_LOCATION"'s type, version, description, uoid, and business name.
OMBRETRIEVE
OMBRETRIEVE MAPPING - Retrieve mapping details such as the number of operators and their connections.
The current context must be in an Oracle Module.
Syntax Diagrams
retrieveMappingCommand = OMBRETRIEVE MAPPING "mappingName" ( "getMappingDetailClause" | "testConnectionClause" );mappingName = "QUOTED_STRING";getMappingDetailClause = GET ( PROPERTIES "propertyKeyList" | [ "operatorType" ] OPERATORS [ "connectionConditionClause" ] | "childType" ) | "getChildDetailClause" | "operatorLocator" "getOperatorDetailClause";testConnectionClause = HAS CONNECTION FROM "mappableBottomUpLocator" TO "mappableBottomUpLocator";propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")";operatorType = "UNQUOTED_STRING";connectionConditionClause = CONNECTED ( FROM "mappableBottomUpLocator" | TO "mappableBottomUpLocator" );childType = "UNQUOTED_STRING";getChildDetailClause = ( "childType" "childName" )+ GET ( PROPERTIES "propertyKeyList" | "childType" );operatorLocator = OPERATOR "operatorName";getOperatorDetailClause = GET ( PROPERTIES "propertyKeyList" | [ "groupDirection" ] GROUPS [ "connectionConditionClause" ] | BOUND_OBJECT | "childType" ) | "getChildDetailClause" | "groupLocator" "getGroupDetailClause";mappableBottomUpLocator = "operatorLocator" | "groupBottomUpLocator" | "attributeBottomUpLocator";propertyKey = "UNQUOTED_STRING";childName = "QUOTED_STRING";operatorName = "QUOTED_STRING";groupDirection = INPUT | OUTPUT | INPUT_OUTPUT;groupLocator = GROUP "groupName";getGroupDetailClause = GET ( PROPERTIES "propertyKeyList" | ATTRIBUTES [ "connectionConditionClause" ] | "childType" ) | "getChildDetailClause" | "attributeLocator" "getAttributeDetailClause";groupBottomUpLocator = GROUP "groupName" OF "operatorLocator";attributeBottomUpLocator = ATTRIBUTE "attributeName" OF "groupBottomUpLocator";groupName = "QUOTED_STRING";attributeLocator = ATTRIBUTE "attributeName";getAttributeDetailClause = GET ( PROPERTIES "propertyKeyList" | BOUND_OBJECT | "childType" ) | "getChildDetailClause";attributeName = "QUOTED_STRING";
retrieveMappingCommand
Retrieve the detail of a mapping such as how many mapping operators are there or which mapping operators are connected to each other.
mappingName
Name of the mapping.
getMappingDetailClause
Get the desired detail of the mapping.
testConnectionClause
Verify if there is a connection between mapping operators, mapping groups or mapping attributes.
propertyKeyList
The list of property keys
operatorType
Type of a mapping operator. The following operator types are available: ADVANCED_QUEUE, AGGREGATOR, CONSTANT, CUBE, DATA_GENERATOR, DEDUPLICATOR, DIMENSION, EXPRESSION, EXTERNAL_PROCESS, EXTERNAL_TABLE, FILTER, FLAT_FILE, INPUT_PARAMETER, JOINER, KEY_LOOKUP, MATCHMERGE, MATERIALIZED_VIEW, NAME_AND_ADDRESS, OUTPUT_PARAMETER, PIVOT, POSTMAPPING_PROCESS, PREMAPPING_PROCESS, SEQUENCE, SET_OPERATION, SORTER, SPLITTER, TABLE, TRANSFORMATION, UNPIVOT, VIEW.
connectionConditionClause
List objects only if they are connected from or to objects specified in the
connection condition.
childType
Type of a child that belongs to map, mapping operator, mapping group or mapping attribute.
getChildDetailClause
Get the desired detail of a child object that belongs to the mapping, mapping operator, mapping group or mapping attribute.
operatorLocator
Location of a mapping operator.
getOperatorDetailClause
Get the desired detail of a mapping operator.
mappableBottomUpLocator
Location of the object to be bound to a mapping mapping operator or mapping
attribute.
propertyKey
A property key for an object.
Basic properties for MAPPING:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the mapping
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the mapping
Basic properties for OPERATOR:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the operator
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the operator
Basic properties for GROUP:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the group
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the group
Basic properties for ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the attribute
Name: DATATYPE
Type: STRING(20)
Valid Values: NUMBER, VARCHAR2, VARCHAR, DATE, LONG
Default: ''
Datatype of the Attribute
Name: LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
Length of the attribute.
Name: PRECISION
Type: NUMBER
Valid Values: N/A
Default: 0
Precision of the attribute.
Name: SCALE
Type: NUMBER
Valid Values: N/A
Default: 0
Scale of the attribute.
Properties for MAPPING:
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: STEP_TYPE
Type: STRING
Valid Values: ABAP, SQLLOADER, PLSQL
Default: UNKNOWN
The step type used to generate this mapping
Properties for MAPPING ABAP STEP:
Name: CONTROL_FILE_NAME
Type: STRING
Valid Values: N/A
Default: owb.dat
Control File Name
Name: DATA_FILE_NAME
Type: STRING
Valid Values: N/A
Default: owb.dat
Data File Name
Name: FILE_DELIMITER_FOR_STAGING_FILE
Type: STRING
Valid Values: N/A
Default: ~
File Delimiter for Staging File
Name: LOG_FILE_NAME
Type: STRING
Valid Values: N/A
Default: owb.log
Log File Name
Name: NESTED_LOOP
Type: STRING
Valid Values: TRUE_DEFAULT, TRUE, FALSE
Default: TRUE_DEFAULT
Nested Loop
Name: PRIMARY_FOREIGN_KEY_FOR_JOIN
Type: STRING
Valid Values: N/A
Default: DEFAULT
Primary Foreign Key for Join
Name: SAP_SYSTEM_VERSION
Type: STRING
Valid Values: SAP_R3_4X, SAP_R3_3X
Default: SAP_R3_4X
SAP System Version
Name: SQL_JOIN_COLLAPSING
Type: STRING
Valid Values: TRUE_DEFAULT, TRUE, FALSE
Default: TRUE_DEFAULT
Sql Join Collapsing
Name: STAGING_FILE_DIRECTORY
Type: STRING
Valid Values: N/A
Default: C:\temp\
Staging File Directory
Name: USE_SELECT_SINGLE
Type: STRING
Valid Values: TRUE_DEFAULT, TRUE, FALSE
Default: TRUE_DEFAULT
Use Select Single
Properties for MAPPING PLSQL STEP:
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: 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_FREQUENCY
Type: NUMBER
Valid Values: N/A
Default: 1000
The default number of rows processed before a commit is issued.
Name: CORRELATED_COMMIT
Type: BOOLEAN
Valid Values: true, false
Default: false
The mapping commits or rolls back correlated rows together.
Name: DEFAULT_AUDIT_LEVEL
Type: STRING
Valid Values: NONE, STATISTICS, ERROR_DETAILS, COMPLETE
Default: ERROR_DETAILS
The default audit level when the step is executed.
Name: DEFAULT_OPERATING_MODE
Type: STRING
Valid Values: SET_BASED, ROW_BASED, ROW_BASED_TARGET_ONLY, 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: MAXIMUM_NUMBER_OF_ERRORS
Type: NUMBER
Valid Values: N/A
Default: 50
The default maximum number of errors encountered before aborting the step execution.
Name: OPTIMIZED_CODE
Type: BOOLEAN
Valid Values: true, false
Default: true
Attempt to generate optimized code if this is true.
Name: PARALLEL_ROW_CODE
Type: BOOLEAN
Valid Values: true, false
Default: false
Generate parallel row code if this is true.
Properties for MAPPING SQLLOADER STEP:
Name: AUDIT
Type: BOOLEAN
Valid Values: true, false
Default: true
Perform audit when the step is executed.
Name: BIND_SIZE
Type: NUMBER
Valid Values: N/A
Default: 50000
Bind Size
Name: CONTINUE_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
Continue Load
Name: CONTROL_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: N/A
The Control File Location
Name: CONTROL_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The control file name used in TCL generation
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Database file name from which to allocate extents
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: DELIMITED_FILE_RECORD_TERMINATION
Type: STRING
Valid Values: N/A
Default: N/A
This property has been deprecated. Please set the record delimiter in the Flat File Sample Wizard or Property Sheet.
Name: DIRECT_MODE
Type: BOOLEAN
Valid Values: true, false
Default: true
Direct Mode
Name: ERRORS_ALLOWED
Type: NUMBER
Valid Values: N/A
Default: 50
Number of errors to allow
Name: LOG_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: N/A
The log file location.
Name: LOG_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The log file name.
Name: NLS_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, WE8MACROM AN8S, WE8MSWIN1252, WE8PC850, WE8PC860, ZHS16CGB231280, ZHS16GBK, ZHS16MACCGB231280, ZHT16BIG5, ZHT16MSWIN950, ZHT32EUC
Default: WE8MSWIN1252
Nls Characterset
Name: OPERATION_RECOVERABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Operation Recoverable
Name: PERFORM_PARALLEL_LOAD
Type: BOOLEAN
Valid Values: true, false
Default: false
Perform Parallel Load
Name: PRESERVE_BLANKS
Type: BOOLEAN
Valid Values: true, false
Default: false
Preserve Blanks
Name: READ_BUFFERS
Type: NUMBER
Valid Values: N/A
Default: 4
The Number of Buffers
Name: READ_SIZE
Type: NUMBER
Valid Values: N/A
Default: 65536
The size of the read buffer
Name: RECORDS_TO_LOAD
Type: NUMBER
Valid Values: N/A
Default: N/A
Number of logical records to load. The default value of 0 indicates to load all records.
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: N/A
Default: N/A
Number of logical records to skip
Name: ROWS_PER_COMMIT
Type: NUMBER
Valid Values: N/A
Default: 200
Rows per Commit
Properties for MAPPING SQLLOADER STEP SOURCE_DATA_FILE CHILD:
Name: BAD_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: N/A
Bad file location.
Name: BAD_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Bad file name. If the Bad File Location is set then this must be a relative file name. Otherwise this should contain a fully qualified path.
Name: DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: N/A
The location for this component.
Name: DATA_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The data file name for this component. If the Data File Location is set then this must be a relative file name. Otherwise this should contain a fully qualified path.
Name: DISCARD_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: N/A
Discard file location
Name: DISCARD_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Discard file name. If the Discard File Location is set then this must be a relative file name. Otherwise this should contain a fully qualified path.
Name: DISCARD_MAX
Type: NUMBER
Valid Values: N/A
Default: 0
Discard Max
Properties for ADVANCED_QUEUE OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Properties for AGGREGATOR OPERATOR:
Name: GROUP_BY_CLAUSE
Type: STRING
Valid Values: N/A
Default: N/A
The Group By clause for the aggregation
Name: HAVING_CLAUSE
Type: STRING
Valid Values: N/A
Default: N/A
The Having clause for the aggregation
Properties for CUBE OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: No constraints
This property is used by public API and scripting to influence how columns are used for UPDATE or DELETE DMLs. If this property is set with the name of a primary or unique key, all the columns in the key will be used for matching during UPDATE or DELETE; and all the columns not in the key are used for loading. The property can also be assigned the value "All constraints" or "No constraints". If the DML type is INSERT, TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING
Valid Values: N/A
Default: N/A
The database link used to access this entity during mapping.
Name: DATA_COLLECTION_FREQUENCY
Type: STRING
Valid Values: UNKNOWN, YEAR, QUARTER, MONTH, DAY, HOUR, MINUTE
Default: UNKNOWN
New Data Granularity
Name: DIRECT
Type: BOOLEAN
Valid Values: true, false
Default: false
Directly swap source into target as a partition without first creating a staging table.
Name: ENABLE_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable Constraints
Name: EXCEPTIONS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Exceptions Table Name
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING
Valid Values: INSERT, UPDATE, INSERT_UPDATE, UPDATE_INSERT, DELETE, NONE, TRUNCATE_INSERT, DELETE_INSERT, CHECK_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: YES
A property to indicate whether unique or primary key information on this target will override the matching criteria obtained from Match by constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Partition Name
Name: PEL_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
PEL Enabled
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: YES, NO
Default: NO
A boolean value to indicate whether this is a primary source or not (only used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: N/A
Default: N/A
Number of records to skip
Name: REPLACE_DATA
Type: BOOLEAN
Valid Values: true, false
Default: false
Replace existing data in target partition if there is any.
Name: SCHEMA
Type: STRING
Valid Values: N/A
Default: N/A
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: N/A
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: N/A
A condition on the rows in the target and if evaluated to true, that row will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: N/A
A condition on the rows in the target and if evaluated to true, that row will participate in the update loading operation.
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Properties for DIMENSION OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: No constraints
This property is used by public API and scripting to influence how columns are used for UPDATE or DELETE DMLs. If this property is set with the name of a primary or unique key, all the columns in the key will be used for matching during UPDATE or DELETE; and all the columns not in the key are used for loading. The property can also be assigned the value "All constraints" or "No constraints". If the DML type is INSERT, TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING
Valid Values: N/A
Default: N/A
The database link used to access this entity during mapping.
Name: DATA_COLLECTION_FREQUENCY
Type: STRING
Valid Values: UNKNOWN, YEAR, QUARTER, MONTH, DAY, HOUR, MINUTE
Default: UNKNOWN
New Data Granularity
Name: DIRECT
Type: BOOLEAN
Valid Values: true, false
Default: false
Directly swap source into target as a partition without first creating a staging table.
Name: ENABLE_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable Constraints
Name: EXCEPTIONS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Exceptions Table Name
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING
Valid Values: INSERT, UPDATE, INSERT_UPDATE, UPDATE_INSERT, DELETE, NONE, TRUNCATE_INSERT, DELETE_INSERT, CHECK_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: YES
A property to indicate whether unique or primary key information on this target will override the matching criteria obtained from Match by constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Partition Name
Name: PEL_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
PEL Enabled
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: YES, NO
Default: NO
A boolean value to indicate whether this is a primary source or not (only used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: N/A
Default: N/A
Number of records to skip
Name: REPLACE_DATA
Type: BOOLEAN
Valid Values: true, false
Default: false
Replace existing data in target partition if there is any.
Name: SCHEMA
Type: STRING
Valid Values: N/A
Default: N/A
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: N/A
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: N/A
A condition on the rows in the target and if evaluated to true, that row will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: N/A
A condition on the rows in the target and if evaluated to true, that row will participate in the update loading operation.
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Properties for EXTERNAL_TABLE OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING
Valid Values: N/A
Default: N/A
The database link used to access this entity during mapping.
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when loading into this table using SQL
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: YES, NO
Default: NO
A boolean value to indicate whether this is a primary source or not (only used in EDW).
Name: SCHEMA
Type: STRING
Valid Values: N/A
Default: N/A
Schema
Properties for FILTER OPERATOR:
Name: FILTER_CONDITION
Type: STRING
Valid Values: N/A
Default: N/A
The boolean filtering condition that identifies what data is to be processed. Any row with a false condition will be ignored.
Properties for FLAT_FILE OPERATOR:
Name: CONCATENATE_RECORDS
Type: NUMBER
Valid Values: N/A
Default: 0
Number of Physical Records per Logical Record.
Name: CONTINUATION_CHARACTER
Type: STRING
Valid Values: N/A
Default: N/A
Character that indicates the record is continued on the next line.
Name: CONTINUATION_CHARACTER_ON_NEXT_LINE
Type: BOOLEAN
Valid Values: true, false
Default: FALSE
If there is a continuation character, is it at the start of the line.
Name: FIELD_ENCLOSURE_CHARACTERS
Type: STRING
Valid Values: N/A
Default: N/A
Characters that wrap fields. Example ' or ".
Name: FIELD_NAMES_IN_THE_FIRST_ROW
Type: BOOLEAN
Valid Values: true, false
Default: FALSE
Indicates whether to write the field names in the first row of the output file.
Name: FIELD_TERMINATION_CHARACTER
Type: STRING
Valid Values: N/A
Default: ,
Character that separates the fields of a delimited file.
Name: FILE_FORMAT
Type: STRING
Valid Values: N/A
Default: DELIMITED
File Format (Fixed or Delimited).
Name: LOADING_TYPE
Type: STRING
Valid Values: INSERT, UPDATE, NONE
Default: INSERT
The loading operation to be performed
Name: NLS_CHARACTERSET
Type: STRING
Valid Values: N/A
Default: WE8MSWIN1252
NLS Characterset
Name: RECORD_DELIMITER
Type: STRING
Valid Values: N/A
Default: N/A
Character that indicates the end of the record.
Name: RECORD_SIZE
Type: NUMBER
Valid Values: N/A
Default: 0
Size of a fixed length record.
Name: RECORD_TYPE_LENGTH
Type: NUMBER
Valid Values: N/A
Default: 0
If this is a multi record file, this will indicate the length of the data that identifies the type of record. It is used with the Record Type Position.
Name: RECORD_TYPE_POSITION
Type: NUMBER
Valid Values: N/A
Default: 0
If this is a multi record file, this will indicate the position of the field that identifies the type of record.
Name: SAMPLED_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name of the file that was sampled to get the metadata for this file.
Name: TARGET_DATA_FILE_LOCATION
Type: STRING
Valid Values: N/A
Default: N/A
The name of the location in which to open the target data file. Make sure the root path of this location, as registered in the Runtime Platform, is exactly specified in the initialization file (INIT.ORA) of your runtime database using the UTL_FILE_DIR parameter.
Name: TARGET_DATA_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.
Properties for INPUT_PARAMETER OPERATOR:
Properties for JOINER OPERATOR:
Name: JOIN_CONDITION
Type: STRING
Valid Values: N/A
Default: N/A
The Join Condition for the join operator
Properties for KEY_LOOKUP OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING
Valid Values: N/A
Default: N/A
The database link used to access this entity during mapping.
Name: LOOKUP_CONDITION
Type: STRING
Valid Values: N/A
Default: N/A
Key lookup condition based on the source inputs. This condition is used to lookup a value in the bound table. If the condition is not met, the default value expression will be returned. If a default expression is not defined, null is used.
Name: SCHEMA
Type: STRING
Valid Values: N/A
Default: N/A
Schema
Properties for MATCHMERGE OPERATOR:
Name: MATCH_KEYS
Type: STRING
Valid Values: N/A
Default: N/A
Ordered list of attributes that control the set of records to be matched at any at any particular time.
Name: MERGED_PREFIX
Type: STRING
Valid Values: N/A
Default: N/A
Set the prefix used for the merged attributes in the cross-reference group.
Properties for MATERIALIZED_VIEW OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: No constraints
This property is used by public API and scripting to influence how columns are used for UPDATE or DELETE DMLs. If this property is set with the name of a primary or unique key, all the columns in the key will be used for matching during UPDATE or DELETE; and all the columns not in the key are used for loading. The property can also be assigned the value "All constraints" or "No constraints". If the DML type is INSERT, TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING
Valid Values: N/A
Default: N/A
The database link used to access this entity during mapping.
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING
Valid Values: INSERT, UPDATE, INSERT_UPDATE, UPDATE_INSERT, DELETE, NONE, TRUNCATE_INSERT, DELETE_INSERT, CHECK_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: YES
A property to indicate whether unique or primary key information on this target will override the matching criteria obtained from Match by constraint property on the attributes of this target.
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: YES, NO
Default: NO
A boolean value to indicate whether this is a primary source or not (only used in EDW).
Name: SCHEMA
Type: STRING
Valid Values: N/A
Default: N/A
Schema
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: N/A
A condition on the rows in the target and if evaluated to true, that row will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: N/A
A condition on the rows in the target and if evaluated to true, that row will participate in the update loading operation.
Properties for NAME_AND_ADDRESS OPERATOR:
Name: ADDRESS_LINE_1
Type: STRING
Valid Values: N/A
Default: N/A
Address line 1
Name: ADDRESS_LINE_2
Type: STRING
Valid Values: N/A
Default: N/A
Address line 2
Name: ADDRESS_LINE_3
Type: STRING
Valid Values: N/A
Default: N/A
Address line 3
Name: ADDRESS_LINE_4
Type: STRING
Valid Values: N/A
Default: N/A
Address line 4
Name: DUAL_ADDRESS_ASSIGNMENT
Type: STRING
Valid Values: NA_DUALADDR_STREET, NA_DUALADDR_POBOX, NA_DUALADDR_CLOSESTTOLASTLINE
Default: NA_DUALADDR_STREET
A dual address refers to two address lines for the same destination. For example, a record contains both a street address and a P.O. Box; this is common with business data. Select which of the two address lines should be assigned in these cases.
Name: GENERATE_CASS_REPORT
Type: STRING
Valid Values: NA_YES, NA_NO
Default: NA_NO
Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS report is a text file specified by the United States Postal Service. The report is written to the [nas/bin/admin/reports] folder under the home folder of the name/address server.
Name: LIST_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The list name is optional and provides a reference for tracking multiple CASS reports.
Name: PARSING_TYPE
Type: STRING
Valid Values: NA_NAMEONLY, NA_ADDRESSONLY, NA_NAMEANDADDRESS
Default: NA_NAMEANDADDRESS
Select a name-address parsing type to be performed on the input data
Name: PRIMARY_COUNTRY
Type: STRING
Valid Values: NA_ARG, NA_AUS, NA_BEL, NA_BRA, NA_CAN, NA_CHL, NA_COL, NA_DNK, NA_FRA, NA_DEU, NA_HKG, NA_IND, NA_IRL, NA_ITA, NA_MEX, NA_MYS, NA_NLD, NA_NZL, NA_PER, NA_PHL, NA_PRT, NA_SGP, NA_ZAF, NA_ESP, NA_SWE, NA_CHE, NA_ARE, NA_GBR, NA_USA, NA_VEN
Default: NA_USA
Select the primary parsing country which best represents the input data. Input addresses having the same country as the primary parsing country will only need to be parsed once. Input addresses having a different country than the primary parsing country may be reparsed by a different parser. For performance reasons, it is best to minimize the percentage of 2-pass parses by selecting the optimal parser.
Name: PROCESSOR_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The processor name is the name of the organization submitting the CASS report.
Properties for OUTPUT_PARAMETER OPERATOR:
Properties for PIVOT OPERATOR:
Name: PIVOT_GROUP_SIZE
Type: NUMBER
Valid Values: 1 - 1000
Default: 2
A number specifying the pivot group size for the pivot operation. Pivot group size determines the number of output rows that are produced from each input row.
Properties for POSTMAPPING_PROCESS OPERATOR:
Name: FUNCTION_CALL
Type: STRING
Valid Values: N/A
Default: N/A
Expression template for procedure call
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Name of the transformation to be called.
Name: POSTMAPPING_PROCESS_RUN_CONDITION
Type: STRING
Valid Values: ALWAYS, ON_SUCCESS, ON_ERROR, ON_WARNING
Default: ON_SUCCESS
Indicates under what condition of the mapping the post-mapping process will be run.
Name: ROWBASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: N/A
Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.
Properties for PREMAPPING_PROCESS OPERATOR:
Name: FUNCTION_CALL
Type: STRING
Valid Values: N/A
Default: N/A
Expression template for procedure call
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Name of the transformation to be called.
Name: MAPPING_RUN_CONDITION
Type: STRING
Valid Values: ALWAYS, ON_SUCCESS, ON_ERROR
Default: ON_SUCCESS
Indicates under what condition of the pre-mapping process the mapping will be run.
Name: ROWBASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: N/A
Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.
Properties for SEQUENCE OPERATOR:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DATABASE_LINK
Type: STRING
Valid Values: N/A
Default: N/A
The database link used to access this entity during mapping.
Name: SCHEMA
Type: STRING
Valid Values: N/A
Default: N/A
Schema
Properties for SET_OPERATION OPERATOR:
Name: SET_OPERATION
Type: STRING
Valid Values: UNION, UNIONALL, INTERSECT, MINUS
Default: UNION
Specifies the set operation that is to be performed by this operator.
Properties for SORTER OPERATOR:
Name: ORDER_BY_CLAUSE
Type: STRING
Valid Values: N/A
Default: N/A
The Order By Clause
Properties for TABLE OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: No constraints
This property is used by public API and scripting to influence how columns are used for UPDATE or DELETE DMLs. If this property is set with the name of a primary or unique key, all the columns in the key will be used for matching during UPDATE or DELETE; and all the columns not in the key are used for loading. The property can also be assigned the value "All constraints" or "No constraints". If the DML type is INSERT, TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING
Valid Values: N/A
Default: N/A
The database link used to access this entity during mapping.
Name: DATA_COLLECTION_FREQUENCY
Type: STRING
Valid Values: UNKNOWN, YEAR, QUARTER, MONTH, DAY, HOUR, MINUTE
Default: UNKNOWN
New Data Granularity
Name: DIRECT
Type: BOOLEAN
Valid Values: true, false
Default: false
Directly swap source into target as a partition without first creating a staging table.
Name: ENABLE_CONSTRAINTS
Type: BOOLEAN
Valid Values: true, false
Default: true
Enable Constraints
Name: EXCEPTIONS_TABLE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Exceptions Table Name
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING
Valid Values: INSERT, UPDATE, INSERT_UPDATE, UPDATE_INSERT, DELETE, NONE, TRUNCATE_INSERT, DELETE_INSERT, CHECK_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: YES
A property to indicate whether unique or primary key information on this target will override the matching criteria obtained from Match by constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Partition Name
Name: PEL_ENABLED
Type: BOOLEAN
Valid Values: true, false
Default: false
PEL Enabled
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: YES, NO
Default: NO
A boolean value to indicate whether this is a primary source or not (only used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: N/A
Default: N/A
Number of records to skip
Name: REPLACE_DATA
Type: BOOLEAN
Valid Values: true, false
Default: false
Replace existing data in target partition if there is any.
Name: SCHEMA
Type: STRING
Valid Values: N/A
Default: N/A
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: N/A
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: N/A
A condition on the rows in the target and if evaluated to true, that row will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: N/A
A condition on the rows in the target and if evaluated to true, that row will participate in the update loading operation.
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Properties for TABLE_FUNCTION OPERATOR:
Name: TABLE_FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name of the Table Function
Properties for TRANSFORMATION OPERATOR:
Name: FUNCTION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Name of the transformation to be called.
Name: ROWBASED_ONLY
Type: BOOLEAN
Valid Values: true, false
Default: N/A
Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.
Properties for VIEW OPERATOR:
Name: ADVANCED_MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: No constraints
This property is used by public API and scripting to influence how columns are used for UPDATE or DELETE DMLs. If this property is set with the name of a primary or unique key, all the columns in the key will be used for matching during UPDATE or DELETE; and all the columns not in the key are used for loading. The property can also be assigned the value "All constraints" or "No constraints". If the DML type is INSERT, TRUNCATE/INSERT, or CHECK/INSERT, setting this property causes no effect.
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DATABASE_FILE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Database file name to allocate extents from
Name: DATABASE_LINK
Type: STRING
Valid Values: N/A
Default: N/A
The database link used to access this entity during mapping.
Name: EXTRACTION_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when extracting from this table using SQL
Name: LOADING_HINT
Type: STRING
Valid Values: N/A
Default: N/A
Hint used when loading into this table using SQL
Name: LOADING_TYPE
Type: STRING
Valid Values: INSERT, UPDATE, INSERT_UPDATE, UPDATE_INSERT, DELETE, NONE, TRUNCATE_INSERT, DELETE_INSERT, CHECK_INSERT
Default: INSERT
The loading operation to be performed when this is a target.
Name: MATCH_BY_CONSTRAINT
Type: STRING
Valid Values: N/A
Default: YES
A property to indicate whether unique or primary key information on this target will override the matching criteria obtained from Match by constraint property on the attributes of this target.
Name: PARTITION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Partition Name
Name: PRIMARY_SOURCE
Type: STRING
Valid Values: YES, NO
Default: NO
A boolean value to indicate whether this is a primary source or not (only used in EDW).
Name: RECORDS_TO_SKIP
Type: NUMBER
Valid Values: N/A
Default: N/A
Number of records to skip
Name: SCHEMA
Type: STRING
Valid Values: N/A
Default: N/A
Schema
Name: SINGLEROW
Type: BOOLEAN
Valid Values: true, false
Default: false
Singlerow
Name: SORTED_INDEXES_CLAUSE
Type: STRING
Valid Values: N/A
Default: N/A
Sorted Indexes Clause
Name: SUBPARTITION_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Subpartition Name
Name: TARGET_FILTER_FOR_DELETE
Type: STRING
Valid Values: N/A
Default: N/A
A condition on the rows in the target and if evaluated to true, that row will participate in the delete loading operation.
Name: TARGET_FILTER_FOR_UPDATE
Type: STRING
Valid Values: N/A
Default: N/A
A condition on the rows in the target and if evaluated to true, that row will participate in the update loading operation.
Name: TRAILING_NULLCOLS
Type: BOOLEAN
Valid Values: true, false
Default: false
Trailing Nullcols
Properties for CUBE,DIMENSION,KEY_LOOKUP,MATERIALIZED_VIEW,TABLE,VIEW OPERATOR KEYS_READONLY CHILD:
Name: KEY_COLUMNS
Type: STRING
Valid Values: N/A
Default: N/A
Local columns that define this key (Comma separated if more than one).
Name: KEY_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Name of the primary, foreign or unique key (primary, foreign, or unique).
Name: KEY_TYPE
Type: STRING
Valid Values: N/A
Default: UNIQUE
Type of key - primary, foreign or unique.
Name: REFERENCED_KEYS
Type: STRING
Valid Values: N/A
Default: N/A
If the key is a foreign key, this will contain the key or keys used of the referenced object.
Properties for MATCHMERGE OPERATOR MATCH_RULES CHILD:
Name: ADDRESS_ADDRESS_LINE_SIMILARITY_SCORE
Type: NUMBER
Valid Values: N/A
Default: N/A
Similarity score for address line in Address Match Rule.
Name: ADDRESS_ALLOW_DIFFERING_SECONDARY_ADDRESSES
Type: BOOLEAN
Valid Values: true, false
Default: false
Allow differing secondary addresses to match in Address Match Rule.
Name: ADDRESS_LAST_LINE_SIMILARITY_SCORE
Type: NUMBER
Valid Values: N/A
Default: N/A
Similarity score for last line in Address Match Rule.
Name: ADDRESS_MATCH_ON_ADDRESS_LINE_SIMILARITY
Type: BOOLEAN
Valid Values: true, false
Default: false
Check address line similarity in Address Match Rule.
Name: ADDRESS_MATCH_ON_BLANK_SECONDARY_ADDRESSES
Type: BOOLEAN
Valid Values: true, false
Default: false
Match on blank secondary address in Address Match Rule.
Name: ADDRESS_MATCH_ON_LAST_LINE_SIMILARITY
Type: BOOLEAN
Valid Values: true, false
Default: false
Check last line similarity in Address Match Rule.
Name: ADDRESS_MATCH_ON_STREET_OR_PO_BOX
Type: BOOLEAN
Valid Values: true, false
Default: false
Match on Street or Post Office (PO) Box in Address Match Rule.
Name: CUSTOM_RULE
Type: STRING
Valid Values: N/A
Default: N/A
Custom Merge Rule
Name: DESCRIPTION
Type: STRING
Valid Values: N/A
Default: N/A
Description of match rule.
Name: FIRM_CROSS_MATCH_FIRM1_AND_FIRM2
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a firm match rule, should Warehouse Builder cross match firm 1 and firm 2?
Name: FIRM_MATCH_ON_ABBREVIATIONS
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a firm match rule, should Warehouse Builder match on abbreviations?
Name: FIRM_MATCH_ON_ACRONYMS
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a firm match rule, should Warehouse Builder match on acronyms?
Name: FIRM_MATCH_ON_PARTIAL_NAMES
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a firm match rule, should Warehouse Builder match on partial names?
Name: FIRM_MATCH_ON_SIMILARITY
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a firm match rule, should Warehouse Builder check firm similarity?
Name: FIRM_SIMILARITY_SCORE
Type: NUMBER
Valid Values: N/A
Default: N/A
Similarity score for firm in Firm Match Rule.
Name: FIRM_STRIP_NOISE_WORDS
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a firm match rule, should Warehouse Builder strip noise words?
Name: PERSON_DETECT_SWITCHED_NAME_ORDER
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person rule, should Warehouse Builder detect the switched name order.
Name: PERSON_FN_DETECT_COMPOUND_NAME
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder detect compound names?
Name: PERSON_FN_MATCH_ON_INITIALS
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder match on initials.
Name: PERSON_FN_MATCH_ON_SIMILARITY
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder match on first name similarity?
Name: PERSON_FN_MATCH_ON_SOUNDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder match on first name soundex?
Name: PERSON_FN_MATCH_ON_SUBSTRINGS
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder match on first name substrings?
Name: PERSON_FN_MRS_MATCH
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder detect MRS? (For example, should Mrs John Smith match Mrs Smith)
Name: PERSON_FN_SIMILARITY_SCORE
Type: NUMBER
Valid Values: N/A
Default: N/A
If matching in first name similarity, what is the similarity score?
Name: PERSON_LN_DETECT_MISSING_HYPHEN
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder detect missing hyphens?
Name: PERSON_LN_MATCH_HYPHENATED_NAMES
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder match on hyphenated last name?
Name: PERSON_LN_MATCH_ON_SIMILARITY
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder match on last name similarity?
Name: PERSON_LN_MATCH_ON_SOUNDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder match on last name soundex?
Name: PERSON_LN_SIMILARITY_SCORE
Type: NUMBER
Valid Values: N/A
Default: N/A
If Warehouse Builder is matching on last name similarity, what is the similarity score?
Name: PERSON_MN_MATCH_ON_INITIALS
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder match on middle name initials?
Name: PERSON_MN_MATCH_ON_SIMILARITY
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder match on middle name similarity?
Name: PERSON_MN_MATCH_ON_SOUNDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder match on middle name soundex?
Name: PERSON_MN_MATCH_ON_SUBSTRINGS
Type: BOOLEAN
Valid Values: true, false
Default: false
If this is a person match rule, should Warehouse Builder match on middle name substrings?
Name: PERSON_MN_SIMILARITY_SCORE
Type: NUMBER
Valid Values: N/A
Default: N/A
If Warehouse Builder is matching on middle name similarity, what is the similarity score?
Name: TOTAL_WEIGHT_SCORE
Type: NUMBER
Valid Values: N/A
Default: N/A
If this is a weight rule, the sum of all weights must be equal to or greater than this score for the records to pass the weght rule.
Name: TYPE
Type: STRING
Valid Values: MM_TRUE, MM_FALSE, MM_WEIGHT, MM_CONDITIONAL, MM_CUSTOM, MM_PERSON, MM_FIRM, MM_ADDRESS
Default: MM_TRUE
What type of match rule is this? Possible types are: MM_TRUE, MM_FALSE, MM_WEIGHT, MM_CONDITIONAL, MM_CUSTOM, MM_PERSON, MM_FIRM, MM_ADDRESS
Name: USAGE
Type: STRING
Valid Values: MM_ACTIVE, MM_PASSIVE
Default: MM_ACTIVE
Is this an active or passive rule? Possible usages are: MM_ACTIVE, MM_PASSIVE.
Properties for MATCHMERGE OPERATOR MERGE_RULES CHILD:
Name: ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Merge Attribute
Name: COPY_ATTRIBUTE
Type: STRING
Valid Values: N/A
Default: N/A
Copy this merged attribute to merge rule target attribute.
Name: CUSTOM_TEXT
Type: STRING
Valid Values: N/A
Default: N/A
Implementation text for custom merge rule. Include "BEGIN and END statements.
Name: DESCRIPTION
Type: STRING
Valid Values: N/A
Default: N/A
Description
Name: MATCH_ID_SEQUENCE_MODULE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Physical sequence module name for match id merge rule. This sequence will be used to generate the match id.
Name: MATCH_ID_SEQUENCE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Physical sequence name for match id merge rule. This sequence will be used to generate the match id.
Name: MIN_MAX_ATTRIBUTE
Type: STRING
Valid Values: N/A
Default: N/A
Selecting attribute for min/max merge rule
Name: MIN_MAX_TYPE
Type: STRING
Valid Values: MM_MIN, MM_MAX, MM_SHORTEST, MM_LONGEST
Default: MM_MAX
Select record where attribute is min,max, shortest, longest. Possible values are MM_MIN, MM_MAX, MM_SHORTEST, MM_LONGEST.
Name: SEQUENCE_MODULE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Physical sequence module name for sequence merge rule.
Name: SEQUENCE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Physical sequence name for sequence merge rule.
Name: TYPE
Type: STRING
Valid Values: MM_ANY, MM_MATCH_ID, MM_RANK, MM_SEQUENCE, MM_MIN_MAX, MM_COPY, MM_CUSTOM, MM_RECORD_ANY, MM_RECORD_RANK, MM_RECORD_MIN_MAX, MM_RECORD_CUSTOM
Default: MM_ANY
Merge Rule Type. Possible values are:MM_ANY,MM_MATCH_ID,MM_RANK,MM_SEQUENCE,MM_MIN_MAX,MM_COPY,MM_CUSTOM,MM_RECORD_ANY,MM_RECORD_RANK,MM_RECORD_MIN_MAX,MM_RECORD_CUSTOM.
Properties for MATCHMERGE OPERATOR MATCH_RULES CHILD ADDRESS_ROLES CHILD:
Name: ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
What is the attribute for this role?
Name: TYPE
Type: STRING
Valid Values: MM_PRIMARY_ADDR, MM_UNIT_NUM, MM_PO_BOX, MM_DUAL_PRIMARY_ADDR, MM_DUAL_UNIT_NUM, MM_DUAL_PO_BOX, MM_CITY, MM_STATE, MM_POSTAL_CODE, MM_IS_FOUND
Default: MM_PRIMARY_ADDR
What role is this attribute? Possible values are: MM_PRIMARY_ADDR, MM_UNIT_NUM, MM_PO_BOX, MM_DUAL_PRIMARY_ADDR, MM_DUAL_UNIT_NUM, MM_DUAL_PO_BOX, MM_CITY, MM_STATE, MM_POSTAL_CODE, MM_IS_FOUND.
Properties for MATCHMERGE OPERATOR MATCH_RULES CHILD CONDITIONS CHILD:
Name: ALGORITHM
Type: STRING
Valid Values: MM_EXACT, MM_STD_EXACT, MM_SOUNDEX, MM_SIMILARITY, MM_STD_SIMILARITY, MM_PARTIAL_NAME, MM_ABBREVIATION, MM_ACRONYM
Default: MM_EXACT
Algorithm of this condition. Possible values are: MM_EXACT, MM_STD_EXACT, MM_SOUNDEX, MM_SIMILARITY, MM_STD_SIMILARITY, MM_PARTIAL_NAME, MM_ABBREVIATION, MM_ACRONYM.
Name: ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
To which attribute does this condition apply?
Name: BLANK_MATCHING
Type: STRING
Valid Values: MM_MATCH_BOTH_BLANK, MM_MATCH_EITHER_BLANK, MM_NO_MATCH_IF_BLANK
Default: MM_MATCH_BOTH_BLANK
How do you want blanks to be handled? Possible values are: MM_MATCH_BOTH_BLANK, MM_MATCH_EITHER_BLANK, MM_NO_MATCH_IF_BLANK.
Name: SIMILARITY_SCORE
Type: NUMBER
Valid Values: N/A
Default: N/A
If this is a similarity condition, what score must the similarity equal or exceed for records to meet the condition?
Properties for MATCHMERGE OPERATOR MATCH_RULES CHILD FIRM_ROLES CHILD:
Name: ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
What is the attribute for this role?
Name: TYPE
Type: STRING
Valid Values: MM_FIRM1, MM_FIRM2
Default: MM_FIRM1
What role is this attribute? Possible values are: MM_FIRM1,MM_FIRM2.
Properties for MATCHMERGE OPERATOR MATCH_RULES CHILD PERSON_ROLES CHILD:
Name: ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
What is the attribute for this role.
Name: TYPE
Type: STRING
Valid Values: MM_PRENAME, MM_FIRST_NAME_STD, MM_MIDDLE_NAME_STD, MM_MIDDLE_NAME_2_STD, MM_MIDDLE_NAME_3_STD, MM_LAST_NAME, MM_MATURITY_POST_NAME
Default: MM_PRENAME
What role is this attribute? Possible values are: MM_PRENAME, MM_FIRST_NAME_STD, MM_MIDDLE_NAME_STD, MM_MIDDLE_NAME_2_STD, MM_MIDDLE_NAME_3_STD, MM_LAST_NAME, MM_MATURITY_POST_NAME.
Properties for MATCHMERGE OPERATOR MATCH_RULES CHILD WEIGHTS CHILD:
Name: BLANK_SCORE
Type: NUMBER
Valid Values: N/A
Default: N/A
Score if either attribute is blank
Name: WEIGHT_ATTRIBUTE
Type: STRING
Valid Values: N/A
Default: N/A
Attribute
Name: WEIGHT_SCORE
Type: NUMBER
Valid Values: N/A
Default: N/A
Score used for this weight if the attributes in the two match records are identical. Similarity will be used to generate this score.
Properties for MATCHMERGE OPERATOR MERGE_RULES CHILD ATTRIBUTES CHILD:
Name: ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
Record merge rule attribute
Properties for MATCHMERGE OPERATOR MERGE_RULES CHILD RANK_RULES CHILD:
Name: EXPRESSION
Type: STRING
Valid Values: N/A
Default: N/A
Rank expression.
Properties for FLAT_FILE OPERATOR INOUT GROUP:
Name: RECORD_TYPE_VALUES
Type: STRING
Valid Values: N/A
Default: N/A
Record Type Values.
Properties for JOINER OPERATOR INPUT GROUP:
Properties for PIVOT OPERATOR OUTPUT GROUP:
Name: ROW_LOCATOR
Type: STRING
Valid Values: N/A
Default: N/A
An expression indicating which attribute within the output group is the row locator.
Properties for SPLITTER OPERATOR OUTPUT GROUP:
Name: SPLIT_CONDITION
Type: STRING
Valid Values: N/A
Default: N/A
Condition that defines when to perform the attribute maps for the attributes in this group.
Properties for TABLE_FUNCTION OPERATOR INPUT GROUP:
Name: INPUT_PARAMETER_TYPE
Type: STRING
Valid Values: REF_CURSOR, SCALAR
Default: REF_CURSOR
This property specifies whether the input parameter is a scalar or a ref cursor type
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: N/A
The position of the argument in the table function signature corresponding to this parameter group
Properties for TABLE_FUNCTION OPERATOR OUTPUT GROUP:
Name: RETURN_TABLE_OF_SCALAR
Type: BOOLEAN
Valid Values: true, false
Default: false
This property specifies whether the return of the table function is a TABLE of SCALAR or not.
Properties for UNPIVOT OPERATOR INPUT GROUP:
Name: ROW_LOCATOR
Type: STRING
Valid Values: N/A
Default: N/A
An expression indicating which attribute within the input group is the row locator.
Name: ROW_LOCATOR_VALUES
Type: STRING
Valid Values: N/A
Default: NULL, NULL
A comma-separated expressions that gives the possible values of the row locator within a unpivot group.
Properties for ADVANCED_QUEUE OPERATOR INOUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Properties for CUBE OPERATOR INOUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will particiate in the insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will particiate in the update load operation.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will be used to construct the matching criteria between the incoming data and the existing data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will be used to construct the matching criteria between the incoming data and the existing data on the target during the update load operation.
Name: UPDATE_OPERATION
Type: STRING
Valid Values: =, +=, -=, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data and the existing data on the target during the update load operation.
Properties for DIMENSION OPERATOR INOUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will particiate in the insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will particiate in the update load operation.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will be used to construct the matching criteria between the incoming data and the existing data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will be used to construct the matching criteria between the incoming data and the existing data on the target during the update load operation.
Name: UPDATE_OPERATION
Type: STRING
Valid Values: =, +=, -=, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data and the existing data on the target during the update load operation.
Properties for EXTERNAL_TABLE OPERATOR INOUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Properties for INPUT_PARAMETER OPERATOR OUTPUT GROUP ATTRIBUTE:
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: N/A
The default value applies when the map is not given a value for this attribute. The value can be specified only by the calling program.
Properties for KEY_LOOKUP OPERATOR OUTPUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: N/A
The default value used for this attribute if no key lookup table row exists for a given input row.
Properties for MATCHMERGE OPERATOR OUTPUT GROUP ATTRIBUTE:
Name: MERGE_ATTR
Type: STRING
Valid Values: N/A
Default: N/A
Related merge attribute
Properties for MATERIALIZED_VIEW OPERATOR INOUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will particiate in the insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will particiate in the update load operation.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will be used to construct the matching criteria between the incoming data and the existing data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will be used to construct the matching criteria between the incoming data and the existing data on the target during the update load operation.
Name: UPDATE_OPERATION
Type: STRING
Valid Values: =, +=, -=, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data and the existing data on the target during the update load operation.
Properties for NAME_AND_ADDRESS OPERATOR INPUT GROUP ATTRIBUTE:
Name: INPUT_ROLE
Type: STRING
Valid Values: NA_NONE, NA_FIRSTNAME, NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_LASTNAME, NA_FIRSTPARTNAME, NA_LASTPARTNAME, NA_PRENAME, NA_POSTNAME, NA_PERSON, NA_PERSON2, NA_PERSON3, NA_FIRMNAME, NA_PRIMARYADDRESS, NA_SECONDARYADDRESS, NA_ADDRESS, NA_ADDRESS2, NA_NEIGHBORHOOD, NA_LASTLINE, NA_CITY, NA_STATE, NA_POSTALCODE, NA_COUNTRYNAME, NA_COUNTRYCODE, NA_LINE1, NA_LINE2, NA_LINE3, NA_LINE4, NA_LINE5, NA_LINE6, NA_LINE7, NA_LINE8, NA_LINE9, NA_LINE10
Default: NA_NONE
Assigns a name-address input role to the selected input attribute
Properties for NAME_AND_ADDRESS OPERATOR OUTPUT GROUP ATTRIBUTE:
Name: ADDRESS_TYPE
Type: STRING
Valid Values: NA_ADDRTYPE_NORMAL, NA_ADDRTYPE_DUAL
Default: NA_ADDRTYPE_NORMAL
You can designate an address type as Normal or Dual. For example, a dual address occurs when a record contains both a street address and a P.O. Box; this is common with business data. A normal address contains only one type of address.
Name: INSTANCE
Type: STRING
Valid Values: NA_INSTANCE_FIRST, NA_INSTANCE_SECOND, NA_INSTANCE_THIRD, NA_INSTANCE_FOURTH, NA_INSTANCE_FIFTH, NA_INSTANCE_SIXTH
Default: NA_INSTANCE_FIRST
The instance option is used when an address contains multiple names, you can specify which name in the group should be used. In addition, you can use this option to assign an address type to a miscellaneous address component.
Name: OUTPUT_COMPONENT
Type: STRING
Valid Values: NA_NONE, NA_PRENAME, NA_FIRSTNAMESTD, NA_MIDDLENAMESTD, NA_MIDDLENAME2STD, NA_MIDDLENAME3STD, NA_POSTNAME, NA_OTHERPOSTNAME, NA_NAMEDESIGNATOR, NA_RELATIONSHIP, NA_PERSON, NA_FIRSTNAME, NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_LASTNAME, NA_GENDER, NA_PERSONCOUNT, NA_FIRMNAME, NA_FIRMCOUNT, NA_ADDRESS, NA_PRIMARYADDRESS, NA_STREETNUMBER, NA_PREDIRECTIONAL, NA_STREETNAME, NA_STREETTYPE, NA_POSTDIRECTIONAL, NA_SECONDARYADDRESS, NA_UNITDESIGNATOR, NA_UNITNUMBER, NA_BOXNAME, NA_BOXNUMBER, NA_ROUTENAME, NA_ROUTENUMBER, NA_BUILDINGNAME, NA_COMPLEX, NA_MISCADDRESS, NA_LASTLINE, NA_NEIGHBORHOOD, NA_CITY, NA_STATE, NA_POSTALCODE, NA_POSTALCODEFORMATTED, NA_DELIVERYPOINT, NA_COUNTRYCODE, NA_COUNTRYCODE3, NA_COUNTRYNAME, NA_ISGOODGROUP, NA_ISPARSED, NA_PARSESTATUS, NA_PARSESTATUSDESC, NA_ISGOODNAME, NA_NAMEWARNING, NA_ISGOODADDRESS, NA_ISFOUND, NA_CITYMATCH, NA_STREETNAMEMATCH, NA_STREETNUMBERMATCH, NA_STREETCOMPMATCH, NA_NONAMBIGUOUSMATCH, NA_CITYWARNING, NA_STREETWARNING, NA_ISADDRESSVERIFIABLE, NA_ADDRESSCORRECTED, NA_POSTALCODECORRECTED, NA_CITYCORRECTED, NA_STREETCORRECTED, NA_STREETCOMPCORRECTED, NA_ADDRESSTYPE, NA_PARSINGCOUNTRY, NA_INSTALLATIONTYPE, NA_INSTALLATIONNAME, NA_DELIVERYOFFICECODE, NA_DELIVERYBEATCODE, NA_ADDRESS2, NA_LOCALITYCODE, NA_LOCALITYNAME, NA_COUNTYNAME, NA_ZIP5, NA_ZIP4, NA_URBANIZATIONNAME, NA_LACS, NA_CART, NA_CHECKDIGIT, NA_MSA, NA_MCD, NA_LATITUDE, NA_LONGITUDE, NA_FIPSCOUNTY, NA_FIPS, NA_CENSUSID
Default: NA_NONE
Assigns a Name and Address output component to the selected output attribute.
Properties for PIVOT OPERATOR INPUT GROUP ATTRIBUTE:
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this input attribute is a part of the pivot group key.
Properties for PIVOT OPERATOR OUTPUT GROUP ATTRIBUTE:
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this output attribute is a part of the pivot group key, which obtains its value from its corresponding input attribute.
Name: PIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: N/A
A comma-separated expression that gives the input attribute to be used for each output row in the pivot group.
Properties for POSTMAPPING_PROCESS OPERATOR INPUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: N/A
The Default Value for the function input parameter
Name: IS_OPTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: N/A
If true, the input is not required to be connected
Properties for POSTMAPPING_PROCESS OPERATOR OUTPUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: FUNCTION_RETURN
Type: BOOLEAN
Valid Values: true, false
Default: N/A
Specifies whether this output is the return value of this function
Properties for PREMAPPING_PROCESS OPERATOR INPUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: N/A
The Default Value for the function input parameter
Name: IS_OPTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: N/A
If true, the input is not required to be connected
Properties for PREMAPPING_PROCESS OPERATOR OUTPUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: FUNCTION_RETURN
Type: BOOLEAN
Valid Values: true, false
Default: N/A
Specifies whether this output is the return value of this function
Properties for TABLE OPERATOR INOUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will particiate in the insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will particiate in the update load operation.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will be used to construct the matching criteria between the incoming data and the existing data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will be used to construct the matching criteria between the incoming data and the existing data on the target during the update load operation.
Name: UPDATE_OPERATION
Type: STRING
Valid Values: =, +=, -=, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data and the existing data on the target during the update load operation.
Properties for TABLE_FUNCTION OPERATOR INPUT GROUP ATTRIBUTE:
Name: PARAMETER_POSITION
Type: NUMBER
Valid Values: N/A
Default: N/A
The position of the argument in the table function signature corresponding to this parmater
Properties for TABLE_FUNCTION OPERATOR OUTPUT GROUP ATTRIBUTE:
Name: TYPE_ATTRIBUTE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name of the field of the PLS Record or attribute of the Object Type or column of the ROWTYPE that corresponds to this attribute. This property is not applicable if the return type is TABLE of SCALAR.
Properties for TRANSFORMATION OPERATOR INPUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: N/A
The Default Value for the function input parameter
Name: IS_OPTIONAL
Type: BOOLEAN
Valid Values: true, false
Default: N/A
If true, the input is not required to be connected
Properties for TRANSFORMATION OPERATOR OUTPUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: FUNCTION_RETURN
Type: BOOLEAN
Valid Values: true, false
Default: N/A
Specifies whether this output is the return value of this function
Properties for TRANSFORMATION OPERATOR INOUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Properties for UNPIVOT OPERATOR INPUT GROUP ATTRIBUTE:
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this input attribute is a part of the unpivot group key.
Properties for UNPIVOT OPERATOR OUTPUT GROUP ATTRIBUTE:
Name: GROUP_KEY
Type: BOOLEAN
Valid Values: true, false
Default: false
A boolean value to indicate whether this output attribute is a part of the unpivot group key, which obtains its value from its corresponding input attribute.
Name: MATCHING_ROW
Type: NUMBER
Valid Values: 1 - 1000
Default: 1
An positive integer to indicate from which row within the unpivot group this output attribute obtains its data.
Name: UNPIVOT_EXPRESSION
Type: STRING
Valid Values: N/A
Default: NULL
An expression that gives the input attribute to be used as the output of this attribute.
Properties for VIEW OPERATOR INOUT GROUP ATTRIBUTE:
Name: BOUND_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The name to be used by the code generator to identify this item. By default it is the same physical name as the item.
Name: LOAD_COLUMN_WHEN_INSERTING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will particiate in the insert load operation.
Name: LOAD_COLUMN_WHEN_UPDATING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will particiate in the update load operation.
Name: MATCH_COLUMN_WHEN_DELETING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will be used to construct the matching criteria between the incoming data and the existing data on the target during the delete load operation.
Name: MATCH_COLUMN_WHEN_UPDATING_ROW
Type: STRING
Valid Values: YES, NO
Default: YES
A boolean value to indicate whether this attribute will be used to construct the matching criteria between the incoming data and the existing data on the target during the update load operation.
Name: UPDATE_OPERATION
Type: STRING
Valid Values: =, +=, -=, =-, =||, ||=
Default: =
The computation to be performed on this attribute between the incoming data and the existing data on the target during the update load operation.
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 map, mapping operator, mapping group or mapping attribute.
operatorName
Name of a mapping operator.
groupDirection
Direction of a mapping group.
groupLocator
Location of a mapping group.
getGroupDetailClause
Get the desired detail of a mapping group.
groupBottomUpLocator
Location of a mapping group.
attributeBottomUpLocator
Location of a mapping attribute.
groupName
Name of a mapping group.
attributeLocator
Location of a mapping attribute.
getAttributeDetailClause
Get the desired detail of a mapping attribute.
attributeName
Name of a mapping attribute.
OMBRETRIEVE MAPPING 'MAP1' GET OPERATORS
OMBRETRIEVE MAPPING 'MAP1' OPERATOR 'SRC1' ATTRIBUTE_GROUP 'INOUTGRP1'
GET ATTRIBUTE CONNECTED TO OPERATOR 'target1'
OMBRETRIEVE MAPPING 'MAP1' OPERATOR 'SRC1' GET PROPERTIES (BUSINESS_NAME, DESCRIPTION)
OMBRETRIEVE, OMBCREATE MAPPING, OMBALTER MAPPING, OMBDROP MAPPING
OMBRETRIEVE MATERIALIZED_VIEW - To retrieve properties of a materialized view.
In the context of an Oracle Module
Syntax Diagrams
retrieveMaterializedViewCommand = OMBRETRIEVE MATERIALIZED_VIEW "QUOTED_STRING" ( "retrieveMaterializedViewClause" | "retrieveColumnClause" | "retrieveUkPkClause" | "retrieveFkClause" | "retrieveCheckConstraintClause" | "retrieveIndexConfigurationClause" | "retrievePartitionConfigurationClause" | "retrievePartitionKeyConfigurationClause" );retrieveMaterializedViewClause = GET ( "getPropertiesClause" | "getTableSCOClause" );retrieveColumnClause = COLUMN "QUOTED_STRING" GET "getPropertiesClause";retrieveUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" GET ( "getPropertiesClause" | COLUMNS );retrieveFkClause = FOREIGN_KEY "QUOTED_STRING" GET ( "getPropertiesClause" | COLUMNS | UNIQUE_KEY | PRIMARY_KEY );retrieveCheckConstraintClause = CHECK_CONSTRAINT "QUOTED_STRING" GET "getPropertiesClause";retrieveIndexConfigurationClause = INDEX "QUOTED_STRING" ( GET ( "getConfigurationPropertiesClause" | INDEX_COLUMNS ) | ( INDEX_COLUMN "QUOTED_STRING" GET "getConfigurationPropertiesClause" ) );retrievePartitionConfigurationClause = PARTITION "QUOTED_STRING" GET "getConfigurationPropertiesClause";retrievePartitionKeyConfigurationClause = PARTITION_KEY "QUOTED_STRING" GET "getConfigurationPropertiesClause";getPropertiesClause = PROPERTIES "(" "propertyNameList" ")";getTableSCOClause = COLUMNS | UNIQUE_KEYS | PRIMARY_KEY | FOREIGN_KEYS | CHECK_CONSTRAINTS | COLUMN AT POSITION "INTEGER_LITERAL" | INDEXES | PARTITIONS | PARTITION_KEYS;getConfigurationPropertiesClause = PROPERTIES "(" "propertyNameList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveMaterializedViewCommand
This clause retrieves a materialized view.
QUOTED_STRING
name of the materialized view.
retrieveMaterializedViewClause
This clause retrieves a properties of a materialized view.
retrieveColumnClause
This clause will retrieve columns
QUOTED_STRING
Name of the column
retrieveUkPkClause
This will get the unique key or primary key clause.
retrieveFkClause
Name of the foreign key
retrieveCheckConstraintClause
This clause gets the check constraint
QUOTED_STRING
name of the check constraint.
retrieveIndexConfigurationClause
Gets the index in this clause.
QUOTED_STRING
Name of the index.
retrievePartitionConfigurationClause
Gets the partition.
QUOTED_STRING
The partition name.
retrievePartitionKeyConfigurationClause
This clause gets the partition key.
QUOTED_STRING
The name of the partition key.
getPropertiesClause
This clause retrieves all the properties.
Basic properties for VIEW, MATERIALIZED_VIEW:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the View, MaterializedView
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the View, MaterializedView
Name: VIEW_QUERY
Type: STRING(4000)
Valid Values: N/A
Default: ''
Sets the query definition in View and MaterializedView.
Name: UOID
Type: STRING
Valid Values: N/A
Default: N/A
Basic properties for INDEX, PARTITION, PARTITION_KEY, INDEX_COLUMN:
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Index, Partition, PartitionKey, IndexColumn in a MaterializedView.
Properties for MATERIALIZED_VIEW:
Name: BASE_TABLES
Type: STRING
Valid Values: N/A
Default: ''
Comma separated list of base tables.
Name: BUILD
Type: STRING
Valid Values: DEFERRED, IMMEDIATE
Default: IMMEDIATE
Immediate : populates the view when it is created. Deferred : delays population until the next refresh operation.
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: HASH_PARTITION_TABLESPACE_LIST
Type: STRING
Valid Values: N/A
Default: ''
A comma separated list of tablespaces to use for [sub]partition storage.
Name: HASH_SUBPARTITION_NUMBER
Type: NUMBER
Valid Values: 2 - 63999
Default: 2
Hash SubPartition Number
Name: LOGGING_MODE
Type: STRING
Valid Values: NOLOGGING, LOGGING
Default: LOGGING
Recovery requirements for a data warehouse : Logging or not logging to Redo Log File.
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: NOPARALLEL, PARALLEL
Default: PARALLEL
Enables or disables parallel processing when the table is created. Also enables or disables parallel processing or access.
Name: QUERY_REWRITE
Type: STRING
Valid Values: DISABLE, ENABLE
Default: ENABLE
Enable marks the View eligible for query rewrite and disable marks the View ineligible for query rewrite
Name: REFRESH
Type: STRING
Valid Values: COMPLETE, FAST, ON_COMMIT, ON_DEMAND, FORCE
Default: COMPLETE
Complete : specifies the complete refresh method implemented by executing the query of the view. Fast : specifies the incremental refresh method which refreshes the view according to changes that have occurred to the master tables. Force : specifies that when a refresh occurs, Oracle performs a fast refresh if possible or a complete refresh otherwise.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Properties for UNIQUE_KEY:
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: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Properties for FOREIGN_KEY:
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: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Properties for CHECK_CONSTRAINT:
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: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Properties for INDEX:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true
Name: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: INDEX_TYPE
Type: STRING
Valid Values: BITMAP, UNIQUE, NO_INDEX
Default: UNIQUE
The types of Indexes created on Dimension are BITMAP, UNIQUE or a non-specific index.
Name: LOCAL_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
A local index is constructed so that it reflects the structure of the underlying table. It is equipartitioned with the underlying table, meaning that it is partitioned on the same columns as the underlying table, creates the same number of partitions or subpartitions, and gives them the same partition bounds as corresponding partitions of the underlying table.
Name: LOGGING_MODE
Type: STRING
Valid Values: NOLOGGING, LOGGING
Default: LOGGING
Recovery requirements for a data warehouse : Logging or not logging to Redo Log File.
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: NOPARALLEL, PARALLEL
Default: PARALLEL
Enables or disables parallel processing when the table is created. Also enables or disables parallel processing or access.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Properties for PARTITION:
Name: DATE_LESS_THAN
Type: STRING
Valid Values: N/A
Default: TO_DATE('01-JAN-1999', 'DD-MON-YYYY')
Value that represents upper bound of partition stored in warehouse key column for the Days Dimension.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: EMPTY_STRING
Use the Tablespace parameter to specify the name of tablespace.
Name: VALUES_LESS_THAN
Type: STRING
Valid Values: N/A
Default: TO_DATE('01-JAN-1999', 'DD-MON-YYYY')
Noninclusive upper bound for the current partition. Type a comma separated list in the same order as the columns in range partitioned key.
Name: VALUE_LESS_THAN
Type: STRING
Valid Values: N/A
Default: ''
Noninclusive upper bound for the current partition. Type a comma separated list in the same order as the columns in range partitioned key.
Properties for PARTITION_KEY:
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: TYPE
Type: STRING
Valid Values: HASH, RANGE
Default: RANGE
Oracle partitions the storage space and stores rows according to a Hash Algorithm or specified ranges.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getTableSCOClause
This clause retrieves components like columns, indexes etc. of a table.
getConfigurationPropertiesClause
This clauses gets the configuration properties of the object.
propertyNameList
The list of properties.
OMBRETRIEVE MATERIALIZED_VIEW 'NEW_MATERIALZED_VIEW' GET PROPERTIES (DESCRIPTION, BUSINESS_NAME) This will retrieve its description and business name.
OMBRETRIEVE
OMBRETRIEVE OBJECT_TYPE - Retrieve details of the Object Type.
Should be in the context of an Oracle Module.
Syntax Diagrams
retrieveObjectTypeCommand = OMBRETRIEVE OBJECT_TYPE "QUOTED_STRING" ( "retrieveObjectTypeClause" | "retrieveAttributeClause" );retrieveObjectTypeClause = GET ( "getPropertiesClause" | "getAttributesClause" );retrieveAttributeClause = OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING" GET "getPropertiesClause";getPropertiesClause = PROPERTIES "(" "propertyNameList" ")";getAttributesClause = OBJECT_TYPE_ATTRIBUTES;propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveObjectTypeCommand
Retrieves the details of the Object Type with the given name.
retrieveObjectTypeClause
Gets the properties or the Attribute names.
retrieveAttributeClause
Gets the properties of the Attribute with the given name.
getPropertiesClause
This clause retrieves all the properties.
Basic properties for OBJECT_TYPE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Object Type
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Object Type
Basic properties for OBJECT_TYPE_ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Attribute
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Attribute
Name: DATATYPE
Type: STRING(20)
Valid Values: NUMBER, VARCHAR2, VARCHAR, DATE, FLOAT
Default: ''
Datatype of the Attribute
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getAttributesClause
Gets the names of all the Attributes of the Object Type with the given name.
propertyNameList
The list of properties.
OMBRETRIEVE OBJECT_TYPE 'SOME_OBJECT_TYPE' OBJECT_TYPE_ATTRIBUTE 'ATTR1' GET PROPERTIES (DATATYPE) This will retrieve the Object Type "SOME_OBJECT_TYPE"'s attribute "ATTR1"'s datatype.
OMBRETRIEVE, OMBALTER OBJECT_TYPE, OMBCREATE OBJECT_TYPE, OMBDROP OBJECT_TYPE
OMBRETRIEVE ORACLE_MODULE - Retrieve details of the Oracle module.
Should be in the context of project.
Syntax Diagrams
retrieveOracleModuleCommand = OMBRETRIEVE ORACLE_MODULE "QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause" );getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";getReferenceLocationClause = GET ( REF | REFERENCE ) LOCATION;propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveOracleModuleCommand
This command retrieves the details of an Oracle Module
QUOTED_STRING
Name of the existing Oracle module or path to the Oracle module.
getPropertiesClause
Retrieve a set of properties that is associated with an Oracle Module.
Properties for ORACLE_MODULE:
Name: ABAP_DIRECTORY
Type: STRING
Valid Values: N/A
Default: abap\
Location where ABAP scripts are stored
Name: ABAP_EXTENSION
Type: STRING
Valid Values: N/A
Default: .abap
File name extension for ABAP scripts
Name: ABAP_RUN_PARAMETER_FILE
Type: STRING
Valid Values: N/A
Default: _run.ini
Run Parameter File Suffix for the parameter script in a ABAP job.
Name: ABAP_SPOOL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: abap\log\
Location where ABAP scripts are buffered during script generation processing.
Name: APPLICATION_SHORT_NAME
Type: STRING
Valid Values: N/A
Default: WB
Application Short Name
Name: ARCHIVE_DIRECTORY
Type: STRING
Valid Values: N/A
Default: archive\
Archive Directory
Name: CONNECT_STRING
Type: STRING
Valid Values: N/A
Default: ''
A Net*8 style connection string to the remote database. Alternatively, you can specify machine, port, service name of the remote database.
Name: DDL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: ddl\
Location where scripts for database objects for the target schema are stored.
Name: DDL_EXTENSION
Type: STRING
Valid Values: N/A
Default: .ddl
File name extension for DDL scripts.
Name: DDL_SPOOL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: ddl\log\
Location where DDL scripts are buffered during script generation processing.
Name: DEFAULT_INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Default name of tablespace to install indexes into.
Name: DEFAULT_OBJECT_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Default name of tablespace to install objects into.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true
Name: END_OF_LINE
Type: STRING
Valid Values: N/A
Default: \r\n
End of Line
Name: INPUT_DIRECTORY
Type: STRING
Valid Values: N/A
Default: input\
Input Directory
Name: INVALID_DIRECTORY
Type: STRING
Valid Values: N/A
Default: invalid\
Directory for SQL*Loader errors and rejected records
Name: LIB_DIRECTORY
Type: STRING
Valid Values: N/A
Default: lib\
LIB Directory
Name: LIB_EXTENSION
Type: STRING
Valid Values: N/A
Default: .lib
LIB Extension
Name: LIB_SPOOL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: lib\log\
LIB Spool Directory
Name: LOADER_DIRECTORY
Type: STRING
Valid Values: N/A
Default: ctl\
Location where control files are stored.
Name: LOADER_EXTENSION
Type: STRING
Valid Values: N/A
Default: .ctl
Suffix for the loader scripts
Name: LOADER_RUN_PARAMETER_FILE
Type: STRING
Valid Values: N/A
Default: _run.ini
Suffix for the parameter initialization file.
Name: LOG_DIRECTORY
Type: STRING
Valid Values: N/A
Default: log\
Log Directory for the SQL*Loader
Name: MAIN_APPLICATION_SHORT_NAME
Type: STRING
Valid Values: N/A
Default: ora
Main Application Short Name
Name: PLSQL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: pls\
Location where PL/SQL scripts are stored.
Name: PLSQL_EXTENSION
Type: STRING
Valid Values: N/A
Default: .pls
File name extension for PL/SQL scripts.
Name: PLSQL_GENERATION_MODE
Type: STRING
Valid Values: Oracle9i, Oracle8i
Default: Oracle9i
Generation mode controls validation and generation for version specific features.
Name: PLSQL_RUN_PARAMETER_FILE
Type: STRING
Valid Values: N/A
Default: _run.ini
Suffix for the parameter script in a PL/SQL job.
Name: PLSQL_SPOOL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: pls\log\
Location where PL/SQL scripts are buffered during script generation processing.
Name: PORT
Type: STRING
Valid Values: N/A
Default: ''
The port number on the machine where the database listens to.
Name: RECEIVE_DIRECTORY
Type: STRING
Valid Values: N/A
Default: receive\
Receive Directory
Name: REMOTE_HOST_NAME
Type: STRING
Valid Values: N/A
Default: ''
The machine where the remote database resides on.
Name: SCHEMA_OWNER
Type: STRING
Valid Values: N/A
Default: OWB
Schema Owner
Name: SERVICE_NAME
Type: STRING
Valid Values: N/A
Default: ''
The service name (global DB name) of the database instance on the remote machine.
Name: SORT_DIRECTORY
Type: STRING
Valid Values: N/A
Default: sort\
Sort Directory
Name: TCL_DIRECTORY
Type: STRING
Valid Values: N/A
Default: tcl\
Location for TCL scripts that are generated after registration with Oracle Enterprise Manager
Name: TOP_DIRECTORY
Type: STRING
Valid Values: N/A
Default: ..\..\codegen\
Top Directory where generated code will get stored
Name: WORK_DIRECTORY
Type: STRING
Valid Values: N/A
Default: work\
Work Directory
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getReferenceLocationClause
Retrieve the location that is set to the Oracle module.
propertyNameList
Comma separated list of property names. Property names are unquoted.
OMBRETRIEVE ORACLE_MODULE 'src_module' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME) This will retrieve the Oracle module "src_module"'s description, uoid, and business name.
OMBRETRIEVE
OMBRETRIEVE PACKAGE - Retrieve details of the Package.
Should be in the context of a Oracle Module or Transformation Module.
Syntax Diagrams
retrievePackageCommand = OMBRETRIEVE PACKAGE "QUOTED_STRING" "getPropertiesClause";getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrievePackageCommand
This command retrieves the details of a Package
QUOTED_STRING
Name of the existing Package or path to the Package.
getPropertiesClause
Used to get properties (core, user-defined) for packages. Valid properties are shown below:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the package
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the package
Name: PACKAGE_SPEC
Type: STRING
Valid Values: N/A
Default: ''
Retrieves the Package Spec of Imported Package
Name: PACKAGE_BODY
Type: STRING
Valid Values: N/A
Default: ''
Retrieves the Package Body of Imported Package
Name: IS_IMPORTED
Type: BOOLEAN
Valid Values: N/A
Default: ''
Retrieves 'true' if the Package is Imported otherwise 'false'
Properties for PACKAGE:
Name: AUTHID
Type: STRING
Valid Values: None, Current_User, Definer
Default: None
Generate the package with selected AUTHID option. Function will be executed with the permissions defined by the AUTHID clause rather than the function owner's permissions.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true
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.
OMBRETRIEVE PACKAGE 'package_1' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME,) This will retrieve the Package "package_1's description, uoid, and business name.
OMBRETRIEVE
OMBRETRIEVE PROCEDURE - Retrieve details of the Procedure.
Should be in the context of a Oracle Module or Package or Transformation Module.
Syntax Diagrams
retrieveProcedureCommand = OMBRETRIEVE PROCEDURE "QUOTED_STRING" ( "getPropertiesClause" | "getFuncProcParameterClause" | "getFuncProcParameterPositionClause" | "getFuncProcSignatureClause" | "retrieveFuncProcParameterClause" );getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";getFuncProcParameterClause = GET PARAMETERS;getFuncProcParameterPositionClause = GET PARAMETER AT POSITION "INTEGER_LITERAL";getFuncProcSignatureClause = GET SIGNATURE;retrieveFuncProcParameterClause = PARAMETER "QUOTED_STRING" "getPropertiesClause";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveProcedureCommand
This command retrieves the details of a Procedure
QUOTED_STRING
Name of the existing Procedure or path to the Procedure.
getPropertiesClause
Used to get properties (core, user-defined) for procedure. Valid properties
are shown below:
Basic properties for PROCEDURE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Procedure
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Procedure
Name: IMPLEMENTATION
Type: STRING
Valid Values: N/A
Default: ''
Set the code for Procedure which is included global variable declaration and code between BEGIN and END.
Basic properties for PARAMETER:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the Parameter
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Parameter
Name: DATATYPE
Type: STRING
Valid Values: PLS_INTEGER, BINARY_INTEGER, BOOLEAN, NUMBER, FLOAT, CHAR, VARCHAR, VARCHAR2, DATE
Default: NUMBER
Set the data type for Parameter
Name: IN_OUT
Type: STRING
Valid Values: IN, OUT, INOUT
Default: 'IN'
Set the parameter mode for Parameter
Name: DEFAULT_VALUE
Type: STRING
Valid Values: N/A
Default: ''
Set the default value for Parameter
Properties for PROCEDURE:
Name: AUTHID
Type: STRING
Valid Values: None, Current_User, Definer
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
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 Procedure
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
propertyNameList
Comma separated list of property names. Property names are unquoted.
OMBRETRIEVE PROCEDURE 'proc' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME, IMPLEMENTATION, IS_IMPORTED)
OMBRETRIEVE
OMBRETRIEVE PROCESS_FLOW - Retrieves the details of the Process Flow.
Should be in the context of a Process Flow Package.
Syntax Diagrams
retrieveProcessFlowCommand = OMBRETRIEVE PROCESS_FLOW "QUOTED_STRING" ( "retrieveProcessFlowClause" | "retrieveActivityClause" | "retrieveTransitionClause" | "retrieveProcessParameterClause" );retrieveProcessFlowClause = "getPropertiesClause" | GET "getProcessFlowSCOClause";retrieveActivityClause = ACTIVITY "QUOTED_STRING" ( "getPropertiesClause" | "getActivityBoundObject" | "getActivityTransitionClause" | "getActivityParameterClause" | "getActivityParameterPropertiesClause" );retrieveTransitionClause = TRANSITION "QUOTED_STRING" ( "getPropertiesClause" | GET "getTransitionActivityClause" );retrieveProcessParameterClause = PARAMETER "QUOTED_STRING" "getPropertiesClause";getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";getProcessFlowSCOClause = ACTIVITIES | AND ACTIVITIES | OR ACTIVITIES | FORK ACTIVITIES | FTP ACTIVITIES | EMAIL ACTIVITIES | FILE_EXISTS ACTIVITIES | START ACTIVITIES | END ACTIVITIES | MAPPING ACTIVITIES | SUBPROCESS ACTIVITIES | TRANSFORMATION ACTIVITIES | USER_DEFINED ACTIVITIES | END_WARNING ACTIVITIES | END_SUCCESS ACTIVITIES | END_ERROR ACTIVITIES | TRANSITIONS | PARAMETERS;getActivityBoundObject = GET ( REFERENCE | REF );getActivityTransitionClause = GET ( INCOMING_TRANSITIONS | OUTGOING_TRANSITIONS );getActivityParameterClause = ( GET PARAMETERS );getActivityParameterPropertiesClause = PARAMETER "QUOTED_STRING" "getPropertiesClause";getTransitionActivityClause = ( SOURCE_ACTIVITY | DESTINATION_ACTIVITY );propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveProcessFlowCommand
Retrieve the details of an existing process flow.
retrieveProcessFlowClause
This clause retrieve the Process Flow.
retrieveActivityClause
This clause retrieves the Activity of a Process Flow.
retrieveTransitionClause
This clause retrieves the Transition of a Process Flow.
retrieveProcessParameterClause
This clause retrieves the Parameter of a Process Flow.
getPropertiesClause
Used to get properties (core, user-defined) for process flow. Valid properties are shown below:
Base properties for Process Flow, Activity, Transition and Parameter:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of a Process Flow
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of a Process Flow
Name: UOID
Type: STRING(40)
Valid Values: N/A
Default: N/A
UOID of a Process Flow
Basic properties for Transition:
Name: TRANSITION_CONDITION
Type: STRING
Valid Values: '', SUCCESS, ERROR, WARNING
Default: '' i.e. Unconditional
Gets the Transition Condition of a Transition Basic properties for Activity Parameter :
Name: DATATYPE
Type: STRING
Valid Values: INTEGER, FLOAT, DATE, STRING, BOOLEAN
Default: STRING
Gets the datatype of a Activity Parameter
Name: DIRECTION
Type: STRING
Valid Values: IN
Default: IN
Gets the direction of a Activity Parameter
Name: VALUE
Type: STRING
Valid Values:
'123', '123.456', 'Jan-08-2003', 'I am String', 'true'
Default: ''
Gets the value of a Activity Parameter
Name: BINDING
Type: STRING
Valid Values:
'PROCESS_PARAM1', 'PROCESS_PARAM2'
Default: ''
Get the name of the process parameter that this parameter is bound to, empty if not bound.
getProcessFlowSCOClause
For the current process flow, retrieve all activities or only activities of
a specific type.
getActivityBoundObject
Retrieve the name of the object that the current activity refers to, pertinent to only MAPPING, SUBPROCESS and TRANSFORMATION activities.
getActivityTransitionClause
This clause retrieves all Activities of a Process Flow.
getActivityParameterClause
Retrieve the activity parameters for the current activity.
getActivityParameterPropertiesClause
Retrieve the details of an activity parameter.
getTransitionActivityClause
This clause retrieves all Transitions of a Process Flow.
propertyNameList
A comma delimited set of property names to set.
OMBRETRIEVE PROCESS_FLOW 'process_flow' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME) GET ACTIVITIES This will retrieve the Process Flow "process_flow"'s description, uoid, and business name, and gets all activities of the process flow.
OMBRETRIEVE
OMBRETRIEVE PROCESS_FLOW_MODULE - Retrieve details of the Process Flow Module.
Should be in the context of a project.
Syntax Diagrams
retrieveProcessFlowModuleCommand = OMBRETRIEVE PROCESS_FLOW_MODULE "QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause" );getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";getReferenceLocationClause = GET ( REF | REFERENCE ) LOCATION;propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveProcessFlowModuleCommand
Retrieve the details of an existing process flow module.
getPropertiesClause
Used to get properties (core, user-defined) for process flow module.
Base properties for PROCESS_FLOW_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of a Process Flow Module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of a Process Flow Module
Name: UOID
Type: STRING(40)
Valid Values: N/A
Default: N/A
UOID of a Process Flow Module
getReferenceLocationClause
Retrieve the name of the Workflow engine location referenced by this process flow module.
propertyNameList
Comma separated list of property names. Property names are not in quotation marks.
OMBRETRIEVE PROCESS_FLOW_MODULE 'process_module' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME) This will retrieve the Process Flow Module "process_module"'s description, uoid, and business name.
OMBRETRIEVE
OMBRETRIEVE PROCESS_FLOW_PACKAGE - Retrieve details of the Process Flow Package.
Should be in the context of a Process Flow Module.
Syntax Diagrams
retrieveProcessFlowPackageCommand = OMBRETRIEVE PROCESS_FLOW_PACKAGE "QUOTED_STRING" "getPropertiesClause";getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveProcessFlowPackageCommand
Retrieve the details of an existing process flow package.
getPropertiesClause
Used to get properties (core, user-defined) for process flow packages. Valid properties are shown below:
Basic properties for PROCESS_FLOW_PACKAGE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of a Process Flow Package
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of a Process Flow Package
Name: UOID
Type: STRING(40)
Valid Values: N/A
Default: N/A
UOID of a Process Flow Package
propertyNameList
A comma delimited set of property names to set.
OMBRETRIEVE PROCESS_FLOW_PACKAGE 'process_package' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME) This will retrieve the Process Flow Package "process_package"'s description, uoid, and business name.
OMBRETRIEVE
OMBRETRIEVE PROJECT - Retrieve details of the project.
Should be in the top level context.
Syntax Diagrams
retrieveProjectCommand = OMBRETRIEVE PROJECT "QUOTED_STRING" "getPropertiesClause";getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveProjectCommand
Retrieve the details of a Project
QUOTED_STRING
Name of the existing project or path to the project.
getPropertiesClause
Retrieve a set of properties that is associated with a Project.
propertyNameList
Comma separated list of property names. Property names are unquoted.
OMBRETRIEVE PROJECT 'New Project' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME) This will retrieve the project "New Project"'s description, uoid, and business name.
OMBRETRIEVE
OMBRETRIEVE RUNTIME_REPOSITORY_CONNECTION - Retrieve details from a runtime
repository connection.
Should be in the context of a project.
Syntax Diagrams
retrieveRuntimeRepositoryCommand = OMBRETRIEVE RUNTIME_REPOSITORY_CONNECTION "QUOTED_STRING" "getPropertiesClause";getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveRuntimeRepositoryCommand
Retrieve details from a runtime repository connection.
getPropertiesClause
Get the specified properties of the runtime repository connection.
propertyNameList
The names of the properties whose values you want to retrieve.
Properties for RUNTIME_REPOSITORY_CONNECTION:
Name: HOST
Type: STRING
Valid Values: N/A
Default: N/A
The host machine the runtime repository is installed on.
Name: PORT
Type: NUMBER
Valid Values: 0 - 65535
Default: N/A
The port number of the database in which the runtime repository is installed.
Name: SERVICE_NAME
Type: STRING
Valid Values: N/A
Default: N/A
The service name of the database in which the runtime repository is installed.
Name: CONNECT_AS_USER
Type: STRING
Valid Values: N/A
Default: N/A
The name of the database user you wish to connect to the runtime repository as.
Name: RUNTIME_REPOSITORY_OWNER
Type: STRING
Valid Values: N/A
Default: N/A
The name of the schema in which the runtime repository is installed.
All of the preceding properties are mandatory for OMBCREATE RUNTIME_REPOSITORY_CONNECTION.
Basic properties for RUNTIME_REPOSITORY_CONNECTION:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the runtime repository connection.
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the runtime repository connection.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
OMBRETRIEVE RUNTIME_REPOSITORY_CONNECTION 'MY_CONNECTION' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME) This will retrieve the runtime repository connection "MY_CONNECTION"'s description, uoid, and business name.
OMBRETRIEVE
OMBRETRIEVE SAP_MODULE - Retrieve details of the SAP module.
You must open a project to retrieve a SAP module.
Syntax Diagrams
retrieveSAPModuleCommand = OMBRETRIEVE SAP_MODULE "QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause" );getPropertiesClause = GET PROPERTIES "(" "propertyNameList" ")";getReferenceLocationClause = GET ( REF | REFERENCE ) LOCATION;propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveSAPModuleCommand
Retrieve the details of an SAP Module
getPropertiesClause
Retrieve a set of properties that is associated with an SAP Module.
Base properties for SAP_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: NAME
Business name of a SAP Module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of an SAP Module
Name: UOID
Type: STRING(40)
Valid Values: N/A
Default: N/A
UOID of an SAP Module
getReferenceLocationClause
Retrieve the name of the SAP location referenced by this SAP module.
propertyNameList
Comma separated list of property names. Property names are unquoted.
OMBRETRIEVE SAP_MODULE 'src_module' GET PROPERTIES (DESCRIPTION, UOID, BUSINESS_NAME) This will retrieve the SAP module "src_module"'s description, uoid, and business name.
OMBRETRIEVE
OMBRETRIEVE SEQUENCE - To retrieve properties of a sequence.
In the context of an Oracle Module
Syntax Diagrams
retrieveSequenceCommand = OMBRETRIEVE SEQUENCE "QUOTED_STRING" ( GET "getPropertiesClause" | "retrieveColumnClause" );getPropertiesClause = PROPERTIES "(" "propertyNameList" ")";retrieveColumnClause = COLUMN "QUOTED_STRING" GET "getPropertiesClause";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveSequenceCommand
This clause retrieves properties of a sequence.
getPropertiesClause
This clause retrieves all the properties.
Basic properties for SEQUENCE:
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the sequence.
Name: CURRVAL
Type: NUMBER
Valid Values: N/A
Default: 1
current increment value.
Name: NEXTVAL
Type: NUMBER
Valid Values: N/A
Default: 1
next increment value. next increment value.
Properties for SEQUENCE:
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: INCREMENT_BY
Type: NUMBER
Valid Values: -2147483648 - 2147483647
Default: 1
Sequence Incremented By
Name: START_WITH
Type: NUMBER
Valid Values: -2147483648 - 2147483647
Default: 1
Sequence Starts With
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
retrieveColumnClause
This clause will retrieve columns
QUOTED_STRING
Name of the column
propertyNameList
The list of properties.
OMBRETRIEVE SEQUENCE 'NEW_SEQUENCE' GET PROPERTIES (DESCRIPTION) This will retrieve its description.
OMBRETRIEVE
OMBRETRIEVE SNAPSHOT - Since the snapshot may contain many components, this
command lets the user view all the contents in a snapshot.
Snapshot contents can be retrieved from any context.
Syntax Diagrams
parseRetrieveCommand = OMBRETRIEVE "retrieveSnapshotCommand";retrieveSnapshotCommand = ( SNAPSHOT "QUOTED_STRING" [ GET "getPropertiesClause" ] );getPropertiesClause = PROPERTIES "(" "propertyNameList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
parseRetrieveCommand
Root production of OMBRETRIEVE SNAPSHOT.
retrieveSnapshotCommand
To view contents of snapshot.
QUOTED_STRING
Name of snapshot whose contents are to be retrieved.
getPropertiesClause
Gets the property of snapshot which are DESCRIPTION, TYPE.
Basic properties for SNAPSHOT:
Name: TYPE
Type: STRING(200)
Valid Values: FULL,SIGNATURE
Default: FULL
This is the type of snapshot
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the snapshot
PROPERTIES
Valid set of properties are DESCRIPTION and TYPE.
propertyNameList
Property names for SNAPSHOT that can be retrieved.
OMBRETRIEVE SNAPSHOT 'S1'
This command gets all the contents of snapshot.
OMBRETRIEVE SNAPSHOT 'S1' GET PROPERTIES(DESCRIPTION,TIMESTAMP,TYPE)
This command gets the properties DESCRIPTION,TIMESTAMP, and TYPE of snapshot S1.
OMBCREATE SNAPSHOT, OMBALTER SNAPSHOT, OMBDROP SNAPSHOT, OMBRESTORE SNAPSHOT, OMBCOMPARE SNAPSHOT, OMBLIST SNAPSHOT
OMBRETRIEVE TABLE - To retrieve properties of a table.
In the context of an Oracle Module
Syntax Diagrams
retrieveTableCommand = OMBRETRIEVE TABLE "QUOTED_STRING" ( "retrieveTableClause" | "retrieveColumnClause" | "retrieveUkPkClause" | "retrieveFkClause" | "retrieveCheckConstraintClause" | "retrievePartitionConfigurationClause" | "retrievePartitionKeyConfigurationClause" | "retrieveIndexConfigurationClause" );retrieveTableClause = GET ( "getPropertiesClause" | "getTableSCOClause" );retrieveColumnClause = COLUMN "QUOTED_STRING" GET "getPropertiesClause";retrieveUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" GET ( "getPropertiesClause" | COLUMNS );retrieveFkClause = FOREIGN_KEY "QUOTED_STRING" GET ( "getPropertiesClause" | COLUMNS | UNIQUE_KEY | PRIMARY_KEY );retrieveCheckConstraintClause = CHECK_CONSTRAINT "QUOTED_STRING" GET "getPropertiesClause";retrievePartitionConfigurationClause = PARTITION "QUOTED_STRING" GET "getConfigurationPropertiesClause";retrievePartitionKeyConfigurationClause = PARTITION_KEY "QUOTED_STRING" GET "getConfigurationPropertiesClause";retrieveIndexConfigurationClause = INDEX "QUOTED_STRING" ( GET ( "getConfigurationPropertiesClause" | INDEX_COLUMNS ) | ( INDEX_COLUMN "QUOTED_STRING" GET "getConfigurationPropertiesClause" ) );getPropertiesClause = PROPERTIES "(" "propertyNameList" ")";getTableSCOClause = COLUMNS | UNIQUE_KEYS | PRIMARY_KEY | FOREIGN_KEYS | CHECK_CONSTRAINTS | COLUMN AT POSITION "INTEGER_LITERAL" | INDEXES | PARTITIONS | PARTITION_KEYS;getConfigurationPropertiesClause = PROPERTIES "(" "propertyNameList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveTableCommand
This clause retrieves a table.
QUOTED_STRING
Name of the table.
retrieveTableClause
This clause retrieves a table.
retrieveColumnClause
This clause will retrieve columns
QUOTED_STRING
Name of the column
retrieveUkPkClause
This will get the unique key or primary key clause.
retrieveFkClause
Name of the foreign key
retrieveCheckConstraintClause
This clause gets the check constraint
QUOTED_STRING
name of the check constraint.
retrievePartitionConfigurationClause
Gets the partition.
QUOTED_STRING
The partition name.
retrievePartitionKeyConfigurationClause
This clause gets the partition key.
QUOTED_STRING
The name of the partition key.
retrieveIndexConfigurationClause
Gets the index in this clause.
QUOTED_STRING
Name of the index.
getPropertiesClause
This clause retrieves all the properties.
Basic properties for TABLE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the table
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the table
Name: UOID
Type: STRING
Valid Values: N/A
Default: N/A
Basic properties for COLUMN:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the table
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the table
Name: DATATYPE
Type: STRING
Valid Values: NUMBER, VARCHAR, VARCHAR2, DATE, FLOAT
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 - 39
Default: 1
The precision of a number.
Name: SCALE
Type: NUMBER
Valid Values: -85 - 125
Default: 1
The scale of a number.
Name: UOID
Type: STRING
Valid Values: N/A
Default: N/A
Basic properties for INDEX, PARTITION, PARTITION_KEY, INDEX_COLUMN:
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Index, Partition, PartitionKey, IndexColumn.
Properties for TABLE:
Name: ANALYZE_TABLE_ESTIMATE_PERCENT
Type: NUMBER
Valid Values: 0 - 100
Default: 99
Value represents the sample size as a percentage of total rows. When set to a nonzero value, Builder generates a DDL script to analyze the table.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true
Name: HASH_PARTITION_TABLESPACE_LIST
Type: STRING
Valid Values: N/A
Default: ''
A comma separated list of tablespaces to use for [sub]partition storage.
Name: HASH_SUBPARTITION_NUMBER
Type: NUMBER
Valid Values: 2 - 63999
Default: 2
To create Hash partition, specify the number of Hash subpartition.
Name: LOGGING_MODE
Type: STRING
Valid Values: NOLOGGING, LOGGING
Default: LOGGING
Recovery requirements for a data warehouse : Logging or not logging to Redo Log File.
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: NOPARALLEL, PARALLEL
Default: PARALLEL
Enables or disables parallel processing when the table is created. Also enables or disables parallel processing or access.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Properties for UNIQUE_KEY:
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: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Properties for FOREIGN_KEY:
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: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Properties for CHECK_CONSTRAINT:
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: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Properties for INDEX:
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true
Name: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: INDEX_TYPE
Type: STRING
Valid Values: BITMAP, UNIQUE, NO_INDEX
Default: UNIQUE
The types of Indexes created on Dimension are BITMAP, UNIQUE or a non-specific index.
Name: LOCAL_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
A local index is constructed so that it reflects the structure of the underlying table. It is equipartitioned with the underlying table, meaning that it is partitioned on the same columns as the underlying table, creates the same number of partitions or subpartitions, and gives them the same partition bounds as corresponding partitions of the underlying table.
Name: LOGGING_MODE
Type: STRING
Valid Values: NOLOGGING, LOGGING
Default: LOGGING
Recovery requirements for a data warehouse : Logging or not logging to Redo Log File.
Name: PARALLEL_ACCESS_MODE
Type: STRING
Valid Values: NOPARALLEL, PARALLEL
Default: PARALLEL
Enables or disables parallel processing when the table is created. Also enables or disables parallel processing or access.
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Use the Tablespace parameter to specify the name of tablespace.
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Properties for PARTITION:
Name: DATE_LESS_THAN
Type: STRING
Valid Values: N/A
Default: TO_DATE('01-JAN-1999', 'DD-MON-YYYY')
Value that represents upper bound of partition stored in warehouse key column for the Days Dimension.
Name: DEPLOYABLE
Type: BOOLEAN
Valid Values: true, false
Default: true
Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true
Name: TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: EMPTY_STRING
Use the Tablespace parameter to specify the name of tablespace.
Name: VALUES_LESS_THAN
Type: STRING
Valid Values: N/A
Default: TO_DATE('01-JAN-1999', 'DD-MON-YYYY')
Noninclusive upper bound for the current partition. Type a comma separated list in the same order as the columns in range partitioned key.
Name: VALUE_LESS_THAN
Type: STRING
Valid Values: N/A
Default: ''
Noninclusive upper bound for the current partition. Type a comma separated list in the same order as the columns in range partitioned key.
Properties for PARTITION_KEY:
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: TYPE
Type: STRING
Valid Values: HASH, RANGE
Default: RANGE
Oracle partitions the storage space and stores rows according to a Hash Algorithm or specified ranges.
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getTableSCOClause
This clause retrieves components like columns, indexes etc. of a table.
getConfigurationPropertiesClause
This clauses gets the configuration properties of the object.
propertyNameList
The list of properties.
OMBRETRIEVE TABLE 'NEW_TABLE' GET PROPERTIES (DESCRIPTION, BUSINESS_NAME) GET COLUMNS This will retrieve its description and business name, and get columns.
OMBRETRIEVE
OMBRETRIEVE VIEW - To retrieve properties of a view.
In the context of an Oracle Module
Syntax Diagrams
retrieveViewCommand = OMBRETRIEVE VIEW "QUOTED_STRING" ( "retrieveViewClause" | "retrieveColumnClause" | "retrieveUkPkClause" | "retrieveFkClause" );retrieveViewClause = GET ( "getPropertiesClause" | "getViewSCOClause" );retrieveColumnClause = COLUMN "QUOTED_STRING" GET "getPropertiesClause";retrieveUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" GET ( "getPropertiesClause" | COLUMNS );retrieveFkClause = FOREIGN_KEY "QUOTED_STRING" GET ( "getPropertiesClause" | COLUMNS | UNIQUE_KEY | PRIMARY_KEY );getPropertiesClause = PROPERTIES "(" "propertyNameList" ")";getViewSCOClause = COLUMNS | UNIQUE_KEYS | PRIMARY_KEY | FOREIGN_KEYS | COLUMN AT POSITION "INTEGER_LITERAL";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };
retrieveViewCommand
This clause retrieves a view.
QUOTED_STRING
name of the view.
retrieveViewClause
This clause will retrieve a view.
retrieveColumnClause
This clause will retrieve columns
QUOTED_STRING
Name of the column
retrieveUkPkClause
This will get the unique key or primary key clause.
retrieveFkClause
Name of the foreign key
getPropertiesClause
This clause retrieves all the properties.
Basic properties for VIEW, MATERIALIZED_VIEW:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: N/A
Default: ''
Business name of the View, MaterializedView
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the View, MaterializedView
Name: VIEW_QUERY
Type: STRING(4000)
Valid Values: N/A
Default: ''
Sets the query definition in View and MaterializedView.
Name: UOID
Type: STRING
Valid Values: N/A
Default: N/A
Basic properties for INDEX, PARTITION, PARTITION_KEY, INDEX_COLUMN:
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: N/A
Default: ''
Description of the Index, Partition, PartitionKey, IndexColumn in a MaterializedView.
Properties for VIEW:
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
Properties for UNIQUE_KEY:
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: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Properties for FOREIGN_KEY:
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: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Properties for CHECK_CONSTRAINT:
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: INDEX_TABLESPACE
Type: STRING(30)
Valid Values: N/A
Default: ''
Tablespace to store Index on Table Constraint
Name: USING_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Use of Index on Dimension Constraint
Note:
1. N/A means any valid character in supported character set.
2. '' represents an empty string
getViewSCOClause
This clause will retrieves components like columns, keys, etc. of a view.
propertyNameList
The list of properties.
OMBRETRIEVE VIEW 'NEW_VIEW' GET PROPERTIES (DESCRIPTION, BUSINESS_NAME) This will retrieve its description and business name.
OMBRETRIEVE
