Skip Headers

Oracle® Warehouse Builder Scripting Reference
10g Release 1 (10.1)

Part Number B12152-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

3 OMBALTER

This chapter contains the following topics:

OMBALTER
OMBALTER FUNCTION
OMBALTER PROCESS_FLOW_MODULE
OMBALTER ADVANCED_QUEUE
OMBALTER LOCATION
OMBALTER PROCESS_FLOW_PACKAGE
OMBALTER COLLECTION
OMBALTER MAPPING
OMBALTER PROJECT
OMBALTER CONNECTOR
OMBALTER MATERIALIZED_VIEW
OMBALTER RUNTIME_REPOSITORY_CONNECTIONS
OMBALTER CUBE_TABLE
OMBALTER OBJECT_TYPE
OMBALTER SEQUENCE
OMBALTER DEPLOYEMENT_ACTION_PLAN
OMBALTER ORACLE_MODULE
OMBALTER SNAPSHOT
OMBALTER EXTERNAL_TABLE
OMBALTER PACKAGE
OMBALTER TABLE
OMBALTER FLAT_FILE
OMBALTER PROCEDURE
OMBALTER VIEW
OMBALTER FLAT_FILE_MODULE
OMBALTER PROCESS_FLOW
n/a


OMBALTER

Purpose

OMBALTER - Alter metadata for a component.

Prerequisites

Should be in the parent context of the component to alter.

Syntax Diagrams

Description of alterCommand.jpg is in surrounding text
Description of alterCommandSubClauses.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of setReferenceClause.jpg is in surrounding text
Description of unsetReferenceClause.jpg is in surrounding text
Description of addSCOClauseForAlter.jpg is in surrounding text
Description of modifySCOClause.jpg is in surrounding text
Description of deleteSCOClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of quotedNameList.jpg is in surrounding text
Description of parentSCOClause.jpg is in surrounding text
Description of modifySCOSubClauses.jpg is in surrounding text
Description of propertyName.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text
Description of moveToClause.jpg is in surrounding text

Syntax

alterCommand = OMBALTER "fco_type" "fco_name" "alterCommandSubClauses";alterCommandSubClauses = ( "renameClause" [ "setPropertiesClause" ] { "setReferenceClause" | "unsetReferenceClause" } { "addSCOClauseForAlter" | "modifySCOClause" | "deleteSCOClause" } ) | ( "setPropertiesClause" { "setReferenceClause" | "unsetReferenceClause" } { "addSCOClauseForAlter" | "modifySCOClause" | "deleteSCOClause" } ) | ( ( "setReferenceClause" | "unsetReferenceClause" )+ { "addSCOClauseForAlter" | "modifySCOClause" | "deleteSCOClause" } ) | ( "addSCOClauseForAlter" | "modifySCOClause" | "deleteSCOClause" )+;renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = SET PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";setReferenceClause = SET ( REF | REFERENCE ) [ "qualifier" ] "type" "quotedNameList" [ { "parentSCOClause" } OF "fco_type" "fco_name" ];unsetReferenceClause = UNSET ( REF | REFERENCE ) [ "qualifier" ] "type";addSCOClauseForAlter = ADD "sco_type" "sco_name" { "parentSCOClause" } [ AT POSITION "pos" ] [ "setPropertiesClause" ] { "setReferenceClause" };modifySCOClause = MODIFY "sco_type" "sco_name" { "parentSCOClause" } "modifySCOSubClauses";deleteSCOClause = DELETE "sco_type" "sco_name" { "parentSCOClause" };propertyNameList = "propertyName" { "," "propertyName" };propertyValueList = "propertyValue" { "," "propertyValue" };quotedNameList = "QUOTED_STRING" | "(" "QUOTED_STRING" { "," "QUOTED_STRING" } ")";parentSCOClause = OF "sco_type" "sco_name";modifySCOSubClauses = ( "renameClause" [ "moveToClause" ] [ "setPropertiesClause" ] { "setReferenceClause" } ) | ( "moveToClause" [ "setPropertiesClause" ] { "setReferenceClause" } ) | ( "setPropertiesClause" { "setReferenceClause" } ) | "setReferenceClause"+;propertyName = "UNQUOTED_STRING";propertyValue = "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL";moveToClause = MOVE TO POSITION "pos";

Keywords and Parameters

alterCommand

Specify the component to alter.

fco_type

The type of the component.

fco_name

The physical name of the component in single quotes.

alterCommandSubClauses

Use this clause to rename the component, reset its properties, or modify the child objects of the component.

renameClause

Rename the component.

setPropertiesClause

Set object properties.

setReferenceClause

Specify reference objects.

qualifier

Specify which reference to set, if there are more than one pointing to the same type.

unsetReferenceClause

Removes an existing reference.

qualifier

Specify which reference to set, if there are more than one pointing to the same type.

addSCOClauseForAlter

Add child objects under the component.

modifySCOClause

Change definition of a child object.

deleteSCOClause

Delete a child object.

propertyNameList

A list of property names.

propertyValueList

A list of property values.

quotedNameList

A list of single-quoted physical names.

parentSCOClause

Used to specify the path from a child object to the component

modifySCOSubClauses

Use this clause to rename a child object, reset its properties or references, or reorder it.

propertyName

An unquoted string representing the name of a property.

propertyValue

The value of a property.

moveToClause

Used to reorder child objects.

Examples

This is an example for altering a table:

OMBALTER TABLE 'T1' SET PROPERTIES (DESCRIPTION) VALUES ('My First Table')

The following statement alters the column of a view:

OMBALTER VIEW 'V1'

MODIFY COLUMN 'COL1'

SET PROPERTIES (DATATYPE) VALUES ('VARCHAR2')

See Also

OMBCREATE, OMBDROP


OMBALTER ADVANCED_QUEUE

Purpose

OMBALTER ADVANCED_QUEUE - Alter the Advanced Queue by resetting its properties.

Prerequisites

Should be in the context of an Oracle Module. The Object Type set as Payload Type should exist in the same Oracle Module.

Syntax Diagrams

Description of alterAQCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterAQCommand = OMBALTER ( ADVANCED_QUEUE "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterAQCommand

Alters the Advanced Queue with the given name by either renaming it or by setting it's properties or both.

renameClause

Renames the Advanced Queue to the given name.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Advanced Queue.

Valid properties are shown below:

Basic properties for ADVANCED_QUEUE:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: ''

Business name of the Advanced Queue

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of the Advanced Queue

Name: 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.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

Examples

OMBALTER ADVANCED_QUEUE 'SOME_ADVANCED_QUEUE' SET PROPERTIES (TABLESPACE, QUEUE_TABLE_NAME) VALUES ('TABLESPACE', 'QUEUE_TABLE') This will set its property Tablespace Name to "TABLESPACE" and Queue Table to 'QUEUE_TABLE'.

See Also

OMBALTER, OMBCREATE ADVANCED_QUEUE, OMBRETRIEVE ADVANCED_QUEUE, OMBDROP ADVANCED_QUEUE


OMBALTER COLLECTION

Purpose

OMBALTER COLLECTION - Alter the collection by adding, removing or modifying

shortcuts.

Prerequisites

Should be in the context of a project, before altering a collection.

Syntax Diagrams

Description of alterCollectionCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of alterCollectionReferences.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of addReferenceClause.jpg is in surrounding text
Description of removeReferenceClause.jpg is in surrounding text
Description of reconcileReferenceClause.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text
Description of componentRefClause.jpg is in surrounding text

Syntax

alterCollectionCommand = OMBALTER ( COLLECTION "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] [ "alterCollectionReferences" ] | SET "setPropertiesClause" [ "alterCollectionReferences" ] | "alterCollectionReferences" ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";alterCollectionReferences = ( "addReferenceClause" | "removeReferenceClause" | "reconcileReferenceClause" )+;propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };addReferenceClause = ADD REFERENCE TO "componentRefClause";removeReferenceClause = REMOVE REFERENCE TO "componentRefClause";reconcileReferenceClause = RECONCILE;propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );componentRefClause = ( EXTERNAL_TABLE | TABLE | VIEW | MATERIALIZED_VIEW | SEQUENCE | MAPPING | DIMENSION_TABLE | CUBE_TABLE | ADVANCED_QUEUE | ORACLE_MODULE | TRANSFORMATION_MODULE | FLAT_FILE_MODULE | FLAT_FILE | PROCESS_FLOW | PROCESS_FLOW_PACKAGE | PROCESS_FLOW_MODULE | SAP_MODULE | COLLECTION | FUNCTION | PROCEDURE | PACKAGE | INTELLIGENCE_MODULE | REPORT_MODULE | REPORT | REPORT_GROUP | QUERY_OBJECT | BUSINESS_AREA | GATEWAY_MODULE | LOCATION | RUNTIME_REPOSITORY_CONNECTION | CONNECTOR | IO_FUNCTION ) "QUOTED_STRING";

Keywords and Parameters

alterCollectionCommand

Alter a collection of objects.

QUOTED_STRING

Name of the existing collection in quotes.

renameClause

Rename a collection.

setPropertiesClause

Associate a set of properties with a collection.

Basic properties for COLLECTION:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: ''

Business name of the collection

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of the collection

Note:

1. N/A means any valid character in supported character set.

2. '' represents an empty string

alterCollectionReferences

Alter the collections references, includes adding, dropping and reconciling

the collection.

propertyNameList

Comma separated list of property names. Property names are unquoted.

propertyValueList

Comma separated list of property values.

addReferenceClause

Add a reference to the collection.

removeReferenceClause

Remove a reference from the collection.

reconcileReferenceClause

Reconcile the collection, deleting references which now refer to deleted objects.

propertyValue

Value of a property.

componentRefClause

Specify the type of the object to reference.

Examples

OMBALTER COLLECTION 'PURCHASING_WAREHOUSE' SET PROPERTIES (DESCRIPTION) VALUES ('Group for purchasing usage.') ADD REFERENCE TO TABLE 'PURCHASING/PRODUCT'

See Also

OMBALTER, OMBCREATE COLLECTION


OMBALTER CONNECTOR

Purpose

OMBALTER CONNECTOR - Alter the connector by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of the connector's owning location.

Syntax Diagrams

Description of alterConnectorCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of setReferenceToLocationClause.jpg is in surrounding text
Description of unsetReferenceToLocationClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterConnectorCommand = OMBALTER ( CONNECTOR "QUOTED_STRING" ( ( "renameClause" [ SET "setPropertiesClause" ] [ SET ( REFERENCE | REF ) "setReferenceToLocationClause" | UNSET ( REFERENCE | REF ) "unsetReferenceToLocationClause" ] ) | ( SET "setPropertiesClause" [ SET ( REFERENCE | REF ) "setReferenceToLocationClause" | UNSET ( REFERENCE | REF ) "unsetReferenceToLocationClause" ] ) | ( SET ( REFERENCE | REF ) "setReferenceToLocationClause" | UNSET ( REFERENCE | REF ) "unsetReferenceToLocationClause" ) ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";setReferenceToLocationClause = LOCATION "QUOTED_STRING";unsetReferenceToLocationClause = LOCATION;propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterConnectorCommand

Alter the connector specified by the quoted string.

renameClause

Rename the connector.

setPropertiesClause

Set specified properties of the connector.

setReferenceToLocationClause

Set the name of the location which the connector references.

unsetReferenceToLocationClause

Unset the referenced location.

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

propertyValueList

The values for the named properties.

propertyValue

A property value.

Examples

OMBALTER CONNECTOR 'OLD_CONNECTOR' RENAME TO 'NEW_CONNECTOR' SET PROPERTIES

(DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a new connector.', 'new connector') This will rename the connector "OLD_CONNECTOR" to "NEW_CONNECTOR", and set its description to "This becomes a new connector", set its business name to "new connector".

OMBALTER CONNECTOR 'A_CONNECTOR' SET REFERENCE LOCATION 'MY_LOCATION'

OMBALTER CONNECTOR 'A_CONNECTOR' UNSET REF LOCATION

See Also

OMBALTER, OMBCREATE CONNECTOR, OMBDROP CONNECTOR


OMBALTER CUBE_TABLE

Purpose

OMBALTER CUBE_TABLE - This command alters a cube.

Prerequisites

Should be in Oracle Module context.

Syntax Diagrams

Description of OMBAlterCube.jpg is in surrounding text
Description of cube_alter.jpg is in surrounding text
Description of name.jpg is in surrounding text
Description of cube_alter_addDeleteModify_clause.jpg is in surrounding text
Description of cube_properties_clause.jpg is in surrounding text
Description of rename_clause.jpg is in surrounding text
Description of cube_add_measureDimensionUse_clause.jpg is in surrounding text
Description of cube_delete_measureDimensionUse_clause.jpg is in surrounding text
Description of cube_modify_measureDimensionUse_clause.jpg is in surrounding text
Description of simple_properties_clause.jpg is in surrounding text
Description of cube_addMeasure_clause.jpg is in surrounding text
Description of cube_addDimensionUse_clause.jpg is in surrounding text
Description of cube_addIndex_clause.jpg is in surrounding text
Description of cube_addIndexColumn_clause.jpg is in surrounding text
Description of cube_addPartition_clause.jpg is in surrounding text
Description of cube_addPartitionKey_clause.jpg is in surrounding text
Description of cube_modify_measure_clause.jpg is in surrounding text
Description of cube_modify_dimensionUse_clause.jpg is in surrounding text
Description of cube_modify_index_clause.jpg is in surrounding text
Description of cube_modify_indexColumn_clause.jpg is in surrounding text
Description of cube_modify_partition_clause.jpg is in surrounding text
Description of cube_modify_partitionKey_clause.jpg is in surrounding text
Description of simple_property.jpg is in surrounding text
Description of value.jpg is in surrounding text
Description of cube_measure_name_clause.jpg is in surrounding text
Description of cube_measure_properties_clause.jpg is in surrounding text
Description of cube_dimensionUse_properties_clause.jpg is in surrounding text
Description of cube_dimensionUse_dimension_references_clause.jpg is in surrounding text
Description of cube_dimensionUse_level_references_clause.jpg is in surrounding text

Syntax

OMBAlterCube = OMBALTER CUBE_TABLE "cube_alter";cube_alter = "name" ( "cube_alter_addDeleteModify_clause"+ | "cube_properties_clause" { "cube_alter_addDeleteModify_clause" } | "rename_clause" { "cube_alter_addDeleteModify_clause" } | ( "rename_clause" "cube_properties_clause" { "cube_alter_addDeleteModify_clause" } ) );name = ( "QUOTED_STRING" );cube_alter_addDeleteModify_clause = "cube_add_measureDimensionUse_clause" | "cube_delete_measureDimensionUse_clause" | "cube_modify_measureDimensionUse_clause";cube_properties_clause = "simple_properties_clause";rename_clause = RENAME TO "QUOTED_STRING";cube_add_measureDimensionUse_clause = ADD ( "cube_addMeasure_clause" | "cube_addDimensionUse_clause" | "cube_addIndex_clause" | "cube_addIndexColumn_clause" | "cube_addPartition_clause" | "cube_addPartitionKey_clause" );cube_delete_measureDimensionUse_clause = DELETE ( MEASURE "name" | DIMENSION_USE "name" | INDEX "name" | INDEX_COLUMN "name" OF INDEX "name" | PARTITION "name" | PARTITION_KEY "name" );cube_modify_measureDimensionUse_clause = MODIFY ( "cube_modify_measure_clause" | "cube_modify_dimensionUse_clause" | "cube_modify_index_clause" | "cube_modify_indexColumn_clause" | "cube_modify_partition_clause" | "cube_modify_partitionKey_clause" );simple_properties_clause = SET PROPERTIES "(" "simple_property" { "," "simple_property" } ")" VALUES "(" "value" { "," "value" } ")";cube_addMeasure_clause = MEASURE "cube_measure_name_clause" [ "cube_measure_properties_clause" ];cube_addDimensionUse_clause = DIMENSION_USE ( "name" [ "cube_dimensionUse_properties_clause" ] [ "cube_dimensionUse_dimension_references_clause" ] );cube_addIndex_clause = INDEX "name" [ "simple_properties_clause" ];cube_addIndexColumn_clause = INDEX_COLUMN "name" OF INDEX "name" [ "simple_properties_clause" ];cube_addPartition_clause = PARTITION "name" [ "simple_properties_clause" ];cube_addPartitionKey_clause = PARTITION_KEY "name" [ "simple_properties_clause" ];cube_modify_measure_clause = MEASURE "name" ( "cube_measure_properties_clause" | ( "rename_clause" [ "cube_measure_properties_clause" ] ) );cube_modify_dimensionUse_clause = DIMENSION_USE "name" [ "rename_clause" ] [ "cube_dimensionUse_properties_clause" ] [ "cube_dimensionUse_dimension_references_clause" [ "cube_dimensionUse_level_references_clause" ] ];cube_modify_index_clause = INDEX "name" ( "simple_properties_clause" | ( "rename_clause" [ "simple_properties_clause" ] ) );cube_modify_indexColumn_clause = INDEX_COLUMN "name" OF INDEX "name" "simple_properties_clause";cube_modify_partition_clause = PARTITION "name" ( "simple_properties_clause" | ( "rename_clause" [ "simple_properties_clause" ] ) );cube_modify_partitionKey_clause = PARTITION_KEY "name" "simple_properties_clause";simple_property = "UNQUOTED_STRING";value = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );cube_measure_name_clause = "name";cube_measure_properties_clause = "simple_properties_clause";cube_dimensionUse_properties_clause = "simple_properties_clause";cube_dimensionUse_dimension_references_clause = SET ( REF | REFERENCE ) ( DIMENSION_TABLE "name" );cube_dimensionUse_level_references_clause = SET ( REF | REFERENCE ) ( LEVEL "name" );

Keywords and Parameters

OMBAlterCube

This command alter a cube_table

cube_alter

This clause alter a cube_table by adding, deleting, and modifying clauses.

name

The name has to be a quoted string or an integer, or a decimal number.

cube_alter_addDeleteModify_clause

This clause adds, deletes, and modifies measures, dimensionUses, indexes, indexColumns, partition, and partitionKeys.

cube_properties_clause

This clause uses the simple properties.

rename_clause

This clause renames to another name

cube_add_measureDimensionUse_clause

This clause adds measures, dimensionUses, indexes, indexColumns, partition,

and partitionKeys.

cube_delete_measureDimensionUse_clause

This clause deletes measures, dimensionUses, indexes, indexColumns, partition, and partitionKeys.

cube_modify_measureDimensionUse_clause

This clause modifies measures, dimensionUses, indexes, indexColumns, partition, and partitionKeys.

simple_properties_clause

Sets properties and their values.

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

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

cube_addMeasure_clause

This clause adds the measure name and its properties.

cube_addDimensionUse_clause

This clause adds the dimensionUse and its properties.

cube_addIndex_clause

This clause adds Index name and its properties.

cube_addIndexColumn_clause

This clause adds IndexColumn of an index and its properties.

cube_addPartition_clause

This clause adds partition and its properties.

cube_addPartitionKey_clause

This clause adds a partitionKey and its properties.

cube_modify_measure_clause

This clause modifies measure by renaming it and changing its properties.

cube_modify_dimensionUse_clause

This clause modifies dimensionUse.

cube_modify_index_clause

This clause modifies an index.

cube_modify_indexColumn_clause

This clause modifies an indexColumn.

cube_modify_partition_clause

This clause modifies an partition.

cube_modify_partitionKey_clause

cube_modify_partition_clause = This clause modifies an partitionKey.

simple_property

gets the simple property.

UNQUOTED_STRING

Name of the simple property.

value

The quoted string name

cube_measure_name_clause

name of the measure.

cube_measure_properties_clause

alters simple properties of a measure.

cube_dimensionUse_properties_clause

alters simple properties of a dimensionUse.

cube_dimensionUse_dimension_references_clause

The dimensionUse references to the first level of the dimension.

cube_dimensionUse_level_references_clause

The dimensionUse references to the user specified level of the dimension.

Examples

OMBALTER CUBE_TABLE 'CUBE1' ADD MEASURE 'MEASURE_2' DELETE MEASURE 'MEASURE_1'

See Also

OMBCREATE CUBE_TABLE, OMBDROP CUBE_TABLE, OMBRETRIEVE CUBE_TABLE


OMBALTER DEPLOYEMENT_ACTION_PLAN

Purpose

OMBALTER DEPLOYMENT_ACTION_PLAN - Modify an existing deployment action plan.

Prerequisites

There must be a current working project.

Syntax Diagrams

Description of AlterActionPlanCommand.jpg is in surrounding text
Description of renameActionPlanClause.jpg is in surrounding text
Description of addActionClause.jpg is in surrounding text
Description of modifyActionClause.jpg is in surrounding text
Description of deleteActionClause.jpg is in surrounding text
Description of setClause.jpg is in surrounding text
Description of renameActionClause.jpg is in surrounding text
Description of setUnsetClause.jpg is in surrounding text
Description of propertiesClause.jpg is in surrounding text
Description of setReferenceClause.jpg is in surrounding text
Description of setClauseForAlter.jpg is in surrounding text
Description of unsetReferenceClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

AlterActionPlanCommand = ( OMBALTER ( DEPLOYMENT_ACTION_PLAN ) "QUOTED_STRING" ( ( "renameActionPlanClause" { "addActionClause" | "modifyActionClause" | "deleteActionClause" } ) | ( "addActionClause" { "addActionClause" | "modifyActionClause" | "deleteActionClause" } ) | ( "modifyActionClause" { "addActionClause" | "modifyActionClause" | "deleteActionClause" } ) | ( "deleteActionClause" { "addActionClause" | "modifyActionClause" | "deleteActionClause" } ) ) );renameActionPlanClause = RENAME TO "QUOTED_STRING";addActionClause = ADD ACTION "QUOTED_STRING" [ SET "setClause" ];modifyActionClause = MODIFY ACTION "QUOTED_STRING" ( ( "renameActionClause" [ "setUnsetClause" ] ) | "setUnsetClause" );deleteActionClause = DELETE ACTION "QUOTED_STRING";setClause = ( "propertiesClause" [ SET "setReferenceClause" ] ) | "setReferenceClause";renameActionClause = RENAME TO "QUOTED_STRING";setUnsetClause = ( ( SET "setClauseForAlter" ) | ( UNSET "unsetReferenceClause" ) );propertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";setReferenceClause = ( REF | REFERENCE ) "ObjType" "QUOTED_STRING";setClauseForAlter = ( "propertiesClause" [ SET "setReferenceClause" | UNSET "unsetReferenceClause" ] ) | "setReferenceClause";unsetReferenceClause = ( REF | REFERENCE );propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

AlterActionPlanCommand

Modify an existing deployment action plan.

renameActionPlanClause

Rename an action plan.

addActionClause

Add an action to an action plan.

modifyActionClause

Modify an action of an action plan.

deleteActionClause

Remove an action from an action plan.

setClause

Set the properties of an action and/or associate an object with an action.

renameActionClause

Rename an action.

setUnsetClause

Set the properties and/or associate/disassociate an object with an action.

propertiesClause

Associate a set of properties with an action.

PROPERTIES

The only valid property is OPERATION, which specifies the type of action to

be taken.

setReferenceClause

Associate an object with an action.

ObjType

Object type. Valid values are ADVANCED_QUEUE, CUBE_TABLE, DIMENSION_TABLE,

EXTERNAL_TABLE, CONNECTOR, FUNCTION, MAPPING, MATERIALIZED_VIEW, PROCEDURE,

PROCESS_FLOW_PACKAGE, SEQUENCE, TABLE, and VIEW.

QUOTED_STRING

Absolute or relative path name of an object (e.g. '/MY_PROJECT/MODULE_X/TABLE_Y').

setClauseForAlter

Set the properties and/or associate/disassociate an object with an action.

unsetReferenceClause

Disassociate a previously associated object from an action.

propertyNameList

Comma separated list of property names. Property names are unquoted.

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property. Valid values for OPERATION are DROP and CREATE.

Examples

OMBALTER DEPLOYMENT_ACTION_PLAN 'MY_PLAN' RENAME TO 'MY_PLAN_2'

OMBALTER DEPLOYMENT_ACTION_PLAN 'MY_PLAN' ADD ACTION 'MY_ALTER_TABLE'

SET PROPERTIES (OPERATION) VALUES ('CREATE') SET REFERENCE TABLE 'TABLE_X'

OMBALTER DEPLOYMENT_ACTION_PLAN 'MY_PLAN' MODIFY ACTION 'MY_VIEW_CREATE'

RENAME TO 'MY_VIEW_DROP' SET PROPERTIES (OPERATION) VALUES ('DROP')

OMBALTER DEPLOYMENT_ACTION_PLAN 'MY_PLAN' DELETE ACTION 'MY_TABLE_DEPLOY'

OMBALTER DEPLOYMENT_ACTION_PLAN 'MY_PLAN'

ADD ACTION 'MY_ALTER_VIEW' SET PROPERTIES (OPERATION) VALUES ('CREATE')

SET REFERENCE VIEW '/MY_PROJECT/MY_MODULE/VIEW_Y'

MODIFY ACTION 'MY_TABLE_DEPLOY' SET REFERENCE TABLE 'MY_MODULE/TABLE_Z'

DELETE ACTION 'MY_VIEW_CREATE'

See Also

OMBCREATE DEPLOYMENT_ACTION_PLAN, OMBDEPLOY


OMBALTER EXTERNAL_TABLE

Purpose

OMBALTER EXTERNAL_TABLE - Alter the external table by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of an Oracle Module.

Syntax Diagrams

Description of alterExternalTableCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesAndReferencesClauses.jpg is in surrounding text
Description of alterExternalTableObjectClauses.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of setReferencesToRecordAndLocationClauses.jpg is in surrounding text
Description of addExternalTableObjectClause.jpg is in surrounding text
Description of modifyExternalTableObjectClause.jpg is in surrounding text
Description of deleteExternalTableObjectClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of setReferencesToRecordFileModuleClause.jpg is in surrounding text
Description of setReferencesToLocationClause.jpg is in surrounding text
Description of setReferencesToFileAndModuleClause.jpg is in surrounding text
Description of setPropertiesAndReferencesToFieldClauses.jpg is in surrounding text
Description of addExternalTableDatafileClause.jpg is in surrounding text
Description of moveExternalTableColumnToClause.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text
Description of setReferencesToFieldClause.jpg is in surrounding text

Syntax

alterExternalTableCommand = OMBALTER ( EXTERNAL_TABLE "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesAndReferencesClauses" ] [ "alterExternalTableObjectClauses" ] | SET "setPropertiesAndReferencesClauses" [ "alterExternalTableObjectClauses" ] | "alterExternalTableObjectClauses" ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesAndReferencesClauses = "setPropertiesClause" [ SET ( REF | REFERENCE ) "setReferencesToRecordAndLocationClauses" ] | ( REF | REFERENCE ) "setReferencesToRecordAndLocationClauses";alterExternalTableObjectClauses = ADD "addExternalTableObjectClause" [ "alterExternalTableObjectClauses" ] | MODIFY "modifyExternalTableObjectClause" [ "alterExternalTableObjectClauses" ] | DELETE "deleteExternalTableObjectClause" [ "alterExternalTableObjectClauses" ];setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";setReferencesToRecordAndLocationClauses = "setReferencesToRecordFileModuleClause" [ "setReferencesToLocationClause" ] | "setReferencesToFileAndModuleClause" [ "setReferencesToLocationClause" ] | "setReferencesToLocationClause";addExternalTableObjectClause = COLUMN "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET "setPropertiesAndReferencesToFieldClauses" ] | "addExternalTableDatafileClause";modifyExternalTableObjectClause = COLUMN "QUOTED_STRING" ( "renameClause" [ "moveExternalTableColumnToClause" ] [ SET "setPropertiesAndReferencesToFieldClauses" ] | "moveExternalTableColumnToClause" [ SET "setPropertiesAndReferencesToFieldClauses" ] | SET "setPropertiesAndReferencesToFieldClauses" ) | DATA_FILE "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" );deleteExternalTableObjectClause = COLUMN "QUOTED_STRING" | DATA_FILE "QUOTED_STRING";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };setReferencesToRecordFileModuleClause = RECORD "QUOTED_STRING" OF FLAT_FILE "QUOTED_STRING";setReferencesToLocationClause = DEFAULT_LOCATION "QUOTED_STRING";setReferencesToFileAndModuleClause = FLAT_FILE "QUOTED_STRING";setPropertiesAndReferencesToFieldClauses = "setPropertiesClause" [ SET ( REF | REFERENCE ) "setReferencesToFieldClause" ] | ( REF | REFERENCE ) "setReferencesToFieldClause";addExternalTableDatafileClause = DATA_FILE "QUOTED_STRING" [ SET "setPropertiesClause" ];moveExternalTableColumnToClause = MOVE TO POSITION "INTEGER_LITERAL";propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );setReferencesToFieldClause = FIELD "QUOTED_STRING";

Keywords and Parameters

alterExternalTableCommand

Alter the existing external table.

QUOTED_STRING

The name of the external table to alter.

renameClause

Rename the external table to the value of the following quoted string.

setPropertiesAndReferencesClauses

Set the properties and/or flat file reference of the external table.

alterExternalTableObjectClauses

Add, modify, or delete columns or data files.

setPropertiesClause

Set specified properties of the external table.

setReferencesToRecordAndLocationClauses

Set the referenced record and/or default location.

addExternalTableObjectClause

Add a column to the external table. The name of the new column will be the

quoted string.

modifyExternalTableObjectClause

Modify the properties of a column or data file or move a column to a new position.

deleteExternalTableObjectClause

Delete a column or data file.

propertyNameList

The names of the properties whose values you want to set.

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.

Properties for DATA_FILE:

Name: DATA_FILE_LOCATION

Type: STRING

Valid Values: N/A

Default: USE_DEFAULT_LOCATION

The location of this data file for the external table.

Name: DATA_FILE_NAME

Type: STRING

Valid Values: N/A

Default: ''

Name of this data file.

Note:

1. N/A means any valid character in supported character set.

2. '' represents an empty string

propertyValueList

The values for the named properties.

setReferencesToRecordFileModuleClause

Specify the record and full path to the flat file for the external table to

reference.

setReferencesToLocationClause

Specify the default location for the external table.

setReferencesToFileAndModuleClause

Specify the full path to the flat file for the external table to reference.

setPropertiesAndReferencesToFieldClauses

Set the properties and/or field reference of the external table column.

addExternalTableDatafileClause

Add a new data file to the external table. The name of the new data file will be the quoted string. You may also set the properties of the new data file.

moveExternalTableColumnToClause

Move a column of the external table.

propertyValue

A property value.

setReferencesToFieldClause

Set the name of the field which the external table column references.

Examples

OMBALTER EXTERNAL_TABLE 'SRC_TABLE' RENAME TO 'MY_TABLE' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('a new description', 'My Table') This will rename the external table "SRC_TABLE" to "MY_TABLE", and set its description to "a new description", and set its business name to "My Table".

See Also

OMBALTER, OMBCREATE EXTERNAL_TABLE, OMBDROP EXTERNAL_TABLE


OMBALTER FLAT_FILE

Purpose

OMBALTER FLAT_FILE - Alter the flat file by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of a flat file module.

Syntax Diagrams

Description of alterFlatFileCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of alterRecordClauses.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of addRecordClauseForAlter.jpg is in surrounding text
Description of modifyRecordClause.jpg is in surrounding text
Description of deleteRecordClause.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text
Description of addFieldClauseForAlter.jpg is in surrounding text
Description of alterFieldClauses.jpg is in surrounding text
Description of modifyFieldClause.jpg is in surrounding text
Description of deleteFieldClause.jpg is in surrounding text
Description of moveFieldToClause.jpg is in surrounding text

Syntax

alterFlatFileCommand = OMBALTER ( FLAT_FILE "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] { "alterRecordClauses" } | SET "setPropertiesClause" { "alterRecordClauses" } | "alterRecordClauses" { "alterRecordClauses" } ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";alterRecordClauses = ADD "addRecordClauseForAlter" | MODIFY "modifyRecordClause" | DELETE "deleteRecordClause";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };addRecordClauseForAlter = RECORD "QUOTED_STRING" [ SET "setPropertiesClause" ] { ADD "addFieldClauseForAlter" };modifyRecordClause = RECORD "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] { "alterFieldClauses" } | SET "setPropertiesClause" { "alterFieldClauses" } | "alterFieldClauses" { "alterFieldClauses" } );deleteRecordClause = RECORD "QUOTED_STRING";propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );addFieldClauseForAlter = FIELD "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ];alterFieldClauses = ADD "addFieldClauseForAlter" | MODIFY "modifyFieldClause" | DELETE "deleteFieldClause";modifyFieldClause = FIELD "QUOTED_STRING" ( "renameClause" [ "moveFieldToClause" ] [ SET "setPropertiesClause" ] | "moveFieldToClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" );deleteFieldClause = FIELD "QUOTED_STRING";moveFieldToClause = MOVE TO POSITION "INTEGER_LITERAL";

Keywords and Parameters

alterFlatFileCommand

Alter a flat file.

QUOTED_STRING

The name of the flat file to alter.

renameClause

Rename the flat file to the following quoted string.

setPropertiesClause

Set the properties of the flat file, record, or field.

alterRecordClauses

Add, modify, or drop a record of the flat file.

propertyNameList

The names of the properties whose values you want to set.

Properties for FLAT_FILE:

Name: DATA_FILE_NAME

Type: STRING

Valid Values: N/A Default '' The name of the "sampled" file. Also the default data file value used in SQL*Loader maps and External Tables.

Name: IS_DELIMITED

Type: BOOLEAN

Valid Values: true, false, 1, 0

Default: true

True indicates that this flat file is delimited. False indicates that its fields are defined by fixed lengths

Name: CHARACTERSET

Type: STRING

Valid Values: AL24UTFFSS,AR8ARABICMAC,AR8ARABICMACS,AR8ISO8859P6,AR8MSAWIN,AR8MSWIN1256,BLT8CP921,BLT8EBCDIC1112,BLT8MSWIN1257,BLT8PC775,CDN8PC863,CL8EBCDIC1025,CL8EBCDIC1025X,CL8ISO8859P5,CL8KOI8R,CL8MACCYRILLIC,CL8MACCYRILLICS,CL8MSWIN1251,D8EBCDIC273,DK8EBCDIC277,EE8EBCDIC870,EE8ISO8859P2,EE8MACCE,EE8MACCES,EE8MACCROATIAN,EE8MACCROATIANS,EE8MSWIN1250,EE8PC852,EL8EBCDIC875,EL8ISO8859P7,EL8MACGREEK,EL8MACGREEKS,EL8MSWIN1253,EL8PC437S,EL8PC737,EL8PC869,F8EBCDIC297,I8EBCDIC280,IS8MACICELANDIC,IS8MACICELANDICS,IS8PC861,IW8EBCDIC424,IW8ISO8859P8,IW8MACHEBREW,IW8MACHEBREWS,IW8MSWIN1255,JA16EBCDIC930,JA16EUC,JA16EUCYEN,JA16MACSJIS,JA16SJIS,JA16SJISYEN,JA16VMS,KO16KSC5601,LT8MSWIN921,N8PC865,NEE8ISO8859P4,RU8PC855,RU8PC866,S8EBCDIC278,SE8ISO8859P3,TH8MACTHAI,TH8MACTHAIS,TH8TISASCII,TR8EBCDIC1026,TR8MACTURKISH,TR8MACTURKISHS,TR8MSWIN1254,TR8PC857,US7ASCII,US8PC437,UTF8,WE8EBCDIC284,WE8EBCDIC285,WE8EBCDIC37,WE8EBCDIC37C,WE8EBCDIC500,WE8EBCDIC500C,WE8EBCDIC871,WE8ISO8859P1,WE8ISO8859P9,WE8MACROMAN8,WE8MACROMAN8S,WE8MSWIN1252,WE8PC850,WE8PC860,ZHS16CGB231280,ZHS16GBK,ZHS16MACCGB231280,ZHT16BIG5,ZHT16MSWIN950,ZHT32EUC

Default: WE8MSWIN1252

The character set of the data file.

Name: RECORD_DELIMITER

Type: STRING

Valid Values: N/A

Default: ''

The character(s) which denote the end of a physical record in a data file. (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.

propertyValueList

The values for the named properties.

addRecordClauseForAlter

Add a record named by the following quoted string.

modifyRecordClause

Modify a record specified by the following quoted string.

deleteRecordClause

Delete a record specified by the following quoted string.

propertyValue

A property value.

addFieldClauseForAlter

Add a field to the record.

alterFieldClauses

Add, modify, or drop a field.

modifyFieldClause

Modify the properties of a field specified by the following quoted string.

deleteFieldClause

Delete a field specified by the following quoted string.

moveFieldToClause

Move a field to a new position in the record.

Examples

OMBALTER FLAT_FILE 'OLD_NAME' RENAME TO 'NEW_NAME' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a target file.', 'target file') This will rename the flat file "OLD_NAME" to "NEW_NAME", set its description to "This becomes a target file", and set its business name to "target file".

See Also

OMBALTER, OMBCREATE FLAT_FILE, OMBDROP FLAT_FILE


OMBALTER FLAT_FILE_MODULE

Purpose

OMBALTER FLAT_FILE_MODULE - Alter the flat file module by renaming it, and/or reseting its properties.

Prerequisites

Should be in the context of a project.

Syntax Diagrams

Description of alterFlatFileModuleCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of alterPropertiesOrLocationClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of setReferenceLocationClause.jpg is in surrounding text
Description of unsetReferenceLocationClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterFlatFileModuleCommand = OMBALTER ( FLAT_FILE_MODULE "QUOTED_STRING" ( "renameClause" [ "alterPropertiesOrLocationClause" ] | "alterPropertiesOrLocationClause" ) );renameClause = RENAME TO "QUOTED_STRING";alterPropertiesOrLocationClause = SET ( "setPropertiesClause" [ SET "setReferenceLocationClause" | UNSET "unsetReferenceLocationClause" ] | "setReferenceLocationClause" ) | UNSET "unsetReferenceLocationClause";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING";unsetReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterFlatFileModuleCommand

Alter a flat file module.

QUOTED_STRING

The name of the flat file module to alter.

renameClause

Rename the flat file module.

QUOTED_STRING

The new name for the flat file module.

alterPropertiesOrLocationClause

Alter either the properties of the flat file module, the location of the flat file module, or both.

setPropertiesClause

Set some properties of the flat file module.

setReferenceLocationClause

Set the location for the flat file module to the location specified by the quoted string.

unsetReferenceLocationClause

Unset the location for the flat file module.

propertyNameList

The names of the properties whose values you want to set.

Basic properties for FLAT_FILE_MODULE:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: NAME

Business name of the flat file module.

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of the flat file module.

Name: UOID

Type: STRING(40)

Valid Values: N/A

Default: N/A

UOID of the flat file module.

propertyValueList

The values for the named properties.

propertyValue

A property value.

Examples

OMBALTER FLAT_FILE_MODULE 'src_module' RENAME TO 'tgt_module' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a target module.', 'target module') This will rename the flat file module "src_module" to "tgt_module", and set its description to "This becomes a target module", set its business name to "target module".

See Also

OMBALTER, OMBCREATE FLAT_FILE_MODULE, OMBDROP FLAT_FILE_MODULE


OMBALTER FUNCTION

Purpose

OMBALTER FUNCTION - Alter the Function by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of a Oracle Module or Package or Transformation Module.

Syntax Diagrams

Description of alterFunctionCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of alterFuncProcParameterSCOClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of alterFuncProcParameterClause.jpg is in surrounding text
Description of modifyFuncProcParameterClause.jpg is in surrounding text
Description of deleteFuncProcParameterClause.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text
Description of moveToClause.jpg is in surrounding text

Syntax

alterFunctionCommand = OMBALTER ( FUNCTION "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] [ "alterFuncProcParameterSCOClause" ] | SET "setPropertiesClause" [ "alterFuncProcParameterSCOClause" ] | "alterFuncProcParameterSCOClause" ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";alterFuncProcParameterSCOClause = ( ADD "alterFuncProcParameterClause" [ "alterFuncProcParameterSCOClause" ] | MODIFY "modifyFuncProcParameterClause" [ "alterFuncProcParameterSCOClause" ] | DELETE "deleteFuncProcParameterClause" [ "alterFuncProcParameterSCOClause" ] );propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };alterFuncProcParameterClause = PARAMETER "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ];modifyFuncProcParameterClause = ( PARAMETER "QUOTED_STRING" ( "renameClause" | "moveToClause" | [ SET "setPropertiesClause" ] ) );deleteFuncProcParameterClause = ( PARAMETER "QUOTED_STRING" );propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );moveToClause = MOVE TO POSITION "INTEGER_LITERAL";

Keywords and Parameters

alterFunctionCommand

This command modifies an existing Function.

QUOTED_STRING

Name of the existing Function in single quotes.

renameClause

Rename a Function.

setPropertiesClause

Used to set properties (core, user-defined) for function. Valid properties are shown below:

Basic properties for FUNCTION:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: ''

Business name of the Function

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of the Function

Name: RETURN_TYPE

Type: STRING

Valid Values: PLS_INTEGER, BINARY_INTEGER, BOOLEAN, NUMBER, FLOAT, CHAR, VARCHAR, VARCHAR2, DATE

Default: NUMBER

Set the Return Type for Function

Name: IMPLEMENTATION

Type: STRING

Valid Values: N/A

Default: ''

Set the code for Function which is included global variable declaration and code between BEGIN and END.

Name: IS_DETERMINISTIC

Type: BOOLEAN

Valid Values: true, false

Default: false

This setting helps the optimizer avoid redundant function calls.

Name: IS_PARALLEL_ENABLE

Type: BOOLEAN

Valid Values: true, false

Default: false

This option sets flag to a stored function can be used safely in the slave sessions of parallel DML evaluations.

Basic properties for PARAMETER:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: ''

Business name of the Parameter

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of the Parameter

Name: DATATYPE

Type: STRING

Valid Values: 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

alterFuncProcParameterSCOClause

Second class object clause to modify, delete or add a Parameter for Function/Procedure.

propertyNameList

Comma separated list of property names. Property names are unquoted.

propertyValueList

Comma separated list of property values.

alterFuncProcParameterClause

This clause alters Parameter of a Function.

modifyFuncProcParameterClause

Modify one or more Parameters to this Function/Procedure.

deleteFuncProcParameterClause

Delete one or more Parameters to this Function/Procedure.

propertyValue

Value of a property.

moveToClause

Move a Parameters of this Function/Procedure.

Examples

OMBALTER FUNCTION 'func' RENAME TO 'function_1' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a function_1', 'function_1') This will rename the Function "func" to "function_1", and set its description to "This becomes a function_1", set its business name to "function_1" If Packaged Function is overloaded, first find the Signature by using OMBLIST command, and then use OMBALTER command using appropriate signature. Example, if OMBLIST FUNCTIONS gives following two signatures, FUNC_1 (NUMBER) RETURN NUMBER FUNC_1 (VARCHAR2, NUMBER) RETURN NUMBER The OMBALTER

Syntax

to modify the first one will be as follows OMBALTER FUNCTION 'FUNC_1 \(NUMBER\) RETURN NUMBER' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('descri_FUNC_1', 'FUNC_1')

See Also

OMBALTER, OMBCREATE FUNCTION, OMBDROP FUNCTION


OMBALTER LOCATION

Purpose

OMBALTER LOCATION - Alter the location by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of a project.

Syntax Diagrams

Description of alterLocationCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesForModifyClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterLocationCommand = OMBALTER ( LOCATION "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesForModifyClause" ] | SET "setPropertiesForModifyClause" ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesForModifyClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterLocationCommand

Alter the location specified by the quoted string.

renameClause

Rename the location to the value of the following quoted string.

setPropertiesForModifyClause

Set or alter specified properties of the location.

propertyNameList

The names of the properties whose values you want to set.

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

propertyValueList

The values for the named properties.

propertyValue

A property value.

Examples

OMBALTER LOCATION 'OLD_LOCATION' RENAME TO 'NEW_LOCATION' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a new location.', 'new location') This will rename the location "OLD_LOCATION" to "NEW_LOCATION", and set its description to "This becomes a new location", set its business name to "new location".

See Also

OMBALTER, OMBCREATE LOCATION, OMBDROP LOCATION


OMBALTER MAPPING

Purpose

OMBALTER MAPPING - Alter the content of a mapping.

Prerequisites

1. The current context of scripting must be an Oracle Module

2. No concurrent user should be modifying the mapping

Syntax Diagrams

Description of alterMappingCommand.jpg is in surrounding text
Description of mappingName.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of alterMapDecendantsClause.jpg is in surrounding text
Description of propertyKeyList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of addOperatorClause.jpg is in surrounding text
Description of addGroupClause.jpg is in surrounding text
Description of addAttributeClause.jpg is in surrounding text
Description of addChildClause.jpg is in surrounding text
Description of addConnectionClause.jpg is in surrounding text
Description of modifyOperatorClause.jpg is in surrounding text
Description of modifyGroupClause.jpg is in surrounding text
Description of modifyAttributeClause.jpg is in surrounding text
Description of modifyChildClause.jpg is in surrounding text
Description of operatorLocator.jpg is in surrounding text
Description of groupBottomUpLocator.jpg is in surrounding text
Description of attributeBottomUpLocator.jpg is in surrounding text
Description of childBottomUpLocator.jpg is in surrounding text
Description of deleteConnectionLocator.jpg is in surrounding text
Description of propertyKey.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text
Description of operatorType.jpg is in surrounding text
Description of operatorName.jpg is in surrounding text
Description of setBindingClause.jpg is in surrounding text
Description of groupDirection.jpg is in surrounding text
Description of groupName.jpg is in surrounding text
Description of attributeName.jpg is in surrounding text
Description of childType.jpg is in surrounding text
Description of childName.jpg is in surrounding text
Description of childOwnerBottomUpLocator.jpg is in surrounding text
Description of groupToGroupConnectType.jpg is in surrounding text
Description of attributesBottomUpLocator.jpg is in surrounding text
Description of mappableBottomUpLocator.jpg is in surrounding text
Description of bindableLocator.jpg is in surrounding text
Description of attributeNameList.jpg is in surrounding text
Description of bindableType.jpg is in surrounding text
Description of bindableName.jpg is in surrounding text

Syntax

alterMappingCommand = OMBALTER MAPPING "mappingName" ( "renameClause" [ "setPropertiesClause" ] [ "alterMapDecendantsClause" ] | "setPropertiesClause" [ "alterMapDecendantsClause" ] | "alterMapDecendantsClause" );

mappingName = "QUOTED_STRING";renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = SET PROPERTIES "propertyKeyList" VALUES "propertyValueList";alterMapDecendantsClause = ( ADD ( "addOperatorClause" | "addGroupClause" | "addAttributeClause" | "addChildClause" | "addConnectionClause" ) | MODIFY ( "modifyOperatorClause" | "modifyGroupClause" | "modifyAttributeClause" | "modifyChildClause" ) | DELETE ( "operatorLocator" | "groupBottomUpLocator" | "attributeBottomUpLocator" | "childBottomUpLocator" | "deleteConnectionLocator" ) )+;propertyKeyList = "(" "propertyKey" { "," "propertyKey" } ")";propertyValueList = "(" "propertyValue" { "," "propertyValue" } ")";addOperatorClause = "operatorType" OPERATOR "operatorName" [ "setPropertiesClause" ] [ "setBindingClause" ];

addGroupClause = "groupDirection" GROUP "groupName" OF "operatorLocator" [ "setPropertiesClause" ];addAttributeClause = ATTRIBUTE "attributeName" OF "groupBottomUpLocator" [ "setPropertiesClause" ];addChildClause = "childType" "childName" "childOwnerBottomUpLocator" [ "setPropertiesClause" ];addConnectionClause = CONNECTION FROM ( "groupBottomUpLocator" TO "groupBottomUpLocator" [ "groupToGroupConnectType" ] | "attributeBottomUpLocator" TO ( "attributeBottomUpLocator" | "attributesBottomUpLocator" | "groupBottomUpLocator" ) | "attributesBottomUpLocator" TO ( "attributesBottomUpLocator" | "groupBottomUpLocator" ) );modifyOperatorClause = "operatorLocator" ( "renameClause" | "setPropertiesClause" );modifyGroupClause = "groupBottomUpLocator" ( "renameClause" | "setPropertiesClause" );modifyAttributeClause = "attributeBottomUpLocator" ( "renameClause" | "setPropertiesClause" );modifyChildClause = "childBottomUpLocator" ( "renameClause" | "setPropertiesClause" );operatorLocator = OPERATOR "operatorName";groupBottomUpLocator = GROUP "groupName" OF "operatorLocator";attributeBottomUpLocator = ATTRIBUTE "attributeName" OF "groupBottomUpLocator";childBottomUpLocator = "childType" "childName" { OF "childType" "childName" } [ OF "mappableBottomUpLocator" ];deleteConnectionLocator = CONNECTION ( FROM "mappableBottomUpLocator" [ TO "mappableBottomUpLocator" ] | TO "mappableBottomUpLocator" );propertyKey = "UNQUOTED_STRING";

propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );operatorType = "UNQUOTED_STRING";operatorName = "QUOTED_STRING";setBindingClause = BOUND TO "bindableLocator";groupDirection = INPUT | OUTPUT | INPUT_OUTPUT;

groupName = "QUOTED_STRING";attributeName = "QUOTED_STRING";childType = "UNQUOTED_STRING";childName = "QUOTED_STRING";childOwnerBottomUpLocator = { OF "childType" "childName" } [ OF "mappableBottomUpLocator" ];

groupToGroupConnectType = COPY ALL | BY ( NAME [ IGNORE ( SPECIAL_CHARS "QUOTED_STRING" | SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX "QUOTED_STRING" | TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX "QUOTED_STRING" ) { "," IGNORE ( SPECIAL_CHARS "QUOTED_STRING" | SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX "QUOTED_STRING" | TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX "QUOTED_STRING" ) } ] | POSITION );attributesBottomUpLocator = ATTRIBUTES "attributeNameList" OF "groupBottomUpLocator";

mappableBottomUpLocator = "operatorLocator" | "groupBottomUpLocator" | "attributeBottomUpLocator";bindableLocator = "bindableType" "bindableName";attributeNameList = "(" "attributeName" { "," "attributeName" } ")";bindableType = "UNQUOTED_STRING";

bindableName = "QUOTED_STRING";

Keywords and Parameters

alterMappingCommand

Alter the content of a mapping.

mappingName

Name of the mapping.

renameClause

Rename a mapping, mapping operator, mapping group, or mapping attribute.

setPropertiesClause

Describe the keys of properties for the map or objects in the map.

alterMapDecendantsClause

Alter a map by adding, modifying or deleting its descendants.

propertyKeyList

The list of property keys

propertyValueList

A list of property values.

addOperatorClause

Adds a mapping operator to a map. When you add an operator, Warehouse Builder creates default groups and parameters for the operator. Please see the appendix section of the Scripting Reference.

The following is an example for creating a child object under a mapping (which is not an operator) OMBALTER MAPPING 'M1' ADD SOURCE_DATA_FILE 'FILE1'

The following is an example for creating an operator:

OMBALTER MAPPING 'M1' ADD TABLE OPERATOR 'T1'

In the second example, when user forgets to type "OPERATOR" "GROUP" "ATTRIBUTE" key word, instead of complaining the keywords are missing, OMBPlus will complain about error getting child objects. Here is an example: OMB+> OMBALTER MAPPING 'M1' ADD TABLE 'T1' OMB02932: Error getting child objects of type TABLE in M1

TO A USER: it looks like OMBPlus should complain they forget to type a keyword.

TO OMBPLUS: the syntax is actually for creating a non-operator child object

under the mapping. Therefore, it goes and tries to find type definition for

non-operator child object "TABLE" and cannot find it. Therefore the exception is thrown.

addGroupClause

Add a mapping group to a mapping operator.

addAttributeClause

Add a mapping attribute to a mapping group.

addChildClause

Add a child to a mapping, mapping operator, mapping group or mapping attribute.

addConnectionClause

Add connections between mapping groups or mapping attributes.

modifyOperatorClause

Modify a mapping operator.

modifyGroupClause

Modify a mapping group.

modifyAttributeClause

Modify a mapping attribute.

modifyChildClause

Modify a child that belongs to a mapping, mapping operator, mapping group or mapping attribute.

operatorLocator

Location of a mapping operator.

groupBottomUpLocator

Location of a mapping group.

attributeBottomUpLocator

Location of a mapping attribute.

childBottomUpLocator

Location of the child that belongs to a map, mapping operator, mapping group or mapping attribute.

deleteConnectionLocator

Delete connections between mapping operators, mapping groups or mapping attributes.

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

propertyValue

A single property value. It can be a number, float, boolean or single-quoted string.

operatorType

Type of a mapping operator. The following operator types are available: ADVANCED_QUEUE, AGGREGATOR, 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.

operatorName

Name of a mapping operator.

setBindingClause

Set the binding during the creation of a mapping operator or mapping attribute.

groupDirection

Direction of a mapping group.

groupName

Name of a mapping group.

attributeName

Name of a mapping attribute.

childType

Type of a child that belongs to map, mapping operator, mapping group or mapping attribute.

childName

Name of a child that belongs to map, mapping operator, mapping group or mapping attribute.

childOwnerBottomUpLocator

Location of a child owner. A child owner can be a map, mapping operator, mapping group, mapping attribute or a child.

groupToGroupConnectType

Connecting from a mapping group in one mapping operator to a mapping group in another mapping operator.

attributesBottomUpLocator

Location of a list of mapping attributes.

mappableBottomUpLocator

Location of the object to be bound to a mapping mapping operator or mapping

attribute.

bindableLocator

Location of the object to be bound to a mapping operator or mapping attribute.

attributeNameList

A list of attribute names.

bindableType

Type of object bound to a mapping operator or mapping attribute.

bindableName

Name of the object bound to a mapping operator or mapping attribute.

Examples

OMBALTER MAPPING 'MAP1' RENAME TO 'MAP2'

OMBALTER MAPPING 'MAP1'

ADD CONNECTION FROM GROUP 'INOUTGRP1' OF OPERATOR 'CUST_SRC'

TO GROUP 'INOUTGRP1' OF OPERATOR 'CUST_LOOK_UP'

OMBALTER MAPPING 'MAP1' DELETE OPERATOR 'OP1'

See Also

OMBALTER, OMBCREATE MAPPING, OMBRETRIEVE MAPPING, OMBDROP MAPPING


OMBALTER MATERIALIZED_VIEW

Purpose

OMBALTER MATERIALIZED_VIEW - To alter properties and definition of a materialized view.

Prerequisites

In the context of an Oracle Module.

Syntax Diagrams

Description of alterMaterializedViewCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of alterViewSCOClauses.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of addColumnClauseForAlter.jpg is in surrounding text
Description of addConstraintClause.jpg is in surrounding text
Description of alterViewConstraintClauses.jpg is in surrounding text
Description of addConfigurationClause.jpg is in surrounding text
Description of alterViewConfigurationClauses.jpg is in surrounding text
Description of modifyColumnClause.jpg is in surrounding text
Description of modifyConstraintClause.jpg is in surrounding text
Description of modifyConfigurationClause.jpg is in surrounding text
Description of deleteColumnClause.jpg is in surrounding text
Description of deleteConstraintClause.jpg is in surrounding text
Description of deleteConfigurationClause.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text
Description of addUkPkClause.jpg is in surrounding text
Description of addFkClause.jpg is in surrounding text
Description of addCheckConstraintClause.jpg is in surrounding text
Description of addViewConstraintClause.jpg is in surrounding text
Description of modifyViewConstraintClause.jpg is in surrounding text
Description of deleteViewConstraintClause.jpg is in surrounding text
Description of addIndexClause.jpg is in surrounding text
Description of addPartitionClause.jpg is in surrounding text
Description of addPartitionKeyClause.jpg is in surrounding text
Description of addIndexColumnClause.jpg is in surrounding text
Description of moveToClause.jpg is in surrounding text
Description of modifyUkPkClause.jpg is in surrounding text
Description of modifyFkClause.jpg is in surrounding text
Description of modifyCheckConstraintClause.jpg is in surrounding text
Description of modifyIndexClause.jpg is in surrounding text
Description of modifyPartitionClause.jpg is in surrounding text
Description of modifyPartitionKeyClause.jpg is in surrounding text
Description of modifyIndexColumnClause.jpg is in surrounding text
Description of setUkPkPropertiesAndReferencesColumnsClauses.jpg is in surrounding text
Description of setFkSubClauses.jpg is in surrounding text
Description of setSCOConfigurationPropertiesClauses.jpg is in surrounding text
Description of renameSCOConfigurationClause.jpg is in surrounding text
Description of constraintColumnReferencesClause.jpg is in surrounding text
Description of setFkReferencesClauses.jpg is in surrounding text
Description of quotedNameList.jpg is in surrounding text
Description of constraintUkReferencesClause.jpg is in surrounding text

Syntax

alterMaterializedViewCommand = OMBALTER ( MATERIALIZED_VIEW "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] [ "alterViewSCOClauses" ] | SET "setPropertiesClause" [ "alterViewSCOClauses" ] | "alterViewSCOClauses" ) );

renameClause = RENAME TO "QUOTED_STRING";

setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";

alterViewSCOClauses = ADD ( "addColumnClauseForAlter" [ "alterViewSCOClauses" ] | "addConstraintClause" { "alterViewConstraintClauses" } | "addConfigurationClause" { "alterViewConfigurationClauses" } ) | MODIFY ( "modifyColumnClause" [ "alterViewSCOClauses" ] | "modifyConstraintClause" { "alterViewConstraintClauses" } | "modifyConfigurationClause" { "alterViewConfigurationClauses" } ) | DELETE ( "deleteColumnClause" [ "alterViewSCOClauses" ] | "deleteConstraintClause" { "alterViewConstraintClauses" } | "deleteConfigurationClause" { "alterViewConfigurationClauses" } );propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };addColumnClauseForAlter = COLUMN "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ];addConstraintClause = "addUkPkClause" | "addFkClause" | "addCheckConstraintClause";alterViewConstraintClauses = ADD "addViewConstraintClause" | MODIFY "modifyViewConstraintClause" | DELETE "deleteViewConstraintClause";addConfigurationClause = "addIndexClause" | "addPartitionClause" | "addPartitionKeyClause" | "addIndexColumnClause";

alterViewConfigurationClauses = ADD "addConfigurationClause" | MODIFY "modifyConfigurationClause" | DELETE "deleteConfigurationClause";

modifyColumnClause = COLUMN "QUOTED_STRING" ( "renameClause" [ "moveToClause" ] [ SET "setPropertiesClause" ] | "moveToClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" );modifyConstraintClause = "modifyUkPkClause" | "modifyFkClause" | "modifyCheckConstraintClause";modifyConfigurationClause = "modifyIndexClause" | "modifyPartitionClause" | "modifyPartitionKeyClause" | "modifyIndexColumnClause";deleteColumnClause = COLUMN "QUOTED_STRING";deleteConstraintClause = UNIQUE_KEY "QUOTED_STRING" | PRIMARY_KEY "QUOTED_STRING" | FOREIGN_KEY "QUOTED_STRING" | CHECK_CONSTRAINT "QUOTED_STRING";

deleteConfigurationClause = INDEX "QUOTED_STRING" | PARTITION "QUOTED_STRING" | PARTITION_KEY "QUOTED_STRING" | INDEX_COLUMN "QUOTED_STRING" OF INDEX "QUOTED_STRING";propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

addUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ];addFkClause = FOREIGN_KEY "QUOTED_STRING" [ SET "setFkSubClauses" ];addCheckConstraintClause = CHECK_CONSTRAINT "QUOTED_STRING" [ SET "setPropertiesClause" ];addViewConstraintClause = "addUkPkClause" | "addFkClause";modifyViewConstraintClause = "modifyUkPkClause" | "modifyFkClause";deleteViewConstraintClause = UNIQUE_KEY "QUOTED_STRING" | PRIMARY_KEY "QUOTED_STRING" | FOREIGN_KEY "QUOTED_STRING";addIndexClause = INDEX "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];addPartitionClause = PARTITION "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];addPartitionKeyClause = PARTITION_KEY "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];addIndexColumnClause = INDEX_COLUMN "QUOTED_STRING" OF INDEX "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];moveToClause = MOVE TO POSITION "INTEGER_LITERAL";modifyUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" ( "renameClause" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ] | SET "setUkPkPropertiesAndReferencesColumnsClauses" );modifyFkClause = FOREIGN_KEY "QUOTED_STRING" ( "renameClause" [ SET "setFkSubClauses" ] | SET "setFkSubClauses" );modifyCheckConstraintClause = CHECK_CONSTRAINT "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" );modifyIndexClause = INDEX "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );modifyPartitionClause = PARTITION "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );

modifyPartitionKeyClause = PARTITION_KEY "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );

modifyIndexColumnClause = INDEX_COLUMN "QUOTED_STRING" OF INDEX "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );

setUkPkPropertiesAndReferencesColumnsClauses = "setPropertiesClause" [ SET ( REF | REFERENCE ) "constraintColumnReferencesClause" ] | ( REF | REFERENCE ) "constraintColumnReferencesClause";setFkSubClauses = "setPropertiesClause" [ SET ( REF | REFERENCE ) "setFkReferencesClauses" ] | ( REF | REFERENCE ) "setFkReferencesClauses";setSCOConfigurationPropertiesClauses = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";

renameSCOConfigurationClause = RENAME TO "QUOTED_STRING";constraintColumnReferencesClause = COLUMNS "(" "quotedNameList" ")";

setFkReferencesClauses = "constraintColumnReferencesClause" [ SET ( REF | REFERENCE ) "constraintUkReferencesClause" ] | "constraintUkReferencesClause" [ SET ( REF | REFERENCE ) "constraintColumnReferencesClause" ];

quotedNameList = "QUOTED_STRING" { "," "QUOTED_STRING" };

constraintUkReferencesClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ OF ( TABLE | VIEW ) "QUOTED_STRING" ];

Keywords and Parameters

alterMaterializedViewCommand

This clause alters a materialized view.

QUOTED_STRING

name of the materialized view.

renameClause

renames a table with a different name.

setPropertiesClause

Used to set properties (core, logical, physical, user-defined) for tables, columns, unique keys, foreign keys, primary keys, and check constraints.

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

alterViewSCOClauses

This clause alters the view clause.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

addColumnClauseForAlter

This clause adds a column at a particular position

QUOTED_STRING

The column name.

addConstraintClause

Adds primary and unique key, and add check constraints.

alterViewConstraintClauses

This clause alters the view's constraint clause.

addConfigurationClause

This clause will add configuration objects.

alterViewConfigurationClauses

This clause alters the view's configuration clause.

modifyColumnClause

This clause renames, set properties, and move columns.

modifyConstraintClause

This clause modifies keys and check constraints

modifyConfigurationClause

This clause will modify configuration objects.

deleteColumnClause

This clause deletes a column.

deleteConstraintClause

This clause deletes a key or check constraint.

deleteConfigurationClause

This clause deletes a configuration object.

QUOTED_STRING

Either index, partition, partition_key, or index column name.

propertyValue

This clause adds the property values.

addUkPkClause

This clause adds the adds unique key and primary keys.

QUOTED_STRING

name of the unique key or primary key.

addFkClause

This clause adds foreign key

QUOTED_STRING

Name of the foreign key.

addCheckConstraintClause

add a check constraint.

QUOTED_STRING

Name of the CheckConstraint.

addViewConstraintClause

This clause adds the view's configuration clause.

modifyViewConstraintClause

= This clause modifies the view's constraint clause.

deleteViewConstraintClause

This clause deletes the view's constraint.

addIndexClause

This clause adds an index.

QUOTED_STRING

Name of the index.

addPartitionClause

This clause adds a partition.

QUOTED_STRING

Name of the partition.

addPartitionKeyClause

This clause adds a partition key.

QUOTED_STRING

Name of the partition key. This should be a column identifier.

addIndexColumnClause

This clause will add indexColumn to a specified index.

QUOTED_STRING

Index name

moveToClause

This clause will move the column to given position.

modifyUkPkClause

It modifies unique or primary key.

modifyFkClause

This clause modifies the foreign key.

modifyCheckConstraintClause

This clause modifies the check constraint.

modifyIndexClause

This clause modifies the Index

QUOTED_STRING

Name of the index.

modifyPartitionClause

This clause modifies a partition

QUOTED_STRING

Name of the partition.

modifyPartitionKeyClause

This clause modifies a partition key.

QUOTED_STRING

Name of the partition key.

modifyIndexColumnClause

Modifies the Index Column. The first quoted_string in this clause denotes index column name, and the latter denotes index.

setUkPkPropertiesAndReferencesColumnsClauses

This clause adds properties and references to columns

setFkSubClauses

This clause set references to a foreign key.

setSCOConfigurationPropertiesClauses

Set the configuration properties for the following objects Index: LOGGING_MODE, PARALLEL_ACCESS_MODE, TABLESPACE, INDEX_TYPE, LOCAL_INDEX, DEPLOYABLE Partition: DATE_LESS_THAN, TABLESPACE, DEPLOYABLE Partition_key: TYPE, DEPLOYABLE RelationalCmdParser$constraintColumnReferencesClause = This clause provides names of all columns.

renameSCOConfigurationClause

This clause renames configuration objects.

constraintColumnReferencesClause

RelationalCmdParser$constraintColumnReferencesClause??

setFkReferencesClauses

This clause sets foreign key references.

quotedNameList

This clause gives column names.

constraintUkReferencesClause

The first QUOTED_STRING denotes the UniqueKey or Primay key name, and the latter denotes the table's or view's name.

Examples

OMBALTER MATERIALIZED_VIEW 'NEW_MATERIALIZED_VIEW' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('this is an altered desc of new materialized view', 'Altered New MaterializedView') This will alter a materialized view named "NEW_MATERIALIZED_VIEW", its description is "this is an altered desc of new materialized view", and business name is "Altered New MaterializedView".

See Also

OMBALTER, OMBCREATE MATERIALIZED_VIEW, OMBDROP MATERIALIZED_VIEW


OMBALTER OBJECT_TYPE

Purpose

OMBALTER OBJECT_TYPE - Alter the Object Type by resetting its properties or

adding/removing its attributes.

Prerequisites

Should be in the context of an Oracle Module.

Syntax Diagrams

Description of alterObjectTypeCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of alterAttributesClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of addAttributeClause.jpg is in surrounding text
Description of deleteAttributeClause.jpg is in surrounding text
Description of modifyAttributeClause.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterObjectTypeCommand = OMBALTER ( OBJECT_TYPE "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] [ "alterAttributesClause" ] | SET "setPropertiesClause" [ "alterAttributesClause" ] | "alterAttributesClause" ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";alterAttributesClause = ( "addAttributeClause" | "deleteAttributeClause" | "modifyAttributeClause" )+;propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };addAttributeClause = ADD OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING" [ SET "setPropertiesClause" ];deleteAttributeClause = DELETE OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING";modifyAttributeClause = MODIFY OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" );propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterObjectTypeCommand

Alters an Object Type of the given name by either renaming it, or by setting it's properties or by modifying one or more of its Attributes or a combination of these.

renameClause

renames a table with a different name.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Object Type or its Attributes.

Basic properties for OBJECT_TYPE:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: ''

Business name of the Object Type

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of the Object Type

Basic properties for OBJECT_TYPE_ATTRIBUTE:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: ''

Business name of the Attribute

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of the Attribute

Name: DATATYPE

Type: STRING(20)

Valid Values: 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

alterAttributesClause

Adds, deletes or modifies one or more Attributes of this Object Type.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

addAttributeClause

Adds an Attribute with the given name and properties.

deleteAttributeClause

Deletes an Attribute with the given name.

modifyAttributeClause

Modifies an Attribute with the given name by either renaming it or changing

its properties or both.

propertyValue

This clause adds the property values.

Examples

OMBALTER OBJECT_TYPE 'SOME_OBJECT_TYPE' SET PROPERTIES (DESCRIPTION) VALUES

('This is will be used as Payload type for an AQ.') DELETE OBJECT_TYPE_ATTRIBUTE 'ATTR' ADD OBJECT_TYPE_ATTRIBUTE 'ATTR1' SET PROPERTIES (DATATYPE) VALUES ('NUMBER') This will set its description to "This is will be used as Payload type for an AQ.", remove attribute 'ATTR' and add an attribute "ATTR1" of Number type.

See Also

ALTER, OMBRETRIEVE OBJECT_TYPE, OMBCREATE OBJECT_TYPE, OMBDROP OBJECT_TYPE


OMBALTER ORACLE_MODULE

Purpose

OMBALTER ORACLE_MODULE - Alter the Oracle module by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of project.

Syntax Diagrams

Description of alterOracleModuleCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of alterPropertiesOrLocationClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of setReferenceLocationClause.jpg is in surrounding text
Description of unsetReferenceLocationClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterOracleModuleCommand = OMBALTER ( ORACLE_MODULE "QUOTED_STRING" ( "renameClause" [ "alterPropertiesOrLocationClause" ] | "alterPropertiesOrLocationClause" ) );renameClause = RENAME TO "QUOTED_STRING";alterPropertiesOrLocationClause = SET ( "setPropertiesClause" [ SET "setReferenceLocationClause" | UNSET "unsetReferenceLocationClause" ] | "setReferenceLocationClause" ) | UNSET "unsetReferenceLocationClause";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING";unsetReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterOracleModuleCommand

This command modifies an existing Oracle module.

QUOTED_STRING

Name of the existing Oracle module in single quotes.

renameClause

Rename an Oracle module.

alterPropertiesOrLocationClause

Alter existing Oracle module's properties and/or location.

setPropertiesClause

Associate a set of properties with the existing Oracle module.

Basic properties for ORACLE_MODULE:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: NAME

Business name of an Oracle Module

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of an Oracle Module

Name: UOID

Type: STRING(40)

Valid Values: N/A

Default: N/A

UOID of 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

setReferenceLocationClause

Set a location to the existing Oracle module.

unsetReferenceLocationClause

Unset a location to the existing Oracle module.

propertyNameList

Comma separated list of property names. Property names are unquoted.

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

Examples

OMBALTER ORACLE_MODULE 'src_module' RENAME TO 'tgt_module' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a target module.', 'target module') This will rename the Oracle module "src_module" to "tgt_module", and set its description to "This becomes a target module.", set its business name to "target module".

See Also

OMBALTER, OMBCREATE ORACLE_MODULE, OMBDROP ORACLE_MODULE


OMBALTER PACKAGE

Purpose

OMBALTER PACKAGE - Alter the Package by renaming it, and/or reset its properties, and/or adding/deleting/modifying the user types.

Prerequisites

Should be in the context of a Oracle Module or Transformation Module.

Syntax Diagrams

Description of alterPackageCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterPackageCommand = OMBALTER ( PACKAGE "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterPackageCommand

This command modifies an existing Package.

QUOTED_STRING

Name of the existing Package in single quotes.

renameClause

Rename a Package.

setPropertiesClause

Used to set 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_BODY

Type: STRING

Valid Values: N/A

Default: ''

Sets the Package Body for a Imported Package

Properties for PACKAGE:

Name: AUTHID

Type: STRING

Valid Values: 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.

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

Examples

OMBALTER PACKAGE 'pkg' RENAME TO 'package_1' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a package_1', 'package_1') This will rename the Package "pkg" to "package_1", and set its description to "This becomes a package_1", set its business name to "package_1"

See Also

OMBALTER, OMBCREATE PACKAGE, OMBDROP PACKAGE


OMBALTER PROCEDURE

Purpose

OMBALTER PROCEDURE - Alter the Procedure by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of a Oracle Module or Package or Transformation Module.

Syntax Diagrams

Description of alterProcedureCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of alterFuncProcParameterSCOClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of alterFuncProcParameterClause.jpg is in surrounding text
Description of modifyFuncProcParameterClause.jpg is in surrounding text
Description of deleteFuncProcParameterClause.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text
Description of moveToClause.jpg is in surrounding text

Syntax

alterProcedureCommand = OMBALTER ( PROCEDURE "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] [ "alterFuncProcParameterSCOClause" ] | SET "setPropertiesClause" [ "alterFuncProcParameterSCOClause" ] | "alterFuncProcParameterSCOClause" ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";alterFuncProcParameterSCOClause = ( ADD "alterFuncProcParameterClause" [ "alterFuncProcParameterSCOClause" ] | MODIFY "modifyFuncProcParameterClause" [ "alterFuncProcParameterSCOClause" ] | DELETE "deleteFuncProcParameterClause" [ "alterFuncProcParameterSCOClause" ] );propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };alterFuncProcParameterClause = PARAMETER "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ];modifyFuncProcParameterClause = ( PARAMETER "QUOTED_STRING" ( "renameClause" | "moveToClause" | [ SET "setPropertiesClause" ] ) );deleteFuncProcParameterClause = ( PARAMETER "QUOTED_STRING" );propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );moveToClause = MOVE TO POSITION "INTEGER_LITERAL";

Keywords and Parameters

alterProcedureCommand

This command modifies an existing Procedure.

QUOTED_STRING

Name of the existing Procedure in single quotes.

renameClause

Rename a Procedure.

setPropertiesClause

Used to set properties (core, user-defined) for procedure. Valid properties

are shown below:

Basic properties for PROCEDURE:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: ''

Business name of the Procedure

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of the Procedure

Name: IMPLEMENTATION

Type: STRING

Valid Values: N/A

Default: ''

Set the code for Procedure which is included global variable declaration and code between BEGIN and END.

Basic properties for PARAMETER:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: ''

Business name of the Parameter

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of the Parameter

Name: DATATYPE

Type: STRING

Valid Values: 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

alterFuncProcParameterSCOClause

Second class object clause to modify, delete or add a Parameter for Function/Procedure.

propertyNameList

Comma separated list of property names. Property names are unquoted.

propertyValueList

Comma separated list of property values.

alterFuncProcParameterClause

This clause alters Parameter of a Procedure.

modifyFuncProcParameterClause

Modify one or more Parameters to this Function/Procedure.

deleteFuncProcParameterClause

Delete one or more Parameters to this Function/Procedure.

propertyValue

Value of a property.

moveToClause

Move a Parameters of this Function/Procedure.

Examples

OMBALTER PROCEDURE 'proc' RENAME TO 'proc_1' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a proc_1', 'proc') This will rename the Procedure "proc" to "proc_1", and set its description to "This becomes a proc_1", set its business name to "proc". If Packaged Function is overloaded, first find the Signature by using OMBLIST command, and then use OMBALTER command using appropriate signature. Example, if OMBLIST PROCEDURES gives following two signatures, PROC_1 (NUMBER) PROC_1 (VARCHAR2, NUMBER) The OMBALTER

Syntax

to modify the first one will be as follows OMBALTER PROCEDURE 'PROC_1 \(NUMBER\)' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('descri_PROC_1', 'PROC_1')

See Also

OMBALTER, OMBCREATE PROCEDURE, OMBDROP PROCEDURE


OMBALTER PROCESS_FLOW

Purpose

OMBALTER PROCESS_FLOW - Alter the Process Flow by renaming it, and/or reset

its properties.

Prerequisites

Should be in the context of a Process Flow Package.

Syntax Diagrams

Description of alterProcessFlowCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of alterProcessFlowSCOClauses.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of addProcessParameterClause.jpg is in surrounding text
Description of addActivityClause.jpg is in surrounding text
Description of addTransitionClause.jpg is in surrounding text
Description of modifyProcessParameterClause.jpg is in surrounding text
Description of modifyActivityClause.jpg is in surrounding text
Description of modifyUserDefinedActivityClause.jpg is in surrounding text
Description of modifyTransitionClause.jpg is in surrounding text
Description of deleteProcessParameterClause.jpg is in surrounding text
Description of deleteActivityClause.jpg is in surrounding text
Description of deleteTransitionClause.jpg is in surrounding text
Description of deleteUserDefinedParameterClause.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text
Description of addStandardActivityClause.jpg is in surrounding text
Description of addMapActivityClause.jpg is in surrounding text
Description of addFunctionActivityClause.jpg is in surrounding text
Description of addSubProcessActivityClause.jpg is in surrounding text
Description of modifyActivityParameterClause.jpg is in surrounding text
Description of modifyUDActivityParameterClause.jpg is in surrounding text
Description of collectPropertiesClause.jpg is in surrounding text
Description of setPropertiesAndReferencesMapClauses.jpg is in surrounding text
Description of setPropertiesAndReferencesFunctionClauses.jpg is in surrounding text
Description of setPropertiesAndReferencesSubProcessClauses.jpg is in surrounding text
Description of modifyActivityParameter.jpg is in surrounding text
Description of addUDActivityParameterClause.jpg is in surrounding text
Description of alterUDActivityParameterClause.jpg is in surrounding text
Description of deleteUDActivityParameterClause.jpg is in surrounding text

Syntax

alterProcessFlowCommand = OMBALTER PROCESS_FLOW "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] [ "alterProcessFlowSCOClauses" ] | SET "setPropertiesClause" [ "alterProcessFlowSCOClauses" ] | "alterProcessFlowSCOClauses" );

renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";

alterProcessFlowSCOClauses = ADD ( "addProcessParameterClause" [ "alterProcessFlowSCOClauses" ] | "addActivityClause" [ "alterProcessFlowSCOClauses" ] | "addTransitionClause" [ "alterProcessFlowSCOClauses" ] ) | MODIFY ( "modifyProcessParameterClause" [ "alterProcessFlowSCOClauses" ] | "modifyActivityClause" [ "alterProcessFlowSCOClauses" ] | "modifyUserDefinedActivityClause" [ "alterProcessFlowSCOClauses" ] | "modifyTransitionClause" [ "alterProcessFlowSCOClauses" ] ) | DELETE ( "deleteProcessParameterClause" [ "alterProcessFlowSCOClauses" ] | "deleteActivityClause" [ "alterProcessFlowSCOClauses" ] | "deleteTransitionClause" [ "alterProcessFlowSCOClauses" ] | "deleteUserDefinedParameterClause" [ "alterProcessFlowSCOClauses" ] );

propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };

propertyValueList = "propertyValue" { "," "propertyValue" };

addProcessParameterClause = ( PARAMETER "QUOTED_STRING" ) [ SET "setPropertiesClause" ];

addActivityClause = ( "addStandardActivityClause" | "addMapActivityClause" | "addFunctionActivityClause" | "addSubProcessActivityClause" );

addTransitionClause = ( TRANSITION "QUOTED_STRING" ( FROM ACTIVITY "QUOTED_STRING" ) ( TO "QUOTED_STRING" ) ) [ SET "setPropertiesClause" ];

modifyProcessParameterClause = PARAMETER "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" );

modifyActivityClause = ACTIVITY "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] [ "modifyActivityParameterClause" ] | SET "setPropertiesClause" [ "modifyActivityParameterClause" ] | "modifyActivityParameterClause" );

modifyUserDefinedActivityClause = USER_DEFINED ACTIVITY "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] [ "modifyUDActivityParameterClause" ] | SET "setPropertiesClause" [ "modifyUDActivityParameterClause" ] | "modifyUDActivityParameterClause" );modifyTransitionClause = TRANSITION "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" );

deleteProcessParameterClause = PARAMETER "QUOTED_STRING";deleteActivityClause = ACTIVITY "QUOTED_STRING";

deleteTransitionClause = TRANSITION "QUOTED_STRING";deleteUserDefinedParameterClause = PARAMETER "QUOTED_STRING" OF USER_DEFINED ACTIVITY "QUOTED_STRING";

propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

addStandardActivityClause = ( AND ACTIVITY "QUOTED_STRING" | OR ACTIVITY "QUOTED_STRING" | FORK ACTIVITY "QUOTED_STRING" | FTP ACTIVITY "QUOTED_STRING" | EMAIL ACTIVITY "QUOTED_STRING" | FILE_EXISTS ACTIVITY "QUOTED_STRING" | USER_DEFINED ACTIVITY "QUOTED_STRING" | END_WARNING ACTIVITY | END_ERROR ACTIVITY | END_SUCCESS ACTIVITY ) [ SET "setPropertiesClause" ];addMapActivityClause = ( MAPPING ACTIVITY "QUOTED_STRING" SET ( PROPERTIES "collectPropertiesClause" SET ( REF | REFERENCE ) "setPropertiesAndReferencesMapClauses" | ( REF | REFERENCE ) "setPropertiesAndReferencesMapClauses" ) );

addFunctionActivityClause = ( TRANSFORMATION ACTIVITY "QUOTED_STRING" SET ( PROPERTIES "collectPropertiesClause" SET ( REF | REFERENCE ) "setPropertiesAndReferencesFunctionClauses" | ( REF | REFERENCE ) "setPropertiesAndReferencesFunctionClauses" ) );

addSubProcessActivityClause = ( SUBPROCESS ACTIVITY "QUOTED_STRING" SET ( PROPERTIES "collectPropertiesClause" SET ( REF | REFERENCE ) "setPropertiesAndReferencesSubProcessClauses" | ( REF | REFERENCE ) "setPropertiesAndReferencesSubProcessClauses" ) );modifyActivityParameterClause = MODIFY "modifyActivityParameter" [ "modifyActivityParameterClause" ];modifyUDActivityParameterClause = ADD ( "addUDActivityParameterClause" [ "modifyUDActivityParameterClause" ] ) | MODIFY ( "alterUDActivityParameterClause" [ "modifyUDActivityParameterClause" ] ) | DELETE ( "deleteUDActivityParameterClause" [ "modifyUDActivityParameterClause" ] );

collectPropertiesClause = "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";setPropertiesAndReferencesMapClauses = ( MAPPING "QUOTED_STRING" );setPropertiesAndReferencesFunctionClauses = ( TRANSFORMATION "QUOTED_STRING" );setPropertiesAndReferencesSubProcessClauses = ( PROCESS_FLOW "QUOTED_STRING" );

modifyActivityParameter = PARAMETER "QUOTED_STRING" SET "setPropertiesClause";addUDActivityParameterClause = PARAMETER "QUOTED_STRING" [ SET "setPropertiesClause" ];

alterUDActivityParameterClause = PARAMETER "QUOTED_STRING" "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause";

deleteUDActivityParameterClause = PARAMETER "QUOTED_STRING";

Keywords and Parameters

alterProcessFlowCommand

Alter process flow.

renameClause

Rename process flow/ activity, depending on current context.

setPropertiesClause

Used to set properties (core, user-defined) for process flow. Note: For MAPPING, TRANSFORMATION and SUBPROCESS activities the setPropertiesAndReferencesMapClauses, setPropertiesAndReferencesFunctionClauses and setPropertiesAndReferencesSubProcessClauses respectively, are mandatory. For MAPPING or TRANSFORMATION activities and the REFERENCE property has to be set to a valid MAP or TRANSFORMATION within the current project. For SUBPROCESS activities the REFERENCE property has to be set to a SUBPROCESS within the same PROCESS_FLOW_PACKAGE. Valid properties are shown below:

Base properties for PROCESS_FLOW:

Basic properties for Process Flow, Activity, Transition and Parameter:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: ''

Business name of the Process Flow

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of the Process Flow Core properties for Transition :

Name: TRANSITION_CONDITION

Type: STRING

Valid Values: '', SUCCESS, ERROR, WARNING

Default: '' i.e. Unconditional

Sets the Transition Condition of a Transition

Description of the Process Flow Core properties for Activity Parameter :

Name: DATATYPE

Type: STRING

Valid Values: INTEGER, FLOAT, DATE, STRING, BOOLEAN

Default: STRING

Sets the datatype of a Activity Parameter

Name: DIRECTION

Type: STRING

Valid Values: IN

Default: IN

Sets the direction of a Activity Parameter

Name: VALUE

Type: STRING

Valid Values:

Examples

'123', '123.456', 'Jan-08-2003', 'I am String', 'true'

Default: ''

For Mapping activities representing PLSQL maps, the allowed value for the parameters: OPERATING_MODE:'SET_BASED' 'ROW_BASED' 'ROW_BASED_TARGET_ONLY' 'SET_BASED_FAIL_OVER_TO_ROW_BASED' 'SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY' AUDIT_LEVEL:'NONE' 'STATISTICS' 'ERROR_DETAILS' 'COMPLETE' Sets the value of a Activity Parameter

Name: BINDING

Type: STRING

Valid Values:

Examples

'PARAM_1', 'PARAM_2'

Default: ''

Represents the parameter on the process flow that this parameter is bound to. When setting users can specify the name of any PROCESS PARAMETER of same datatype. This feature allows for parameterizing the process flow. If the parameter is bound the VALUE property is ignored when generating the process flow. To unbind a parameter, use an empty quoted string ie. '', and the parameter will be unbound.

Properties for PROCESS_FLOW:

Name: BOUND_NAME

Type: STRING

Valid Values: N/A

Default: ''

Physical name of the object that this activity represents.

Name: DEPLOYED_LOCATION

Type: STRING

Valid Values: N/A

Default: USE_DEFAULT_LOCATION

Deployed Location of Transformation Activities only.

Name: EXECUTION_LOCATION

Type: STRING

Valid Values: N/A

Default: NATIVE_EXECUTION

The location from which this activity will be executed.

Name: REMOTE_LOCATION

Type: STRING

Valid Values: N/A

Default: USE_DEFAULT_LOCATION

Remote Location for FTP activities only.

Name: USE_RETURN_AS_STATUS

Type: BOOLEAN

Valid Values: true, false

Default: false

Use any return value to select the Transition path.

Name: WORKING_LOCATION

Type: STRING

Valid Values: N/A

Default: USE_DEFAULT_LOCATION

Working Location for FTP, FILE_EXIST and USER_DEFINED activites only.

Properties for ACTIVITY:

Name: BOUND_NAME

Type: STRING

Valid Values: N/A

Default: ''

Physical name of the object that this activity represents.

Name: DEPLOYED_LOCATION

Type: STRING

Valid Values: N/A

Default: USE_DEFAULT_LOCATION

Deployed Location of Transformation Activities only.

Name: EXECUTION_LOCATION

Type: STRING

Valid Values: N/A

Default: NATIVE_EXECUTION

The location from which this activity will be executed.

Name: REMOTE_LOCATION

Type: STRING

Valid Values: N/A

Default: USE_DEFAULT_LOCATION

Remote Location for FTP activities only.

Name: USE_RETURN_AS_STATUS

Type: BOOLEAN

Valid Values: true, false

Default: false

Use any return value to select the Transition path.

Name: WORKING_LOCATION

Type: STRING

Valid Values: N/A

Default: USE_DEFAULT_LOCATION

Working Location for FTP, FILE_EXIST and USER_DEFINED activites only.

Note:

1. N/A means any valid character in supported character set.

2. '' represents an empty string

alterProcessFlowSCOClauses

This clause is wrapper clause to add, modify or delete Process Flow's second class objects.

propertyNameList

A comma delimited set of property names to set.

propertyValueList

A comma delimited set of property values to set.

addProcessParameterClause

This clause adds the Parameters for a Process Flow.

addActivityClause

This clause adds the Activities for a Process Flow.

addTransitionClause

This clause adds the Transitions for a Process Flow.

modifyProcessParameterClause

This clause modifies the Parameters of a Process Flow.

modifyActivityClause

This clause modifies the Activities of a Process Flow.

modifyUserDefinedActivityClause

Alter the properties of the specified user defined activity.

modifyTransitionClause

This clause modifies the Transitions of a Process Flow.

deleteProcessParameterClause

This clause deletes the Parameters of a Process Flow.

deleteActivityClause

This clause deletes the Activities of a Process Flow.

deleteTransitionClause

This clause deletes the Transitions of a Process Flow.

deleteUserDefinedParameterClause

This clause deletes the Parametrers of a User Defined Activity of a Process

Flow.

propertyValue

Integer value, float value or quoted string literal.

addStandardActivityClause

This clause adds standard activity types AND, FORK, FTP, OR, USER_DEFINED to a Process Flow.

addMapActivityClause

This clause adds the MAP activity to a Process Flow.

addFunctionActivityClause

This clause adds the Function or Procedure activity to a Process Flow.

addSubProcessActivityClause

This clause adds a Process as an activity to a Process Flow.

modifyActivityParameterClause

Alter the properties of activity parameters.

modifyUDActivityParameterClause

Alter user defined activity by adding new parameters or modifying existing parameter.

collectPropertiesClause

This clause collects core properties of Map, Function/Procedure and Subprocess activity.

setPropertiesAndReferencesMapClauses

This clause sets reference to the existing Map.

setPropertiesAndReferencesFunctionClauses

This clause sets a reference to existing Function or Procedure.

setPropertiesAndReferencesSubProcessClauses

This clause sets a reference to existing Process Flow.

modifyActivityParameter

Alter the properties of the parameter.

addUDActivityParameterClause

Add more activity parameters to the user defined activity.

alterUDActivityParameterClause

In the current user defined activity, alter the properties of the activity parameter eg. rename, set DATATYPE or set VALUE.

deleteUDActivityParameterClause

For the current user defined activity, delete the activity parameter.

Examples

OMBALTER PROCESS_FLOW 'process_flow' RENAME TO 'p_flow' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a process flow.', 'process flow') This will rename the Process Flow "process_flow" to "p_flow", and set its description to "This becomes a process flow", set its business name to "process flow".

See Also

OMBALTER, OMBCREATE PROCESS_FLOW, OMBDROP PROCESS_FLOW


OMBALTER PROCESS_FLOW_MODULE

Purpose

OMBALTER PROCESS_FLOW_MODULE - Alter the Process Flow Module by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of a project.

Syntax Diagrams

Description of alterProcessFlowModuleCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of alterPropertiesOrLocationClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of setReferenceLocationClause.jpg is in surrounding text
Description of unsetReferenceLocationClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterProcessFlowModuleCommand = OMBALTER ( PROCESS_FLOW_MODULE "QUOTED_STRING" ( "renameClause" [ "alterPropertiesOrLocationClause" ] | "alterPropertiesOrLocationClause" ) );

renameClause = RENAME TO "QUOTED_STRING";alterPropertiesOrLocationClause = SET ( "setPropertiesClause" [ SET "setReferenceLocationClause" | UNSET "unsetReferenceLocationClause" ] | "setReferenceLocationClause" ) | UNSET "unsetReferenceLocationClause";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";

setReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING";unsetReferenceLocationClause = ( REFERENCE | REF ) LOCATION "QUOTED_STRING";

propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };

propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterProcessFlowModuleCommand

This command modifies an existing process flow module.

renameClause

Rename an existing process flow module.

alterPropertiesOrLocationClause

Modify the details of this process flow module.

setPropertiesClause

Set values of properties of a process flow module.

Base properties for PROCESS_FLOW_MODULE:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: NAME

Business name of a Process Flow Module

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of a Process Flow Module

setReferenceLocationClause

Set a location to a supported workflow engine.

unsetReferenceLocationClause

Unset the location of the process flow module.

propertyNameList

Comma-separated list of property names. Property names are not in quotation marks.

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

Examples

OMBALTER PROCESS_FLOW_MODULE 'process_module' RENAME TO 'p_module' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a process flow module.', 'process module') This will rename the Process Flow Module "process_module" to "p_module", and set its description to "This becomes a process flow module", set its business name to "process module".

See Also

OMBALTER, OMBCREATE PROCESS_FLOW_MODULE, OMBDROP PROCESS_FLOW_MODULE


OMBALTER PROCESS_FLOW_PACKAGE

Purpose

OMBALTER PROCESS_FLOW_PACKAGE - Alter the Process Flow Package by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of a Process Flow Module.

Syntax Diagrams

Description of alterProcessFlowPackageCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterProcessFlowPackageCommand = OMBALTER ( PROCESS_FLOW_PACKAGE "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterProcessFlowPackageCommand

Alter process flow package.

renameClause

Rename the process flow package.

setPropertiesClause

Set the properties of the process flow package.

Basic properties for PROCESS_FLOW_PACKAGE:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: ''

Business name of the Process Flow Package

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of the Process Flow Package

Note:

1. N/A means any valid character in supported character set.

2. '' represents an empty string

propertyNameList

A comma delimited set of property names to set.

propertyValueList

A comma delimited set of property values to set.

propertyValue

Integer value, float value or quoted string literal.

Examples

OMBALTER PROCESS_FLOW_PACKAGE 'process_package' RENAME TO 'p_package' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a process flow package.', 'process package') This will rename the Process Flow Package "process_package" to "p_package", and set its description to "This becomes a process flow package", set its business name to "process package".

See Also

OMBALTER, OMBCREATE PROCESS_FLOW_PACKAGE, OMBDROP PROCESS_FLOW_PACKAGE


OMBALTER PROJECT

Purpose

OMBALTER PROJECT - Alter the project by renaming it, and/or reset its properties.

Prerequisites

Should be in the top level context.

Syntax Diagrams

Description of alterProjectCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterProjectCommand = OMBALTER ( PROJECT "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterProjectCommand

Modify an existing project.

QUOTED_STRING

Name of the existing project in quotes.

renameClause

Rename a project.

setPropertiesClause

Associate a set of properties with a project.

Basic properties for PROJECT:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: N/A

Default: NAME

Business name of a Project

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: N/A

Default: ''

Description of a Project

Name: UOID

Type: STRING(40)

Valid Values: N/A

Default: N/A

UOID of a Project

propertyNameList

Comma separated list of property names. Property names are unquoted.

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

Examples

OMBALTER PROJECT 'New Project' RENAME TO 'Old Project' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes an old project.', 'old payroll project') This will rename project "New Project" to "Old Project", and set its description to "This becomes an old project", set its business name to "old payroll project".

See Also

OMBALTER, OMBCREATE PROJECT, OMBDROP PROJECT


OMBALTER RUNTIME_REPOSITORY_CONNECTIONS

Purpose

OMBALTER RUNTIME_REPOSITORY_CONNECTION - Alter the runtime repository connection by renaming it, and/or reseting its properties.

Prerequisites

Should be in the context of a project.

Syntax Diagrams

Description of alterRuntimeRepositoryCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterRuntimeRepositoryCommand = OMBALTER ( RUNTIME_REPOSITORY_CONNECTION "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterRuntimeRepositoryCommand

Alter a runtime repository connection.

renameClause

Rename the runtime repository connection to the value of the following quoted string.

setPropertiesClause

Set the specified properties of the runtime repository connection.

propertyNameList

The names of the properties whose values you want to set.

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

propertyValueList

The values for the named properties.

propertyValue

A property value.

Examples

OMBALTER RUNTIME_REPOSITORY_CONNECTION 'MY_CONNECTION' RENAME TO 'NEW_CONNECTION' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('This becomes a new repository.', 'new repository') This will rename the runtime repository connection "MY_CONNECTION" to "NEW_CONNECTION", and set its description to "This becomes a new repository", set its business name to "new repository".

See Also

OMBALTER, OMBCREATE RUNTIME_REPOSITORY_CONNECTION, OMBDROP RUNTIME_REPOSITORY_CONNECTION


OMBALTER SEQUENCE

Purpose

OMBALTER SEQUENCE - To alter properties and definition of a sequence.

Prerequisites

In the context of an Oracle Module.

Syntax Diagrams

Description of alterSequenceCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of modifySequenceColumnClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

alterSequenceCommand = OMBALTER ( SEQUENCE "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] { MODIFY "modifySequenceColumnClause" } | SET "setPropertiesClause" { MODIFY "modifySequenceColumnClause" } | ( MODIFY "modifySequenceColumnClause" )+ ) );renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";modifySequenceColumnClause = COLUMN "QUOTED_STRING" SET "setPropertiesClause";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

alterSequenceCommand

This clause is for sequence alter command.

renameClause

renames a table with a different name.

setPropertiesClause

set sequences 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

modifySequenceColumnClause

This clause modifies the sequence's column.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

Examples

OMBALTER SEQUENCE 'NEW_SEQUENCE' SET PROPERTIES (DESCRIPTION) VALUES ('this

is an altered desc of new sequence') This will alter a sequence named "NEW_SEQUENCE", its description is "this is an altered desc of new sequence."

See Also

OMBALTER, OMBCREATE SEQUENCE, OMBDROP SEQUENCE


OMBALTER SNAPSHOT

Purpose

OMBALTER SNAPSHOT - A snapshot can be altered to remove, add or update components.

Prerequisites

The snapshot to be altered should already exist. This command can be executed for any component regardless of current context.

Syntax Diagrams

Description of parseAlterCommand.jpg is in surrounding text
Description of alterSnapshotCommand.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of folderObjectClause.jpg is in surrounding text
Description of entityObjectClause.jpg is in surrounding text
Description of folderObjectNoCascadeClause.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text

Syntax

parseAlterCommand = OMBALTER "alterSnapshotCommand";alterSnapshotCommand = ( SNAPSHOT "QUOTED_STRING" ( SET "setPropertiesClause" | ( ( ( ADD | MODIFY ) ( "folderObjectClause" | "entityObjectClause" ) ) | ( DELETE ( "folderObjectNoCascadeClause" | "entityObjectClause" ) ) )+ ) );setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";folderObjectClause = ( FLAT_FILE_MODULE | INTELLIGENCE_MODULE | GATEWAY_MODULE | ORACLE_MODULE | PROJECT | REPORT_MODULE | SAP_MODULE | PACKAGE | PROCESS_FLOW_PACKAGE | PROCESS_FLOW_MODULE ) "QUOTED_STRING" [ CASCADE | NO CASCADE ];entityObjectClause = ( ( BUSINESS_AREA | COLLECTION | CUBE_TABLE | FUNCTION | PROCEDURE | DIMENSION_TABLE | EXTERNAL_TABLE | FLAT_FILE | IO_FUNCTION | MAPPING | MATERIALIZED_VIEW | QUERY_OBJECT | REPORT | REPORT_GROUP | SEQUENCE | TABLE | PROCESS_FLOW | LOCATION | CONNECTOR | ADVANCED_QUEUE | OBJECT_TYPE | RUNTIME_REPOSITORY_CONNECTION | VIEW ) "QUOTED_STRING" );folderObjectNoCascadeClause = ( FLAT_FILE_MODULE | INTELLIGENCE_MODULE | GATEWAY_MODULE | ORACLE_MODULE | PROJECT | REPORT_MODULE | SAP_MODULE | PACKAGE | PROCESS_FLOW_PACKAGE | PROCESS_FLOW_MODULE ) "QUOTED_STRING";propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

Keywords and Parameters

parseAlterCommand

Root production for OMBALTER SNAPSHOT.

alterSnapshotCommand

To alter already existing snapshot.

QUOTED_STRING

Name of snapshot to be altered.

ADD

Add components to snapshot.

MODIFY

Replace an already existing component with the latest definition of the component from repository.

DELETE

Remove component from snapshot.

setPropertiesClause

Properties of snapshot can be altered through this optional clause. Properties of Snapshot is DESCRIPTION and TYPE. Altering TYPE property is an irreversible operation. Altering snapshot from FULL to SIGNATURE will only keep information required for comparing. SIGNATURE snapshots cannot be exported.

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

folderObjectClause

Folder component clause, syntax is same as in CREATE SNAPSHOT command. It refers to the folder object and all components containted in it. For the ADD and MODIFY operation, this must be the relative path to the folder within the current repository. For the DELETE operation, this must be the fully-qualified path of the folder within a snapshot. Use OMBRETRIEVE SNAPSHOT to get the fully-qualified path of the folder within the snapshot to be altered.

entityObjectClause

Component clause, syntax is same as in CREATE SNAPSHOT. For the ADD and MODIFY operation, this must be the relative path to the component within the current repository. For the DELETE operation, this must be the fully-qualified path of the component within a snapshot. Use OMBRETRIEVE SNAPSHOT to get the fully-qualified path of the component within the snapshot to be altered.

folderObjectNoCascadeClause

Folder component with no cascade clause, It only refers to the folder object itself, its properties and none of its contained components. For the ADD and MODIFY operation, this must be the relative path to the folder within the current repository. For the DELETE operation, this must be the fully-qualified path of the folder within a snapshot. Use OMBRETRIEVE SNAPSHOT to get the fully-qualified path of the folder within the snapshot to be altered.

propertyNameList

Property names for SNAPSHOT that can be altered.

propertyValueList

List of property values for SNAPSHOT.

propertyValue

Allowable value types for a snapshot property.

Examples

OMBALTER SNAPSHOT 'S1' ADD TABLE '/Project1/WH2/T3'

This command adds table T3 into snapshot S1.

OMBALTER SNAPSHOT 'S1' DELETE TABLE '/Project1/WH2/T1'

This command removes T1 table from snapshot S1, if system can find that table in snapshot. OMBALTER SNAPSHOT 'S1' MODIFY TABLE '/Project1/WH2/T1' This command updates definition of component T1 in snapshot from repository. OMBALTER SNAPSHOT 'S1' SET PROPERTIES (DESCRIPTION) VALUES ('this is new description'); This command sets new description for snapshot. OMBALTER SNAPSHOT 'S1' SET PROPERTIES (TYPE) VALUES('SIGNATURE') This command transforms a FULL snapshot into a SIGNATURE snapshot, which is only useful for the compare service.

See Also

OMBCREATE SNAPSHOT, OMBDROP SNAPSHOT, OMBRESTORE SNAPSHOT, OMBCOMPARE SNAPSHOT, OMBLIST SNAPSHOT, OMBRETRIEVE SNAPSHOT


OMBALTER TABLE

Purpose

OMBALTER TABLE - To alter properties and definition of a table.

Prerequisites

In the context of an Oracle Module.

Syntax Diagrams

Description of alterTableCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of alterTableSCOClauses.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of addColumnClauseForAlter.jpg is in surrounding text
Description of addConstraintClause.jpg is in surrounding text
Description of alterTableConstraintClauses.jpg is in surrounding text
Description of addConfigurationClause.jpg is in surrounding text
Description of alterTableConfigurationClauses.jpg is in surrounding text
Description of modifyColumnClause.jpg is in surrounding text
Description of modifyConstraintClause.jpg is in surrounding text
Description of modifyConfigurationClause.jpg is in surrounding text
Description of deleteColumnClause.jpg is in surrounding text
Description of deleteConstraintClause.jpg is in surrounding text
Description of deleteConfigurationClause.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text
Description of addUkPkClause.jpg is in surrounding text
Description of addFkClause.jpg is in surrounding text
Description of addCheckConstraintClause.jpg is in surrounding text
Description of addIndexClause.jpg is in surrounding text
Description of addPartitionClause.jpg is in surrounding text
Description of addPartitionKeyClause.jpg is in surrounding text
Description of addIndexColumnClause.jpg is in surrounding text
Description of moveToClause.jpg is in surrounding text
Description of modifyUkPkClause.jpg is in surrounding text
Description of modifyFkClause.jpg is in surrounding text
Description of modifyCheckConstraintClause.jpg is in surrounding text
Description of modifyIndexClause.jpg is in surrounding text
Description of modifyPartitionClause.jpg is in surrounding text
Description of modifyPartitionKeyClause.jpg is in surrounding text
Description of modifyIndexColumnClause.jpg is in surrounding text
Description of setUkPkPropertiesAndReferencesColumnsClauses.jpg is in surrounding text
Description of setFkSubClauses.jpg is in surrounding text
Description of setSCOConfigurationPropertiesClauses.jpg is in surrounding text
Description of renameSCOConfigurationClause.jpg is in surrounding text
Description of constraintColumnReferencesClause.jpg is in surrounding text
Description of setFkReferencesClauses.jpg is in surrounding text
Description of quotedNameList.jpg is in surrounding text
Description of constraintUkReferencesClause.jpg is in surrounding text

Syntax

alterTableCommand = OMBALTER ( TABLE "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] [ "alterTableSCOClauses" ] | SET "setPropertiesClause" [ "alterTableSCOClauses" ] | "alterTableSCOClauses" ) );

renameClause = RENAME TO "QUOTED_STRING";setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";alterTableSCOClauses = ADD ( "addColumnClauseForAlter" [ "alterTableSCOClauses" ] | "addConstraintClause" { "alterTableConstraintClauses" } | "addConfigurationClause" { "alterTableConfigurationClauses" } ) | MODIFY ( "modifyColumnClause" [ "alterTableSCOClauses" ] | "modifyConstraintClause" { "alterTableConstraintClauses" } | "modifyConfigurationClause" { "alterTableConfigurationClauses" } ) | DELETE ( "deleteColumnClause" [ "alterTableSCOClauses" ] | "deleteConstraintClause" { "alterTableConstraintClauses" } | "deleteConfigurationClause" { "alterTableConfigurationClauses" } );propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };addColumnClauseForAlter = COLUMN "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ];

addConstraintClause = "addUkPkClause" | "addFkClause" | "addCheckConstraintClause";alterTableConstraintClauses = ADD "addConstraintClause" | MODIFY "modifyConstraintClause" | DELETE "deleteConstraintClause";addConfigurationClause = "addIndexClause" | "addPartitionClause" | "addPartitionKeyClause" | "addIndexColumnClause";

alterTableConfigurationClauses = ADD "addConfigurationClause" | MODIFY "modifyConfigurationClause" | DELETE "deleteConfigurationClause";modifyColumnClause = COLUMN "QUOTED_STRING" ( "renameClause" [ "moveToClause" ] [ SET "setPropertiesClause" ] | "moveToClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" );modifyConstraintClause = "modifyUkPkClause" | "modifyFkClause" | "modifyCheckConstraintClause";modifyConfigurationClause = "modifyIndexClause" | "modifyPartitionClause" | "modifyPartitionKeyClause" | "modifyIndexColumnClause";

deleteColumnClause = COLUMN "QUOTED_STRING";deleteConstraintClause = UNIQUE_KEY "QUOTED_STRING" | PRIMARY_KEY "QUOTED_STRING" | FOREIGN_KEY "QUOTED_STRING" | CHECK_CONSTRAINT "QUOTED_STRING";

deleteConfigurationClause = INDEX "QUOTED_STRING" | PARTITION "QUOTED_STRING" | PARTITION_KEY "QUOTED_STRING" | INDEX_COLUMN "QUOTED_STRING" OF INDEX "QUOTED_STRING";propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );

addUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ];addFkClause = FOREIGN_KEY "QUOTED_STRING" [ SET "setFkSubClauses" ];

addCheckConstraintClause = CHECK_CONSTRAINT "QUOTED_STRING" [ SET "setPropertiesClause" ]addIndexClause = INDEX "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];addPartitionClause = PARTITION "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];

addPartitionKeyClause = PARTITION_KEY "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];addIndexColumnClause = INDEX_COLUMN "QUOTED_STRING" OF INDEX "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];moveToClause = MOVE TO POSITION "INTEGER_LITERAL";modifyUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" ( "renameClause" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ] | SET "setUkPkPropertiesAndReferencesColumnsClauses" );modifyFkClause = FOREIGN_KEY "QUOTED_STRING" ( "renameClause" [ SET "setFkSubClauses" ] | SET "setFkSubClauses" );

modifyCheckConstraintClause = CHECK_CONSTRAINT "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" );modifyIndexClause = INDEX "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );modifyPartitionClause = PARTITION "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );modifyPartitionKeyClause = PARTITION_KEY "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );modifyIndexColumnClause = INDEX_COLUMN "QUOTED_STRING" OF INDEX "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );setUkPkPropertiesAndReferencesColumnsClauses = "setPropertiesClause" [ SET ( REF | REFERENCE ) "constraintColumnReferencesClause" ] | ( REF | REFERENCE ) "constraintColumnReferencesClause";setFkSubClauses = "setPropertiesClause" [ SET ( REF | REFERENCE ) "setFkReferencesClauses" ] | ( REF | REFERENCE ) "setFkReferencesClauses";setSCOConfigurationPropertiesClauses = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";renameSCOConfigurationClause = RENAME TO "QUOTED_STRING";constraintColumnReferencesClause = COLUMNS "(" "quotedNameList" ")";

setFkReferencesClauses = "constraintColumnReferencesClause" [ SET ( REF | REFERENCE ) "constraintUkReferencesClause" ] | "constraintUkReferencesClause" [ SET ( REF | REFERENCE ) "constraintColumnReferencesClause" ];quotedNameList = "QUOTED_STRING" { "," "QUOTED_STRING" };

constraintUkReferencesClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ OF ( TABLE | VIEW ) "QUOTED_STRING" ];

Keywords and Parameters

alterTableCommand

This clause alters a table.

QUOTED_STRING

name of the table.

renameClause

renames a table with a different name.

setPropertiesClause

Used to set properties (core, logical, physical, user-defined) for tables, columns, unique keys, foreign keys, primary keys, and check constraints.

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

alterTableSCOClauses

This clause will add, modify, delete, columns, configuration, and keys.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

addColumnClauseForAlter

This clause adds a column at a particular position

QUOTED_STRING

The column name.

addConstraintClause

Adds primary and unique key, and add check constraints.

alterTableConstraintClauses

This clause alters table constraints through addition, modification, and deletion.

addConfigurationClause

This clause will add configuration objects.

alterTableConfigurationClauses

This clause has modify and delete configuration clause.

modifyColumnClause

This clause renames, set properties, and move columns.

modifyConstraintClause

This clause modifies keys and check constraints

modifyConfigurationClause

This clause will modify configuration objects.

deleteColumnClause

This clause deletes a column.

deleteConstraintClause

This clause deletes a key or check constraint.

deleteConfigurationClause

This clause deletes a configuration object.

QUOTED_STRING

Either index, partition, partition_key, or index column name.

propertyValue

This clause adds the property values.

addUkPkClause

This clause adds the adds unique key and primary keys.

QUOTED_STRING

name of the unique key or primary key.

addFkClause

This clause adds foreign key

QUOTED_STRING

Name of the foreign key.

addCheckConstraintClause

add a check constraint.

QUOTED_STRING

Name of the CheckConstraint.

addIndexClause

This clause adds an index.

QUOTED_STRING

Name of the index.

addPartitionClause

This clause adds a partition.

QUOTED_STRING

Name of the partition.

addPartitionKeyClause

This clause adds a partition key.

QUOTED_STRING

Name of the partition key. This should be a column identifier.

addIndexColumnClause

This clause will add indexColumn to a specified index.

QUOTED_STRING

Index name

moveToClause

This clause will move the column to given position.

modifyUkPkClause

It modifies unique or primary key.

modifyFkClause

This clause modifies the foreign key.

modifyCheckConstraintClause

This clause modifies the check constraint.

modifyIndexClause

This clause modifies the Index

QUOTED_STRING

Name of the index.

modifyPartitionClause

This clause modifies a partition

QUOTED_STRING

Name of the partition.

modifyPartitionKeyClause

This clause modifies a partition key.

QUOTED_STRING

Name of the partition key.

modifyIndexColumnClause

Modifies the Index Column. The first quoted_string in this clause denotes index column name, and the latter denotes index.

setUkPkPropertiesAndReferencesColumnsClauses

This clause adds properties and references to columns

setFkSubClauses

This clause set references to a foreign key.

setSCOConfigurationPropertiesClauses

Set the configuration properties for the following objects Index: LOGGING_MODE, PARALLEL_ACCESS_MODE, TABLESPACE, INDEX_TYPE, LOCAL_INDEX, DEPLOYABLE Partition: DATE_LESS_THAN, TABLESPACE, DEPLOYABLE Partition_key: TYPE, DEPLOYABLE RelationalCmdParser$constraintColumnReferencesClause = This clause provides names of all columns.

renameSCOConfigurationClause

This clause renames configuration objects.

constraintColumnReferencesClause

RelationalCmdParser$constraintColumnReferencesClause??

setFkReferencesClauses

This clause sets foreign key references.

quotedNameList

This clause gives column names.

constraintUkReferencesClause

The first QUOTED_STRING denotes the UniqueKey or Primay key name, and the latter denotes the table's or view's name.

Examples

OMBALTER TABLE 'new_table' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES ('this is an altered desc of new table', 'Altered New Table') This will alter a table named "NEW_TABLE", its description is "this is an altered desc of new table", and business name is "Altered New Table".

See Also

OMBALTER, OMBCREATE TABLE, OMBDROP TABLE


OMBALTER VIEW

Purpose

OMBALTER VIEW - To alter properties and definition of a view.

Prerequisites

In the context of an Oracle Module.

Syntax Diagrams

Description of alterViewCommand.jpg is in surrounding text
Description of renameClause.jpg is in surrounding text
Description of setPropertiesClause.jpg is in surrounding text
Description of alterViewSCOClauses.jpg is in surrounding text
Description of propertyNameList.jpg is in surrounding text
Description of propertyValueList.jpg is in surrounding text
Description of addColumnClauseForAlter.jpg is in surrounding text
Description of addConstraintClause.jpg is in surrounding text
Description of alterViewConstraintClauses.jpg is in surrounding text
Description of addConfigurationClause.jpg is in surrounding text
Description of alterViewConfigurationClauses.jpg is in surrounding text
Description of modifyColumnClause.jpg is in surrounding text
Description of modifyConstraintClause.jpg is in surrounding text
Description of modifyConfigurationClause.jpg is in surrounding text
Description of deleteColumnClause.jpg is in surrounding text
Description of deleteConstraintClause.jpg is in surrounding text
Description of deleteConfigurationClause.jpg is in surrounding text
Description of propertyValue.jpg is in surrounding text
Description of addUkPkClause.jpg is in surrounding text
Description of addFkClause.jpg is in surrounding text
Description of addCheckConstraintClause.jpg is in surrounding text
Description of addViewConstraintClause.jpg is in surrounding text
Description of modifyViewConstraintClause.jpg is in surrounding text
Description of deleteViewConstraintClause.jpg is in surrounding text
Description of addIndexClause.jpg is in surrounding text
Description of addPartitionClause.jpg is in surrounding text
Description of addPartitionKeyClause.jpg is in surrounding text
Description of addIndexColumnClause.jpg is in surrounding text
Description of moveToClause.jpg is in surrounding text
Description of modifyUkPkClause.jpg is in surrounding text
Description of modifyFkClause.jpg is in surrounding text
Description of modifyCheckConstraintClause.jpg is in surrounding text
Description of modifyIndexClause.jpg is in surrounding text
Description of modifyPartitionClause.jpg is in surrounding text
Description of modifyPartitionKeyClause.jpg is in surrounding text
Description of modifyIndexColumnClause.jpg is in surrounding text
Description of setUkPkPropertiesAndReferencesColumnsClauses.jpg is in surrounding text
Description of setFkSubClauses.jpg is in surrounding text
Description of setSCOConfigurationPropertiesClauses.jpg is in surrounding text
Description of renameSCOConfigurationClause.jpg is in surrounding text
Description of constraintColumnReferencesClause.jpg is in surrounding text
Description of setFkReferencesClauses.jpg is in surrounding text
Description of quotedNameList.jpg is in surrounding text
Description of constraintUkReferencesClause.jpg is in surrounding text

Syntax

alterViewCommand = OMBALTER ( VIEW "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] [ "alterViewSCOClauses" ] | SET "setPropertiesClause" [ "alterViewSCOClauses" ] | "alterViewSCOClauses" ) );

renameClause = RENAME TO "QUOTED_STRING";

setPropertiesClause = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";

alterViewSCOClauses = ADD ( "addColumnClauseForAlter" [ "alterViewSCOClauses" ] | "addConstraintClause" { "alterViewConstraintClauses" } | "addConfigurationClause" { "alterViewConfigurationClauses" } ) | MODIFY ( "modifyColumnClause" [ "alterViewSCOClauses" ] | "modifyConstraintClause" { "alterViewConstraintClauses" } | "modifyConfigurationClause" { "alterViewConfigurationClauses" } ) | DELETE ( "deleteColumnClause" [ "alterViewSCOClauses" ] | "deleteConstraintClause" { "alterViewConstraintClauses" } | "deleteConfigurationClause" { "alterViewConfigurationClauses" } );

propertyNameList = "UNQUOTED_STRING" { "," "UNQUOTED_STRING" };propertyValueList = "propertyValue" { "," "propertyValue" };

addColumnClauseForAlter = COLUMN "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ];

addConstraintClause = "addUkPkClause" | "addFkClause" | "addCheckConstraintClause";alterViewConstraintClauses = ADD "addViewConstraintClause" | MODIFY "modifyViewConstraintClause" | DELETE "deleteViewConstraintClause";addConfigurationClause = "addIndexClause" | "addPartitionClause" | "addPartitionKeyClause" | "addIndexColumnClause";

alterViewConfigurationClauses = ADD "addConfigurationClause" | MODIFY "modifyConfigurationClause" | DELETE "deleteConfigurationClause";modifyColumnClause = COLUMN "QUOTED_STRING" ( "renameClause" [ "moveToClause" ] [ SET "setPropertiesClause" ] | "moveToClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" );

modifyConstraintClause = "modifyUkPkClause" | "modifyFkClause" | "modifyCheckConstraintClause";modifyConfigurationClause = "modifyIndexClause" | "modifyPartitionClause" | "modifyPartitionKeyClause" | "modifyIndexColumnClause";deleteColumnClause = COLUMN "QUOTED_STRING";deleteConstraintClause = UNIQUE_KEY "QUOTED_STRING" | PRIMARY_KEY "QUOTED_STRING" | FOREIGN_KEY "QUOTED_STRING" | CHECK_CONSTRAINT "QUOTED_STRING";deleteConfigurationClause = INDEX "QUOTED_STRING" | PARTITION "QUOTED_STRING" | PARTITION_KEY "QUOTED_STRING" | INDEX_COLUMN "QUOTED_STRING" OF INDEX "QUOTED_STRING";propertyValue = ( "QUOTED_STRING" | "INTEGER_LITERAL" | "FLOATING_POINT_LITERAL" );addUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ];addFkClause = FOREIGN_KEY "QUOTED_STRING" [ SET "setFkSubClauses" ];addCheckConstraintClause = CHECK_CONSTRAINT "QUOTED_STRING" [ SET "setPropertiesClause" ];

addViewConstraintClause = "addUkPkClause" | "addFkClause";modifyViewConstraintClause = "modifyUkPkClause" | "modifyFkClause";

deleteViewConstraintClause = UNIQUE_KEY "QUOTED_STRING" | PRIMARY_KEY "QUOTED_STRING" | FOREIGN_KEY "QUOTED_STRING";addIndexClause = INDEX "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];addPartitionClause = PARTITION "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];addPartitionKeyClause = PARTITION_KEY "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];addIndexColumnClause = INDEX_COLUMN "QUOTED_STRING" OF INDEX "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ];moveToClause = MOVE TO POSITION "INTEGER_LITERAL";

modifyUkPkClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" ( "renameClause" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ] | SET "setUkPkPropertiesAndReferencesColumnsClauses" );modifyFkClause = FOREIGN_KEY "QUOTED_STRING" ( "renameClause" [ SET "setFkSubClauses" ] | SET "setFkSubClauses" );modifyCheckConstraintClause = CHECK_CONSTRAINT "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET "setPropertiesClause" );modifyIndexClause = INDEX "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );modifyPartitionClause = PARTITION "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );modifyPartitionKeyClause = PARTITION_KEY "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );

modifyIndexColumnClause = INDEX_COLUMN "QUOTED_STRING" OF INDEX "QUOTED_STRING" ( "renameSCOConfigurationClause" [ SET "setSCOConfigurationPropertiesClauses" ] | SET "setSCOConfigurationPropertiesClauses" );setUkPkPropertiesAndReferencesColumnsClauses = "setPropertiesClause" [ SET ( REF | REFERENCE ) "constraintColumnReferencesClause" ] | ( REF | REFERENCE ) "constraintColumnReferencesClause";setFkSubClauses = "setPropertiesClause" [ SET ( REF | REFERENCE ) "setFkReferencesClauses" ] | ( REF | REFERENCE ) "setFkReferencesClauses";setSCOConfigurationPropertiesClauses = PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList" ")";

renameSCOConfigurationClause = RENAME TO "QUOTED_STRING";constraintColumnReferencesClause = COLUMNS "(" "quotedNameList" ")";setFkReferencesClauses = "constraintColumnReferencesClause" [ SET ( REF | REFERENCE ) "constraintUkReferencesClause" ] | "constraintUkReferencesClause" [ SET ( REF | REFERENCE ) "constraintColumnReferencesClause" ];

quotedNameList = "QUOTED_STRING" { "," "QUOTED_STRING" };constraintUkReferencesClause = ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ OF ( TABLE | VIEW ) "QUOTED_STRING" ];

Keywords and Parameters

alterViewCommand

This clause alters a view.

QUOTED_STRING

name of the view.

renameClause

renames a table with a different name.

setPropertiesClause

Used to set properties (core, logical, physical, user-defined) for tables, columns, unique keys, foreign keys, primary keys, and check constraints.

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

alterViewSCOClauses

This clause alters the view clause.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

addColumnClauseForAlter

This clause adds a column at a particular position

QUOTED_STRING

The column name.

addConstraintClause

Adds primary and unique key, and add check constraints.

alterViewConstraintClauses

This clause alters the view's constraint clause.

addConfigurationClause

This clause will add configuration objects.

alterViewConfigurationClauses

This clause alters the view's configuration clause.

modifyColumnClause

This clause renames, set properties, and move columns.

modifyConstraintClause

This clause modifies keys and check constraints

modifyConfigurationClause

This clause will modify configuration objects.

deleteColumnClause

This clause deletes a column.

deleteConstraintClause

This clause deletes a key or check constraint.

deleteConfigurationClause

This clause deletes a configuration object.

QUOTED_STRING

Either index, partition, partition_key, or index column name.

propertyValue

This clause adds the property values.

addUkPkClause

This clause adds the adds unique key and primary keys.

QUOTED_STRING

name of the unique key or primary key.

addFkClause

This clause adds foreign key

QUOTED_STRING

Name of the foreign key.

addCheckConstraintClause

add a check constraint.

QUOTED_STRING

Name of the CheckConstraint.

addViewConstraintClause

This clause adds the view's configuration clause.

modifyViewConstraintClause

= This clause modifies the view's constraint clause.

deleteViewConstraintClause

This clause deletes the view's constraint.

addIndexClause

This clause adds an index.

QUOTED_STRING

Name of the index.

addPartitionClause

This clause adds a partition.

QUOTED_STRING

Name of the partition.

addPartitionKeyClause

This clause adds a partition key.

QUOTED_STRING

Name of the partition key. This should be a column identifier.

addIndexColumnClause

This clause will add indexColumn to a specified index.

QUOTED_STRING

Index name

moveToClause

This clause will move the column to given position.

modifyUkPkClause

It modifies unique or primary key.

modifyFkClause

This clause modifies the foreign key.

modifyCheckConstraintClause

This clause modifies the check constraint.

modifyIndexClause

This clause modifies the Index

QUOTED_STRING

Name of the index.

modifyPartitionClause

This clause modifies a partition

QUOTED_STRING

Name of the partition.

modifyPartitionKeyClause

This clause modifies a partition key.

QUOTED_STRING

Name of the partition key.

modifyIndexColumnClause

Modifies the Index Column. The first quoted_string in this clause denotes index column name, and the latter denotes index.

setUkPkPropertiesAndReferencesColumnsClauses

This clause adds properties and references to columns

setFkSubClauses

This clause set references to a foreign key.

setSCOConfigurationPropertiesClauses

Set the configuration properties for the following objects Index: LOGGING_MODE, PARALLEL_ACCESS_MODE, TABLESPACE, INDEX_TYPE, LOCAL_INDEX, DEPLOYABLE Partition: DATE_LESS_THAN, TABLESPACE, DEPLOYABLE Partition_key: TYPE, DEPLOYABLE RelationalCmdParser$constraintColumnReferencesClause = This clause provides names of all columns.

renameSCOConfigurationClause

This clause renames configuration objects.

constraintColumnReferencesClause

RelationalCmdParser$constraintColumnReferencesClause??

setFkReferencesClauses

This clause sets foreign key references.

quotedNameList

This clause gives column names.

constraintUkReferencesClause

The first QUOTED_STRING denotes the UniqueKey or Primay key name, and the latter denotes the table's or view's name.

Examples

OMBALTER VIEW 'NEW_VIEW' SET PROPERTIES (DESCRIPTION, BUSINESS_NAME) VALUES

('this is an altered desc of new view', 'Altered New View') This will alter a view named "NEW_VIEW", its description is "this is an altered desc of new view", and business name is "Altered New View".

See Also

OMBRETRIEVE VIEW, OMBCREATE VIEW, OMBDROP VIEW