PK pFJoa,mimetypeapplication/epub+zipPKpFJOEBPS/chap15001.htmR OMBDROP TABLE_FUNCTION

OMBDROP TABLE_FUNCTION

Purpose

Delete the Table Function.

Prerequisites

Should be in the context of Oracle Module or Package.

Syntax

dropTableFunctionCommand =  OMBDROP ( TABLE_FUNCTION "QUOTED_STRING" )

Parameters

dropTableFunctionCommand

Drops a Table Function

PK)ίPKpFJOEBPS/chap24.htm OMUSTARTJOB to OMUVALIDATE

24 OMUSTARTJOB to OMUVALIDATE

PKPKpFJOEBPS/chap18008.htm OMBRETRIEVE CORRECTION_MAPS_ACTION_PLAN

OMBRETRIEVE CORRECTION_MAPS_ACTION_PLAN

Purpose

To retrieve properties of a correction map action plan.

Prerequisites

In the context of a data profile.

Syntax

RetrieveActionPlanCommand =  ( OMBRETRIEVE ( ( DEPLOYMENT_ACTION_PLAN | 
          ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN | 
          CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" ) ( "getActionsClause"
           | "retrieveActionClause" )
     getActionsClause =  GET ACTIONS
     retrieveActionClause =  ACTION "QUOTED_STRING" ( GET ( 
          "getPropertiesClause" | "getReferenceClause" ) )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceClause =  ( REF | REFERENCE )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

RetrieveActionPlanCommand

Retrieve correction maps action plan.

QUOTED_STRING

Action plan name.

getActionsClause

Get a list of actions from an action plan.

retrieveActionClause

Retrieve a set of properties or the associated object of an action.

getPropertiesClause

Retrieve a set of properties that is associated with an action.

getReferenceClause

Retrieve the object associated with an action.

propertyNameList

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

PKPKpFJOEBPS/chap21005.htmR OMBRETRIEVE SNAPSHOT

OMBRETRIEVE SNAPSHOT

Purpose

Since the snapshot may contain many components, this command lets the user view all the contents in a snapshot.

Prerequisites

Snapshot contents can be retrieved from any context.

Syntax

parseRetrieveCommand =  OMBRETRIEVE "retrieveSnapshotCommand"
     retrieveSnapshotCommand =  ( SNAPSHOT "QUOTED_STRING" [ GET 
          "getPropertiesClause" ] )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

parseRetrieveCommand

Root production of OMBRETRIEVE SNAPSHOT.

retrieveSnapshotCommand

To view contents of snapshot.

QUOTED_STRING

Name of snapshot whose contents are to be retrieved.

getPropertiesClause

Gets the property of snapshot which are DESCRIPTION, TYPE.

getPropertiesClause

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: Any valid character string in supported character set.
Default: Empty string
Description of the snapshot

PROPERTIES

Valid set of properties are DESCRIPTION and TYPE.

propertyNameList

Property names for SNAPSHOT that can be retrieved.

PKͭ`PKpFJOEBPS/chap1006.htm7 OMBALTER ANALYZE_ACTION_PLAN

OMBALTER ANALYZE_ACTION_PLAN

Purpose

To alter an existing profile action plan.

Prerequisites

alterAnalyzeActionPlanPreTag??

Syntax

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

Parameters

AlterActionPlanCommand

Alter an action plan.

QUOTED_STRING

Action plan name.

renameActionPlanClause

Rename an action plan.

addActionClause

Add an action to an action plan.

QUOTED_STRING

Action name.

modifyActionClause

Modify an action of an action plan.

QUOTED_STRING

Action name.

deleteActionClause

Delete an action of an action plan.

QUOTED_STRING

Action name.

setClause

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

renameActionClause

Rename an action of the action plan.

setUnsetClause

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

propertiesClause

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

setReferenceClause

Associate an object with an action.

ObjType

Object type. The only valid value is DATA_PROFILE_TABLE.

setClauseForAlter

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

unsetReferenceClause

Disassociate a previously associated object from an action.

propertyNameList

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

propertyValueList

Comma separated list of property values.

useClause

Currently used only in CORRECTION_SCHEMA_ACTION_PLAN.

propertyValue

Value of a property.

PK/j<7PKpFJOEBPS/chap20017.htm$ OMBRETRIEVE PSFT_MODULE

OMBRETRIEVE PSFT_MODULE

Purpose

retrievePSFTModuleCommandPurposeTag??

Prerequisites

retrievePSFTModuleCommandPreTag??

Syntax

retrievePSFTModuleCommand =  OMBRETRIEVE PSFT_MODULE "QUOTED_STRING" ( 
          "getPropertiesClause" | "getReferenceLocationClause" | 
          "getReferenceDefaultLocationClause" | 
          "getReferenceMetadataLocationClause" | "getReferenceIconSetClause" | 
          "getReferenceLocationsClause" | "getJournalCodeTemplateClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceLocationClause =  GET ( REF | REFERENCE ) LOCATION
     getReferenceDefaultLocationClause =  GET ( REF | REFERENCE ) DEFAULT 
          LOCATION
     getReferenceMetadataLocationClause =  GET ( REF | REFERENCE ) 
          METADATA_LOCATION
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     getReferenceLocationsClause =  GET ( REF | REFERENCE ) LOCATIONS
     getJournalCodeTemplateClause =  GET ( REF | REFERENCE ) CDC_CT OPTIONS | 
          GET ( REF | REFERENCE ) CDC_CT OPTION "QUOTED_STRING" | GET ( REF | 
          REFERENCE ) CDC_CT
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

getPropertiesClause

corePropertiesForPSFTModuleTag??

See Also

OMBRETRIEVE

PK|P) $ PKpFJOEBPS/chap13018.htm' OMBDROP ORACLE_EBS_MODULE

OMBDROP ORACLE_EBS_MODULE

Purpose

dropOracleEBSModuleCommandPurposeTag??

Prerequisites

dropOracleEBSModuleCommandPreTag??

Syntax

dropOracleEBSModuleCommand =  OMBDROP ( ORACLE_EBS_MODULE "QUOTED_STRING" )

Parameters

PKy1,'PKpFJOEBPS/chap14013.htm. OMBDROP QUEUE_TABLE

OMBDROP QUEUE_TABLE

Purpose

Delete the Queue Table.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

dropQTCommand =  OMBDROP QUEUE_TABLE "QUOTED_STRING"

Parameters

dropQTCommand

Drops the Queue Table with the given name.

PK(>PKpFJOEBPS/chap7018.htmO$ OMBCREATE GATEWAY_MODULE

OMBCREATE GATEWAY_MODULE

Purpose

To create a Gateway module.

Prerequisites

Should be in the context of project.

Syntax

createGatewayModuleCommand =  OMBCREATE ( GATEWAY_MODULE "QUOTED_STRING" ( 
          SET "setPropertiesClause" ) [ SET 
          "setReferenceClauseForDataMetadataModule" ] [ 
          "addModuleReferenceLocationClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] | 
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     addModuleReferenceLocationClause =  "addReferenceLocationClause" { 
          "addReferenceLocationClause" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  ( 
          "setJournalCodeTemplateClause" [ SET 
          "setReferenceMetadataLocationOrIconSetClause" ] | 
          "setReferenceMetadataLocationOrIconSetClause" )
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION 
          "QUOTED_STRING" [ SET AS DEFAULT ]
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )
     setJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT "QUOTED_STRING" 
          | ( ( REFERENCE | REF ) CDC_CT OPTIONS "(" "propertyValueList" ")" 
          VALUES "(" "propertyValueList" ")" )
     setReferenceMetadataLocationOrIconSetClause =  ( 
          "setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
           ] | "setReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"

Parameters

createGatewayModuleCommand

This command creates a Gateway module

QUOTED_STRING

Name of the Gateway module to be created.

setPropertiesClause

Associate a set of properties with the Gateway module.

setPropertiesClause

Basic properties for GATEWAY_MODULE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of an Gateway Module 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of an Gateway Module

Name: GATEWAY_TYPE
Type: STRING
Valid Values: Any valid character string in supported character set.
 Default: N/A
Type of gateway module. Supported values are: 'DB2 Gateway Module', 'Sybase Gateway Module', 'Sql*server Gateway Module', 'Informix Gateway Module', 'ODBC Gateway Module', 'DRDA Gateway Module', 'RDB Gateway Module', 'Teradata Gateway Module', 'Other Gateway Module'.

setReferenceClauseForDataMetadataModule

Set location and/or icon set for the gateway module.

addModuleReferenceLocationClause

Add data locations to the gateway module.

propertyNameList

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

propertyValueList

Comma separated list of property values.

setReferenceLocationClause

Set a data location to the gateway module as the new configuration default.

addReferenceLocationClause

Add a data location to the gateway module.

propertyValue

Value of a property.

setReferenceMetadataLocationOrIconSetClause

Set metadata location and/or icon set for the gateway module.

setReferenceMetadataLocationClause

Set metadata location for the gateway module.

setReferenceIconSetClause

Set icon set for the gateway module.

GATEWAY_MODULE Object

Table 7-12 GATEWAY_MODULE Object

PropertyTypeChoicesMinMaxDefaultDescription

DB_LOCATION

STRING

none

none

none

empty string

If this is a source module, this value indicates the location from which data will be read. If this is a target warehouse module, this value indicates the location where generated code will be deployed to and/or where data will be written to.


PK>hT$O$PKpFJOEBPS/chap20010.htmL OMBRETRIEVE PLUGGABLE_MAPPING_FOLDER

OMBRETRIEVE PLUGGABLE_MAPPING_FOLDER

Purpose

Retrieve details of pluggable map folder such as its business name and description.

Prerequisites

The current context of scripting must be a project.

Syntax

retrievePluggableMappingLibraryCommand =  OMBRETRIEVE ( 
          PLUGGABLE_MAPPING_FOLDER | PLUGGABLE_MAPPING_LIBRARY ) 
          "pluggableMapLibraryName" GET ( PROPERTIES "propertyKeyList" | 
          "getReferenceIconSetClause" )
     pluggableMapLibraryName =  "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     propertyKey =  "UNQUOTED_STRING" | FILE_FORMAT

Parameters

retrievePluggableMappingLibraryCommand

Retrieve the detail of a pluggable mapping folder such as its business name and description.

pluggableMapLibraryName

Name of the pluggable map folder.

propertyKeyList

The list of property keys.

getReferenceIconSetClause

Retrieve the icon set for the pluggable map folder.

propertyKey

A property key for an object.

propertyKey

Basic properties for MAPPING: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the mapping 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string

See Also

OMBRETRIEVE

PKۊPKpFJOEBPS/chap14014.htm# OMBDROP REAL_TIME_MAPPING

OMBDROP REAL_TIME_MAPPING

Purpose

Drop an existing Real Time mapping.

Prerequisites

The current context of scripting must be an Oracle

Syntax

dropRealTimeMappingCommand =  OMBDROP REAL_TIME_MAPPING "mappingName"
     mappingName =  "QUOTED_STRING"

Parameters

mappingName

Name of the mapping.

PKn4_( # PKpFJOEBPS/chap23.htm OMUCONFIGURE to OMUSTART EXPERT

23 OMUCONFIGURE to OMUSTART EXPERT

PK);U   PKpFJOEBPS/chap9020.htmd4 OMBCREATE TABLE_FUNCTION

OMBCREATE TABLE_FUNCTION

Purpose

To create a Table Function.

Prerequisites

Should be in the context of Oracle Module or Package. The REFCursorType and PLSQLTableType which are set as Datatype for parameters should pre-exist.

Syntax

createTableFunctionCommand =  OMBCREATE ( TABLE_FUNCTION "QUOTED_STRING" 
          SET "setPropertiesClause" [ SET "setReferenceIconSetClause" ] { ADD 
          "addFuncProcParameterClause" } )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addFuncProcParameterClause =  PARAMETER "QUOTED_STRING" [ SET 
          "setPropertiesClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

createTableFunctionCommand

Creates a table function

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Table Function and its Parameters. Valid properties are shown below:

setPropertiesClause

Properties for TABLE_FUNCTION: 
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Table Function 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Table Function 

Name: PARALLEL_EXECUTION
Type: STRING(5)
Valid Values: TRUE, FALSE
Default: Empty string
Enables Parallel Execution of the Table Function

Name: PIPELINED_EXECUTION
Type: STRING(5)
Valid Values: TRUE, FALSE
Default: Empty string
Enables Partitioned Execution of the Table Function

Name: ORDER_METHOD
Type: STRING(9)
Valid Values: ORDERBY, CLUSTERBY
Default: ORDERBY
Order Method for the Table Function

Name: PARTITION_METHOD
Type: STRING(5)
Valid Values: NONE, ANY, HASH, RANGE
Default: NONE
Partition Method for the Table Function

Name: RETURN_TYPE
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Name of the Return Type of this Table Function. For this release, this has to be a PLSQL Table Type whose datatype has to be PLSQLRecordType. Also, it should already be defined in USER_TYPES Package in this Module. 

Name: IMPLEMENTATION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Implementation code for this Table Function.

Name: IS_DETERMINISTIC
Type: STRING(5)
Valid Values: TRUE, FALSE
Default: Empty string
Whether this Table Function is Deterministic.

Properties for PARAMETER:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Parameter

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Parameter

Name: DATATYPE
Type: STRING(4000)
Valid Values: Any valid REF cursor type
Default: Empty string
Datatype of the Parameter. Parameter will always be IN type for Table Function. For this release, it has to be a REF Cursor type. Also, this REF Cursor should already be defined in USER_TYPES Package in this Module.

setReferenceIconSetClause

Set reference icon set to this table function.

addFuncProcParameterClause

Adds a Parameter with the given name and datatype to the Table Function. The datatype of the Parameter is set as its DATATYPE property.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

TABLE_FUNCTION Object

Table 9-107 TABLE_FUNCTION Object

PropertyTypeChoicesMinMaxDefaultDescription

AUTHID

STRING

, CURRENT_USER, DEFINER

none

none

empty string

Generate the transformation with selected AUTHID option. The function will be executed with the permissions defined by the AUTHID clause instead of the function owner's permissions.

CALLED_ON_NULL_INPUT

STRING

, CALLED ON NULL INPUT

none

none

empty string

Specifies that the function is called regardless of whether any of its arguments are null. It can return a null value or a non-null value.

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

DETERMINISTIC_STATE

STRING

, DETERMINISTIC, NOT DETERMINISTIC

none

none

empty string

Specifies that the function returns the same result every time, for a given set of inputs.

ENCRYPTION

STRING

, ENCRYPTION

none

none

empty string

Specifies whether the function body will be encrypted when the function is created.

EXECUTE_AS

STRING

, EXECUTE AS CALLER, EXECUTE AS OWNER, EXECUTE AS SELF

none

none

empty string

Generate the transformation with selected EXECUTE AS option. Function will be executed with the permissions defined by the EXECUTE AS clause rather than the function owner's permissions.

EXTERNAL_ACTION

STRING

, EXTERNAL ACTION, NO EXTERNAL ACTION

none

none

empty string

Specifies that the function takes some action that changes the state of an object not managed by the database manager, such as reading or writing a file in the OS-managed folders.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

INHERIT_ISOLATION_LEVEL

STRING

, INHERIT ISOLATION LEVEL WITH LOCK REQUEST, INHERIT ISOLATION LEVEL WITHOUT LOCK REQUEST

none

none

empty string

Specifies whether or not a lock request can be associated with the isolation-clause of the statement when the function inherits the isolation level of the statement that invokes the function. The default is INHERIT ISOLATION LEVEL WITHOUT LOCK REQUEST.

INHERIT_SPECIAL_REGISTERS

STRING

, INHERIT SPECIAL REGISTERS

none

none

empty string

Specifies that the function will inherit all the special registers from the invoking statement.

IS_DETERMINISTIC

STRING

, DETERMINISTIC

none

none

empty string

Optimization hint that specifies that the function returns the same result every time for a given set of arguments. If the function is called with the same arguments multiple times, then the optimizer may re-use the previous result.

IS_PARALLEL_ENABLE

STRING

, PARALLEL_ENABLE

none

none

empty string

Optimization hint, instructing Oracle to execute the function in parallel whenever called from within a SQL query.

LANGUAGE_SQL

STRING

, LANGUAGE SQL

none

none

empty string

This Optional clause indicates that the function is written in SQL PL. This is the default option, to satisfy SQL99 requirements.

PARAMETER_CCSID

STRING

, PARAMETER CCSID ASCII, PARAMETER CCSID UNICODE

none

none

empty string

Specifies the encoding scheme to use for all string data passed into and out of the function. If the PARAMETER CCSID clause is not specified, the default is PARAMETER CCSID UNICODE for Unicode databases, and PARAMETER CCSID ASCII for all other databases.

PRAGMA_AUTONOMOUS_TRANSACTION

STRING

, PRAGMA AUTONOMOUS_TRANSACTION

none

none

empty string

Instructs the PL/SQL compiler to mark the function as independent, which allows the function to suspend the main transaction.

SCHEMABINDING

STRING

, SCHEMABINDING

none

none

empty string

Specifies that the function is bound to the database objects that it references (that is, they cannot be dropped or modified). This condition will prevent changes to the function if other schema-bound objects are referencing it. If a function is created with SCHEMABINDING, then the function is a deterministic function.

SPECIFIC

STRING

none

none

none

empty string

Uniquely identifies a function within the current schema. The specific name can be the same as the function name, and it can be up to 18 characters long. If the SPECIFIC keyword is omitted, then the IBM DB2 UDB Database Manager automatically generates a unique identifier for the function in the format SQLyymmddhhmmssxxx.

SQL_DATA

STRING

, CONTAINS SQL, MODIFIES SQL DATA, READS SQL DATA

none

none

empty string

Specifies what type of SQL statements can be executed by the function. CONTAINS SQL specifies that the function can only execute SQL statements that do not read or modify SQL data. READS SQL DATA specifies that only SQL statements that do not modify SQL data can be executed by the function. MODIFIES SQL DATA specifies that all SQL statements supported in dynamic-compound-statement can be executed by the function.

STATIC_DISPATCH

STRING

, STATIC DISPATCH

none

none

empty string

Specifies that the function is to return the static values of an ARRAY or a user-defined type. Required if you have a non-SQL function that uses an ARRAY or a user-defined type as parameters.

WITH_NULL_INPUT

STRING

, CALLED ON NULL INPUT, RETURNS NULL ON NULL INPUT

none

none

empty string

Specifies that if RETURNS NULL ON NULL INPUT is specified in a CLR function, then SQL Server can return NULL when any of the arguments it receives is NULL, without actually invoking the body of the function. If CALLED ON NULL INPUT is specified, then the function body executes even if NULL is passed as an argument.


PKhn!ddPKpFJOEBPS/chap15006.htm} OMBDROP VIEW

OMBDROP VIEW

Purpose

To drop a view.

Prerequisites

In the context of an Oracle Module.

Syntax

dropViewCommand =  OMBDROP VIEW "QUOTED_STRING"

Parameters

dropViewCommand

This clause drops a View.

PK;PKpFJOEBPS/chap23021.htm OMUSTART EXPERT

OMUSTART EXPERT

Purpose

To start running the expert assistant.

Prerequisites

Connect to a repository.

Syntax

parseStartExpertCommand =  OMUSTART ( GUIDED_ASST | EXPERT "QUOTED_STRING" 
          [ "parameterClause" ] )
     parameterClause =  WITH PARAMETERS "(" "parameterNameList" ")" VALUES "(" 
          "parameterValueList" ")"
     parameterNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     parameterValueList =  "parameterValue" { "," "parameterValue" }
     parameterValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

parseStartExpertCommand

Start an expert.

parameterClause

Supply a list of input parameter values to be passed into the expert.

parameterNameList

The list of input parmater names.

parameterValueList

The list of parameter values to be passed in.

parameterValue

A parameter value in quoted string, can be STRING, NUMBER, BOOLEAN or ARRAY.

PK~| PKpFJOEBPS/chap21002.htm OMBRETRIEVE SAP_MODULE

OMBRETRIEVE SAP_MODULE

Purpose

Retrieve details of the SAP module.

Prerequisites

You must open a project to retrieve a SAP module.

Syntax

retrieveSAPModuleCommand =  OMBRETRIEVE SAP_MODULE "QUOTED_STRING" ( 
          "getPropertiesClause" | "getReferenceLocationClause" | 
          "getReferenceDefaultLocationClause" | 
          "getReferenceMetadataLocationClause" | "getReferenceIconSetClause" | 
          "getReferenceLocationsClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceLocationClause =  GET ( REF | REFERENCE ) LOCATION
     getReferenceDefaultLocationClause =  GET ( REF | REFERENCE ) DEFAULT 
          LOCATION
     getReferenceMetadataLocationClause =  GET ( REF | REFERENCE ) 
          METADATA_LOCATION
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     getReferenceLocationsClause =  GET ( REF | REFERENCE ) LOCATIONS
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveSAPModuleCommand

Retrieve the details of an SAP Module

getPropertiesClause

Retrieve a set of properties that is associated with an SAP Module.

getPropertiesClause

Base properties for SAP_MODULE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of a SAP Module 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of an SAP Module

getReferenceLocationClause

Retrieve the new configuration default data location referenced by this module. This clause is synonymous with getReferenceDefaultLocationClause.

getReferenceDefaultLocationClause

Retrieve the new configuration default data location referenced by this module. This clause is synonymous with getReferenceLocationClause.

getReferenceMetadataLocationClause

Retrieve the metadata location referenced by this SAP module.

getReferenceIconSetClause

Retrieve the icon set referenced by this SAP module.

getReferenceLocationsClause

Retrieve all of the data locations referenced by this module.

propertyNameList

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

See Also

OMBRETRIEVE

PKqPKpFJOEBPS/chap1001.htm% OMBALTER

OMBALTER

Purpose

Alter metadata for a component.

Prerequisites

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

Syntax

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

Parameters

alterCommand

Specify the component to alter.

fco_type

The type of the component.

fco_name

The physical name of the component in single quotes.

alterCommandSubClauses

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

renameClause

Rename the component.

setPropertiesClause

Set object properties.

setReferenceClause

Specify reference objects.

qualifier

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

unsetReferenceClause

Removes an existing reference.

qualifier

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

addSCOClauseForAlter

Add child objects under the component.

modifySCOClause

Change definition of a child object.

deleteSCOClause

Delete a child object.

propertyNameList

A list of property names.

propertyValueList

A list of property values.

quotedNameList

A list of single-quoted physical names.

parentSCOClause

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

modifySCOSubClauses

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

propertyName

An unquoted string representing the name of a property.

propertyValue

The value of a property.

moveToClause

Used to reorder child objects.

See Also

OMBCREATE

OMBDROP

PK[*%PKpFJOEBPS/chap19013.htmgH OMBRETRIEVE LOCATION

OMBRETRIEVE LOCATION

Purpose

Retrieve details of the location.

Prerequisites

Can be in any context.

Syntax

retrieveLocationCommand =  OMBRETRIEVE LOCATION "QUOTED_STRING" ( 
          "getPropertiesClause" | "getReferenceIconSetClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveLocationCommand

Retrieve details of the named location.

getPropertiesClause

Get specified properties of the location.

getReferenceIconSetClause

Get specified Icon Set.

propertyNameList

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

propertyNameList

Properties for LOCATION:

Basic properties:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the location.

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the location.

Name: TYPE
Type: STRING
Valid Values:
'Apps Concurrent Manager'
'CONCURRENT_MANAGER'
'DB2UDB'
'DB2UDB GATEWAY'
'DB2UDB PEOPLESOFT'
'DB2UDB SIEBEL'
'DISCOVERER'
'DRDA GATEWAY'
'FILE_SYSTEM'
'INFORMIX GATEWAY'
'J2EE Runtime'
'OBIEE'
'ODBC GATEWAY'
'ODBC EBS GATEWAY'
'ORACLE_DATABASE'
'ORACLE EBS'
'ORACLE_GATEWAY (deprecated)'
'ORACLE PEOPLESOFT'
'ORACLE SIEBEL'
'ORACLE_WORKFLOW'
'RDB GATEWAY'
'SQLSERVER'
'SQLSERVER GATEWAY'
'SQLSERVER PEOPLESOFT'
'SQLSERVER PEOPLESOFT GATEWAY'
'SQLSERVER SIEBEL'
'SQLSERVER SIEBEL GATEWAY'
'SYBASE GATEWAY'
'SAP'
'TRANSPORTABLE_MODULE_SOURCE'
'TRANSPORTABLE_MODULE_TARGET'
'URI'
'platform_name'
Default: N/A
The type of system the location represents. For extended platforms, it would be the logical name of the platform.

Name: VERSION
Type: STRING
Valid Values:
for 'Apps Concurrent Manager'     : '11i','R12'
for 'CONCURRENT_MANAGER'          : '11i','R12'
for 'FILE_SYSTEM'                 : do not set version
for 'ORACLE_DATABASE'             : '8.1','9.0','9.2','10.1','10.2','11.1','11.2'
for 'ORACLE_WORKFLOW'             : '2.6.2','2.6.3','2.6.4','11i','R12'
for 'DB2UDB'                      : '8.1','8.2','9.1' but no version is ok
for 'SQLSERVER'                   : '7.0','8.0','9.0' but no version is ok
for 'SAP'                         : '4.x','3.x'
for 'TRANSPORTABLE_MODULE_SOURCE' : '8.1','9.0','9.2','10.1','10.2','11.1','11.2'
for 'TRANSPORTABLE_MODULE_TARGET' : '8.1','9.0','9.2','10.1','10.2','11.1','11.2'
for Gateway                       : do not set version
Default: N/A
The version of the system(s) the location represents.

propertyNameList

Lists of available properties for different types of LOCATION:

for 'Apps Concurrent Manager'  'CONCURRENT_MANAGER' :
TYPE,PASSWORD,CONNECTION_TYPE,SCHEMA,VERSION,APPLICATION,APPLICATION_USER,RESPONSIBILITY
if CONNECTION_TYPE = HOST:PORT:SERVICE(default) HOST,PORT,SERVICE_NAME
if CONNECTION_TYPE = SQL_NET_CONNECTION NET_SERVICE_NAME

for 'DB2UDB', 'DB2UDB PEOPLESOFT', 'DB2UDB SIEBEL', 'SQLSERVER', 'SQLSERVER PEOPLESOFT' and 'SQLSERVER SIEBEL'
TYPE,CONNECT_AS_USER (or USER_NAME),PASSWORD,HOST,PORT,DATABASE_NAME,VERSION,SCHEMA

for 'DISCOVERER':
TYPE,USER,PASSWORD,INTEGRATION_TYPE,TRANSPORT_TYPE
if CONNECTION_TYPE = HOST:PORT:SERVICE(default) HOST,PORT,SERVICE_NAME
if CONNECTION_TYPE = SQL_NET_CONNECTION NET_SERVICE_NAME
if TRANSPORT_TYPE = FILE  ROOT_PATH, FILENAME
if TRANSPORT_TYPE = FTP   HOST_LOGIN_HOST,HOST_LOGIN_PORT,TRANSFER_TYPE,HOST_LOGIN_USER,HOST_LOGIN_PASSWORD,FILENAME
if TRANSPORT_TYPE = HTTP or HTTPS  HOST_LOGIN_HOST,HOST_LOGIN_PORT,HOST_LOGIN_USER,HOST_LOGIN_PASSWORD,FILENAME

for 'FILE_SYSTEM':
TYPE,USER (or USER_NAME),PASSWORD,HOST,ROOTPATH
if CONNECTION_TYPE = General(default)ROOTPATH
if CONNECTION_TYPE = FTP ROOTPATH

for Gateways:
TYPE,CONNECTION_TYPE, SCHEMA
if CONNECTION_TYPE = HOST:PORT:SERVICE(default) CONNECT_AS_USER (or USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,DATABASE_NAME
if CONNECTION_TYPE = OCI CONNECT_AS_USER, PASSWORD,NET_SERVICE_NAME
if CONNECTION_TYPE = SQL_NET_CONNECTION CONNECT_AS_USER,PASSWORD,NET_SERVICE_NAME,DATABASE_NAME

for 'Generic':
TYPE,CONNECTION_TYPE, SCHEMA,PORT,JNDI,DRIVER_CLASS,URI,IS_TEST_ON_REGISTER
if CONNECTION_TYPE = JNDI(default) CONNECT_AS_USER,PASSWORD

for 'J2EE Runtime':
TYPE, USER (or USER_NAME),PASSWORD,HOST,PORT,PORT_TYPE,INSTANCE,APPLICATION_NAME,WEB_PORT

propertyNameList

for 'OBIEE':
TYPE,VERSION,TRANSPORT_TYPE
if TRANSPORT_TYPE = FILE  ROOT_PATH, FILENAME
if TRANSPORT_TYPE = FTP   HOST_LOGIN_HOST,HOST_LOGIN_PORT,TRANSFER_TYPE,HOST_LOGIN_USER,HOST_LOGIN_PASSWORD,FILENAME
if TRANSPORT_TYPE = HTTP or HTTPS  HOST_LOGIN_HOST,HOST_LOGIN_PORT,HOST_LOGIN_USER,HOST_LOGIN_PASSWORD,FILENAME

for 'ORACLE_DATABASE', 'ORACLE EBS', 'ORACLE PEOPLESOFT' and 'ORACLE SIEBEL':
TYPE,CONNECTION_TYPE,VERSION,SCHEMA
if CONNECTION_TYPE = HOST:PORT:SERVICE(default) CONNECT_AS_USER (or USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,DATABASE_NAME
if CONNECTION_TYPE = DATABASE_LINK
if CONNECTION_TYPE = OCI CONNECT_AS_USER, PASSWORD,NET_SERVICE_NAME
if CONNECTION_TYPE = SQL_NET_CONNECTION CONNECT_AS_USER,PASSWORD,NET_SERVICE_NAME,DATABASE_NAME

for 'ORACLE_WORKFLOW':
TYPE,CONNECTION_TYPE,VERSION,PASSWORD,SCHEMA
if CONNECTION_TYPE = HOST:PORT:SERVICE(default) HOST,PORT,SERVICE_NAME
if CONNECTION_TYPE = SQL_NET_CONNECTION NET_SERVICE_NAME

for 'SAP':
TYPE, VERSION, HOST_LOGIN_USER, HOST_LOGIN_PASSWORD, FTP_DIRECTORY, EXECUTION_FM
if CONNECTION_TYPE = RFC_CONNECTION USER (or USER_NAME), PASSWORD, APPLICATION_SERVER, SYSTEM_NUMBER, CLIENT, LANGUAGE,TRANSPORT_TYPE
if CONNECTION_TYPE = SAPRFC.INI USER (or USER_NAME), PASSWORD, APPLICATION_SERVER, SYSTEM_NUMBER, CLIENT, LANGUAGE,TRANSPORT_TYPE
if TRANSPORT_TYPE = FILE  ROOT_PATH, FILENAME
if TRANSPORT_TYPE = FTP   HOST_LOGIN_HOST,HOST_LOGIN_PORT,TRANSFER_TYPE,HOST_LOGIN_USER,HOST_LOGIN_PASSWORD,FILENAME
if TRANSPORT_TYPE = HTTP or HTTPS  HOST_LOGIN_HOST,HOST_LOGIN_PORT,HOST_LOGIN_USER,HOST_LOGIN_PASSWORD,FILENAME

for 'TRANSPORTABLE_MODULE_SOURCE':
TYPE, VERSION,CONNECT_AS_USER (or USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME,TRANSPORT_TYPE
if TRANSPORT_TYPE = FILE 
if TRANSPORT_TYPE = FTP   HOST_LOGIN_PORT,TRANSFER_TYPE,HOST_LOGIN_USER,HOST_LOGIN_PASSWORD
if TRANSPORT_TYPE = HTTP or HTTPS  HOST_LOGIN_HOST,HOST_LOGIN_PORT,HOST_LOGIN_USER,HOST_LOGIN_PASSWORD,FILENAME

for 'TRANSPORTABLE_MODULE_TARGET':
TYPE, VERSION,CONNECT_AS_USER (or USER_NAME),PASSWORD,HOST,PORT,SERVICE_NAME

for 'URI':
URI,USER,PASSWORD

propertyNameList

Additional detail properties for LOCATIONs:

Name: APPLICATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The Application name for Apps Concurrent Manager locations.

Name: APPLICATION_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
Application name for the J2EE Runtime location.

Name: APPLICATION_USER
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The user name for Apps Concurrent Manager locations.

Name: APPLICATION_SERVER
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The application server for SAP locations.

Name: CLIENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The client for SAP locations.

Name: CONNECT_AS_USER
Synonym: USER_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The user name.

Name: CONNECTION_TYPE
Type: STRING
Valid Values: 'HOST_PORT_SERVICE', 'SQL_NET_CONNECTION', 'DATABASE_LINK', 'OCI', 'General', 'FTP', 'RCF_CONNECTION', 'SAPRFC.INI' 
Default: 'HOST_PORT_SERVICE'
The location connection details format.

Name: DATABASE_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The Data Base name.

Name: DRIVER_CLASS
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
Full path for driver class.

Name: EXECUTION_FM
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
RFC Function Module for remote ABAP report execution for SAP locations.

Name: FTP_DIRECTORY
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The directory used in an ftp session for SAP locations.

Name: HOST
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The machine name.

Name: HOST_LOGIN_HOST
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The host for FTP, HTTP and HTTPS transports.

Name: HOST_LOGIN_PASSWORD
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The port number for FTP, HTTP and HTTPS transports.

Name: HOST_LOGIN_PORT
Type: NUMBER
Valid Values: 1 - 65535
Default: 1521
The port number for FTP, HTTP and HTTPS transports.

Name: HOST_LOGIN_USER
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The user for FTP, HTTP and HTTPS transports.

Name: INSTANCE
Type: STRING
Valid Values: 'DIRECT','INDIRECT'
Default: 'DIRECT'
OC4J Instance Name for J2EE Runtime locations.

propertyNameList

Advanced properties for LOCATIONs:

Name: CATALOG

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Catalog for the location.

Name: DATASERVER_NAME

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Data server name for the location.

Name: DRIVER_CLASS

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Full path for driver class.

Name: URI

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Connection string.

Name: URI_TEMPLATE

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Connection string.

Name: WORK_SCHEMA

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Work schema (owner) for the location.

Name: WORK_CATALOG

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Work catalog for the location.

propertyNameList

Mask properties for LOCATIONs:

Name: DATE_MASK

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Date mask for the location..

Name: DATE_FCT_MASK

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Date function mask for the location..

Name: LOCAL_OBJECT_MASK

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Local mask for the location..

Name: NUMERIC_MASK

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Numeric mask for the location..

Name: REMOTE_OBJECT_MASK

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Remote mask for the location..

Name: VARCHAR_OBJECT_MASK

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: N/A

Varchar mask for the location..

propertyNameList

Prefix properties for LOCATIONs:

Name: DATASTORE_PREFIX

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: 'J$_'

Data stores prefix for the location.

Name: ERROR_TABLE_PREFIX

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: 'E$_'

Error table prefix for the location.

Name: INTEGRATION_TABLE_PREFIX

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: 'I$_'

Integration table prefix for the location.

Name: LOADING_TABLE_PREFIX

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: C$_

Loading table prefix for the location..

Name: TRIGGER_PREFIX

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: 'T$_'

Trigger prefix for the location.

Name: VIEW_PREFIX

Type: STRING

Valid Values: Any valid character string in supported character set.

Default: 'JV$_'

View prefix for the location.

LOCATION Object

Table 19-6 LOCATION Object

PropertyTypeChoicesMinMaxDefaultDescription

PLATFORM_NAME

STRING

none

none

none

empty string

Platform for the location.

VERSION

STRING

none

none

none

0

Version of the location


See Also

OMBRETRIEVE

PKulHgHPKpFJOEBPS/chap7016.htmRi OMBCREATE FUNCTION

OMBCREATE FUNCTION

Purpose

To create a Function.

Prerequisites

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

A Transformation Module may be WB_CUSTOM_TRANS for Public Transformations.

WB_CUSTOM_TRANS may by modified by an administrator.

WB_CUSTOM_TRANS is not dependent on any project.

Syntax

createFunctionCommand =  OMBCREATE ( FUNCTION "QUOTED_STRING" ( [ SET ( 
          "setPropertiesClause" [ SET "setFunctionCodeTemplateClause" | 
          "setReferenceIconSetClause" ] | "setFunctionCodeTemplateClause" | 
          "setReferenceIconSetClause" ) ] ) { ADD ( "addFuncProcParameterClause"
           | "addRelationalDependentClause" | "addFuncImplementationClause" ) } 
          )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setFunctionCodeTemplateClause =  ( REFERENCE | REF ) CODE_TEMPLATE 
          "QUOTED_STRING" FOR PLATFORM "QUOTED_STRING" | ( ( REFERENCE | REF ) 
          CODE_TEMPLATE FOR PLATFORM "QUOTED_STRING" OPTIONS "(" 
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")" )
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addFuncProcParameterClause =  PARAMETER "QUOTED_STRING" [ SET 
          "setPropertiesClause" ]
     addRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW | 
          MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE ) 
          "QUOTED_STRING"
     addFuncImplementationClause =  FUNCTION_IMPLEMENTATION "QUOTED_STRING" [ 
          SET "setFuncImplPropertiesClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setFuncImplPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES
           "(" "propertyValueList" ")"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

createFunctionCommand

This command creates a Function

QUOTED_STRING

Name of the Function to be created.

setPropertiesClause

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

getPropertiesClause

Basic properties for FUNCTION: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Function 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
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: Any valid character string in supported character set.
Default: Empty string
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: Any valid character string in supported character set.
Default: Empty string
Business name of the Parameter 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Parameter 

Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BINARY_INTEGER, BLOB, BOOLEAN, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, PLS_INTEGER, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: NUMBER
Set the data type for Parameter

Name: IN_OUT
Type: STRING
Valid Values: IN, OUT, INOUT
Default: 'IN'
Set the parameter mode for Parameter 

Name: DEFAULT_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Set the default value for Parameter

setReferenceIconSetClause

Set reference icon set for function.

addFuncProcParameterClause

Adds one or more Parameters to this Function.

addRelationalDependentClause

This clause adds referential dependencies to other relational objects.

addFuncImplementationClause

Add function implementation for this function.

propertyNameList

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

propertyValueList

Comma separated list of property values.

setFuncImplPropertiesClause

Set function implementation properties.

propertyValue

Value of a property.

FUNCTION Object

Table 7-10 FUNCTION Object

PropertyTypeChoicesMinMaxDefaultDescription

AUTHID

STRING

, CURRENT_USER, DEFINER

none

none

empty string

Generate the transformation with selected AUTHID option. The function will be executed with the permissions defined by the AUTHID clause instead of the function owner's permissions.

CALLED_ON_NULL_INPUT

STRING

, CALLED ON NULL INPUT

none

none

empty string

Specifies that the function is called regardless of whether any of its arguments are null. It can return a null value or a non-null value.

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

DETERMINISTIC_STATE

STRING

, DETERMINISTIC, NOT DETERMINISTIC

none

none

empty string

Specifies that the function returns the same result every time, for a given set of inputs.

ENCRYPTION

STRING

, ENCRYPTION

none

none

empty string

Specifies whether the function body will be encrypted when the function is created.

EXECUTE_AS

STRING

, EXECUTE AS CALLER, EXECUTE AS OWNER, EXECUTE AS SELF

none

none

empty string

Generate the transformation with selected EXECUTE AS option. Function will be executed with the permissions defined by the EXECUTE AS clause rather than the function owner's permissions.

EXTERNAL_ACTION

STRING

, EXTERNAL ACTION, NO EXTERNAL ACTION

none

none

empty string

Specifies that the function takes some action that changes the state of an object not managed by the database manager, such as reading or writing a file in the OS-managed folders.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

INHERIT_ISOLATION_LEVEL

STRING

, INHERIT ISOLATION LEVEL WITH LOCK REQUEST, INHERIT ISOLATION LEVEL WITHOUT LOCK REQUEST

none

none

empty string

Specifies whether or not a lock request can be associated with the isolation-clause of the statement when the function inherits the isolation level of the statement that invokes the function. The default is INHERIT ISOLATION LEVEL WITHOUT LOCK REQUEST.

INHERIT_SPECIAL_REGISTERS

STRING

, INHERIT SPECIAL REGISTERS

none

none

empty string

Specifies that the function will inherit all the special registers from the invoking statement.

IS_DETERMINISTIC

STRING

, DETERMINISTIC

none

none

empty string

Optimization hint that specifies that the function returns the same result every time for a given set of arguments. If the function is called with the same arguments multiple times, then the optimizer may re-use the previous result.

IS_PARALLEL_ENABLE

STRING

, PARALLEL_ENABLE

none

none

empty string

Optimization hint, instructing Oracle to execute the function in parallel whenever called from within a SQL query.

LANGUAGE_SQL

STRING

, LANGUAGE SQL

none

none

empty string

This Optional clause indicates that the function is written in SQL PL. This is the default option, to satisfy SQL99 requirements.

PARAMETER_CCSID

STRING

, PARAMETER CCSID ASCII, PARAMETER CCSID UNICODE

none

none

empty string

Specifies the encoding scheme to use for all string data passed into and out of the function. If the PARAMETER CCSID clause is not specified, the default is PARAMETER CCSID UNICODE for Unicode databases, and PARAMETER CCSID ASCII for all other databases.

PRAGMA_AUTONOMOUS_TRANSACTION

STRING

, PRAGMA AUTONOMOUS_TRANSACTION

none

none

empty string

Instructs the PL/SQL compiler to mark the function as independent, which allows the function to suspend the main transaction.

SCHEMABINDING

STRING

, SCHEMABINDING

none

none

empty string

Specifies that the function is bound to the database objects that it references (that is, they cannot be dropped or modified). This condition will prevent changes to the function if other schema-bound objects are referencing it. If a function is created with SCHEMABINDING, then the function is a deterministic function.

SPECIFIC

STRING

none

none

none

empty string

Uniquely identifies a function within the current schema. The specific name can be the same as the function name, and it can be up to 18 characters long. If the SPECIFIC keyword is omitted, then the IBM DB2 UDB Database Manager automatically generates a unique identifier for the function in the format SQLyymmddhhmmssxxx.

SQL_DATA

STRING

, CONTAINS SQL, MODIFIES SQL DATA, READS SQL DATA

none

none

empty string

Specifies what type of SQL statements can be executed by the function. CONTAINS SQL specifies that the function can only execute SQL statements that do not read or modify SQL data. READS SQL DATA specifies that only SQL statements that do not modify SQL data can be executed by the function. MODIFIES SQL DATA specifies that all SQL statements supported in dynamic-compound-statement can be executed by the function.

STATIC_DISPATCH

STRING

, STATIC DISPATCH

none

none

empty string

Specifies that the function is to return the static values of an ARRAY or a user-defined type. Required if you have a non-SQL function that uses an ARRAY or a user-defined type as parameters.

WITH_NULL_INPUT

STRING

, CALLED ON NULL INPUT, RETURNS NULL ON NULL INPUT

none

none

empty string

Specifies that if RETURNS NULL ON NULL INPUT is specified in a CLR function, then SQL Server can return NULL when any of the arguments it receives is NULL, without actually invoking the body of the function. If CALLED ON NULL INPUT is specified, then the function body executes even if NULL is passed as an argument.


PK]WiRiPKpFJOEBPS/chap13011.htm_ OMBDROP MAPPING

OMBDROP MAPPING

Purpose

Drop an existing mapping.

Prerequisites

The current context of scripting must be an Oracle

Syntax

dropMappingCommand =  OMBDROP MAPPING "mappingName"
     mappingName =  "QUOTED_STRING"

Parameters

dropMappingCommand

Drop an existing mapping.

mappingName

Name of the mapping.

PK/Zd _ PKpFJOEBPS/chap12003.htmY OMBDROP CONTROL_CENTER

OMBDROP CONTROL_CENTER

Purpose

Delete the control center.

Prerequisites

Can be in any context.

Syntax

dropControlCenterCommand =  OMBDROP ( CONTROL_CENTER "QUOTED_STRING" )

Parameters

dropControlCenterCommand

Drop the control center from the workspace.

PK ?ثPKpFJOEBPS/chap15008.htm' OMBDROP WEB_SERVICE_PACKAGE

OMBDROP WEB_SERVICE_PACKAGE

Purpose

Delete the Web Service Package.

Prerequisites

Should be in the context of a Web Service Module.

Syntax

dropWebServicePackageCommand =  OMBDROP WEB_SERVICE_PACKAGE "QUOTED_STRING"

Parameters

dropWebServicePackageCommand

Drop the web service package.

PKW, ' PKpFJOEBPS/chap10020.htmd OMBDESCRIBE CLASS_DEFINITION

OMBDESCRIBE CLASS_DEFINITION

Purpose

To describe a class definition or its property definitions.

Prerequisites

Class definition must be already exist. This command can be executed for any class definition regardless of current context.

Syntax

parseDescribeClassCommand =  OMBDESCRIBE CLASS_DEFINITION "QUOTED_STRING" [
           ( ON | OF ) "modelClause" ] ( ( PROPERTY_DEFINITION "QUOTED_STRING" 
          GET "getPropertyDefinitionPropertiesClause" ) | ( GET ( [ USER_DEFINED
           | CORE | LOGICAL | ( CONFIGURATION | PHYSICAL_CONFIGURATION ) ] 
          PROPERTY_DEFINITIONS ) ) | GET "getClassDefinitionPropertiesClause" | 
          GET CHILD_TYPES | GET ASSOCIATION_DEFINITIONS )
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" | 
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM 
          "QUOTED_STRING" )
     getPropertyDefinitionPropertiesClause =  PROPERTIES "(" "propertyNameList" 
          ")"
     getClassDefinitionPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "propertyNameClause" { "," "propertyNameClause" }
     propertyNameClause =  ( "UNQUOTED_STRING" )

Parameters

parseDescribeClassCommand

Describe a class definition.

QUOTED_STRING

Name of the class definition.

PROPERTY_DEFINITIONS

Get the list of property definitions for the class definition.

propertyNameList

List of the names of the properties.

propertyNameClause

Name of the property.

UNQUOTED_STRING

Name of the property.

PK *FidPKpFJOEBPS/chap18001.htm OMBRETRIEVE CMI_DEFINITION

OMBRETRIEVE CMI_DEFINITION

Purpose

Retrieve details of the CMI definition.

Prerequisites

Should be in the root context.

Syntax

retrieveMIVDefinitionCommand =  OMBRETRIEVE CMI_DEFINITION "QUOTED_STRING" 
          "getPropertiesClause"
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveMIVDefinitionCommand

This command retrieves the details of an CMI Definition

QUOTED_STRING

Name of the existing CMI definition or path to the CMI definition.

getPropertiesClause

Retrieve a set of properties that is associated with an CMI Definition.

propertyNameList

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

CMI_DEFINITION Object

Table 18-1 CMI_DEFINITION Object

PropertyTypeChoicesMinMaxDefaultDescription

LOCATION_UOID

STRING

none

none

none

empty string

Location Warehouse Builder should use to retrieve the data.


See Also

OMBRETRIEVE

PK3jPKpFJOEBPS/chap6004.htm OMBCREATE BUSINESS_AREA

OMBCREATE BUSINESS_AREA

Purpose

Creates a Business Area to group business related items.

Prerequisites

Should be in the context of a Business Definition Module.

Syntax

createBusinessAreaCommand =  ( OMBCREATE BUSINESS_AREA "QUOTED_STRING" [ 
          SET "setPropertiesClause" ] [ SET "setReferenceIconSetClause" ] [ SET 
          ( REF | REFERENCE ) "(" "setfolderNameList" ")" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setfolderNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

createBusinessAreaCommand

This command creates a business area.

QUOTED_STRING

Specify the name of the business area to be created.

setPropertiesClause

Used to set properties (core, logical, physical, user-defined) for business areas. Valid properties are shown below:

getPropertiesClause

Basic properties for BUSINESS_AREA: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the business area 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the business area

setReferenceIconSetClause

Set specified Icon Set.

setfolderNameList

Used to set item folder references for this business area.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

propertyValue

This is a property value.

BUSINESS_AREA Object

Table 6-2 BUSINESS_AREA Object

PropertyTypeChoicesMinMaxDefaultDescription

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those objects marked as Deployable = true


PK0PKpFJOEBPS/chap12004.htm > OMBDROP CORRECTION_MAPS_ACTION_PLAN

OMBDROP CORRECTION_MAPS_ACTION_PLAN

Purpose

Drop an action plan for creating a correction map.

Prerequisites

In the context of a data profile.

Syntax

DropActionPlanCommand =  ( OMBDROP ( ( DEPLOYMENT_ACTION_PLAN | 
          ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN | 
          CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" )

Parameters

DropActionPlanCommand

Drop a correction map action plan.

QUOTED_STRING

Name of correction map action plan.

PKuJ PKpFJOEBPS/chap4020.htm?k OMBALTER TIME_DIMENSION

OMBALTER TIME_DIMENSION

Purpose

This command alter a time dimension.

Prerequisites

Should be in Oracle Module context.

Syntax

alterTimeDimensionCommand =  OMBALTER TIME_DIMENSION "TimeDimensionName" ( 
          ( "renameDimensionClause" [ "setPropertiesClause" ] | 
          "setPropertiesClause" ) | "setFiscalPropertyClause" | 
          "renameMapClause" | "useSequenceClause" | ( "addDimensionRoleClause" |
           DELETE ( "deleteDimensionRoleClause" | "deleteLevelClause" ) | MODIFY
           ( "modifyDimensionRoleClause" | "modifyLevelClause" ) )+ | ( { 
          "addCalendarHierarchyClause" | "modifyCalendarHierarchyClause" | 
          "addFiscalCalendarHierarchyClause" | 
          "modifyFiscalCalendarHierarchyClause" | "deleteHierarchyClause" } [ 
          "implementationClause" ] [ "populationClause" ] ) )
     TimeDimensionName =  "QUOTED_STRING"
     renameDimensionClause =  RENAME DIMENSION TO "QUOTED_STRING"
     setPropertiesClause =  SET PROPERTIES "propertyKeyList" VALUES 
          "propertyValueList"
     setFiscalPropertyClause =  "setFiscalPropertiesClause"
     renameMapClause =  RENAME MAPPING TO "QUOTED_STRING"
     useSequenceClause =  SET REF SEQUENCE "QUOTED_STRING"
     addDimensionRoleClause =  ADD DIMENSION_ROLE "roleName" [ 
          "setPropertiesClause" ]
     deleteDimensionRoleClause =  DIMENSION_ROLE "roleName"
     deleteLevelClause =  "levelLocator"
     modifyDimensionRoleClause =  DIMENSION_ROLE "roleName" RENAME TO "roleName"
           [ "setPropertiesClause" ]
     modifyLevelClause =  "levelLocator" ( "renameClause" [ 
          "setPropertiesClause" ] )
     addCalendarHierarchyClause =  ADD ( ( NORMAL_CALENDAR HIERARCHY 
          "hierarchyName" [ "setPropertiesClause" ] SET ( REF | REFERENCE ) 
          "normalCalendarLevelList" ) | ( WEEK_CALENDAR HIERARCHY 
          "hierarchyName" [ "setPropertiesClause" ] SET ( REF | REFERENCE ) 
          "weekCalendarLevelList" ) )
     modifyCalendarHierarchyClause =  MODIFY ( ( NORMAL_CALENDAR 
          "hierarchyLocator" ( [ "renameClause" ] [ "setPropertiesClause" ] SET 
          ( REF | REFERENCE ) "normalCalendarLevelList" ) ) | ( WEEK_CALENDAR 
          "hierarchyLocator" [ "renameClause" ] [ "setPropertiesClause" ] SET ( 
          REF | REFERENCE ) "weekCalendarLevelList" ) )
     addFiscalCalendarHierarchyClause =  ADD FISCAL_CALENDAR HIERARCHY 
          "hierarchyName" [ "setPropertiesClause" ] SET ( REF | REFERENCE ) 
          "fiscalCalendarLevelList"
     modifyFiscalCalendarHierarchyClause =  MODIFY FISCAL_CALENDAR 
          "hierarchyLocator" [ "renameClause" ] [ "setPropertiesClause" ] SET ( 
          REF | REFERENCE ) "fiscalCalendarLevelList"
     deleteHierarchyClause =  DELETE "hierarchyLocator"
     implementationClause =  IMPLEMENTED BY ( STAR | SNOWFLAKE ) [ USING 
          COMPOSITE_UNIQUE_KEY ]
     populationClause =  POPULATE DATA FROM "calendarYear" FOR "yearCount" YEARS
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     setFiscalPropertiesClause =  SET FISCAL_CALENDAR PROPERTIES 
          "propertyKeyList" VALUES "propertyValueList"
     roleName =  "QUOTED_STRING"
     levelLocator =  LEVEL "levelName"
     renameClause =  RENAME TO "QUOTED_STRING"
     hierarchyName =  "QUOTED_STRING"
     normalCalendarLevelList =  "(" ( "normalCalendarLevelType" LEVEL [ 
          "levelName" ] [ "setPropertiesClause" ] ) { "," 
          "normalCalendarLevelType" LEVEL [ "levelName" ] [ 
          "setPropertiesClause" ] } ")"
     weekCalendarLevelList =  "(" ( "weekCalendarLevelType" LEVEL [ "levelName" 
          ] [ "setPropertiesClause" ] ) { "," "weekCalendarLevelType" LEVEL [ 
          "levelName" ] [ "setPropertiesClause" ] } ")"
     hierarchyLocator =  HIERARCHY "hierarchyName"
     fiscalCalendarLevelList =  "(" ( "fiscalCalendarLevelType" LEVEL [ 
          "levelName" ] [ "setPropertiesClause" ] ) { "," 
          "fiscalCalendarLevelType" LEVEL [ "levelName" ] [ 
          "setPropertiesClause" ] } ")"
     calendarYear =  "INTEGER_LITERAL"
     yearCount =  "INTEGER_LITERAL"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )
     levelName =  "QUOTED_STRING"
     normalCalendarLevelType =  ( DAY | CALENDAR_MONTH | CALENDAR_QUARTER | 
          CALENDAR_YEAR )
     weekCalendarLevelType =  ( DAY | CALENDAR_WEEK )
     fiscalCalendarLevelType =  ( DAY | FISCAL_WEEK | FISCAL_MONTH | 
          FISCAL_QUARTER | FISCAL_YEAR )

Parameters

alterTimeDimensionCommand

This command alters time dimension.

TimeDimensionName

The name of the time dimension.

renameDimensionClause

This clause renames the time dimension.

setPropertiesClause

This clause sets the following properties:

Name: BUSINESS_NAME

Type: STRING(200)

Valid Values: Any valid character string in supported character set.

Default: Empty string

Name: DESCRIPTION

Type: STRING(4000)

Valid Values: Any valid character string in supported character set.

Default: Empty string

setFiscalPropertyClause

set the fiscal properties.

renameMapClause

This clause renames the map that is created by the OMBCREATE TIME_DIMENSION command.

useSequenceClause

This clause sets the Sequence.

addDimensionRoleClause

This clause adds a dimension role.

deleteDimensionRoleClause

This clause deletes a dimension role.

deleteLevelClause

This clause finds the level to be deleted.

modifyDimensionRoleClause

This clause allows to rename the dimension role, or it change the dimension role's properties.

modifyLevelClause

This clause modifies level by either renaming it, or setting level properties.

addCalendarHierarchyClause

This clause adds a new hierarchy to the time dimension by: renaming the hierarchy, setting of hierarchy properties, or setting level references.

modifyCalendarHierarchyClause

This clause modifies a hierarchy of the time dimension by: renaming the hierarchy, setting of hierarchy properties, or setting level references.

addFiscalCalendarHierarchyClause

This clause adds an fiscal hierarchy to the time dimension.

modifyFiscalCalendarHierarchyClause

This clause modifies a fiscal hierarchy of the time dimension by: renaming the fiscal hierarchy, setting of fiscal hierarchy properties, or setting fiscal level references.

deleteHierarchyClause

This clause deletes a hierarchy from time dimension.

implementationClause

Time Dimension is implemented as STAR or as SNOWFLAKE.

populationClause

This clause specifies the starting year and the number of years for which data will be populated.

propertyKeyList

A list of time dimension properties.

propertyValueList

A list of time dimension property values.

setFiscalPropertiesClause

This clause sets the following properties:

Fiscal types allowed in OWB time dimension. Name: FISCAL_TYPE

Type: STRING

Valid Values: '544', '445'

Default: '544'

Fiscal calendar year start date, it could be any date of a year.

Name: FISCAL_CALENDAR_START_YEAR

Type: STRING

Valid Values: Dates in these format 'DD-MON-YYYY' or 'DD-MM-YYYY'

Default: '01-JAN-2000'

The day of the week when the fiscal year begins.

Name: FISCAL_CALENDAR_START_DAY_OF_WEEK

Type: STRING

Valid Values: 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY'

Default: 'false'

roleName

A role name.

levelLocator

This clause gets the level.

renameClause

Renaming of the time dimension.

hierarchyName

The name of a hierarchy.

normalCalendarLevelList

List of Normal Calendar's Levels.

weekCalendarLevelList

List of Week Calendar Levels.

hierarchyLocator

This clause gets the hierarchy.

fiscalCalendarLevelList

This clause creates a fiscal hierarchy and sets reference fiscal levels.

calendarYear

Calendar year in INTEGER_LITERAL

yearCount

Year count in INTEGER_LITERAL

propertyKey

Property Key in UNQUOTED_STRING

propertyKey

Basic properties for TIME DIMENSION, TIME DIMENSION MAP, DIMENSION_ATTRIBUTE, LEVEL, LEVEL_ATTRIBUTE and HIERARCHY: 

Basic properties for TIME DIMENSION :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Time Dimension 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Time Dimension 

Name: STORAGE
Type: STRING
Valid Values: 'RELATIONAL', 'AW' 
Default: 'RELATIONAL' 
The storage of a dimension can be AW or relational 

Name: AW_NAME
Type: STRING(32)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Set the analytical workspace name where the dimension is implemented 

Name: AW_DIMENSION_NAME
Type: STRING(32)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Set the Analytical Workspace dimension physical object name 


Basic properties for TIME MAP :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Time Dimension Map

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Time Dimension Map

Basic properties for DIMENSION_ATTRIBUTE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Dimension_Attribute 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string

propertyValue

Property Key Value in QUOTED_STRING, INTEGER_LITERAL, FLOATING_POINT_LITERAL

levelName

Level name in QUOTED_STRING

normalCalendarLevelType

Type of Normal Calendar Levels: DAY, CALENDAR_MONTH, CALENDAR_QUARTER, CALENDAR_YEAR

weekCalendarLevelType

Type of Week Calendar Levels: DAY, CALENDAR_WEEK

fiscalCalendarLevelType

Type of Fiscal Calendar Type: DAY, FISCAL_WEEK, FISCAL_MONTH, FISCAL_QUARTER, FISCAL_YEAR

DIMENSION Object

Table 4-63 DIMENSION Object

PropertyTypeChoicesMinMaxDefaultDescription

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

DEPLOYMENT_OPTIONS

STRING

DEPLOY_ALL, DEPLOY_DATA_OBJECTS_ONLY, DEPLOY_TO_CATALOG_ONLY

none

none

DEPLOY_DATA_OBJECTS_ONLY

Warehouse Builder generates a set of scripts for Dimension, they are DDL Scripts for Relational Dimensional or Scripts for ROLAP or or Scripts for AW.

ENABLE_MV_REFRESH

BOOLEAN

true, false

none

none

false

Enable MV Refresh

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

MVCONSTRAINTS

STRING

, ENFORCED, TRUSTED

none

none

TRUSTED

MV Constraints

NEXTDATE

STRING

none

none

none

empty string

Refresh Next Date

REFRESH

STRING

, COMPLETE, FAST, FORCE

none

none

FORCE

Refresh Mode

REFRESH_ON

STRING

, DEMAND, ONDATE

none

none

DEMAND

Refresh On

STARTWITH

STRING

none

none

none

empty string

Refresh Start Date

VIEW_NAME

STRING(30)

none

none

none

empty string

Name of the view that is generated to hide the control rows on the dimension implementation table of a star schema. If this field is left blank, the view name will default to '&lt;Name of Dimension&gt;_v'

VISIBLE

BOOLEAN

true, false

none

none

true

The Dimension is visible to OLAP end user if value is set = true.


HIERARCHY Object

Table 4-64 HIERARCHY Object

PropertyTypeChoicesMinMaxDefaultDescription

HIERLOADLEVEL

STRING

none

none

none

empty string



PKs[Dk?kPKpFJOEBPS/chap18006.htm3 OMBRETRIEVE CONNECTOR

OMBRETRIEVE CONNECTOR

Purpose

Retrieve details from a connector.

Prerequisites

Can be in any context; the name is a name of the connector's owning location and a connector name separated by slash.

Syntax

retrieveConnectorCommand =  OMBRETRIEVE CONNECTOR "QUOTED_STRING" ( 
          "getPropertiesClause" | "getReferencedLocationClause" | 
          "getReferenceIconSetClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferencedLocationClause =  GET ( REF | REFERENCE ) LOCATION
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveConnectorCommand

Retrieve details from the named connector.

getPropertiesClause

Get properties of the connector.

getReferencedLocationClause

Get the name of the location which the connector references.

getReferenceIconSetClause

Get the referenced icon set

propertyNameList

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

propertyNameList

Properties for CONNECTOR:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the connector.

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the connector.

Name: DATABASE_LINK_NAME
Type: STRING(30)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Database Link name.

CONNECTOR Object

Table 18-3 CONNECTOR Object

PropertyTypeChoicesMinMaxDefaultDescription

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those objects marked as Deployable = true


See Also

OMBRETRIEVE

PK>Bq83PKpFJOEBPS/chap1008.htmY OMBALTER BUSINESS_AREA

OMBALTER BUSINESS_AREA

Purpose

Alters a Business Area.

Prerequisites

Should be in the context of a Business Definition Module or use the full path.

Syntax

alterBusinessAreaCommand =  ( OMBALTER BUSINESS_AREA "QUOTED_STRING" ( ( 
          "renameClause" [ SET "setPropertiesClause" ] [ SET 
          "setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ] 
          { "alterBusinessAreaClauses" } ) | ( SET "setPropertiesClause" [ SET 
          "setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ] 
          { "alterBusinessAreaClauses" } ) | ( SET "setReferenceIconSetClause" [
           UNSET "unsetReferenceIconSetClause" ] { "alterBusinessAreaClauses" } 
          ) | ( UNSET "unsetReferenceIconSetClause" { "alterBusinessAreaClauses"
           } ) | ( "alterBusinessAreaClauses" { "alterBusinessAreaClauses" } ) )
           )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterBusinessAreaClauses =  ( SET ( REF | REFERENCE ) "(" 
          "setfolderNameList" ")" | UNSET ( REF | REFERENCE ) "(" 
          "unsetfolderNameList" ")" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setfolderNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     unsetfolderNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

alterBusinessAreaCommand

This clause alters a Business Area.

QUOTED_STRING

name of the Business Area.

renameClause

Renames a Business Area with a different name.

setPropertiesClause

This clause sets the properties of the object.

getPropertiesClause

Basic properties for BUSINESS_AREA: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the business area 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the business area

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set.

alterBusinessAreaClauses

This clause adds or deletes item folder shortcuts.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

setfolderNameList

Used to set item folder references for this business area.

unsetfolderNameList

Used to remove folder references for this business area.

propertyValue

This is a property value.

BUSINESS_AREA Object

Table 1-4 BUSINESS_AREA Object

PropertyTypeChoicesMinMaxDefaultDescription

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those objects marked as Deployable = true


PKf1]^YPKpFJOEBPS/chap6003.htm OMBCREATE APPLICATION_SERVER_MODULE

OMBCREATE APPLICATION_SERVER_MODULE

Purpose

To create a Application Server Module.

Prerequisites

Should be in the context of a project.

Syntax

createApplicationServerModuleCommand =  OMBCREATE APPLICATION_SERVER_MODULE
           "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET 
          "setReferenceClause" ] | "setReferenceClause" ) ]
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceClause =  ( "setReferenceLocationClause" [ SET 
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

createApplicationServerModuleCommand

Create an application server module.

setPropertiesClause

Set values of properties of the application server module.

setPropertiesClause

Base properties for APPLICATION_SERVER_MODULE:

 Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of a Application Server Module 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of a Application Server Module

setReferenceClause

Set reference location or iconset for the application server module.

propertyNameList

A list of the property names.

propertyValueList

A list of the property values.

setReferenceLocationClause

Specify the ref location for the application server module as the new configuration default.

setReferenceIconSetClause

Specify the ref icon set for the application server module.

propertyValue

The property value of the object.

PK8fnPKpFJOEBPS/chap19014.htmAO OMBRETRIEVE LOGICAL_TABLE

OMBRETRIEVE LOGICAL_TABLE

Purpose

Retrieve details of a logical table.

Prerequisites

Should be in the context of an OBIEE Business Definition Module or use the full path.

Syntax

retrieveLogicalTableCommand =  OMBRETRIEVE LOGICAL_TABLE "QUOTED_STRING" ( 
          "retrieveItemFolderClauseLT" | "retrieveItemFolderItemClauseLT" | 
          "retrieveItemFolderJoinClauseLT" )
     retrieveItemFolderClauseLT =  GET ( "getPropertiesClause" | 
          "getReferenceIconSetClause" | "getItemFolderSCOClauseLT" )
     retrieveItemFolderItemClauseLT =  ITEM "QUOTED_STRING" GET ( 
          "getPropertiesClause" | SOURCE_OBJECTS | ( REF | REFERENCE ) 
          DRILL_LEVELS | ( REF | REFERENCE ) LOCAL JOINS | ( REF | REFERENCE ) 
          REMOTE JOINS )
     retrieveItemFolderJoinClauseLT =  JOIN "QUOTED_STRING" ( 
          "retrieveItemFolderJoinComponentClause" | GET ( "getPropertiesClause" 
          | JOIN_COMPONENTS | ( REF | REFERENCE ) FOREIGN_KEY | ( REF | 
          REFERENCE ) REMOTE LOGICAL_TABLE ) )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getItemFolderSCOClauseLT =  ITEMS | JOINS | SOURCE_OBJECTS | 
          DERIVATION_SOURCE | USING FOREIGN_KEYS | ( REF | REFERENCE ) 
          CATALOG_FOLDERS | ( REF | REFERENCE ) REMOTE JOINS | ( REF | REFERENCE
           ) ROLE | ( REF | REFERENCE ) LEVEL | DEPENDENTS
     retrieveItemFolderJoinComponentClause =  JOIN_COMPONENT "QUOTED_STRING" GET
           ( "getPropertiesClause" | ( REF | REFERENCE ) LOCAL ITEM | ( REF | 
          REFERENCE ) REMOTE ITEM )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveLogicalTableCommand

To retrieve a logical table.

QUOTED_STRING

name of the logical table.

retrieveItemFolderClauseLT

This clause retrieves the contents of a logical table.

GET

For a logical table, this clause retrieves the following

ITEMS retrieves the items in the logical table.

JOINS retrieves the joins in the logical table.

SOURCE_OBJECTS retrieves the objects the logical table is based on.

DERIVATION_SOURCE retrieves the source object derived into this logical table.

REF USING FOREIGN_KEYS retrieves the foreign keys usages for the logical table.

REF CATALOG_FOLDERS retrieves the catalog folders the logical table belongs to.

REF ROLE retrieves the dimension use reference for the logical table.

REF LEVEL retrieves the level reference for the logical table.

DEPENDENTS retrieves the dependents for the logical table.

retrieveItemFolderItemClauseLT

Retrieves a specific item.

QUOTED_STRING

name of the item.

GET

For an item, this clause retrieves the following

SOURCE_OBJECT retrieves the object that the item is based on.

In the case of a complex item (i.e. an expression) the list of items referenced by the current item

REF DRILL LEVELS retrieves the list of Drill Levels that reference this Item.

REF LOCAL JOINS retrieves the list of Join Components that reference this Item as their local Item.

REF REMOTE JOINS retrieves the list of Join Components that reference this Item as their remote Item.

retrieveItemFolderJoinClauseLT

Retrieves a specific join.

QUOTED_STRING

name of the join.

GET

For join this clause retrieves the following

JOIN_COMPONENTS retrieves the list of Join Components of this Join.

REF FOREIGN KEY retrieves the foreign key associated with this join.

ombretrieve_logical_table$getItemFolderSCOClauseLT = Retrieves the contents of the logical table.

getPropertiesClause

Retrieves the properties of the object.

getPropertiesClause

Basic properties for ITEM_FOLDER: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the item folder 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the item folder 

Name: EXTERNAL_TABLE_NAME
Type: STRING(255)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The physical name for the corresponding table or view.  This is automatically set if the Folder is associated with a Table

Name: VISIBLE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the item folder should be visible to the user 

Name: DISTINCT_VALUES
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether to select distinct values from the source. Oracle Business Intelligence Modules (OBIEE) only 

Name: BRIDGE_TABLE
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether this represents an intermediate table between a fact and dimension. Oracle Business Intelligence (OBIEE) only 

Name: FOLDER_TYPE
Type: STRING(40)
Valid Values: SIMPLE, COMPLEX
Default: Empty string
The type of item folder

Basic properties for ITEM:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the item 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the item 

Name: ALIGNMENT
Type: STRING(40)
Valid Values: GENERAL, LEFT, CENTER, RIGHT
Default: 'GENERAL'
The default alignment for displaying the item

Name: DISPLAY_CASE
Type: STRING(40)
Valid Values: GENERAL, LOWER, UPPER, INITCAPPED
Default: 'GENERAL'
How alphabetic characters should be displayed

Name: CASE_STORAGE
Type: STRING(40)
Valid Values: GENERAL, LOWER, UPPER, MIXED
Default: 'GENERAL'
How alphabetic characters are stored

Name: CONTENT_TYPE
Type: STRING(40)
Valid Values: No Value or FILE. For datatypes such as BLOB, it may contain a file extension such as DOC, AVI, WAV, JPG
Default: Empty string
Details on whether the Item contains a file name or should be processed by an external application

Name: DEFAULT_AGGREGATE
Type: STRING(255)
Valid Values (in a Logical Table): NONE, SUM, AVG, COUNT, COUNT DISTINCT, MAX, MIN, FIRST, LAST, MEDIAN, STDDEV and STDDEV_POP
Default: 'NONE'
Valid Values (in an Item Folder): Detail, AVG, COUNT, MAX, MIN, SUM
Default: 'SUM' when the datatype is Numeric, 'Detail' otherwise
Name of the default rollup function for the item

getPropertiesClause

Name: DEFAULT_POSITION
Type: STRING(40)
Valid Values: MEASURE, TOP OR SIDE, TOP, SIDE, PAGE
Default: 'MEASURE' when the datatype is NUMBER or FLOAT, 'TOP OR SIDE' otherwise
Default position for the item

Name: REPLACE_NULL_WITH
Type: STRING(255)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The value to be displayed for null values

Name: FORMULA
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The text of the derivation expression for a derived item 

Name: EXTERNAL_COLUMN_NAME
Type: STRING(255)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The external name of the corresponding column.  This is automatically set if the Item is is associated with a Column

Name: FORMAT_MASK
Type: STRING(255)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The display format mask for the item 

Name: HEADING
Type: STRING(255)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The displayed heading text for the item 

For Logical Table Items for OBI EE
Name: DATATYPE
Type: STRING(40)
Valid Values: BINARY, BIT, CHAR, DATE, DATETIME, DOUBLE, 
FLOAT, INT, INTERVAL, LONGVARBINARY, LONGVARCHAR, SMALLINT, 
TIME, TIMESTAMP, TINYINT, UNKNOWN, VARBINARY, VARCHAR
Default: 'VARCHAR'
For Item Folder Items for Oracle Discoverer
Name: DATATYPE
Type: STRING(40)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, LONG, LONG RAW 
NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE
TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHAR2, XMLTYPE
Default: 'VARCHAR2'
The datatype for the item 

Name: VISIBLE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the item should be visible to the user 

Name: MAX_CHAR_FETCHED
Type: Number
Valid Values: Any valid character string in supported character set.
Default: Empty string
The maximum number of characters fetched for an item 

Name: DEFAULT_WIDTH
Type: Number
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default number of characters to display 

Name: WORD_WRAP
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether wordwrap is allowed in the display

getPropertiesClause

Basic properties for JOIN:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the join 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the join 

Name: INCLUDE_UNMATCHED_DETAIL_ROWS
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether detail rows with no related master row should be included in the join

Name: INCLUDE_UNMATCHED_MASTER_ROWS
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether master rows with no related detail rows should be included in the join

Name: EXTERNAL_KEY_NAME
Type: STRING(255)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The external name of the corresponding foreign key.  This is automatically set if the Join is is associated with a Foreign Key 

Name: DETAIL_ALWAYS_HAS_MASTER
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether every detail row must reference a unique master row 

Name: ONE_TO_ONE
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether a master row only ever has a single detail row

Basic properties for JOIN_COMPONENT:

Name: JOIN_OPERATOR
Type: STRING(200)
Valid Values: =, &lt;&gt;, &lt;, &lt;=, &gt; or &gt;= 
Default: Empty string
Business name of the join 

Basic properties for CONDITION:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the condition 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the condition 

Name: MATCH_CASE
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the case of alphabetic characters must match exactly

Name: FORMULA
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The expression for the condition

Name: MANDATORY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the Condition is optional or mandatory

getReferenceIconSetClause

Get specified Icon Set.

getItemFolderSCOClauseLT

ombretrieve_logical_table$getItemFolderSCOClauseLT??

retrieveItemFolderJoinComponentClause

Retrieves the join components.

QUOTED_STRING

name of the join component.

GET

For join component this clause retrieves the following

REF LOCAL ITEM retrieves the local item used in the join.

REF REMOTE ITEM retrieves the remote item used in the join.

propertyNameList

This is the list of property names.

LOGICAL_TABLE Object

Table 19-7 LOGICAL_TABLE Object

PropertyTypeChoicesMinMaxDefaultDescription

BRIDGE_TABLE

BOOLEAN

true, false

none

none

false

Whether the Logical Table represents an intermediate table between a fact table and a dimension table (to resolve many-to-many associations).

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those objects marked as Deployable = true

DISTINCT_VALUES

BOOLEAN

true, false

none

none

false

Whether to only select distinct values from the source physical table.

EXTERNAL_TABLE_NAME

STRING

none

none

none

empty string

The physical name for the corresponding table or view.

VISIBLE

BOOLEAN

true, false

none

none

false

Whether this object is visible for use in query definitions.


PKFOAOPKpFJOEBPS/chap20019.htmi OMBRETRIEVE QUEUE_TABLE

OMBRETRIEVE QUEUE_TABLE

Purpose

Retrieve details of the Queue Table.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

retrieveQTCommand =  OMBRETRIEVE QUEUE_TABLE "QUOTED_STRING" ( GET 
          "getQTPropertiesClause" )
     getQTPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveQTCommand

Retrieves the details of the Queue Table with the given name.

getQTPropertiesClause

Retrieves the values of the given Properties for the Queue Table with the given name.

getQTPropertiesClause

Basic properties for QUEUE_TABLE: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Queue Table

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Queue Table

Name: PAYLOAD_TYPE
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Object Type for the Queue Table. This has to be the name of an Object Type  (OBJECT_TYPE) existing in any Oracle Module.

propertyNameList

The list of properties.

QUEUE_TABLE Object

Table 20-59 QUEUE_TABLE Object

PropertyTypeChoicesMinMaxDefaultDescription

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those objects marked as Deployable = true.

GENERATE_QUEUE_TABLE

BOOLEAN

true, false

none

none

true

Generate code to create the queue table that will persist the messages of this Advanced Queue.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

TABLESPACE

STRING(30)

none

none

none

empty string



PK,?PKpFJOEBPS/chap7011.htm: OMBCREATE EXPERT_MODULE

OMBCREATE EXPERT_MODULE

Purpose

To create an expert module.

Prerequisites

In the context of a project.

Syntax

createExpertModuleCommand =  OMBCREATE EXPERT_MODULE "QUOTED_STRING" [ SET 
          ( "setPropertiesClause" [ SET "setReferenceIconSetClause" ] | 
          "setReferenceIconSetClause" ) ]
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

createExpertModuleCommand

Create an expert module.

setPropertiesClause

Set properties for the expert module.

getPropertiesClause

Basic properties for EXPERT_MODULE: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the expert module

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the expert module

setReferenceIconSetClause

Set icon set for the expert module.

propertyNameList

The list of properties to set.

propertyValueList

The list of property values to set.

propertyValue

The value of the property.

PK;PKpFJOEBPS/chap13016.htm OMBDROP OBIEE_BUSINESS_DEFINITION_MODULE

OMBDROP OBIEE_BUSINESS_DEFINITION_MODULE

Purpose

Delete the Oracle BI business definition module.

Prerequisites

Should be in the context of project.

Syntax

dropOBIEEModuleCommand =  OMBDROP ( OBIEE_BUSINESS_DEFINITION_MODULE 
          "QUOTED_STRING" )

Parameters

dropOBIEEModuleCommand

Remove an existing Oracle BI business definition module.

QUOTED_STRING

Name of the existing Oracle BI business definition module in quotes.

PKaS  PKpFJOEBPS/chap10012.htmN OMBDEFINE COMPONENT_DEFINITION

OMBDEFINE COMPONENT_DEFINITION

Purpose

To define a component definition.

Prerequisites

The class definition for the component should already exist. The class must be a first class object.

Syntax

parseDefineComponentCommand =  OMBDEFINE COMPONENT_DEFINITION 
          "QUOTED_STRING" [ ( ON | OF ) "modelClause" ] [ 
          "addChildClassesClause" ]
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" | 
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM 
          "QUOTED_STRING" )
     addChildClassesClause =  "addChildClassClause"+
     addChildClassClause =  ( ADD "QUOTED_STRING" )

Parameters

PKPKpFJOEBPS/chap17019.htm 6 OMBRETRIEVE CALENDAR

OMBRETRIEVE CALENDAR

Purpose

Retrieve details of a Calendar.

Prerequisites

Should be in the context of a CalendarModule

Syntax

retrieveCalendarClause =  OMBRETRIEVE CALENDAR "QUOTED_STRING" ( ( GET ( 
          "getCalendarPropertiesClause" | "getReferenceIconSetClause" ) ) | 
          "getSchedulePropertiesClause" )
     getCalendarPropertiesClause =  ( PROPERTIES "propertyKeyList" ) | SCHEDULES
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getSchedulePropertiesClause =  SCHEDULE "QUOTED_STRING" GET PROPERTIES 
          "propertyKeyList"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyKey =  "UNQUOTED_STRING"

Parameters

retrieveCalendarClause

Retrieve the specified calendar.

getCalendarPropertiesClause

Describe the keys of properties for specified calendar.

getReferenceIconSetClause

Get the Icon Set for the calendar.

getSchedulePropertiesClause

Describe the keys of properties for specified schedule.

propertyKeyList

The list of property keys.

propertyKey

A property key for an object.

PKz? PKpFJOEBPS/chap4015.htm}# OMBALTER SEQUENCE

OMBALTER SEQUENCE

Purpose

To alter properties and definition of a sequence.

Prerequisites

In the context of an Oracle Module.

Syntax

alterSequenceCommand =  OMBALTER ( SEQUENCE "QUOTED_STRING" ( 
          "renameClause" [ "alterPropertiesOrIconSetClause" ] { MODIFY 
          "modifySequenceColumnClause" } | "alterPropertiesOrIconSetClause" { 
          MODIFY "modifySequenceColumnClause" } | ( MODIFY 
          "modifySequenceColumnClause" )+ ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET ( REF |
           REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE ) 
          "unsetReferenceIconSetClause" ] | ( REF | REFERENCE ) 
          "setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE ) 
          "unsetReferenceIconSetClause"
     modifySequenceColumnClause =  COLUMN "QUOTED_STRING" SET 
          "setPropertiesClause"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

alterSequenceCommand

This clause is for sequence alter command.

renameClause

renames a table with a different name.

modifySequenceColumnClause

This clause modifies the sequence's column.

setPropertiesClause

set sequences properties.

getPropertiesClause

Basic properties for SEQUENCE: 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the sequence. 

Name: CURRVAL
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: 1
current increment value. 

Name: NEXTVAL
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: 1
next increment value. next increment value.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

SEQUENCE Object

Table 4-53 SEQUENCE Object

PropertyTypeChoicesMinMaxDefaultDescription

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Description not available.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

INCREMENT_BY

NUMBER

none

-2147483648

2147483647

1

Description not available.

START_WITH

NUMBER

none

-2147483648

2147483647

1

Description not available.


PKd#}#PKpFJOEBPS/chap19021.htm!g OMBRETRIEVE OBIEE_BUSINESS_DEFINITION_MODULE

OMBRETRIEVE OBIEE_BUSINESS_DEFINITION_MODULE

Purpose

Retrieve details of the Oracle BI business definition module.

Prerequisites

Should be in the context of a project or use the full path.

Syntax

retrieveOBIEEModuleCommand =  OMBRETRIEVE OBIEE_BUSINESS_DEFINITION_MODULE 
          "QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause"
           | "getReferenceDefaultLocationClause" | "getReferenceIconSetClause" |
           "getReferenceLocationsClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceLocationClause =  GET ( REF | REFERENCE ) LOCATION
     getReferenceDefaultLocationClause =  GET ( REF | REFERENCE ) DEFAULT 
          LOCATION
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     getReferenceLocationsClause =  GET ( REF | REFERENCE ) LOCATIONS
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveOBIEEModuleCommand

This command retrieves the details of a Oracle BI business definition module.

QUOTED_STRING

Name of the existing Oracle BI business definition module or path to the Oracle BI business definition module.

getPropertiesClause

Retrieve a set of properties associated with a Oracle BI business definition module.

getPropertiesClause

Basic properties for OBIEE_BUSINESS_DEFINITION_MODULE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of a OBIEE business definition module 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of a OBIEE business definition module

getReferenceLocationClause

Retrieve the new configuration default data location referenced by this module. This clause is synonymous with getReferenceDefaultLocationClause.

getReferenceDefaultLocationClause

Retrieve the new configuration default data location referenced by this module. This clause is synonymous with getReferenceLocationClause.

getReferenceIconSetClause

Retrieve the icon set referenced by this Oracle BI business definition module.

getReferenceLocationsClause

Retrieve all of the data locations referenced by this module.

propertyNameList

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

OBIEE_BUSINESS_DEFINITION_MODULE Object

Table 19-61 OBIEE_BUSINESS_DEFINITION_MODULE Object

PropertyTypeChoicesMinMaxDefaultDescription

DB_LOCATION

STRING

none

none

none

empty string

Location for Business Intelligence Module

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those objects marked as Deployable = true

MLS_DEPLOYMENT_LANGUAGE

STRING

none

none

none

MLS_BASE_LANGUAGE

MLS Language to be used for deployment


See Also

OMBRETRIEVE

PK!!PKpFJOEBPS/chap5007.htm OMBCAC

OMBCAC

Purpose

Change Active Configuration command allows users to set as active another Configuration in a Project.

Prerequisites

Must be in a Project context.

Syntax

parseChangeActiveConfigurationCommand =  OMBCAC "QUOTED_STRING"

Parameters

parseChangeActiveConfigurationCommand

Specify Change Active Configuration command.

QUOTED_STRING

The name of the Configuration to be set as active.

See Also

OMBDAC

PK<PKpFJOEBPS/chap22008.htm \ OMBSWITCHMODE

OMBSWITCHMODE

Purpose

To switch the current workspace connection between SINGLE_USER_MODE (i.e. exclusive) and MULTIPLE_USER_MODE.

Prerequisites

Must be connected to an OWB workspace and not have any outstanding/unsaved work. If not already connected, use OMBCONNECT first. If there exists work that is not saved, use either OMBSAVE or OMBREVERT first.

Syntax

parseSwitchModeCommand =  OMBSWITCHMODE ( SINGLE_USER_MODE | 
          MULTIPLE_USER_MODE )

Parameters

parseSwitchModeCommand

Specify switch command.

SINGLE_USER_MODE

If specified, the user's current connection will be changed to permit them to use the workspace exclusively.

MULTIPLE_USER_MODE

If specified, the user's current connection will be changed to permit more than one session to work on the workspace at the same time.

PK| PKpFJOEBPS/chap11007.htm5 OMBDROP ACTIVITY_TEMPLATE

OMBDROP ACTIVITY_TEMPLATE

Purpose

To drop an activity template.

Prerequisites

Should be in the context of a Activity Template folder.

Syntax

dropActivityTemplate =  OMBDROP ACTIVITY_TEMPLATE "QUOTED_STRING"

Parameters

dropActivityTemplate

Drop the specified activity template.

PKNPKpFJOEBPS/chap8009.htm OMBCREATE MATERIALIZED_VIEW

OMBCREATE MATERIALIZED_VIEW

Purpose

To create a materialized view.

Prerequisites

In the context of an Oracle Module.

Syntax

createMaterializedViewCommand =  OMBCREATE ( MATERIALIZED_VIEW 
          "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET ( REF | REFERENCE 
          ) "setReferenceIconSetClause" ] | ( REF | REFERENCE ) 
          "setReferenceIconSetClause" ) ] [ 
          "addMaterializedViewSCOandDependentClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     addMaterializedViewSCOandDependentClause =  ADD ( "addColumnClause" | 
          "addViewConstraintClause" | "addSCOClause" | 
          "addRelationalDependentClause" ) [ 
          "addMaterializedViewSCOandDependentClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addColumnClause =  COLUMN "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ]
           [ SET "setPropertiesClause" ]
     addViewConstraintClause =  "addUkPkClause" | "addFkClause"
     addSCOClause =  "addIndexClause" | "addIndexPartitionClause" | 
          "addIndexPartitionKeyClause" | "addPartitionClause" | 
          "addPartitionKeyClause" | "addSubpartitionClause" | 
          "addaddMaterializedViewSCOandDependentClauseClause" | 
          "addSubPartitionKeyClause" | "addIndexColumnClause" | 
          "addAttributeSetClause"
     addRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW | 
          MATERIALIZED_VIEW ) "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )
     addUkPkClause =  ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ SET 
          "setUkPkPropertiesAndReferencesColumnsClauses" ]
     addFkClause =  FOREIGN_KEY "QUOTED_STRING" [ SET "setFkSubClauses" ]
     addIndexClause =  INDEX "QUOTED_STRING" [ SET 
          "setSCOConfigurationPropertiesClauses" ]
     addIndexPartitionClause =  INDEX_PARTITION "QUOTED_STRING" OF INDEX 
          "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] ( 
          "renameSCOConfigurationClause" [ SET 
          "setSCOConfigurationPropertiesClauses" ] | [ SET 
          "setSCOConfigurationPropertiesClauses" ] )
     addIndexPartitionKeyClause =  INDEX_PARTITION_KEY "QUOTED_STRING" OF INDEX 
          "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ]
     addPartitionClause =  PARTITION "QUOTED_STRING" [ AT POSITION 
          "INTEGER_LITERAL" ] [ SET "setSCOConfigurationPropertiesClauses" ]
     addPartitionKeyClause =  PARTITION_KEY "QUOTED_STRING" [ SET 
          "setSCOConfigurationPropertiesClauses" ]
     addSubpartitionClause =  SUBPARTITION "QUOTED_STRING" OF PARTITION 
          "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET 
          "setSCOConfigurationPropertiesClauses" ]
     addaddMaterializedViewSCOandDependentClauseClause =  TEMPLATE_SUBPARTITION 
          "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ] [ SET 
          "setSCOConfigurationPropertiesClauses" ]
     addSubPartitionKeyClause =  SUBPARTITION_KEY "QUOTED_STRING" [ SET 
          "setSCOConfigurationPropertiesClauses" ]
     addIndexColumnClause =  INDEX_COLUMN "QUOTED_STRING" OF INDEX 
          "QUOTED_STRING" [ SET "setSCOConfigurationPropertiesClauses" ]
     addAttributeSetClause =  ATTRIBUTE_SET "QUOTED_STRING"
     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" ]

Parameters

createMaterializedViewCommand

This command creates a materialized view.

QUOTED_STRING

Specify the name of the materialized view to be created.

setPropertiesClause

Used to set properties (core, logical, physical, user-defined) for materialized views (including partitions and subpartitions) and their columns, indexes (including index partitions), unique keys, foreign keys, and primary keys.

getPropertiesClause

Note:

Constraints can be specified but will not be generated for either View or Materialized View in this release.


Basic properties for VIEW, MATERIALIZED_VIEW: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the View, MaterializedView 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the View, MaterializedView 

Name: VIEW_QUERY
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Sets the query definition in View and MaterializedView.

getPropertiesClause

Basic properties for COLUMN: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the column

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the column 

Name: DATATYPE
Type: STRING
Valid Values: 
(Oracle) BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, LONG RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
(DB2 UDB) BIGINT, BLOB, CHAR, CLOB, DATE, DBCLOB, DECIMAL, DOUBLE, FLOAT, GRAPHIC, INT, LONG VARCHAR, LONG VARGRAPHIC, NUMERIC, REAL, SMALLINT, TIME, TIMESTAMP, VARCHAR, VARGRAPHIC, XML
(SQL Server) BIGINT, BINARY, BIT, CHAR, DATETIME, DECIMAL, FLOAT, IMAGE, INT, MONEY, NCHAR, NTEXT, NUMERIC, NVARCHAR, NVARCHAR(MAX), REAL, SMALLDATETIME, SMALLINT, SMALLMONEY, SQL_VARIANT, TEXT, TIMESTAMP, TINYINT, UNIQUEIDENTIFIER, VARBINARY, VARBINARY(MAX), VARCHAR, VARCHAR(MAX), XML

Default: NUMBER
The datatype of a column

Name: LENGTH
Type: NUMBER
Valid Values: 
Default: 1
The length of a number 

Name: PRECISION
Type: NUMBER
Valid Values: 0 - 38
Default: 1
The precision of a number. Use 0 to specify floating-point numbers.
Also use this to specify Year or Day precision for INTERVAL data types.

Name: SCALE
Type: NUMBER
Valid Values: -84 - 127
Default: 1
The scale of a number.

Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.

Name: DEFAULT_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Default value of the column 

Name: NOT_NULL
Type: BOOLEAN
Valid Values: true, false
Default: false
Specify "true" to enforce Not Null restriction on a column. 

Name: VIRTUAL
Type: BOOLEAN
Valid Values: true, false
Default: false
Specify "true" to indicate a virtual Column. 

Name: EXPRESSION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Column expression for a virtual column

getPropertiesClause

Basic properties for PARTITION_KEY: 

Name: TYPE
Type: STRING
Valid Values: RANGE, LIST, HASH, HASH BY QUANTITY
Default: (No default, must be one of the choices above)
Ask Oracle to partition the table rows according to a Hash Algorithm, lists of values, or specified ranges.

Name: HASH_QUANTITY
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: '0'
Specify how many HASH partitions the database should create on HASH BY QUANTITY partitioning. For optimal load balancing you should specify a number of partitions that is a power of 2. If you have multiple Partition Keys, you only have to specify once. 

Name: INTERVAL
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Specify valid interval value or expression (NUMBER or DATE) for Interval (Range) Partitioning. 

Basic properties for PARTITION: 

Name: VALUES_LESS_THAN
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Specify the noninclusive upper bound for the current RANGE partition. The value list is a comma-delimited, ordered list of literal values corresponding to the index partitioning column list. Always specify MAXVALUE(s) as the value(s) of the last partition, and make sure you have specified PARTITION_KEY(s) before you specify any PARTITION. 

Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Specify a list of literal values for the current LIST partition. The value list is a comma-delimited, ordered list of literal values corresponding to the index partitioning column. Commas can be escaped using "" (e.g. '1,2,3'). Always specify DEFAULT as the value of the last partition, and make sure you have specified PARTITION_KEY(s) before you specify any PARTITION.. Each LIST partition must have at least one value. No value, including NULL, can appear in more than one partition. 

Name: HASH_QUANTITY
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: '0'
Specify how many HASH customized subpartitions the database should create for a particular main RANGE partition (RANGE-HASH BY QUANTITY partitioning). For optimal load balancing you should specify a number of subpartitions that is a power of 2. If you have multiple Subpartition Keys, you only have to specify once. Set it to 0 to reverse to the use of generic template HASH_QUANTITY specified in SUBPARTITION_KEY.

getPropertiesClause

Basic properties for SUBPARTITION_KEY: 

Name: TYPE
Type: STRING
Valid Values: LIST, HASH, HASH BY QUANTITY
Default: (No default, must be one of the choices above)
For partition-level partitioning according to a Hash Algorithm or lists of values. Each partition is further sorted into subpartitions.

Name: HASH_QUANTITY
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: '0'
Specify how many HASH subpartitions the database should create on HASH BY QUANTITY partitioning. For optimal load balancing you should specify a number of subpartitions that is a power of 2. If you have multiple Subpartition Keys, you only have to specify once. 

Basic properties for SUBPARTITION: 

Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Specify a list of literal values for the current LIST subpartition. The value list is a comma-delimited, ordered list of literal values corresponding to the index partitioning column. Always specify DEFAULT as the value of the last subpartition, and make sure you have specified SUBPARTITION_KEY(s) before you specify any SUBPARTITION. Each LIST subpartition must have at least one value. No value, including NULL, can appear in more than one subpartition. 

Basic properties for TEMPLATE_SUBPARTITION: 

Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
In composite partitioning, template subpartitions are automatically applied to those partitions without their subpartitions specified. Here for LIST subpartitions only, specify a comma-delimited, ordered list of literal values corresponding to the LIST subpartitioning column. Always specify DEFAULT as the value of the last template LIST subpartition, and and make sure you have specified SUBPARTITION_KEY(s) before you specify any TEMPLATE_SUBPARTITION. Each LIST template subpartition must have at least one value. No value, including NULL, can appear in more than one template subpartition.

getPropertiesClause

Basic properties for INDEX: 

Name: INDEX_TYPE
Type: STRING
Valid Values: UNIQUE, NON-UNIQUE, BITMAP, FUNCTION-BASED 
Default: (No default, must be one of the choices above)
Specify the type of an index.  NORMAL can be used in place of NON-UNIQUE.

Name: LOCAL_INDEX
Type: BOOLEAN
Valid Values: true, false
Default: false
Specify if an index is Global or Local. The default is Global.
Specify Local so that the index is partitioned on the same columns, with the same number of partitions and the same partition bounds as table. Oracle Database automatically maintains local index partitioning as the underlying table is repartitioned.

Name: COLUMN_EXPRESSION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Specify an expression built from columns of table, constants, SQL functions, and user-defined functions to create a FUNCTION-BASED index.

Basic properties for INDEX_PARTITION_KEY: 

Name: TYPE
Type: STRING
Valid Values: RANGE, HASH, HASH BY QUANTITY
Default: (No default, must be one of the choices above)
Ask Oracle to partition the index rows according to a Hash Algorithm, lists of values, or specified ranges. Hash index partitioning is supported starting with Oracle 10g version. 

Name: HASH_QUANTITY
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: '0'
Specify how many HASH index partitions the database should create based on HASH BY QUANTITY partitioning. For optimal load balancing you should specify a number of index partitions that is a power of 2. If you have multiple index Partition Keys, you only have to specify once. 

Basic properties for INDEX_PARTITION: 

Name: VALUES_LESS_THAN
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Specify the noninclusive upper bound for the current RANGE partition in a global index. The value list is a comma-delimited, ordered list of literal values corresponding to the index partitioning column list. Always specify MAXVALUE(s) as the value(s) of the last partition. No need to specify VALUES_LESS_THAN for Local index.

Name: VALUES_EQUAL_TO
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Specify a list of literal values for the current LIST partition in a global index. The value list is a comma-delimited, ordered list of literal values corresponding to the index partitioning column. Always specify DEFAULT as the value of the last partition. Each LIST partition must have at least one value. No value, including NULL, can appear in more than one partition. No need to specify VALUES_EQUAL_TO for Local index.

getPropertiesClause

Basic properties for CHECK_CONSTRAINTS: 

Name: CHECK_CONDITION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Specify a condition that each row in the table must satisfy.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

addColumnClause

This clause adds a column.

When you create a table or alter a table to add a set of columns, the

position that you specify for a column must be either less than or equal to

the number of columns that you have listed up to that point in the command.

For example, the following OMBCREATE command does not add the specified

columns to the table:

OMBCREATE TABLE 'MY_TABLE' \

SET PROPERTIES (DESCRIPTION) VALUES ('TRIAL TABLE') \

ADD COLUMN 'C1' \

SET PROPERTIES (DATATYPE, PRECISION) VALUES ('NUMBER',10) \

ADD COLUMN 'C2' AT POSITION 3 \

SET PROPERTIES (DATATYPE, PRECISION) VALUES ('NUMBER',10) \

ADD COLUMN 'C3' AT POSITION 2 \

SET PROPERTIES (DATATYPE) VALUES ('VARCHAR2')

This is because at the point when you specify the position of the column

C2 as 3, you have added just two columns to the table.But the following

OMBALTER command adds the specified columns to the table. This is because

at the point when you specify the position of the column C2 as 2, you are

adding the second column to the table.

OMBCREATE TABLE 'MY_TABLE' \

SET PROPERTIES (DESCRIPTION) VALUES ('TRIAL TABLE') \

ADD COLUMN 'C1' \

SET PROPERTIES (DATATYPE, PRECISION) VALUES ('NUMBER',10) \

ADD COLUMN 'C2' AT POSITION 2 \

SET PROPERTIES (DATATYPE) VALUES ('VARCHAR2') \

ADD COLUMN 'C3' AT POSITION 1 \

SET PROPERTIES (DATATYPE, PRECISION) VALUES ('NUMBER',10)

In the above example, the order in which the columns are added are as

follows:

C1

C1, C2

C3, C1, C2

addViewConstraintClause

This clause adds the view's configuration clause.

addSCOClause

This clause will add SCOs.

addRelationalDependentClause

This clause adds referential dependencies to other relational objects.

propertyValue

This clause adds the property values.

addUkPkClause

This clause adds a unique key and primary key.

QUOTED_STRING

name of the unique key or primary key.

addFkClause

This clause adds foreign key.

QUOTED_STRING

Name of the foreign key.

addIndexClause

This clause adds an index.

QUOTED_STRING

Name of the index.

addPartitionClause

This clause adds a partition.

QUOTED_STRING

Name of the partition.

addPartitionKeyClause

This clause adds a partition key.

QUOTED_STRING

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

addIndexColumnClause

This clause will add index column to a specified index.

QUOTED_STRING

This should be a column identifier of owning object (such as a table) of the index.

addAttributeSetClause

This clause adds an attribute set.

QUOTED_STRING

name of the attribute set.

setUkPkPropertiesAndReferencesColumnsClauses

This clause adds properties and references to columns.

setFkSubClauses

This clause sets references to a foreign key.

setSCOConfigurationPropertiesClauses

Set the configuration properties for the following:

- Partition, Subpartition, and Template Subpartition: All refer to configuration properties of Partition.

- Index, and Index Partition: For Index Partition, refer to configuration properties of Partition.

renameSCOConfigurationClause

This clause renames configuration objects.

constraintColumnReferencesClause

This clause provides names of all columns.

setFkReferencesClauses

This clause sets foreign key references.

quotedNameList

This clause gives column names.

constraintUkReferencesClause

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

MATERIALIZED_VIEW Object

Table 8-51 MATERIALIZED_VIEW Object

PropertyTypeChoicesMinMaxDefaultDescription

BASE_TABLES

STRING

none

none

none

empty string

Description not available.

BUFFER_POOL

STRING

, DEFAULT, KEEP, RECYCLE

none

none

empty string


BUILD

STRING

, DEFERRED, IMMEDIATE, PREBUILT

none

none

empty string

Description not available.

CACHE_MODE

STRING

, CACHE, NOCACHE

none

none

empty string

Description not available.

CONSTRAINTS

STRING

, ENFORCED, TRUSTED

none

none

empty string

Description not available.

DATA_SEGMENT_COMPRESSION

STRING

, COMPRESS, COMPRESS ALL, NOCOMPRESS

none

none

empty string

Description not available.

DEFAULTINDEXBUFFERPOOL

STRING

, DEFAULT, KEEP, RECYCLE

none

none

empty string


DEFAULTINDEXFREELISTGROUPS

STRING

none

none

none

empty string


DEFAULTINDEXFREELISTS

STRING

none

none

none

empty string


DEFAULTINDEXINITIAL

STRING

none

none

none

empty string


DEFAULTINDEXINITRANS

STRING

none

none

none

empty string


DEFAULTINDEXMAXEXTENTS

STRING

none

none

none

empty string


DEFAULTINDEXMAXTRANS

STRING

none

none

none

empty string


DEFAULTINDEXMINEXTENTS

STRING

none

none

none

empty string


DEFAULTINDEXNEXT

STRING

none

none

none

empty string


DEFAULTINDEXPCTINCREASE

STRING

none

none

none

empty string


DEFAULT_INDEX_TABLESPACE

STRING(30)

none

none

none

empty string


DEPLOYABLE

BOOLEAN

true, false

none

none

true

Description not available.

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string


ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string


FOR_UPDATE

STRING

, NO, YES

none

none

empty string


FREELISTGROUPS

STRING

none

none

none

empty string


FREELISTS

STRING

none

none

none

empty string


GENERATE_ERROR_TABLE_ONLY

BOOLEAN

true, false

none

none

false

Create, drop, replace or upgrade only the error table.

GENERATE_MV_LOG

STRING

, NO, YES

none

none

empty string


GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

HASH_PARTITION_TABLESPACE_LIST

STRING

none

none

none

empty string

Description not available.

INITIAL

STRING

none

none

none

empty string


INITRANS

STRING

none

none

none

empty string


LOGGING_MODE

STRING

, LOGGING, NOLOGGING

none

none

empty string

Description not available.

MAXEXTENTS

STRING

none

none

none

empty string


MAXTRANS

STRING

none

none

none

empty string


MINEXTENTS

STRING

none

none

none

empty string


MV_LOG_NEW_VALUES

STRING

, EXCLUDING, INCLUDING

none

none

empty string


MV_LOG_PRIMARY_KEY

STRING

, PRIMARY KEY

none

none

empty string


MV_LOG_ROWID

STRING

, ROWID

none

none

empty string


MV_LOG_SEQUENCE

STRING

, SEQUENCE

none

none

empty string


NEXT

STRING

none

none

none

empty string

Description not available.

NEXTDATE

STRING

none

none

none

empty string


PARALLEL_ACCESS_MODE

STRING

, NOPARALLEL, PARALLEL

none

none

empty string

Description not available.

PARALLEL_DEGREE

STRING

none

none

none

empty string


PCTFREE

STRING

none

none

none

empty string


PCTINCREASE

STRING

none

none

none

empty string


PCTUSED

STRING

none

none

none

empty string


QUERY_REWRITE

STRING

, DISABLE, ENABLE

none

none

empty string


REDUCED_PRECISION

STRING

, NO, YES

none

none

empty string

Description not available.

REFRESH

STRING

, COMPLETE, FAST, FORCE, NEVER

none

none

empty string

Description not available.

REFRESH_ON

STRING

, COMMIT, DEMAND

none

none

empty string

Description not available.

ROLLBACK

STRING

, DEFAULT, DEFAULT LOCAL, DEFAULT MASTER, NONE

none

none

DEFAULT LOCAL


ROLLBACKSEGMENTLOCAL

STRING

none

none

none

empty string

Description not available.

ROLLBACKSEGMENTMASTER

STRING

none

none

none

empty string

Description not available.

STARTWITH

STRING

none

none

none

empty string

Description not available.

TABLESPACE

STRING(30)

none

none

none

empty string


USING_INDEX_MODE

STRING

, USING_INDEX, USING_NO_INDEX

none

none

empty string

Description not available.

WITH_KEY

STRING

, PRIMARY_KEY, ROWID

none

none

empty string

Description not available.


COLUMN Object

Table 8-52 COLUMN Object

PropertyTypeChoicesMinMaxDefaultDescription

META_IMPORT_BYTES_PER_CHAR

NUMBER

none

none

none

1


META_IMPORT_CHARSET

STRING(45)

none

none

none

empty string


META_IMPORT_USE_CHAR_SEMANTICS

BOOLEAN

true, false

none

none

false



UNIQUE_KEY Object

Table 8-53 UNIQUE_KEY Object

PropertyTypeChoicesMinMaxDefaultDescription

DB_LOCATION

STRING

none

none

none

empty string

Location for referenced database objects.

DEFERRABLE

STRING

, DEFERRABLE, NOT DEFERRABLE

none

none

empty string

Specify DEFERRABLE to indicate that in subsequent transactions you can use the SET CONSTRAINT[S] clause to defer checking of this constraint until after the transaction is committed. Specify NOT DEFERRABLE to indicate that in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to defer checking of this constraint until the transaction is committed. The default is NOT DEFERRABLE.

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

ENABLECONSTRAINT

STRING

, DISABLE, ENABLE

none

none

empty string

Specify ENABLE if you want the constraint to be applied to the data in the table. Specify DISABLE to disable the integrity constraint. The default is ENABLE.

EXCEPTIONSINTO

STRING

none

none

none

empty string

Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the table you specify must exist on your local database. If you create your own exceptions table, then it must follow the format prescribed by one of the two scripts supplied by Oracle. Do not use this property with NOVALIDATE option.

INDEX_TABLESPACE

STRING(30)

none

none

none

empty string

Specify index tablespace to be used for a constraint if created as an index.

INITIALLY

STRING

, DEFERRED, IMMEDIATE

none

none

empty string

Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a DEFERRABLE constraint at the end of each subsequent SQL statement. Specify (INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE constraint at the end of subsequent transactions. The default is (INITIALLY) IMMEDIATE.

RELY

STRING

, NORELY, RELY

none

none

empty string

Specify RELY to activate an existing constraint in NOVALIDATE mode for query rewrite in an unenforced query rewrite integrity mode. The default is NORELY.

SUBSTITUTE_KEY

BOOLEAN

true, false

none

none

false

This is related to Streams Support. If this is true, deployment will result only in creation of the key metadata. The constraint itself will not be enforced. This will be done by creating a Streams substitute key.

USING_INDEX

BOOLEAN

true, false

none

none

false

Specify True to create a constraint as an index.

VALIDATECONSTRAINT

STRING

, NOVALIDATE, VALIDATE

none

none

empty string

The behavior of VALIDATE and NOVALIDATE always depends on whether the constraint is enabled or disabled, either explicitly or by default. (ENABLE) VALIDATE specifies that all old and new data must compliy with the constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on the constrained data comply with the constraint. (DISABLE) VALIDATE disables the constraint and drops the index on the constraint, but keeps the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no effort to maintain the constraint (because it is disabled) and cannot guarantee that the constraint is true (because it is not being validated). The default is NOVALIDATE.


FOREIGN_KEY Object

Table 8-54 FOREIGN_KEY Object

PropertyTypeChoicesMinMaxDefaultDescription

DB_LOCATION

STRING

none

none

none

empty string

Location for referenced database objects.

DEFERRABLE

STRING

, DEFERRABLE, NOT DEFERRABLE

none

none

empty string

Specify DEFERRABLE to indicate that in subsequent transactions you can use the SET CONSTRAINT[S] clause to defer checking of this constraint until after the transaction is committed. Specify NOT DEFERRABLE to indicate that in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to defer checking of this constraint until the transaction is committed. The default is NOT DEFERRABLE.

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

ENABLECONSTRAINT

STRING

, DISABLE, ENABLE

none

none

empty string

Specify ENABLE if you want the constraint to be applied to the data in the table. Specify DISABLE to disable the integrity constraint. The default is ENABLE.

EXCEPTIONSINTO

STRING

none

none

none

empty string

Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the table you specify must exist on your local database. If you create your own exceptions table, then it must follow the format prescribed by one of the two scripts supplied by Oracle. Do not use this property with NOVALIDATE option.

INITIALLY

STRING

, DEFERRED, IMMEDIATE

none

none

empty string

Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a DEFERRABLE constraint at the end of each subsequent SQL statement. Specify (INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE constraint at the end of subsequent transactions. The default is (INITIALLY) IMMEDIATE.

ONDELETE

STRING

, CASCADE, SET NULL

none

none

empty string

Specify CASCADE if you want Oracle to remove dependent foreign key values. Specify SET NULL if you want Oracle to convert dependent foreign key values to NULL.

RELY

STRING

, NORELY, RELY

none

none

empty string

Specify RELY to activate an existing constraint in NOVALIDATE mode for query rewrite in an unenforced query rewrite integrity mode. The default is NORELY.

SUBSTITUTE_KEY

BOOLEAN

true, false

none

none

false

This is related to Streams Support. If this is true, deployment will result only in creation of the key metadata. The constraint itself will not be enforced. This will be done by creating a Streams substitute key.

VALIDATECONSTRAINT

STRING

, NOVALIDATE, VALIDATE

none

none

empty string

The behavior of VALIDATE and NOVALIDATE always depends on whether the constraint is enabled or disabled, either explicitly or by default. (ENABLE) VALIDATE specifies that all old and new data must compliy with the constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on the constrained data comply with the constraint. (DISABLE) VALIDATE disables the constraint and drops the index on the constraint, but keeps the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no effort to maintain the constraint (because it is disabled) and cannot guarantee that the constraint is true (because it is not being validated). The default is NOVALIDATE.


CHECK_CONSTRAINT Object

Table 8-55 CHECK_CONSTRAINT Object

PropertyTypeChoicesMinMaxDefaultDescription

DB_LOCATION

STRING

none

none

none

empty string

Location for referenced database objects.

DEFERRABLE

STRING

, DEFERRABLE, NOT DEFERRABLE

none

none

empty string

Specify DEFERRABLE to indicate that in subsequent transactions you can use the SET CONSTRAINT[S] clause to defer checking of this constraint until after the transaction is committed. Specify NOT DEFERRABLE to indicate that in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to defer checking of this constraint until the transaction is committed. The default is NOT DEFERRABLE.

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

ENABLECONSTRAINT

STRING

, DISABLE, ENABLE

none

none

empty string

Specify ENABLE if you want the constraint to be applied to the data in the table. Specify DISABLE to disable the integrity constraint. The default is ENABLE.

EXCEPTIONSINTO

STRING

none

none

none

empty string

Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the table you specify must exist on your local database. If you create your own exceptions table, then it must follow the format prescribed by one of the two scripts supplied by Oracle. Do not use this property with NOVALIDATE option.

INITIALLY

STRING

, DEFERRED, IMMEDIATE

none

none

empty string

Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a DEFERRABLE constraint at the end of each subsequent SQL statement. Specify (INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE constraint at the end of subsequent transactions. The default is (INITIALLY) IMMEDIATE.

RELY

STRING

, NORELY, RELY

none

none

empty string

Specify RELY to activate an existing constraint in NOVALIDATE mode for query rewrite in an unenforced query rewrite integrity mode. The default is NORELY.

SUBSTITUTE_KEY

BOOLEAN

true, false

none

none

false

This is related to Streams Support. If this is true, deployment will result only in creation of the key metadata. The constraint itself will not be enforced. This will be done by creating a Streams substitute key.

VALIDATECONSTRAINT

STRING

, NOVALIDATE, VALIDATE

none

none

empty string

The behavior of VALIDATE and NOVALIDATE always depends on whether the constraint is enabled or disabled, either explicitly or by default. (ENABLE) VALIDATE specifies that all old and new data must compliy with the constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on the constrained data comply with the constraint. (DISABLE) VALIDATE disables the constraint and drops the index on the constraint, but keeps the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no effort to maintain the constraint (because it is disabled) and cannot guarantee that the constraint is true (because it is not being validated). The default is NOVALIDATE.


INDEX Object

Table 8-56 INDEX Object

PropertyTypeChoicesMinMaxDefaultDescription

BUFFER_POOL

STRING

, DEFAULT, KEEP, RECYCLE

none

none

empty string

Specify a default buffer pool (cache) for table or partition object. The default is DEFAULT.

COMPUTESTATISTICS

STRING

, NO, YES

none

none

empty string

Specify YES to collect statistics at relatively little cost during the creation of an index.

DB_LOCATION

STRING

none

none

none

empty string

Location for referenced database objects.

DEFERRABLE

STRING

, DEFERRABLE, NOT DEFERRABLE

none

none

empty string

Specify DEFERRABLE to indicate that in subsequent transactions you can use the SET CONSTRAINT[S] clause to defer checking of this constraint until after the transaction is committed. Specify NOT DEFERRABLE to indicate that in subsequent transactions you cannot use the SET CONSTRAINT[S] clause to defer checking of this constraint until the transaction is committed. The default is NOT DEFERRABLE.

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

ENABLECONSTRAINT

STRING

, DISABLE, ENABLE

none

none

empty string

Specify ENABLE if you want the constraint to be applied to the data in the table. Specify DISABLE to disable the integrity constraint. The default is ENABLE.

EXCEPTIONSINTO

STRING

none

none

none

empty string

Specify an exceptions table ([schema.]table). The EXCEPTIONS table or the table you specify must exist on your local database. If you create your own exceptions table, then it must follow the format prescribed by one of the two scripts supplied by Oracle. Do not use this property with NOVALIDATE option.

FREELISTGROUPS

STRING

none

none

none

empty string

Specify the number of groups of free lists for the database object you are creating. The default is 1.

FREELISTS

STRING

none

none

none

empty string

Specify the number of free lists for each of the free list groups for the table, partition, cluster, or index. The default is 1.

INDEXORDER

STRING

, ASC, DESC

none

none

empty string

Use ASC or DESC to indicate whether the index should be created in ascending or descending order. The Oracle default is ASC.

INITIAL

STRING

none

none

none

empty string

Specify in bytes the size of the first extent. Use K or M to specify size in kilobytes or megabytes.

INITIALLY

STRING

, DEFERRED, IMMEDIATE

none

none

empty string

Specify (INITIALLY) IMMEDIATE to indicate that Oracle should check a DEFERRABLE constraint at the end of each subsequent SQL statement. Specify (INITIALLY) DEFERRED to indicate that Oracle should check a DEFERRABLE constraint at the end of subsequent transactions. The default is (INITIALLY) IMMEDIATE.

INITRANS

STRING

none

none

none

empty string

Specify the initial number (2-255) of concurrent transaction entries allocated within each data block allocated to the database object. The default is 2 for Index.

KEYCOMPRESS

STRING

, COMPRESS, NOCOMPRESS

none

none

empty string

Specify COMPRESS to enable key compression.

KEYCOMPRESSPREFIXLENGTH

STRING

none

none

none

empty string

Specify the prefix length (number of prefix columns to compress). For unique indexes, the valid range of prefix length values is from 1 to the number of key columns minus 1. The default prefix length is the number of key columns minus 1. For nonunique indexes, the valid range of prefix length values is from 1 to the number of key columns. The default prefix length is the number of key columns. Oracle compresses only nonpartitioned indexes that are nonunique or unique indexes of at least two columns. You cannot specify COMPRESS for a bitmap index.

LOGGING_MODE

STRING

, LOGGING, NOLOGGING

none

none

empty string

Recovery requirements for a data warehouse : Logging or not logging to Redo Log File. The default is LOGGING.

MAXEXTENTS

STRING

none

none

none

empty string

Specify the total number of extents, including the first, that Oracle can allocate for the object.

MAXTRANS

STRING

none

none

none

empty string

Specify the maximum number (2-255) of concurrent transactions that can update a data block allocated to the database object.

MINEXTENTS

STRING

none

none

none

empty string

Specify the total number of extents to allocate when the object is created.

NEXT

STRING

none

none

none

empty string

Specify in bytes the size of the next extent to be allocated. Use K or M to specify size in kilobytes or megabytes.

ONLINE

STRING

, NO, YES

none

none

empty string

Specify YES to indicate that DML operations on the table will be allowed during creation of the index.

OPTIMAL

STRING

none

none

none

empty string

Specifies an optimal size in bytes for a rollback segment. Use K or M to specify this size in kilobytes or megabytes. Specify NULL for no optimal size for the rollback segment. The default is NULL.

OVERFLOW

STRING

none

none

none

empty string

Enter a comma separated list of Index tablespaces for overflow data. For simple-partitoned object, it is used for HASH BY QUANTITY partition overflow Index tablespaces. The number of Index tablespaces does not have to equal the number of partitions. If the number of partitions is greater than the number of Index tablespaces, then Oracle cycles through the names of the Index tablespaces.

PARALLEL_ACCESS_MODE

STRING

, NOPARALLEL, PARALLEL

none

none

empty string

Enables or disables parallel processing when the table is created. Also enables or disables parallel processing or access. The default is PARALLEL.

PARALLEL_DEGREE

STRING

none

none

none

empty string

Enter degree of parallelism, which is the number of parallel threads used in the parallel operation.

PARTITION_TABLESPACE_LIST

STRING

none

none

none

empty string

Enter a comma separated list of tablespaces for a locally partitioned index. For simple-partitoned object, it is used for HASH BY QUANTITY partition tablespaces. If specified, then individual local Hash index partitions specified will be ignored for Local Hash or Range-Hash Index partitioning.

PCTFREE

STRING

none

none

none

empty string

Specify a whole number representing the percentage (0-99) of space in each data block of the database object reserved for future updates to the rows of the object. The default is 10.

PCTINCREASE

STRING

none

none

none

empty string

Specify the percent by which the third and subsequent extents grow over the preceding extent. The default is 50.

RELY

STRING

, NORELY, RELY

none

none

empty string

Specify RELY to activate an existing constraint in NOVALIDATE mode for query rewrite in an unenforced query rewrite integrity mode. The default is NORELY.

SORT

STRING

, NOSORT, REVERSE, SORT

none

none

empty string

Specify NOSORT to indicate to Oracle that the rows are already stored in the database in ascending order. Specify REVERSE to store the bytes of the index block in reverse order, excluding the rowid.

SUBSTITUTE_KEY

BOOLEAN

true, false

none

none

false

This is related to Streams Support. If this is true, deployment will result only in creation of the key metadata. The constraint itself will not be enforced. This will be done by creating a Streams substitute key.

TABLESPACE

STRING(30)

none

none

none

empty string


VALIDATECONSTRAINT

STRING

, NOVALIDATE, VALIDATE

none

none

empty string

The behavior of VALIDATE and NOVALIDATE always depends on whether the constraint is enabled or disabled, either explicitly or by default. (ENABLE) VALIDATE specifies that all old and new data must compliy with the constraint. (ENABLE) NOVALIDATE only ensures that all new DML operations on the constrained data comply with the constraint. (DISABLE) VALIDATE disables the constraint and drops the index on the constraint, but keeps the constraint valid. (DISABLE) NOVALIDATE signifies that Oracle makes no effort to maintain the constraint (because it is disabled) and cannot guarantee that the constraint is true (because it is not being validated). The default is NOVALIDATE.


PARTITION Object

Table 8-57 PARTITION Object

PropertyTypeChoicesMinMaxDefaultDescription

BUFFER_POOL

STRING

, DEFAULT, KEEP, RECYCLE

none

none

empty string

Specify a default buffer pool (cache) for table or partition object. The default is DEFAULT.

DATA_SEGMENT_COMPRESSION

STRING

, COMPRESS, COMPRESS ALL, NOCOMPRESS

none

none

empty string

Use this clause to instruct Oracle whether to compress data segments to reduce disk use. The default is NOCOMPRESS.

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

FREELISTGROUPS

STRING

none

none

none

empty string

Specify the number of groups of free lists for the database object you are creating. The default is 1.

FREELISTS

STRING

none

none

none

empty string

Specify the number of free lists for each of the free list groups for the table, partition, cluster, or index.

INITIAL

STRING

none

none

none

empty string

Specify in bytes the size of the first extent. Use K or M to specify size in kilobytes or megabytes.

INITRANS

STRING

none

none

none

empty string

Specify the initial number (1-255) of concurrent transaction entries allocated within each data block allocated to the database object. The default is 1 for Table and 2 for Index.

LOGGING_MODE

STRING

, LOGGING, NOLOGGING

none

none

empty string

Specify whether the creation of the table and of any indexes required because of constraints, partition, or LOB storage characteristics will be logged in the redo log file (LOGGING) or not (NOLOGGING). The default is LOGGING.

MAXEXTENTS

STRING

none

none

none

empty string

Specify the total number of extents, including the first, that Oracle can allocate for the object.

MAXTRANS

STRING

none

none

none

empty string

Specify the maximum number (1-255) of concurrent transactions that can update a data block allocated to the database object.

MINEXTENTS

STRING

none

none

none

empty string

Specify the total number of extents to allocate when the object is created.

NEXT

STRING

none

none

none

empty string

Specify in bytes the size of the next extent to be allocated. Use K or M to specify size in kilobytes or megabytes.

OPTIMAL

STRING

none

none

none

empty string

Specifies an optimal size in bytes for a rollback segment. Use K or M to specify this size in kilobytes or megabytes. Specify NULL for no optimal size for the rollback segment. The default is NULL.

PCTFREE

STRING

none

none

none

empty string

Specify a whole number representing the percentage (0-99) of space in each data block of the database object reserved for future updates to the rows of the object. The default is 10.

PCTINCREASE

STRING

none

none

none

empty string

Specify the percent by which the third and subsequent extents grow over the preceding extent. The default is 50.

PCTUSED

STRING

none

none

none

empty string

Specify a whole number representing the minimum percentage (0-99) of used space that Oracle maintains for each data block of the database object. The default is 40.

TABLESPACE

STRING(30)

none

none

none

empty string



PK//PKpFJOEBPS/chap10015.htm ` OMBDEINSTALL OWB_REPOSITORY

OMBDEINSTALL OWB_REPOSITORY

Purpose

Drop a workspace in the OWB repository schema OWBSYS.

Prerequisites

To drop a workspace, within the same OMBPlus session, no other OMB commands should be issued before or after the OMBDEINSTALL WORKSPACE command. The workspace name must exist for the specified owning db user.

Syntax

parseDeinstallOWBRepositoryCommand =  OMBDEINSTALL ( OWB_REPOSITORY | 
          WORKSPACE ) "QUOTED_STRING" USING CREDENTIAL "UNQUOTED_STRING"

Parameters

parseDeinstallOWBRepositoryCommand

Specify an OMBDEINSTALL WORKSPACE command.

QUOTED_STRING

Specify the workspace name and, optionally, the workspace owner. If not provided, owner defaults to the user supplied in the connection string.

UNQUOTED_STRING

Specify the connection string to the database using this format: username/password@host:port:service name.

PK KQ PKpFJOEBPS/chap18.htmm OMBRETRIEVE CMI_DEFINITION to OMBRETRIEVE DRILL_TO_DETAIL

18 OMBRETRIEVE CMI_DEFINITION to OMBRETRIEVE DRILL_TO_DETAIL

PK r m PKpFJOEBPS/chap3019.htm OMBALTER PLSQL_REF_CURSOR_TYPE

OMBALTER PLSQL_REF_CURSOR_TYPE

Purpose

Alter the Ref-Cursor Type by resetting its properties.

Prerequisites

Should be in the context of a Package.

Syntax

alterPlSqlRefCursorTypeCommand =  OMBALTER ( PLSQL_REF_CURSOR_TYPE 
          "QUOTED_STRING" ( "renameClause" [ "alterPropertiesOrIconSetClause" ] 
          | SET "setPropertiesClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET ( REF |
           REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE ) 
          "unsetReferenceIconSetClause" ] | ( REF | REFERENCE ) 
          "setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE ) 
          "unsetReferenceIconSetClause"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

alterPlSqlRefCursorTypeCommand

Alters a PL/SQL Ref-cursor Type of the given name by setting it's properties.

renameClause

renames a table with a different name.

alterPropertiesOrIconSetClause

ombalter_plsql_ref_cursor_type$alterPropertiesOrIconSetClause??

getPropertiesClause

Basic properties for PLSQL_REF_CURSOR_TYPE: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Ref-Cursor Type

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Ref-Cursor Type

Name: RETURN_TYPE
Type: STRING(20)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Return type of the Ref-Cursor Type. This should be a PLSQL Record Type.

setReferenceIconSetClause

Sets reference icon set.

unsetReferenceIconSetClause

Unsets reference icon set.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

PLSQL_REF_CURSOR_TYPE Object

Table 3-65 PLSQL_REF_CURSOR_TYPE Object

PropertyTypeChoicesMinMaxDefaultDescription

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.


ATTRIBUTE Object

Table 3-66 ATTRIBUTE Object

PropertyTypeChoicesMinMaxDefaultDescription

ADDRESS_TYPE

STRING

NA_ADDRTYPE_DUAL, NA_ADDRTYPE_NORMAL

none

none

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.

AGGMAP_NAME

STRING

none

none

none

empty string


ATTRIBUTE_ROLE

STRING

END_DATE, LOOKUP_ACTIVE_DATE, MEASURE, NATURAL_KEY, NATURAL_KEY_AND_SURROGATE_KEY, NONE, PARENT_NATURAL_KEY, PARENT_NATURAL_KEY_AND_PARENT_SURROGATE_KEY, PARENT_REF_KEY, PARENT_SURROGATE_KEY, PREV_VALUE, START_DATE, SURROGATE_KEY, TRIGGER

none

none

NONE

The type of role to indicate how this attribute will be used in history logging. History As Previous Value indicates that this attribute will be used to keep previous value. Surrogate Identifier indicates that this attribute will be used to keep the surrogate identifier. Natural Identifier indicates that this attribute will be used to keep the natural identifier. Effective Time indicates that this attribute will be used as the effective time of the version. Expiration Time indicates that this attribute will be used as the expiration time of the version. Trigger indicates that this attribute will be used to trigger history logging. If none is specified, this attribute will be used to keep current value.

ATTR_NOT_NULL

BOOLEAN

true, false

none

none

false


BINDING_COLUMN_NAME

STRING

none

none

none

empty string

The binding column name for this attribute

BOUND_NAME

STRING

none

none

none

empty string

The name to be used by the code generator to identify this item. By default it is the same physical name as the item.

CODE_TEMPLATE_SCD

STRING(9)

SCD_END, SCD_FLAG, SCD_INS, SCD_NK, SCD_SK, SCD_START, SCD_UND, SCD_UPD

none

none

SCD_UND

Slowly changing dimension behavior for this attribute.

CODE_TEMPLATE_UPDATE

STRING(3)

NO, YES

none

none

YES

A boolean value indicating whether this attribute will included in code template functions using the UPD (Update) tag.

CODE_TEMPLATE_USER_DEFINED_1

STRING(3)

NO, YES

none

none

NO

A boolean value indicating whether this attribute will included in code template functions using the UD1 (User Defined 1) tag.

CODE_TEMPLATE_USER_DEFINED_2

STRING(3)

NO, YES

none

none

NO

A boolean value indicating whether this attribute will included in code template functions using the UD2 (User Defined 2) tag.

CODE_TEMPLATE_USER_DEFINED_3

STRING(3)

NO, YES

none

none

NO

A boolean value indicating whether this attribute will included in code template functions using the UD3 (User Defined 3) tag.

CODE_TEMPLATE_USER_DEFINED_4

STRING(3)

NO, YES

none

none

NO

A boolean value indicating whether this attribute will included in code template functions using the UD4 (User Defined 4) tag.

CODE_TEMPLATE_USER_DEFINED_5

STRING(3)

NO, YES

none

none

NO

A boolean value indicating whether this attribute will included in code template functions using the UD5 (User Defined 5) tag.

COLUMN_USAGE

STRING

CDC_COL, ROWID, ROWNUM, TABLE_COL

none

none

TABLE_COL


CONTROL_FLOW

BOOLEAN

true, false

none

none

false


CONTROL_STATIC

BOOLEAN

true, false

none

none

false


DATA_TYPE

STRING

none

none

none

empty string

The data type of the attribute

DEFAULT_VALUE

STRING

none

none

none

empty string

The default value for the attribute, used for orphan management default parent record creation.

DIMENSION_ATTRIBUTE_NAME

STRING

none

none

none

empty string

The dimension attribute referenced to by this level attribute.

EXPRESSION

STRING

none

none

none

empty string

The output expression for the attribute

FIELD_DATA_TYPE

STRING

BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE, FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARGRAPHIC, VARRAW, VARRAWC, ZONED, ZONED EXTERNAL

none

none

CHAR

SQL Data Type of the field in the file to which this operator is bound.

FIELD_DATA_TYPE_LENGTH

NUMBER

none

none

none

0

Field Length of the field in the file to which this operator is bound.

FIELD_DATA_TYPE_PRECISION

NUMBER

none

none

none

0

Field Precision of the field in the file to which this operator is bound.

FIELD_DATA_TYPE_SCALE

NUMBER

none

none

none

0

Field Scale of the field in the file to which this operator is bound.

FIELD_DEFAULTIF_VALUE

STRING

none

none

none

empty string

The expression that indicates the value of the field is blank or zero, based on the datatype.

FIELD_END_POSITION

NUMBER

none

none

none

0

The ending position of the field in the file

FIELD_MASK

STRING

none

none

none

empty string

The mask for the field

FIELD_NULLIF_VALUE

STRING

none

none

none

empty string

The expression that indicates the value of the field is null

FIELD_START_POSITION

NUMBER

none

none

none

0

The starting position of the field in the file

FRACTIONAL_SECONDS_PRECISION

NUMBER

none

none

none

0

The data fractional seconds precision value of the attribute

FUNCTION_RETURN

BOOLEAN

true, false

none

none

false

Specifies whether this output is the return value of this function

GROUP_KEY

BOOLEAN

true, false

none

none



false

A boolean value to indicate whether this input attribute is a part of the unpivot group key.

HISTORY_ATTRIBUTE

STRING

none

none

none

empty string

The bound name of the attribute to indicate where the history of the current attribute is to be logged.

INPUT_ROLE

STRING

NA_ADDRESS, NA_ADDRESS2, NA_CITY, NA_COUNTRYCODE, NA_COUNTRYNAME, NA_FIRMNAME, NA_FIRSTNAME, NA_FIRSTPARTNAME, NA_LASTLINE, NA_LASTLINE_2, NA_LASTNAME, NA_LASTPARTNAME, NA_LINE1, NA_LINE10, NA_LINE2, NA_LINE3, NA_LINE4, NA_LINE5, NA_LINE6, NA_LINE7, NA_LINE8, NA_LINE9, NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4, NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_NEIGHBORHOOD, NA_NONE, NA_PASSTHRU, NA_PERSON, NA_PERSON2, NA_PERSON3, NA_POSTALCODE, NA_POSTNAME, NA_PRENAME, NA_PRIMARYADDRESS, NA_SECONDARYADDRESS, NA_STATE

none

none

NA_NONE

Assigns a name-address input role to the selected input attribute

INSTANCE

STRING

NA_INSTANCE_FIFTH, NA_INSTANCE_FIRST, NA_INSTANCE_FOURTH, NA_INSTANCE_SECOND, NA_INSTANCE_SIXTH, NA_INSTANCE_THIRD

none

none

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.

IN_MATCHING_ATTRIBUTE

STRING

none

none

none

empty string

Defines the matching output attribute for the "IN" subquery

IS_AGGREGATION

STRING

NO, YES

none

none

NO


IS_CAST_TARGET

BOOLEAN

true, false

none

none

false

Description not available.

IS_CHUNKING_COLUMN

BOOLEAN

true, false

none

none

false

This Number Column will be used as the chunking column .

IS_OPTIONAL

BOOLEAN

true, false

none

none

false

If true, the input is not required to be connected

IS_PREDEFINED_CONSTANT

BOOLEAN

true, false

none

none

false

Description not available.

IS_VARIABLE_EXPRESSION

BOOLEAN

true, false

none

none

false

If true, the expression value is stored as a runtime variable. The value is altered only when the write condition is true.

JOIN_INPUT_UOID

STRING

none

none

none

empty string


JOIN_OUTPUT_UOID

STRING

none

none

none

empty string


LENGTH

NUMBER

none

none

none

0


LEVEL_ATTRIBUTE_COLNAME_NAME

STRING

none

none

none

empty string

Column name in the AW staging table and source view for this attribute.

LEVEL_ATTRIBUTE_ISPARENT

STRING

NO, YES

none

none

NO

Indicates whether this is a parent level.

LEVEL_ATTRIBUTE_LEVEL_INDICATOR_COLNAME

STRING

none

none

none

empty string

Level indicating columns name. This level will contain the name of the name of the level this parent reference belongs to. This is relavant only for skip level hierarchies.

LEVEL_ATTRIBUTE_NAME

STRING

none

none

none

empty string

The name of the Level Attribute.

LEVEL_ATTRIBUTE_OBJECT_ID

STRING

none

none

none

empty string


LEVEL_PARENTHIERARCHY

STRING

none

none

none

empty string

Name of the parent hierarchy.

LEVEL_PARENTREF_PARENTLEVEL

STRING

none

none

none

empty string

The name of the parent level if relavant.

LEVEL_RELATIONSHIP_NAME

STRING

none

none

none

empty string

The level relationship name associated to this attribute.

LOADING_FLAG

STRING

none

none

none

YES

A boolean value to indicate whether this attribute will particiate in the load operation.

LOAD_COLUMN_WHEN_INSERTING_ROW

STRING(3)

NO, YES

none

none

YES

A boolean value to indicate whether this attribute will particiate in the insert load operation.

LOAD_COLUMN_WHEN_UPDATING_ROW

STRING(3)

NO, YES

none

none

YES

A boolean value to indicate whether this attribute will particiate in the update load operation.

LOAD_MATCHING

STRING

NO, YES

none

none

NO

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 load operation.

LOAD_ON_INSERT

STRING(3)

NO, YES

none

none

YES

A boolean value to indicate whether this level attribute will participate in an insert when inserting a new record. Has no effect for SCD type 2 trigger or business key attributes.

LOAD_ON_UPDATE

STRING(3)

NO, YES

none

none

YES

A boolean value to indicate whether this level attribute will participate in an update when updating an existing record. Has no effect for SCD type 2 trigger attributes.

LOOKUP_ATTRIBUTE_ROLE

STRING

DIMENSION_KEY, END_DATE, NATURAL_KEY, NATURAL_KEY_AND_SURROGATE_KEY, NONE, PREV_VALUE, START_DATE, SURROGATE_KEY, TRIGGER

none

none

NONE

The role of the attribute, synchronized from the referencing lookup table or level

LOOKUP_MATCHING

STRING

NO, YES

none

none

NO

A boolean value to indicate whether this attribute will be used to construct the lookup condition to resolve level reference between the incoming child data and the existing parent data on the target during the selected operation.

MATCHING_ROW

NUMBER

none

1

1000

1

An positive integer to indicate from which row within the unpivot group this output attribute obtains its data.

MATCH_COLUMN_WHEN_DELETING_ROW

STRING(3)

NO, YES

none

none

NO

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.

MATCH_COLUMN_WHEN_UPDATING_ROW

STRING(3)

NO, YES

none

none

NO

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.

MCM_MATCH_VALUE

STRING

none

none

none

empty string


MERGE_ATTR

STRING

none

none

none

empty string

Related merge attribute

NULL_VALUE

STRING

none

none

none

NULL

The data value that is interpreted as "null" by orphan management. Default is SQL NULL, specified as unquoted NULL.

OUTPUT_COMPONENT

STRING

NA_ADDRESS, NA_ADDRESS2, NA_ADDRESSCORRECTED, NA_ADDRESSTYPE, NA_AUTO_ZONE_IND, NA_BOXNAME, NA_BOXNUMBER, NA_BUILDINGNAME, NA_CART, NA_CBSA_CODE, NA_CBSA_DESC, NA_CENSUSID, NA_CHECKDIGIT, NA_CITY, NA_CITYCORRECTED, NA_CITYMATCH, NA_CITYWARNING, NA_CITY_ABBREV, NA_CITY_ABBREV_2, NA_CITY_ALTERNATE, NA_COMPLEX, NA_COUNTRYCODE, NA_COUNTRYCODE3, NA_COUNTRYNAME, NA_COUNTYNAME, NA_DELIVERYBEATCODE, NA_DELIVERYOFFICECODE, NA_DELIVERYPOINT, NA_EMAIL, NA_EXTRA_1, NA_EXTRA_10, NA_EXTRA_11, NA_EXTRA_12, NA_EXTRA_13, NA_EXTRA_14, NA_EXTRA_15, NA_EXTRA_16, NA_EXTRA_17, NA_EXTRA_18, NA_EXTRA_19, NA_EXTRA_2, NA_EXTRA_20, NA_EXTRA_3, NA_EXTRA_4, NA_EXTRA_5, NA_EXTRA_6, NA_EXTRA_7, NA_EXTRA_8, NA_EXTRA_9, NA_FIPS, NA_FIPSCOUNTY, NA_FIPS_PLACE_CODE, NA_FIRMCOUNT, NA_FIRMNAME, NA_FIRM_LOC, NA_FIRSTNAME, NA_FIRSTNAMESTD, NA_GENDER, NA_GEO_MATCH_PREC, NA_INSTALLATIONNAME, NA_INSTALLATIONTYPE, NA_ISADDRESSVERIFIABLE, NA_ISFOUND, NA_ISGOODADDRESS, NA_ISGOODGROUP, NA_ISGOODNAME, NA_ISPARSED, NA_LACS, NA_LASTLINE, NA_LASTLINE_2, NA_LASTNAME, NA_LATITUDE, NA_LOCALITYCODE, NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4, NA_LONGITUDE, NA_LOT, NA_LOT_ORDER, NA_MCD, NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME2STD, NA_MIDDLENAME3, NA_MIDDLENAME3STD, NA_MIDDLENAMESTD, NA_MISCADDRESS, NA_MSA, NA_NAMEDESIGNATOR, NA_NAMEWARNING, NA_NAME_FIRM_EXTRA, NA_NEIGHBORHOOD, NA_NONAMBIGUOUSMATCH, NA_NONE, NA_NP_SEC_ADDR, NA_NP_UNIT_DESIG, NA_NP_UNIT_NBR, NA_OTHERPOSTNAME, NA_PARSESTATUS, NA_PARSESTATUSDESC, NA_PARSINGCOUNTRY, NA_PASSTHRU, NA_PERSON, NA_PERSONCOUNT, NA_PHONE, NA_POSTALCODE, NA_POSTALCODECORRECTED, NA_POSTALCODEFORMATTED, NA_POSTDIRECTIONAL, NA_POSTNAME, NA_PREDIRECTIONAL, NA_PRENAME, NA_PRIMARYADDRESS, NA_PRIM_NAME_2, NA_RELATIONSHIP, NA_ROUTENAME, NA_ROUTENUMBER, NA_SECONDARYADDRESS, NA_SSN, NA_STATE, NA_STREETCOMPCORRECTED, NA_STREETCOMPMATCH, NA_STREETCORRECTED, NA_STREETNAME, NA_STREETNAMEMATCH, NA_STREETNUMBER, NA_STREETNUMBERMATCH, NA_STREETTYPE, NA_STREETWARNING, NA_TITLE, NA_UNITDESIGNATOR, NA_UNITNUMBER, NA_URBANIZATIONNAME, NA_URBAN_IND, NA_ZIP4, NA_ZIP5

none

none

NA_NONE

Assigns a Name and Address output component to the selected output attribute.

OUTPUT_GROUP_KEY

BOOLEAN

true, false

none

none

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.

PIVOT_EXPRESSION

STRING

none

none

none

empty string

A comma-separated expression that gives the input attribute to be used for each output row in the pivot group.

PRECISION

NUMBER

none

none

none

0

The data precision value of the attribute

REFERENCED_LEVEL_ATTRIBUTE_NAME

STRING

none

none

none

empty string

The bound name of the parent level attribute associated to this attribute.

REFERENCED_LEVEL_NAME

STRING

none

none

none

empty string

The bound name of the parent level group associated to this attribute.

REFERENCING_TYPE

STRING

LOOKUP_KEY, LOOKUP_KEY_AND_REFERENCE_KEY_ALL, LOOKUP_KEY_AND_REFERENCE_KEY_ONLY, NONE, REFERENCE_KEY_ALL, REFERENCE_KEY_ONLY

none

none

NONE

The type of reference to indicate how this attribute participates in resolving existing level relationships and level implementations. If Lookup Reference Attribute is specified, this attribute will be used as lookup attribute upon parent level to resolve level implementations during loading. If Level Relationship Attribute (Snowflake) is specified, this attribute will be directly used as level relationship attribute and no lookup upon parent level would be performed during loading. If Level Relationship Attribute (Star) is specified, this attribute will be directly used as level relationship attribute, as well as lookup attribute upon parent level to resolve level implementations during loading. If none is specified, this attribute does not participate in any level relationship.

REMOVE_MATCHING

STRING

NO, YES

none

none

NO

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 remove operation.

REPRESENTS_LOOKUP_TABLE_COLUMN

BOOLEAN

true, false

none

none

false


SCALE

NUMBER

none

none

none

0

The data scale value of the attribute

SKIP_LEVEL_DIMENSION

STRING

NO, YES

none

none

NO

Indicates whether this level has a skip level parent.

SOURCE_AGGREGATION_FUNCTION

STRING

none

none

none

SUM

The source loading aggregation function for the measure.

SUBQUERY_OUTPUT_MATCHING

STRING

none

none

none

empty string

A unique matching value which will match a corresponding property for an output attribute

TYPE_ATTRIBUTE_NAME

STRING

none

none

none

empty string

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.

TYPE_TWO_SCD_TRIGGER

STRING

NO, YES

none

none

NO

If YES, indicates that this attribute will be used as a trigger for type 2 Slowly Changing Dimension history recording.

UNPIVOT_EXPRESSION

STRING

none

none

none

NULL

An expression that gives the input attribute to be used as the output of this attribute.

UPDATE_OPERATION

STRING(3)

*=, +=, -=, /=, =, =-, =/, =||, ||=

none

none

=


The computation to be performed on this attribute between the incoming data and the existing data on the target during the update load operation. Only applicable to measure attributes.

VALUETYPE

STRING

NEW, NEW_OLD, OLD

none

none

NEW_OLD

Specifies the value type of this attribute

VARIABLE_INITIAL_VALUE

STRING

none

none

none

empty string

If this is a variable expression, then this is the initial value of the variable expression.

VARIABLE_WRITE_CONDITION

STRING

none

none

none

empty string

If this is a variable expression, then the variable value is set when processing a row where this condition is true.


PKdS45%5PKpFJOEBPS/chap4012.htm#s܌ OMBALTER REGISTERED_FUNCTION

OMBALTER REGISTERED_FUNCTION

Purpose

Alters a function that can be used in a query.

Prerequisites

Should be in the context of a Business Definition Module or use the full path.

Syntax

alterRegisteredFunctionCommand =  ( OMBALTER REGISTERED_FUNCTION 
          "QUOTED_STRING" ( ( "renameClause" [ SET 
          "setPropertiesClauseforRegFun" ] [ SET "setReferenceIconSetClause" ] [
           UNSET "unsetReferenceIconSetClause" ] { "alterFunctionClauses" } ) | 
          ( SET "setPropertiesClauseforRegFun" [ SET "setReferenceIconSetClause"
           ] [ UNSET "unsetReferenceIconSetClause" ] { "alterFunctionClauses" } 
          ) | ( SET "setReferenceIconSetClause" [ UNSET 
          "unsetReferenceIconSetClause" ] { "alterFunctionClauses" } ) | ( UNSET
           "unsetReferenceIconSetClause" { "alterFunctionClauses" } ) | ( 
          "alterFunctionClauses" { "alterFunctionClauses" } ) ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClauseforRegFun =  PROPERTIES "(" "propertyNameListforRegFun" 
          ")" VALUES "(" "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterFunctionClauses =  ADD "addFunctionArgClausesForAlter" | MODIFY 
          "modifyFunctionArgClause" | DELETE "deleteFunctionArgClause"
     propertyNameListforRegFun =  ( "UNQUOTED_STRING" | ( PACKAGE | SIGNATURE ) 
          ) { "," ( "UNQUOTED_STRING" | ( PACKAGE | SIGNATURE ) ) }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addFunctionArgClausesForAlter =  PARAMETER "QUOTED_STRING" [ AT POSITION 
          "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     modifyFunctionArgClause =  PARAMETER "QUOTED_STRING" [ "renameClause" ] [ 
          "moveParamToClause" ] [ SET "setPropertiesClause" ]
     deleteFunctionArgClause =  PARAMETER "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     moveParamToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

alterRegisteredFunctionCommand

This clause alters a function.

QUOTED_STRING

name of the function.

renameClause

Renames a function with a different name.

setPropertiesClauseforRegFun

This clause sets the properties of the object.

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set.

alterFunctionClauses

This clause alters the function parameters.

propertyNameListforRegFun

This is the list of property names.

propertyValueList

This is the list of property values.

addFunctionArgClausesForAlter

This clause adds a function parameter.

QUOTED_STRING

name of the parameter.

modifyFunctionArgClause

This clause modifies a function parameter.

QUOTED_STRING

name of the parameter.

deleteFunctionArgClause

This clause deletes a function parameter.

QUOTED_STRING

name of the parameter.

propertyValue

This is a property value.

setPropertiesClause

This clause sets the properties of the object.

getPropertiesClause

Basic properties for REGISTERED_FUNCTION: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the function 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the function 

Name: AVAILABLE
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the Function is available for the user to use in calculations

Name: RETURN_TYPE
Type: STRING()
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BINARY_INTEGER, BLOB, BOOLEAN, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH
NCHAR, NCLOB, NUMBER, NVARCHAR2, PLS_INTEGER, RAW, SYS.ANYDATA, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE
TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHAR2, XMLTYPE, 
SYS.LCR$_ROW_RECORD, SYS.XMLSEQUENCETYPE, SYS_REFCURSOR
Default: 'NUMBER'
Return type of the function 

Basic properties for PARAMETER:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the parameter 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the parameter 

Name: DATATYPE
Type: STRING()
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BINARY_INTEGER, BLOB, BOOLEAN, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH
NCHAR, NCLOB, NUMBER, NVARCHAR2, PLS_INTEGER, RAW, SYS.ANYDATA, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE
TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHAR2, XMLTYPE, 
SYS.LCR$_ROW_RECORD, SYS.XMLSEQUENCETYPE, SYS_REFCURSOR 
Default: 'VARCHAR2'
Datatype of the parameter

moveParamToClause

This clause moves parameters within registered functions.

propertyNameList

This is the list of property names.

REGISTERED_FUNCTION Object

Table 4-52 REGISTERED_FUNCTION Object

PropertyTypeChoicesMinMaxDefaultDescription

AUTHID

STRING

, CURRENT_USER, DEFINER

none

none

empty string

Generate the transformation with selected AUTHID option. The function will be executed with the permissions defined by the AUTHID clause instead of the function owner's permissions.

CALLED_ON_NULL_INPUT

STRING

, CALLED ON NULL INPUT

none

none

empty string

Specifies that the function is called regardless of whether any of its arguments are null. It can return a null value or a non-null value.

DB_LOCATION

STRING

none

none

none

empty string

Location for the referenced Function

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

DETERMINISTIC_STATE

STRING

, DETERMINISTIC, NOT DETERMINISTIC

none

none

empty string

Specifies that the function returns the same result every time, for a given set of inputs.

ENCRYPTION

STRING

, ENCRYPTION

none

none

empty string

Specifies whether the function body will be encrypted when the function is created.

EXECUTE_AS

STRING

, EXECUTE AS CALLER, EXECUTE AS OWNER, EXECUTE AS SELF

none

none

empty string

Generate the transformation with selected EXECUTE AS option. Function will be executed with the permissions defined by the EXECUTE AS clause rather than the function owner's permissions.

EXTERNAL_ACTION

STRING

, EXTERNAL ACTION, NO EXTERNAL ACTION

none

none

empty string

Specifies that the function takes some action that changes the state of an object not managed by the database manager, such as reading or writing a file in the OS-managed folders.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

INHERIT_ISOLATION_LEVEL

STRING

, INHERIT ISOLATION LEVEL WITH LOCK REQUEST, INHERIT ISOLATION LEVEL WITHOUT LOCK REQUEST

none

none

empty string

Specifies whether or not a lock request can be associated with the isolation-clause of the statement when the function inherits the isolation level of the statement that invokes the function. The default is INHERIT ISOLATION LEVEL WITHOUT LOCK REQUEST.

INHERIT_SPECIAL_REGISTERS

STRING

, INHERIT SPECIAL REGISTERS

none

none

empty string

Specifies that the function will inherit all the special registers from the invoking statement.

IS_DETERMINISTIC

STRING

, DETERMINISTIC

none

none

empty string

Optimization hint that specifies that the function returns the same result every time for a given set of arguments. If the function is called with the same arguments multiple times, then the optimizer may re-use the previous result.

IS_PARALLEL_ENABLE

STRING

, PARALLEL_ENABLE

none

none

empty string

Optimization hint, instructing Oracle to execute the function in parallel whenever called from within a SQL query.

LANGUAGE_SQL

STRING

, LANGUAGE SQL

none

none

empty string

This Optional clause indicates that the function is written in SQL PL. This is the default option, to satisfy SQL99 requirements.

PACKAGE

STRING

none

none

none

empty string

May be used to identify the name of a Package that contains the Function

PARAMETER_CCSID

STRING

, PARAMETER CCSID ASCII, PARAMETER CCSID UNICODE

none

none

empty string

Specifies the encoding scheme to use for all string data passed into and out of the function. If the PARAMETER CCSID clause is not specified, the default is PARAMETER CCSID UNICODE for Unicode databases, and PARAMETER CCSID ASCII for all other databases.

PRAGMA_AUTONOMOUS_TRANSACTION

STRING

, PRAGMA AUTONOMOUS_TRANSACTION

none

none

empty string

Instructs the PL/SQL compiler to mark the function as independent, which allows the function to suspend the main transaction.

SCHEMABINDING

STRING

, SCHEMABINDING

none

none

empty string

Specifies that the function is bound to the database objects that it references (that is, they cannot be dropped or modified). This condition will prevent changes to the function if other schema-bound objects are referencing it. If a function is created with SCHEMABINDING, then the function is a deterministic function.

SPECIFIC

STRING

none

none

none

empty string

Uniquely identifies a function within the current schema. The specific name can be the same as the function name, and it can be up to 18 characters long. If the SPECIFIC keyword is omitted, then the IBM DB2 UDB Database Manager automatically generates a unique identifier for the function in the format SQLyymmddhhmmssxxx.

SQL_DATA

STRING

, CONTAINS SQL, MODIFIES SQL DATA, READS SQL DATA

none

none

empty string

Specifies what type of SQL statements can be executed by the function. CONTAINS SQL specifies that the function can only execute SQL statements that do not read or modify SQL data. READS SQL DATA specifies that only SQL statements that do not modify SQL data can be executed by the function. MODIFIES SQL DATA specifies that all SQL statements supported in dynamic-compound-statement can be executed by the function.

STATIC_DISPATCH

STRING

, STATIC DISPATCH

none

none

empty string

Specifies that the function is to return the static values of an ARRAY or a user-defined type. Required if you have a non-SQL function that uses an ARRAY or a user-defined type as parameters.

WITH_NULL_INPUT

STRING

, CALLED ON NULL INPUT, RETURNS NULL ON NULL INPUT

none

none

empty string

Specifies that if RETURNS NULL ON NULL INPUT is specified in a CLR function, then SQL Server can return NULL when any of the arguments it receives is NULL, without actually invoking the body of the function. If CALLED ON NULL INPUT is specified, then the function body executes even if NULL is passed as an argument.


PKF@(s#sPKpFJOEBPS/content.opf Oracle® Warehouse Builder OMB*Plus Command Reference, 11g Release 2 (11.2) en-US E14406-01 Oracle Corporation Oracle Corporation Oracle® Warehouse Builder OMB*Plus Command Reference, 11g Release 2 (11.2) 2009-08-03T19:01:35Z Provides a complete language reference for OMB and OMU commands, which comprise OMB*Plus. OMB*Plus is the programming language included with Oracle Warehouse Builder. PKJ/  PKpFJOEBPS/chap2005.htm OMBALTER DATA_PROFILE

OMBALTER DATA_PROFILE

Purpose

Alter the Data Profile by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of project.

Syntax

alterDataProfileCommand =  OMBALTER ( DATA_PROFILE "QUOTED_STRING" ( 
          "renameClause" [ "alterPropertiesOrReferenceClause" ] | ( [ 
          "alterPropertiesOrReferenceClause" ] ( { ( ADD | DELETE ) ( TABLE | 
          VIEW | EXTERNAL_TABLE | MATERIALIZED_VIEW | DIMENSION | CUBE ) 
          "QUOTED_STRING" [ USING ATTRIBUTE_SET "QUOTED_STRING" ] [ 
          LIMIT_COLUMNS ] } ) ) ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceClause =  SET ( "setPropertiesClause" [ SET 
          "setReferenceClause" [ UNSET "unsetReferenceClause" ] | UNSET 
          "unsetReferenceClause" [ SET "setReferenceClause" ] ] | 
          "setReferenceClause" [ UNSET "unsetReferenceClause" ] ) | UNSET 
          "unsetReferenceClause" [ SET "setReferenceClause" ]
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceClause =  ( "setReferenceLocationClause" [ SET 
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
     unsetReferenceClause =  ( "unsetReferenceLocationClause" [ UNSET 
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION 
          "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )

Parameters

alterDataProfileCommand

This command modifies an existing Data Profile.

QUOTED_STRING

Name of the existing Data Profile in single quotes.

renameClause

Rename a Data Profile.

alterPropertiesOrReferenceClause

Alter existing Data Profile's core properties, locations and icon sets.

setPropertiesClause

Associate a set of properties with the existing Data Profile.

setPropertiesClause

Configuration properties for DATA_PROFILE that affect loading:

Name: COPY_DATA

Type: BOOLEAN

Valid Values: true | false

Default: true

Setting this to true will enable copying of data from source to profile workspace.

Name: FORCE_COPY_DATA

Type: BOOLEAN

Valid Values: true | false

Default: false

Setting this to true will allways force a profile to run.

Name: CALCULATE_DATATYPES

Type: BOOLEAN

Valid Values: true | false

Default: false

Setting this to true will enable data type discovery for the selected table.

Name: CALCULATE_COMMON_FORMATS

Type: BOOLEAN

Valid Values: true | false

Default: false

This tells the profiler if common formats are to be discovered for all sources in this profile.

Name: NULL_VALUE

Type: STRING

Valid Values: any string value

Default: null

This value will be considered as the null value when profiling. Please enclose the value in single quotes. An unqouted null (the current default value) will be considered a database null.

Name: SAMPLE_RATE

Type: NUMBER

Valid Values: 1-100

Default: 100

This value will be the percent of total rows that will be randomly selected during loading.

setPropertiesClause

Configuration properties for DATA_PROFILE that affect profiling:

Name: CALCULATE_DOMAINS

Type: BOOLEAN

Valid Values: true | false

Default: true

Setting this to true will enable domain discovery.

Name: DOMAIN_MAX_COUNT

Type: NUMBER

Valid Values: 1-any number

Default: true

The maximum number of distinct values in a column in order for that column to be discovered as possibly being defined by a domain. Domain Discovery of a column occurs if the number of distinct values in that column is at or below the Max Distinct Values Count property, AND, the number of distinct values as a percentage of total rows is at or below the Max Distinct Values Percent property.

Name: DOMAIN_MAX_PERCENT

Type: NUMBER

Valid Values: 1-100

Default: true

The maximum number of distinct values in a column, expressed as a percentage of the total number of rows in the table, in order for that column to be discovered as possibly being defined by a domain. Domain Discovery of a column occurs if the number of distinct values in that column is at or below the Max Distinct Values Count property, AND, the number of distinct values as a percentage of total rows is at or below the Max Distinct Values Percent property.

Name: DOMAIN_MIN_COUNT

Type: NUMBER

Valid Values: 1-any number

Default: true

The minimum number of rows for the given distinct value in order for that distinct value to be considered as compliant with the domain. Domain Value Compliance for a value occurs if the number of rows with that value is at or above the Min Rows Count property, AND, the number of rows with that value as a percentage of total rows is at or above the Min Rows Percent property.

Name: DOMAIN_MIN_PERCENT

Type: NUMBER

Valid Values: 1-100

Default: true

The minimum number of rows, expressed as a percentage of the total number of rows, for the given distinct value in order for that distinct value to be considered as compliant with the domain. Domain Value Compliance for a value occurs if the number of rows with that value is at or above the Min Rows Count property, AND, the number of rows with that value as a percentage of total rows is at or above the Min Rows Percent property.

Name: CALCULATE_UK

Type: BOOLEAN

Valid Values: true | false

Default: true

Setting this to true will enable unique key discovery.

Name: UK_MIN_PERCENT

Type: NUMBER

Valid Values: 1-100

Default: 75

This is the minimum percentage of rows that need to satisfy a unique key relationship.

Name: CALCULATE_FD

Type: BOOLEAN

Valid Values: true | false

Default: true

Setting this to true will enable functional dependency discovery.

Name: FD_MIN_PERCENT

Type: NUMBER

Valid Values: 1-100

Default: 75

This is the minimum percentage of rows that need to satisfy a functional dependency relationship.

Name: FD_UK_LHS_COUNT

Type: NUMBER

Valid Values: 1-number of attributes of source less 1

Default: 1

This is the maximum number of attributes for unique key and functional dependency profiling.

setPropertiesClause

Name: CALCULATE_FK

Type: BOOLEAN

Valid Values: true | false

Default: true

Setting this to true will enable foreign key discovery.

Name: FK_MIN_PERCENT

Type: NUMBER

Valid Values: 1-100

Default: 75

This is the minimum percentage of rows that need to satisfy a foreign key relationship.

Name: CALCULATE_REDUNDANT_COLUMNS

Type: BOOLEAN

Valid Values: true | false

Default: false

Setting this to true will enable redundant column discovery with respect to a foreign key-unique key pair.

Name: REDUNDANT_MIN_PERCENT

Type: NUMBER

Valid Values: 1-100

Default: 75

This is the minimum percentage of rows that are redundant.

Name: CALCULATE_DATA_RULES

Type: BOOLEAN

Valid Values: true | false

Default: false

Setting this to true will enable data rule profiling for the selected table.

Name: CALCULATE_PATTERNS

Type: BOOLEAN

Valid Values: true | false

Default: false

Setting this to true will enable pattern discovery.

Name: MAX_NUM_PATTERNS

Type: NUMBER

Valid Values: any number less than the number of rows of the source

Default: 10

This tells the profiler to get the top-N patterns for the attribute.

setReferenceClause

A general clause for setting references for a Data Profile.

unsetReferenceClause

A general clause for unsetting references for a Data Profile.

propertyNameList

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

propertyValueList

Comma separated list of property values.

setReferenceLocationClause

Set a location for an existing Data Profile.

setReferenceIconSetClause

Set icon set for the Data Profile.

unsetReferenceLocationClause

Unset a location for an existing Data Profile.

unsetReferenceIconSetClause

Unset icon set for the Data Profile.

propertyValue

Value of a property.

DATA_PROFILE Object

Table 2-5 DATA_PROFILE Object

< }td align="left" headers="r28c1-t6 r1c5-t6" rowspan="1" colspan="1">

none

PropertyTypeChoicesMinMaxDefaultDescription

ABAP_DIRECTORY

STRING

none

none

none

/tmp

Location where SAP data is dumped as flat files

ABAP_EXTENSION

STRING

none

none

none

.abap

File name extension for ABAP scripts

ABAP_RUN_PARAMETER_FILE

STRING

none

none

none

_run.ini

Run Parameter File Suffix for the parameter script in a ABAP job.

ABAP_SPOOL_DIRECTORY

STRING

none

none

none

abap\log\

Location where ABAP scripts are buffered during script generation processing.

APPLICATION_SHORT_NAME

STRING

none

none

none

WB

Application Short Name

ARCHIVE_DIRECTORY

STRING

none

none

none

archive\

Archive Directory

CALCULATE_COMMON_FORMATS

BOOLEAN

true, false

none

none

false

Setting this to true will enable common format discovery for all the columns in this profile.

CALCULATE_DATATYPES

BOOLEAN

true, false

none

none

true

Setting this to true will enable data type discovery for all the columns in this profile.

CALCULATE_DATA_RULES

BOOLEAN

true, false

none

none

false

Setting this to true will enable data rule profiling for the selected table.

CALCULATE_DOMAINS

BOOLEAN

true, false

none

none

true

Setting this to true will enable domain discovery.

CALCULATE_FD

BOOLEAN

true, false

none

none

true

Setting this to true will enable functional dependency discovery.

CALCULATE_FK

BOOLEAN

true, false

none

none

true

Setting this to true will enable foreign key discovery.

CALCULATE_PATTERNS

BOOLEAN

true, false

none

none

false

Setting this to true will enable pattern discovery.

CALCULATE_REDUNDANT_COLUMNS

BOOLEAN

true, false

none

none

false

Setting this to true will enable redundant column discovery.

CALCULATE_SOUNDEX

BOOLEAN

true, false

none

none

false

Setting this to true will enable soundex relationship discovery for columns with string data types. Note that you must ensure that these attributes are part of relationship discovery. You can set this by clicking on the attribute and enabling the checkbox for Row Relationship Discovery Configuration.

CALCULATE_UK

BOOLEAN

true, false

none

none

true

Setting this to true will enable unique key discovery.

COPY_DATA

BOOLEAN

true, false

none

none

true

Setting this to true will enable copying of data from source to staging area.

CREATE_MVIEWS

BOOLEAN

true, false

none

none

false

Setting this to true will create materialized views for each column in every table of this profile to enhance query performance during drill down.

DB_LOCATION

STRING

none

none

none

empty string

If this is a source module, this value indicates the location from which data will be read. If this is a target warehouse module, this value indicates the location where generated code will be deployed to and/or where data will be written to.

DDL_DIRECTORY

STRING

none

none

none

ddl\

Location where scripts for database objects for the target schema are stored.

DDL_EXTENSION

STRING

none

none

none

.ddl

File name extension for DDL scripts.

DDL_SPOOL_DIRECTORY

STRING

none

none

none

ddl\log\

Location where DDL scripts are buffered during script generation processing.

DEBUG

BOOLEAN

true, false

none

none

false


DEFAULT_INDEX_TABLESPACE

STRING(30)

none

none

none

empty string

Default name of tablespace to install indexes into.

DEFAULT_OBJECT_TABLESPACE

STRING(30)

none

none

none

empty string

Default name of tablespace to install objects into.

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

DESIGNER_CONTAINER_ELEMENT

STRING

none

none

empty string


DOMAIN_MAX_COUNT

NUMBER

none

none

none

100

The maximum number of distinct values in a column in order for that column to be discovered as possibly being defined by a domain. Domain Discovery of a column occurs if the number of distinct values in that column is at or below the Max Distinct Values Count property, AND, the number of distinct values as a percentage of total rows is at or below the Max Distinct Values Percent property.

DOMAIN_MAX_PERCENT

NUMBER

none

0

100

50

The maximum number of distinct values in a column, expressed as a percentage of the total number of rows in the table, in order for that column to be discovered as possibly being defined by a domain. Domain Discovery of a column occurs if the number of distinct values in that column is at or below the Max Distinct Values Count property, AND, the number of distinct values as a percentage of total rows is at or below the Max Distinct Values Percent property.

DOMAIN_MIN_COUNT

NUMBER

none

none

none

2

The minimum number of rows for the given distinct value in order for that distinct value to be considered as compliant with the domain. Domain Value Compliance for a value occurs if the number of rows with that value is at or above the Min Rows Count property, AND, the number of rows with that value as a percentage of total rows is at or above the Min Rows Percent property.

DOMAIN_MIN_PERCENT

NUMBER

none

0

100

1

The minimum number of rows, expressed as a percentage of the total number of rows, for the given distinct value in order for that distinct value to be considered as compliant with the domain. Domain Value Compliance for a value occurs if the number of rows with that value is at or above the Min Rows Count property, AND, the number of rows with that value as a percentage of total rows is at or above the Min Rows Percent property.

END_OF_LINE

STRING

none

none

none

\r\n

End of Line

FD_MIN_PERCENT

NUMBER

none

0

100

100

This is the minimum percentage of rows that need to satisfy a functional dependency relationship.

FD_UK_FK_LHS_COUNT

NUMBER

none

none

none

1

This is the maximum number of attributes for unique key and functional dependency profiling.

FK_MIN_PERCENT

NUMBER

none

0

100

75

This is the minimum percentage of rows that need to satisfy a foreign key relationship.

FORCE_COPY_DATA

BOOLEAN

true, false

none

none

false

Setting this to true will force a profile to run.

INPUT_DIRECTORY

STRING

none

none

none

input\

Input Directory

INVALID_DIRECTORY

STRING

none

none

none

invalid\

Directory for SQL*Loader errors and rejected records

LAST_PROFILE_LOCATION

STRING

none

none

none

empty string


LAST_SEQUENCE

NUMBER

none

none

none

1


LIB_DIRECTORY

STRING

none

none

none

lib\

LIB Directory

LIB_EXTENSION

STRING

none

none

none

.lib

LIB Extension

LIB_SPOOL_DIRECTORY

STRING

none

none

none

lib\log\

LIB Spool Directory

LOADER_DIRECTORY

STRING

none

none

none

ctl\

Location where control files are stored.

LOADER_EXTENSION

STRING

none

none

none

.ctl

Suffix for the loader scripts

LOADER_RUN_PARAMETER_FILE

STRING

none

none

none

_run.ini

Suffix for the parameter initialization file.

LOG_DIRECTORY

STRING

none

none

none

log\

Log Directory for the SQL*Loader

MAIN_APPLICATION_SHORT_NAME

STRING

none

none

none

ora

Main Application Short Name

MAX_NUM_PATTERNS

NUMBER

none

none

none

10

This tells the profiler to get the top-N patterns for the attribute.

NULL_PERCENT

NUMBER

none

0

100

10

If the percentage of null values in a column is less than this threshold percentage, then that column will be discovered as a possible Not Null column.

NULL_VALUE

STRING

none

none

none

null

This value will be considered as the null value when profiling. Please enclose the value in single quotes. An unqouted null (the current default value) will be considered a database null.

PLSQL_DIRECTORY

STRING

none

none

none

pls\

Location where PL/SQL scripts are stored.

PLSQL_EXTENSION

STRING

none

none

none

.pls

File name extension for PL/SQL scripts.

PLSQL_GENERATION_MODE

STRING

Default, Oracle10g, Oracle10gR2, Oracle11gR1, Oracle11gR2, Oracle8i, Oracle9i

none

none

Default

Generation mode controls validation and generation for version specific features.

PLSQL_RUN_PARAMETER_FILE

STRING

none

none

none

_run.ini

Suffix for the parameter script in a PL/SQL job.

PLSQL_SPOOL_DIRECTORY

STRING

none

none

none

pls\log\

Location where PL/SQL scripts are buffered during script generation processing.

RECEIVE_DIRECTORY

STRING

none

none

none

receive\

Receive Directory

REDUNDANT_MIN_PERCENT

NUMBER

none

0

100

75

This is the minimum percentage of rows that are redundant with respect to a foreign key-unique key pair.

SAMPLE_RATE

NUMBER

none

0

100

100

This value will be the percent of total rows that will be randomly selected during loading.

SORT_DIRECTORY

STRING

none

none

none

sort\

Sort Directory

SOUNDEX_MIN_PERCENT

NUMBER

none

0

100

75

This is the minimum percentage of rows that need to satisfy a soundex relationship. Values with the same soundex value will be considered the same.

SQLPLUS_DIRECTORY

STRING

none

none

none

sqlplus\

Location where SQLPLUS scripts are stored

SQLPLUS_EXTENSION

STRING

none

none

none

.sql

Suffix for the SqlPlus scripts

SQLPLUS_RUN_PARAMETER_FILE

STRING

none

none

none

_run.ini

Suffix for the parameter initialization file

STREAMS_ADMINISTRATOR_LOCATION

STRING

none

none

none

empty string

The location corresponding to the Streams Administrator

TCL_DIRECTORY

STRING

none

none

none

tcl\

Location for TCL scripts that are generated after registration with Oracle Enterprise Manager

TOP_DIRECTORY

STRING

none

none

none

..\..\codegen\

Top Directory where generated code will get stored

UK_MIN_PERCENT

NUMBER

none

0

100

75

This is the minimum percentage of rows that need to satisfy a unique key relationship.

WORK_DIRECTORY

STRING

none

none

none

work\

Work Directory


PKJw PKpFJOEBPS/chap22006.htmd OMBSTATS

OMBSTATS

Purpose

This command will display statistical information about the scripting run, such as memory usage, and elapsed time.

Prerequisites

None.

Syntax

parseStatisticsCommand =  OMBSTATS

Parameters

parseStatisticsCommand

Specify stats command.

PK jidPKpFJOEBPS/chap11009.htm OMBDROP ADVANCED_QUEUE

OMBDROP ADVANCED_QUEUE

Purpose

Delete the Advanced Queue.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

dropAQCommand =  OMBDROP ADVANCED_QUEUE "QUOTED_STRING"

Parameters

dropAQCommand

Drops the Advanced Queue with the given name.

PK԰XPKpFJOEBPS/chap16002.htmM OMBIMPORT MDL_FILE

OMBIMPORT MDL_FILE

Purpose

Imports metadata and metadata definitions from a Metadata Loader file.

Prerequisites

Must be connected to the workspace where the import is to be performed.

Syntax

mdlImportCommand =  ( MDL_FILE "QUOTED_STRING" [ "noUpgradeClause" ] [ 
          "includeUserDefsClause" ] [ "useModeClause" | "asSnapshotClause" ] [ 
          "matchByClause" ] [ "includeGrantsClause" ] [ "includeCMIDefsClause" ]
           [ "controlFileClause" ] [ "supportedLangsClause" ] [ 
          "allowDiffBaseLangClause" ] [ "outputLogClause" ] [ 
          "usingCredentialClause" ] [ "netServiceNameClause" ] )
     noUpgradeClause =  NO_UPGRADE
     includeUserDefsClause =  INCLUDE_USER_DEFINITIONS
     useModeClause =  USE "modeValue"
     asSnapshotClause =  AS SNAPSHOT "QUOTED_STRING"
     matchByClause =  MATCH_BY "matchByValue"
     includeGrantsClause =  INCLUDE_GRANTS
     includeCMIDefsClause =  INCLUDE_CMI_DEFINITIONS
     controlFileClause =  CONTROL_FILE "QUOTED_STRING"
     supportedLangsClause =  SUPPORTED_LANGUAGES "(" "supportedLangsList" ")"
     allowDiffBaseLangClause =  ALLOW_DIFFERENT_BASE_LANGUAGE
     outputLogClause =  OUTPUT LOG [ TO ] "QUOTED_STRING"
     usingCredentialClause =  USING CREDENTIAL "UNQUOTED_STRING"
     netServiceNameClause =  NET_SERVICE_NAME "QUOTED_STRING"
     modeValue =  ( CREATE_MODE | REPLACE_MODE | UPDATE_MODE | MERGE_MODE )
     matchByValue =  ( UNIVERSAL_IDENTIFIER | NAMES )
     supportedLangsList =  "QUOTED_STRING" { "," "QUOTED_STRING" }

Parameters

mdlImportCommand

Import metadata from a file.

noUpgradeClause

Specify that MDL files that are not compatible with current repository version should not be automatically upgraded. The default is to automatically upgrade unless this clause is used.

includeUserDefsClause

Use to request that any metadata definitions in the MDL file be imported.

useModeClause

Specify import mode for importing metadata file.

asSnapshotClause

Specify a new snapshot name into which the contents of the MDL file are to be imported. Use this option to import old archive files as snapshots.

QUOTED_STRING

Enclose the new snapshot name in single quotes.

matchByClause

Specify whether import should search for already existing objects using universal identifiers or physical names.

includeGrantsClause

Use to request that security related metadata be imported.

includeCMIDefsClause

Use to request that related CMI Definitions for CMI Modules be imported.

controlFileClause

Specify a control file with import options not directly supported by the OMBIMPORT command.

QUOTED_STRING

Enclose the control file name in single quotes.

supportedLangsClause

List supported languages to be imported.

allowDiffBaseLangClause

Use to specify that MDL files with a different base langugae than that of the import target repository can be imported.

outputLogClause

Log file for import messages and statistics.

QUOTED_STRING

Enclose the log file name in single quotes.

usingCredentialClause

Specify the credential string which is used to connect to the repository.

UNQUOTED_STRING

An unquoted string representing the credential in the format username/password@host:port:servicename.

netServiceNameClause

Specify the net service name which is used to connect to the repository.

QUOTED_STRING

Enclose the net service name in single quotes.

modeValue

Import mode. Use CREATE_MODE, REPLACE_MODE, UPDATE_MODE, or MERGE_MODE. The default is CREATE_MODE.

CREATE_MODE: create new metadata only

REPLACE_MODE: replace existing objects only

UPDATE_MODE: replace existing objects and create new metadata

MERGE_MODE: merge existing objects and create new metadata

matchByValue

Use UNIVERSAL_IDENTIFIER or NAMES. The default is UNIVERSAL_IDENTIFIER.

supportedLangsList

Comma separated list of supported languages to be imported.

QUOTED_STRING

Language name or ISO id of supported language (e.g. 'German' or 'de_DE').

PKRMPKpFJOEBPS/chap14021.htmv OMBDROP TABLE

OMBDROP TABLE

Purpose

To drop a table.

Prerequisites

In the context of an Oracle Module.

Syntax

dropTableCommand =  OMBDROP TABLE "QUOTED_STRING"

Parameters

dropTableCommand

This clause drops a table.

PKݶlPKpFJOEBPS/chap8007.htm OMBCREATE MAPPING

OMBCREATE MAPPING

Purpose

Create a mapping in an Oracle Module.

Prerequisites

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

2. No concurrent user should be locking the Oracle Module or any of its ancestors exclusively at the moment the map is being created.

3. The map name must not conflict with existing map names and the maps names that concurrent user tries to use.

4. The GENERATION_LANGUAGE property has to be set for configuration properties of the map can be set. The list of available configuration properties of map is determined by the GENERATION_LANGUAGE property.

Syntax

createMappingCommand =  OMBCREATE MAPPING "mappingName" ( [ AS ( 
          TRICKLE_FEED_MAPPING | BATCH_MAPPING ) ] ) [ 
          "createOperatorOwnerDetailClause" ]
     mappingName =  "QUOTED_STRING"
     createOperatorOwnerDetailClause =  ( 
          "createOperatorOwnerPropertiesCTClause" [ 
          "createOperatorOwnerDescendantsClause" ] ) | 
          "createOperatorOwnerDescendantsClause"
     createOperatorOwnerPropertiesCTClause =  SET ( ( "setPropertiesClause" [ ( 
          SET "setCodeTemplateClause" [ SET "setReferenceIconSetClause" ] ) | ( 
          SET "setControlCodeTemplateClause" [ SET "setReferenceIconSetClause" ]
           ) | SET "setReferenceIconSetClause" ] ) | ( "setCodeTemplateClause" [
           SET "setReferenceIconSetClause" ] ) | ( 
          "setControlCodeTemplateClause" [ SET "setReferenceIconSetClause" ] ) |
           "setReferenceIconSetClause" )
     createOperatorOwnerDescendantsClause =  ( ADD ( "addOperatorClause" | 
          "addGroupClause" | "addAttributeClause" | "addChildClause" | 
          "addConnectionClause" | "addExecutionUnitClause" ) )+ [ 
          "setDefaultExecutionUnitClause" ]
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES 
          "propertyValueList"
     setCodeTemplateClause =  ( REFERENCE | REF ) CODE_TEMPLATE "QUOTED_STRING" 
          | ( ( REFERENCE | REF ) CODE_TEMPLATE OPTIONS "(" "optionValueList" 
          ")" VALUES "(" "optionValueList" ")" )
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setControlCodeTemplateClause =  ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE 
          "QUOTED_STRING" | ( ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE OPTIONS 
          "(" "optionValueList" ")" VALUES "(" "optionValueList" ")" )
     addOperatorClause =  "operatorType" OPERATOR "operatorName" [ 
          "pluggableMapBottomUpLocator" ] [ SET "setPropertiesClause" ] [ 
          "setBindingClause" ]
     addGroupClause =  "groupDirection" GROUP "groupName" OF 
          "operatorBottomUpLocator" [ SET "setPropertiesClause" ] [ 
          "setBindingClause" ] [ "internallyConnectToClause" ]
     addAttributeClause =  ATTRIBUTE "attributeName" OF "groupBottomUpLocator" [
           SET "setPropertiesClause" ]
     addChildClause =  "childType" "childName" "childOwnerBottomUpLocator" [ SET
           "setPropertiesClause" ]
     addConnectionClause =  CONNECTION FROM ( "groupBottomUpLocator" TO 
          "groupBottomUpLocator" [ "groupToGroupConnectType" ] | 
          "attributeBottomUpLocator" TO ( "attributeBottomUpLocator" | 
          "attributesBottomUpLocator" | "groupBottomUpLocator" ) | 
          "attributesBottomUpLocator" TO ( "attributesBottomUpLocator" | 
          "groupBottomUpLocator" ) )
     addExecutionUnitClause =  EXECUTION_UNIT "executionUnitName" OPERATORS 
          "operatorNameList" [ SET ( REFERENCE | REF ) CODE_TEMPLATE 
          "setEUCodeTemplateClause" ] [ SET ( REFERENCE | REF ) 
          CONTROL_CODE_TEMPLATE "setEUControlCodeTemplateClause" ]
     setDefaultExecutionUnitClause =  SET DEFAULT_EXECUTION_UNIT
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     optionValueList =  "propertyValue" { "," "propertyValue" }
     operatorType =  PLUGGABLE_MAPPING | "UNQUOTED_STRING"
     operatorName =  "QUOTED_STRING"
     pluggableMapBottomUpLocator =  ( OF PLUGGABLE_MAPPING "pluggableMapName" [ 
          "pluggableMapBottomUpLocator" ] )
     setBindingClause =  BOUND TO "bindableLocator"
     groupDirection =  INPUT | OUTPUT | INPUT_OUTPUT
     groupName =  "QUOTED_STRING"
     operatorBottomUpLocator =  OPERATOR "operatorName" [ 
          "pluggableMapBottomUpLocator" ]
     internallyConnectToClause =  SET REF "groupLocator"
     attributeName =  "QUOTED_STRING"
     groupBottomUpLocator =  GROUP "groupName" OF "operatorBottomUpLocator"
     childType =  "UNQUOTED_STRING"
     childName =  "QUOTED_STRING"
     childOwnerBottomUpLocator =  { OF "childType" "childName" } [ OF 
          "mappableBottomUpLocator" ]
     groupToGroupConnectType =  COPY ALL | BY ( NAME [ IGNORE ( SPECIAL_CHARS 
          "QUOTED_STRING" | SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX 
          "QUOTED_STRING" | TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX 
          "QUOTED_STRING" ) { "," IGNORE ( SPECIAL_CHARS "QUOTED_STRING" | 
          SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX "QUOTED_STRING" | 
          TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX "QUOTED_STRING" ) } ] | 
          POSITION )
     attributeBottomUpLocator =  ATTRIBUTE "attributeName" OF 
          "groupBottomUpLocator"
     attributesBottomUpLocator =  ATTRIBUTES "attributeNameList" OF 
          "groupBottomUpLocator"
     executionUnitName =  "QUOTED_STRING"
     operatorNameList =  "(" "operatorName" { "," "operatorName" } ")"
     setEUCodeTemplateClause =  "QUOTED_STRING" | OPTIONS "(" "optionValueList" 
          ")" VALUES "(" "optionValueList" ")"
     setEUControlCodeTemplateClause =  "QUOTED_STRING" | OPTIONS "(" 
          "optionValueList" ")" VALUES "(" "optionValueList" ")"
     propertyKey =  "UNQUOTED_STRING" | FILE_FORMAT
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" | 
          "FLOATING_POINT_LITERAL" )
     pluggableMapName =  "QUOTED_STRING"
     bindableLocator =  "bindableType" "bindableName" [ OF "bindableType" 
          "bindableName" ]
     groupLocator =  GROUP "groupName"
     mappableBottomUpLocator =  "operatorBottomUpLocator" | 
          "groupBottomUpLocator" | "attributeBottomUpLocator"
     attributeNameList =  "(" "attributeName" { "," "attributeName" } ")"
     bindableType =  PLUGGABLE_MAPPING | OBJECT_TYPE | "UNQUOTED_STRING"
     bindableName =  "QUOTED_STRING"

Parameters

createMappingCommand

Create a mapping in an Oracle Module.

mappingName

Name of the mapping.

createOperatorOwnerDetailClause

Create the desired detail of a pluggable mapping.

createOperatorOwnerPropertiesCTClause

Describe the properties, code template or icon set settings in the map.

createOperatorOwnerDescendantsClause

Create the desired child objects of a mapping or a pluggable mapping.

setPropertiesClause

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

setReferenceIconSetClause

Set icon set for the map.

addOperatorClause

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

The following is an example for creating an operator:

OMBALTER MAPPING 'M1' ADD TABLE OPERATOR 'T1'

addGroupClause

Add a mapping group to a mapping operator.

addAttributeClause

Add a mapping attribute to a mapping group.

addChildClause

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

The following is an example for creating a child object under a mapping

OMBALTER MAPPING 'M1' ADD SOURCE_DATA_FILE 'FILE1'

Note: Key word "OPERATOR" "GROUP" "ATTRIBUTE" are important for their respective ADD clauses. Without the key words, OMBPlus will interpret the ADD clause as an addChildClause. Here is an example:

OMB+&gt; OMBALTER MAPPING 'M1' ADD TABLE 'T1'

OMB02932: Error getting child objects of type TABLE in M1

OMBPLUS interprets the ADD clause as one for creating a non-operator child object under the mapping object. Therefore, it tries to find type definition for non-operator child object "TABLE" and cannot find it.

addConnectionClause

Add connections between mapping groups or mapping attributes.

addExecutionUnitClause

Create the execution unit, the operators it contains, and the code template used to implement the logic represented by the execution unit.

setDefaultExecutionUnitClause

Create execution units for the map and assign code templates to the execution units based on a predefined algorithm.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

optionValueList

Describe the list of option names or the option values for the code template.

operatorType

Type of a mapping operator. The following operator types are available: ADVANCED_QUEUE, AGGREGATOR, ANYDATA_CAST, CONSTANT, CONSTRUCT_OBJECT, CUBE, DATA_GENERATOR, DEDUPLICATOR, DIMENSION, EXPAND_OBJECT, EXPRESSION, EXTERNAL_TABLE, FILTER, FLAT_FILE, INPUT_PARAMETER, INPUT_SIGNATURE, ITERATOROPERATOR, JOINER, KEY_LOOKUP, LCRCAST, LCRSPLITTER, MATCHMERGE, MATERIALIZED_VIEW, NAME_AND_ADDRESS, OUTPUT_PARAMETER, OUTPUT_SIGNATURE, PIVOT, PLUGGABLE_MAPPING, POSTMAPPING_PROCESS, PREMAPPING_PROCESS, SEQUENCE, SET_OPERATION, SORTER, SPLITTER, TABLE, TABLE_FUNCTION, TRANSFORMATION, UNPIVOT, VIEW.

operatorName

Name of a mapping operator.

pluggableMapBottomUpLocator

Location of a child pluggable mapping within a mapping or another pluggable mapping.

setBindingClause

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

groupDirection

Direction of a mapping group.

groupName

Name of a mapping group.

operatorBottomUpLocator

Location of a mapping operator.

internallyConnectToClause

Specify the input attribute group that this output attribute group is associated with (for lookup operator).

attributeName

Name of a mapping attribute.

groupBottomUpLocator

Location of a mapping group.

childType

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

childName

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

childOwnerBottomUpLocator

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

groupToGroupConnectType

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

attributeBottomUpLocator

Location of a mapping attribute.

attributesBottomUpLocator

Location of a list of mapping attributes.

executionUnitName

The name of the execution unit to be created, modified or deleted.

operatorNameList

Describe the list of operators to be contained in the execution unit.

propertyKey

A property key for an object.

propertyKey

Basic properties for MAPPING: 

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the mapping 

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the mapping 

Basic properties for OPERATOR:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the operator

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the operator

Basic properties for GROUP:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the group

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the group

Basic properties for ATTRIBUTE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the attribute

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the attribute

Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Attribute

Name: LENGTH
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: 0
Length of the attribute. 

Name: PRECISION
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: 0
Precision of the attribute. 

Name: SCALE
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: 0
Scale of the attribute. 

Name: FRACTIONAL_SECONDS_PRECISION
Type: NUMBER
Valid Values: 0 - 9
Default: 0
The precision of a timestamp or interval.
Basic properties for SQLPLUS Mapping:

Name: ARRAYSIZE
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: 15
The default array size

Name: COPYCOMMIT
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: 0
number of records copied before commit

Name: LONG_SIZE
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: 2000000
The default long size

Name: SQL_FILE_DIRECTORY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
SQL file directory

Name: SQL_FILE_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
SQL file name

Name: LOG_FILE_DIRECTORY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
log file directory

Name: LOG_FILE_NAME_SQLPLUS
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
log file name

propertyValue

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

pluggableMapName

Name of the pluggable map.

bindableLocator

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

groupLocator

Location of a mapping group.

mappableBottomUpLocator

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

attributeNameList

A list of attribute names.

bindableType

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

bindableName

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

MAPPING Object

Table 8-6 MAPPING Object

PropertyTypeChoicesMinMaxDefaultDescription

DEPLOYABLE

BOOLEAN

true, false

none

none

true

True if the map is deployable to a physical implementation

DIAGRAM_LAYOUT

STRING

none

none

none

empty string


EXECUTION_TYPE

STRING

BATCH, TRICKLE

none

none

BATCH

Batch if this map is to be executed in batch; Trickle if this map is to be executed as a real-time map.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

GENERATION_LANGUAGE

STRING

ABAP, PLSQL, SQLLOADER, UNDEFINED

none

none

UNDEFINED

The language used when generating code for the mapping.

MAX_CHUNK_ITERATOR_COUNT

NUMBER

none

none

none

50

The maximum number of chunking iterations allowed for this map, if chunking is switched on for any source.

REFERRED_CALENDAR

STRING

none

none

none

empty string

Enter the Schedule to associate with this object.

STOP_CHUNKING_IF_NO_DATA

BOOLEAN

true, false

none

none

true

Stop chunk processing if no rows are processed for a given chunk iterator value (serial chunking only).

TARGET_LOAD_ORDER

STRING(65535)

none

none

none

empty string

The Target Load Order property allows you to determine the order in which multiple targets within the same mapping get loaded. Warehouse Builder determines a default order based on the FK relationships. However, using the property you can overrule that default order.


OPERATOR Object

Table 8-7 OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


HEIGHT

NUMBER

none

none

none

150


IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


WIDTH

NUMBER

none

none

none

180


X_COORDINATE

NUMBER

none

none

none

0


Y_COORDINATE

NUMBER

none

none

none

0



GROUP Object

Table 8-8 GROUP Object

PropertyTypeChoicesMinMaxDefaultDescription

AW_LOAD_STAGETABLE_NAME

STRING

none

none

none

empty string

The stage table used to load the AW level

AW_LOAD_VIEW_NAME

STRING

none

none

none

empty string

The view used to load the AW level

BOUND_NAME

STRING

none

none

none

empty string

The name to be used by reconciliation for this item. Unlike other operators, it is not needed for generation. By default it is the same name as the item.

CAST_SOURCE

STRING

none

none

none

empty string


COMMANDTYPE

STRING

ALL_COMMAND_TYPES, DELETE, INSERT, UPDATE

none

none

ALL_COMMAND_TYPES

The operation causing the change described by the LCR

CREATE_NO_MATCH_ROW

BOOLEAN

true, false

none

none

true

If true, a row is created and the user-defined default values are used, in the case where no lookup match is found. If false, no row is produced.

DATABASE_LINK

STRING(128)

none

none

none

empty string

The database link used to access this entity during mapping.

DB_LOCATION

STRING

none

none

none

empty string

The location used to access this entity during mapping.

DEBUG_BOUND_NAME

STRING

none

none

none

empty string

Physical name used to bind to a physical entity during a debug session

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string


DIMENSION_KEY

STRING(32)

none

none

none

empty string


DML_ERROR_TABLE_NAME

STRING(32)

none

none

none

empty string

The error table name of this target for DML error logging.

DYNAMIC_LOOKUP_FILTER

STRING

none

none

none

empty string

A filter condition on lookup table.

ERROR_TABLE_NAME

STRING(32)

none

none

none

empty string

The error table name of this target to log invalid records.

EXPRESSION_INOUT

STRING

none

none

none

empty string

Description not available.

EXPRESSION_OUT

STRING

none

none

none

empty string

Description not available.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

IS_ERROR_GRP

BOOLEAN

true, false

none

none

false

Set if the group is associated with an error table.

IS_EXPANDED

BOOLEAN

true, false

none

none

true

Set if the operator is expanded in the UI (should be hidden)

IS_USER-DEFINED_DATA

BOOLEAN

true, false

none

none

false

If TRUE, test data for this source or target is user-defined

JOIN_INPUT_ROLE

STRING(16)

OUTER, STANDARD

none

none

STANDARD

The role the input stream plays in the join.

KEY_NAMES

STRING

none

none

none

empty string

A comma separated list of unique keys used in the lookup condition for this output group.

LEADING_SOURCE

BOOLEAN

true, false

none

none

false

If true, this source is considered the leading source when debugging the map

LEVEL_BOUND_NAME

STRING

none

none

none

empty string

The bound name of this level.

LEVEL_BOUND_UOID

STRING

none

none

none

empty string


LEVEL_NAME

STRING

none

none

none

empty string

The full level name of the bound level

LEVEL_POSITION

STRING

LOWEST, MIDDLE, TOP

none

none

MIDDLE

The position of the level inside the hierarchies. The level will only be marked TOP or LOWEST if it is the top or lowest level in all hierarchies in which it participates.

LOOKUP_BOUND_OBJECT

STRING

none

none

none

empty string

The full name of the bound lookup object for the group.

LOOKUP_CONDITION

STRING

none

none

none

empty string

Lookup condition matching source inputs with lookup table. This condition is used to look up rows in the lookup table using values from the input group.

MCM_MATCH_VALUE

STRING

none

none

none

empty string


METADATA_DBLINK

STRING(128)

none

none

none

empty string

Database link name in OWB repository used to capture metadata during import.

METADATA_DBLINK_IS_NEW

STRING(1)

none

none

none

N

Flag indicating reconciliation of the database link is required.

MODULENAME

STRING

none

none

none

empty string

Description not available.

NTH_ROW_NUMBER

NUMBER

none

none

none

0

The "n" number for the nth row selection.

OBJECT_LOC_NAME

STRING

none

none

none

empty string


OBJECT_LOC_UOID

STRING

none

none

none

empty string


OBJECT_TYPE

STRING

none

none

none

empty string


OBJECT_UOID

STRING

none

none

none

empty string


ORDER_RESULT_SET_BY

STRING

none

none

none

empty string

A list of lookup table columns with which to sort result rows before selecting the single row result.

OWNER_IM</p>

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

PARENT_OBJECT_LOC_NAME

STRING

none

none

none

empty string


PARENT_OBJECT_LOC_UOID

STRING

none

none

none

empty string


PARENT_OBJECT_NAME

STRING

none

none

none

empty string


PARENT_OBJECT_TYPE

STRING

none

none

none

empty string


PARENT_OBJECT_UOID

STRING

none

none

none

empty string


PARENT_OPERATOR_NAME

STRING

none

none

none

empty string


PARENT_OPERATOR_UOID

STRING

none

none

none

empty string


RECORD_TYPE_VALUES

STRING

none

none

none

empty string

Record Type Values.

RETURN_TABLE_OF_SCALAR

BOOLEAN

true, false

none

none

false

This property specifies whether the return of the table function is a TABLE of SCALAR or not.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

ROW_LOCATOR

STRING

none

none

none

empty string

An expression indicating which attribute within the input group is the row locator.

ROW_LOCATOR_VALUES

STRING

none

none

none

NULL, NULL

A comma-separated expressions that gives the possible values of the row locator within a unpivot group.

ROW_POSITION

STRING

ALL_ROWS, ANY_ROW, ERROR, FIRST_ROW, LAST_ROW, NTH_ROW

none

none

ANY_ROW

Specifies which row from result set is to be selected as the single row lookup result.

SCHEMA

STRING(30)

none

none

none

empty string

Schema

SLOWLY_CHANGING_TYPE

STRING

TYPE1, TYPE2, TYPE3

none

none

TYPE2

The slowly changing type of this target.

SPLIT_CONDITION

STRING

none

none

none

empty string

Condition that defines when to perform the attribute maps for the attributes in this group.

TABLENAME

STRING

none

none

none

empty string

The source table corresponding to the LCR

TARGET_TABLE_NAME

STRING(32)

none

none

none

empty string

The table name bound to this target.

TARGET_TABLE_UOID

STRING

none

none

none

empty string


TEST_DATA_COLUMN_LIST

STRING

none

none

none

empty string

Column list for test data VIEW for this source or target

TEST_DATA_WHERE_CLAUSE

STRING

none

none

none

empty string

WHERE clause for test data VIEW for this source or target

TYPE2_HISTORY_LOOKUP_DATE

STRING

none

none

none

SYSDATE

A date expression used when doing a lookup on a type 2 dimension level, to specify the historical date for which to retrieve data. If blank, the most current record is used.


ATTRIBUTE Object

Table 8-9 ATTRIBUTE Object

PropertyTypeChoicesMinMaxDefaultDescription

ADDRESS_TYPE

STRING

NA_ADDRTYPE_DUAL, NA_ADDRTYPE_NORMAL

none

none

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.

AGGMAP_NAME

STRING

none

none

none

empty string


ATTRIBUTE_ROLE

STRING

END_DATE, LOOKUP_ACTIVE_DATE, MEASURE, NATURAL_KEY, NATURAL_KEY_AND_SURROGATE_KEY, NONE, PARENT_NATURAL_KEY, PARENT_NATURAL_KEY_AND_PARENT_SURROGATE_KEY, PARENT_REF_KEY, PARENT_SURROGATE_KEY, PREV_VALUE, START_DATE, SURROGATE_KEY, TRIGGER

none

none

NONE

The type of role to indicate how this attribute will be used in history logging. History As Previous Value indicates that this attribute will be used to keep previous value. Surrogate Identifier indicates that this attribute will be used to keep the surrogate identifier. Natural Identifier indicates that this attribute will be used to keep the natural identifier. Effective Time indicates that this attribute will be used as the effective time of the version. Expiration Time indicates that this attribute will be used as the expiration time of the version. Trigger indicates that this attribute will be used to trigger history logging. If none is specified, this attribute will be used to keep current value.

ATTR_NOT_NULL

BOOLEAN

true, false

none

none

false


BINDING_COLUMN_NAME

STRING

none

none

none

empty string

The binding column name for this attribute

BOUND_NAME

STRING

none

none

none

empty string

The name to be used by the code generator to identify this item. By default it is the same physical name as the item.

CODE_TEMPLATE_SCD

STRING(9)

SCD_END, SCD_FLAG, SCD_INS, SCD_NK, SCD_SK, SCD_START, SCD_UND, SCD_UPD

none

none

SCD_UND

Slowly changing dimension behavior for this attribute.

CODE_TEMPLATE_UPDATE

STRING(3)

NO, YES

none

none

YES

A boolean value indicating whether this attribute will included in code template functions using the UPD (Update) tag.

CODE_TEMPLATE_USER_DEFINED_1

STRING(3)

NO, YES

none

none

NO

A boolean value indicating whether this attribute will included in code template functions using the UD1 (User Defined 1) tag.

CODE_TEMPLATE_USER_DEFINED_2

STRING(3)

NO, YES

none

none

NO

A boolean value indicating whether this attribute will included in code template functions using the UD2 (User Defined 2) tag.

CODE_TEMPLATE_USER_DEFINED_3

STRING(3)

NO, YES

none

none

NO

A boolean value indicating whether this attribute will included in code template functions using the UD3 (User Defined 3) tag.

CODE_TEMPLATE_USER_DEFINED_4

STRING(3)

NO, YES

none

none

NO

A boolean value indicating whether this attribute will included in code template functions using the UD4 (User Defined 4) tag.

CODE_TEMPLATE_USER_DEFINED_5

STRING(3)

NO, YES

none

none

NO

A boolean value indicating whether this attribute will included in code template functions using the UD5 (User Defined 5) tag.

COLUMN_USAGE

STRING

CDC_COL, ROWID, ROWNUM, TABLE_COL

none

none

TABLE_COL


CONTROL_FLOW

BOOLEAN

true, false

none

none

false


CONTROL_STATIC

BOOLEAN

true, false

none

none

false


DATA_TYPE

STRING

none

none

none

empty string

The data type of the attribute

DEFAULT_VALUE

STRING

none

none

none

empty string

The default value for the attribute, used for orphan management default parent record creation.

DIMENSION_ATTRIBUTE_NAME

STRING

none

none

none

empty string

The dimension attribute referenced to by this level attribute.

EXPRESSION

STRING

none

none

none

empty string

The output expression for the attribute

FIELD_DATA_TYPE

STRING

BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE, FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARGRAPHIC, VARRAW, VARRAWC, ZONED, ZONED EXTERNAL

none

none

CHAR

SQL Data Type of the field in the file to which this operator is bound.

FIELD_DATA_TYPE_LENGTH

NUMBER

none

none

none

0

Field Length of the field in the file to which this operator is bound.

FIELD_DATA_TYPE_PRECISION

NUMBER

none

none

none

0

Field Precision of the field in the file to which this operator is bound.

FIELD_DATA_TYPE_SCALE

NUMBER

none

none

none

0

Field Scale of the field in the file to which this operator is bound.

FIELD_DEFAULTIF_VALUE

STRING

none

none

none

empty string

The expression that indicates the value of the field is blank or zero, based on the datatype.

FIELD_END_POSITION

NUMBER

none

none

none

0

The ending position of the field in the file

FIELD_MASK

STRING

none

none

none

empty string

The mask for the field

FIELD_NULLIF_VALUE

STRING

none

none

none

empty string

The expression that indicates the value of the field is null

FIELD_START_POSITION

NUMBER

none

none

none

0

The starting position of the field in the file

FRACTIONAL_SECONDS_PRECISION

NUMBER

none

none

none

0

The data fractional seconds precision value of the attribute

FUNCTION_RETURN

BOOLEAN

true, false

none

none

false

Specifies whether this output is the return value of this function

GROUP_KEY

BOOLEAN

true, false

none

none

false

A boolean value to indicate whether this input attribute is a part of the unpivot group key.

HISTORY_ATTRIBUTE

STRING

none

none

none

empty string

The bound name of the attribute to indicate where the history of the current attribute is to be logged.

INPUT_ROLE

STRING

NA_ADDRESS, NA_ADDRESS2, NA_CITY, NA_COUNTRYCODE, NA_COUNTRYNAME, NA_FIRMNAME, NA_FIRSTNAME, NA_FIRSTPARTNAME, NA_LASTLINE, NA_LASTLINE_2, NA_LASTNAME, NA_LASTPARTNAME, NA_LINE1, NA_LINE10, NA_LINE2, NA_LINE3, NA_LINE4, NA_LINE5, NA_LINE6, NA_LINE7, NA_LINE8, NA_LINE9, NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4, NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME3, NA_NEIGHBORHOOD, NA_NONE, NA_PASSTHRU, NA_PERSON, NA_PERSON2, NA_PERSON3, NA_POSTALCODE, NA_POSTNAME, NA_PRENAME, NA_PRIMARYADDRESS, NA_SECONDARYADDRESS, NA_STATE

none

none

NA_NONE

Assigns a name-address input role to the selected input attribute

INSTANCE

STRING

NA_INSTANCE_FIFTH, NA_INSTANCE_FIRST, NA_INSTANCE_FOURTH, NA_INSTANCE_SECOND, NA_INSTANCE_SIXTH, NA_INSTANCE_THIRD

none

none

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.

IN_MATCHING_ATTRIBUTE

STRING

none

none

none

empty string

Defines the matching output attribute for the "IN" subquery

IS_AGGREGATION

STRING

NO, YES

none

none

NO


IS_CAST_TARGET

BOOLEAN

true, false

none

none

false

Description not available.

IS_CHUNKING_COLUMN

BOOLEAN

true, false

none

none

false

This Number Column will be used as the chunking column .

IS_OPTIONAL

BOOLEAN

true, false

none

none

false

If true, the input is not required to be connected

IS_PREDEFINED_CONSTANT

BOOLEAN

true, false

none

none

false

Description not available.

IS_VARIABLE_EXPRESSION

BOOLEAN

true, false

none

none

false

If true, the expression value is stored as a runtime variable. The value is altered only when the write condition is true.

JOIN_INPUT_UOID

STRING

none

none

none

empty string


JOIN_OUTPUT_UOID

STRING

none

none

none

empty string


LENGTH

NUMBER

none

none

none

0


LEVEL_ATTRIBUTE_COLNAME_NAME

STRING

none

none

none

empty string

Column name in the AW staging table and source view for this attribute.

LEVEL_ATTRIBUTE_ISPARENT

STRING

NO, YES

none

none

NO

Indicates whether this is a parent level.

LEVEL_ATTRIBUTE_LEVEL_INDICATOR_COLNAME

STRING

none

none

none

empty string

Level indicating columns name. This level will contain the name of the name of the level this parent reference belongs to. This is relavant only for skip level hierarchies.

LEVEL_ATTRIBUTE_NAME

STRING

none

none

none

empty string

The name of the Level Attribute.

LEVEL_ATTRIBUTE_OBJECT_ID

STRING

none

none

none

empty string


LEVEL_PARENTHIERARCHY

STRING

none

none

none

empty string

Name of the parent hierarchy.

LEVEL_PARENTREF_PARENTLEVEL

STRING

none

none

none

empty string

The name of the parent level if relavant.

LEVEL_RELATIONSHIP_NAME

STRING

none

none

none

empty string

The level relationship name associated to this attribute.

LOADING_FLAG

STRING

none

none

none

YES

A boolean value to indicate whether this attribute will particiate in the load operation.

LOAD_COLUMN_WHEN_INSERTING_ROW

STRING(3)

NO, YES

none

none

YES

A boolean value to indicate whether this attribute will particiate in the insert load operation.

LOAD_COLUMN_WHEN_UPDATING_ROW

STRING(3)

NO, YES

none

none

YES

A boolean value to indicate whether this attribute will particiate in the update load operation.

LOAD_MATCHING

STRING

NO, YES

none

none

NO

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 load operation.

LOAD_ON_INSERT

STRING(3)

NO, YES

none

none

YES

A boolean value to indicate whether this level attribute will participate in an insert when inserting a new record. Has no effect for SCD type 2 trigger or business key attributes.

LOAD_ON_UPDATE

STRING(3)

NO, YES

none

none

YES

A boolean value to indicate whether this level attribute will participate in an update when updating an existing record. Has no effect for SCD type 2 trigger attributes.

LOOKUP_ATTRIBUTE_ROLE

STRING

DIMENSION_KEY, END_DATE, NATURAL_KEY, NATURAL_KEY_AND_SURROGATE_KEY, NONE, PREV_VALUE, START_DATE, SURROGATE_KEY, TRIGGER

none

none

NONE

The role of the attribute, synchronized from the referencing lookup table or level

LOOKUP_MATCHING

STRING

NO, YES

none

none

NO

A boolean value to indicate whether this attribute will be used to construct the lookup condition to resolve level reference between the incoming child data and the existing parent data on the target during the selected operation.

MATCHING_ROW

NUMBER

none

1

1000

1

An positive integer to indicate from which row within the unpivot group this output attribute obtains its data.

MATCH_COLUMN_WHEN_DELETING_ROW

STRING(3)

NO, YES

none

none

NO

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.

MATCH_COLUMN_WHEN_UPDATING_ROW

STRING(3)

NO, YES

none

none

NO

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.

MCM_MATCH_VALUE

STRING

none

none

none

empty string


MERGE_ATTR

STRING

none

none

none

empty string

Related merge attribute

NULL_VALUE

STRING

none

none

none

NULL

The data value that is interpreted as "null" by orphan management. Default is SQL NULL, specified as unquoted NULL.

OUTPUT_COMPONENT

STRING

NA_ADDRESS, NA_ADDRESS2, NA_ADDRESSCORRECTED, NA_ADDRESSTYPE, NA_AUTO_ZONE_IND, NA_BOXNAME, NA_BOXNUMBER, NA_BUILDINGNAME, NA_CART, NA_CBSA_CODE, NA_CBSA_DESC, NA_CENSUSID, NA_CHECKDIGIT, NA_CITY, NA_CITYCORRECTED, NA_CITYMATCH, NA_CITYWARNING, NA_CITY_ABBREV, NA_CITY_ABBREV_2, NA_CITY_ALTERNATE, NA_COMPLEX, NA_COUNTRYCODE, NA_COUNTRYCODE3, NA_COUNTRYNAME, NA_COUNTYNAME, NA_DELIVERYBEATCODE, NA_DELIVERYOFFICECODE, NA_DELIVERYPOINT, NA_EMAIL, NA_EXTRA_1, NA_EXTRA_10, NA_EXTRA_11, NA_EXTRA_12, NA_EXTRA_13, NA_EXTRA_14, NA_EXTRA_15, NA_EXTRA_16, NA_EXTRA_17, NA_EXTRA_18, NA_EXTRA_19, NA_EXTRA_2, NA_EXTRA_20, NA_EXTRA_3, NA_EXTRA_4, NA_EXTRA_5, NA_EXTRA_6, NA_EXTRA_7, NA_EXTRA_8, NA_EXTRA_9, NA_FIPS, NA_FIPSCOUNTY, NA_FIPS_PLACE_CODE, NA_FIRMCOUNT, NA_FIRMNAME, NA_FIRM_LOC, NA_FIRSTNAME, NA_FIRSTNAMESTD, NA_GENDER, NA_GEO_MATCH_PREC, NA_INSTALLATIONNAME, NA_INSTALLATIONTYPE, NA_ISADDRESSVERIFIABLE, NA_ISFOUND, NA_ISGOODADDRESS, NA_ISGOODGROUP, NA_ISGOODNAME, NA_ISPARSED, NA_LACS, NA_LASTLINE, NA_LASTLINE_2, NA_LASTNAME, NA_LATITUDE, NA_LOCALITYCODE, NA_LOCALITYNAME, NA_LOCALITY_2, NA_LOCALITY_3, NA_LOCALITY_4, NA_LONGITUDE, NA_LOT, NA_LOT_ORDER, NA_MCD, NA_MIDDLENAME, NA_MIDDLENAME2, NA_MIDDLENAME2STD, NA_MIDDLENAME3, NA_MIDDLENAME3STD, NA_MIDDLENAMESTD, NA_MISCADDRESS, NA_MSA, NA_NAMEDESIGNATOR, NA_NAMEWARNING, NA_NAME_FIRM_EXTRA, NA_NEIGHBORHOOD, NA_NONAMBIGUOUSMATCH, NA_NONE, NA_NP_SEC_ADDR, NA_NP_UNIT_DESIG, NA_NP_UNIT_NBR, NA_OTHERPOSTNAME, NA_PARSESTATUS, NA_PARSESTATUSDESC, NA_PARSINGCOUNTRY, NA_PASSTHRU, NA_PERSON, NA_PERSONCOUNT, NA_PHONE, NA_POSTALCODE, NA_POSTALCODECORRECTED, NA_POSTALCODEFORMATTED, NA_POSTDIRECTIONAL, NA_POSTNAME, NA_PREDIRECTIONAL, NA_PRENAME, NA_PRIMARYADDRESS, NA_PRIM_NAME_2, NA_RELATIONSHIP, NA_ROUTENAME, NA_ROUTENUMBER, NA_SECONDARYADDRESS, NA_SSN, NA_STATE, NA_STREETCOMPCORRECTED, NA_STREETCOMPMATCH, NA_STREETCORRECTED, NA_STREETNAME, NA_STREETNAMEMATCH, NA_STREETNUMBER, NA_STREETNUMBERMATCH, NA_STREETTYPE, NA_STREETWARNING, NA_TITLE, NA_UNITDESIGNATOR, NA_UNITNUMBER, NA_URBANIZATIONNAME, NA_URBAN_IND, NA_ZIP4, NA_ZIP5

none

none

NA_NONE

Assigns a Name and Address output component to the selected output attribute.

OUTPUT_GROUP_KEY

BOOLEAN

true, false

none

none

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.

PIVOT_EXPRESSION

STRING

none

none

none

empty string

A comma-separated expression that gives the input attribute to be used for each output row in the pivot group.

PRECISION

NUMBER

none

none

none

0

The data precision value of the attribute

REFERENCED_LEVEL_ATTRIBUTE_NAME

STRING

none

none

none

empty string

The bound name of the parent level attribute associated to this attribute.

REFERENCED_LEVEL_NAME

STRING

none

none

none

empty string

The bound name of the parent level group associated to this attribute.

REFERENCING_TYPE

STRING

LOOKUP_KEY, LOOKUP_KEY_AND_REFERENCE_KEY_ALL, LOOKUP_KEY_AND_REFERENCE_KEY_ONLY, NONE, REFERENCE_KEY_ALL, REFERENCE_KEY_ONLY

none

none

NONE

The type of reference to indicate how this attribute participates in resolving existing level relationships and level implementations. If Lookup Reference Attribute is specified, this attribute will be used as lookup attribute upon parent level to resolve level implementations during loading. If Level Relationship Attribute (Snowflake) is specified, this attribute will be directly used as level relationship attribute and no lookup upon parent level would be performed during loading. If Level Relationship Attribute (Star) is specified, this attribute will be directly used as level relationship attribute, as well as lookup attribute upon parent level to resolve level implementations during loading. If none is specified, this attribute does not participate in any level relationship.

REMOVE_MATCHING

STRING

NO, YES

none

none

NO

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 remove operation.

REPRESENTS_LOOKUP_TABLE_COLUMN

BOOLEAN

true, false

none

none

false


SCALE

NUMBER

none

none

none

0

The data scale value of the attribute

SKIP_LEVEL_DIMENSION

STRING

NO, YES

none

none

NO

Indicates whether this level has a skip level parent.

SOURCE_AGGREGATION_FUNCTION

STRING

none

none

none

SUM

The source loading aggregation function for the measure.

SUBQUERY_OUTPUT_MATCHING

STRING

none

none

none

empty string

A unique matching value which will match a corresponding property for an output attribute

TYPE_ATTRIBUTE_NAME

STRING

none

none

none

empty string

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.

TYPE_TWO_SCD_TRIGGER

STRING

NO, YES

none

none

NO

If YES, indicates that this attribute will be used as a trigger for type 2 Slowly Changing Dimension history recording.

UNPIVOT_EXPRESSION

STRING

none

none

none

NULL

An expression that gives the input attribute to be used as the output of this attribute.

UPDATE_OPERATION

STRING(3)

*=, +=, -=, /=, =, =-, =/, =||, ||=

none

none

=


The computation to be performed on this attribute between the incoming data and the existing data on the target during the update load operation. Only applicable to measure attributes.

VALUETYPE

STRING

NEW, NEW_OLD, OLD

none

none

NEW_OLD

Specifies the value type of this attribute

VARIABLE_INITIAL_VALUE

STRING

none

none

none

empty string

If this is a variable expression, then this is the initial value of the variable expression.

VARIABLE_WRITE_CONDITION

STRING

none

none

none

empty string

If this is a variable expression, then the variable value is set when processing a row where this condition is true.


AGGREGATOR_OPERATOR Object

Table 8-10 AGGREGATOR_OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


GROUP_BY_CLAUSE

STRING

none

none

none

empty string

The Group By clause for the aggregation

HAVING_CLAUSE

STRING

none

none

none

empty string

The Having clause for the aggregation

HEIGHT

NUMBER

none

none

none

150


INLINEVIEW_HINT

STRING

none

none

none

empty string

Hint used on inline view when extracting using SQL

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


WIDTH

NUMBER

none

none

none

180


X_COORDINATE

NUMBER

none

none

none

0


Y_COORDINATE

NUMBER</p>

none

none

none

0



ANYDATA_CAST_OPERATOR Object

Table 8-11 ANYDATA_CAST_OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


HEIGHT

NUMBER

none

none

none

150


IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


WIDTH

NUMBER

none

none

none

180


X_COORDINATE

NUMBER

none

none

none

0


Y_COORDINATE

NUMBER

none

none

none

0



CONSTANT_OPERATOR Object

Table 8-12 CONSTANT_OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


HEIGHT

NUMBER

none

none

none

150


IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


WIDTH

NUMBER

none

none

none

180


X_COORDINATE

NUMBER

none

none

none

0


Y_COORDINATE

NUMBER

none

none

none

0



CONSTRUCT_OBJECT_OPERATOR Object

Table 8-13 CONSTRUCT_OBJECT_OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

BOUND_NAME

STRING

none

none

none

empty string

The name to be used by the code generator to identify this item. By default it is the same physical name as the item.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


HEIGHT

NUMBER

none

none

none

150


IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


WIDTH

NUMBER

none

none

none

180


X_COORDINATE

NUMBER

none

none

none

0


Y_COORDINATE

NUMBER

none

none

none

0



CUBE_OPERATOR Object

Table 8-14 CUBE_OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

ALLOW_PARALLEL_SOLVE

BOOLEAN

true, false

none

none

false

If true, allow parallel solve when solving the cube.

AUTOMATIC_HINTS_ENABLED

BOOLEAN

true, false

none

none

true

Automatic hints enabled using SQL

AW_LOAD_STAGETABLE_NAME

STRING

none

none

none

empty string

The stage table used to load the AW level

AW_LOAD_VIEW_NAME

STRING

none

none

none

empty string

The view used to load the AW level

AW_STAGED_LOAD

BOOLEAN

true, false

none

none

false

If true, the set-based AW load data is staged into a temporary table before loading into the AW.

BOUND_NAME

STRING

none

none

none

empty string

The name to be used by the code generator to identify this item. By default it is the same physical name as the item.

CUBE_STORAGE_ISAW

STRING

NO, YES

none

none

NO

Indicates whether the storage for this cube in AW.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


DIMENSION_AWNAME

STRING

none

none

none

empty string

AW Name which contains this Dimension.

DML_ERROR_TABLE_NAME

STRING(32)

none

none

none

empty string

The error table name of this target for DML error logging.

ENABLE_SOURCE_AGGREGATION

BOOLEAN

true, false

none

none

false

If set, add source loading aggregation grouped by the dimension reference attributes. Measure aggregation functions are determined by the SOURCE_AGGREGATION_FUNCTION attribute properties, or the presence of "MAX", "MIN", "SUM", "AVG" or "MEDIAN" in the cube attribute name.

ERROR_TABLE_NAME

STRING(32)

none

none

none

empty string

The error table name of this target to log invalid records.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150


INCREMENTAL_AGGREGATION

BOOLEAN

true, false

none

none

true

Indicates whether incremental aggregation should be done or full aggregation.

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


LOADING_HINT

STRING

none

none

none

empty string

Hint used when loading into this table using SQL

LOADING_TYPE

STRING

INSERT_LOAD, LOAD, REMOVE

none

none

LOAD

The loading operation to be performed when this is a target. If INSERT_LOAD is specified (recommended if orphan management is enabled), OWB will try to insert all input data into the target. If LOAD is specified, OWB will try to merge all input data into the target. If REMOVE is specified, OWB will try to match between the input data and target data to compute existing data; it will then remove existing data from target.

LOAD_POLICY_FOR_INVALID_KEY

STRING

DEFAULT_DIMENSION_RECORD, NO_MAINTENANCE, REJECT_ORPHAN

none

none

NO_MAINTENANCE

The orphan management policy for loading records which contain an invalid dimension natural key reference.

LOAD_POLICY_FOR_NULL_KEY

STRING

DEFAULT_DIMENSION_RECORD, NO_MAINTENANCE, REJECT_ORPHAN

none

none

NO_MAINTENANCE

The orphan management policy for loading records which contain a null dimension natural key reference.

MATCHING_CRITERIA

STRING

MATCH_BY_ATTRIBUTES, MATCH_BY_NATURAL_ID

none

none

MATCH_BY_NATURAL_ID

The type of matching criteria between the incoming data and the existing data on the target during the selected operation. If Matching by Attributes is selected, then the matching attributes (specified in the attribute property) will be matched to perform the selected operation. If Matching by Natural Identifier is selected, then the natural identifier attributes will be matched to perform the selected operation.

MAX_JOB_QUEUES_ALLOCATED

NUMBER

none

1

1000

0

The maximum number of job queues allocated when solving the cube.

OBJECT_LOC_NAME

STRING

none

none

none

empty string


OBJECT_LOC_UOID

STRING

none

none

none

empty string


OBJECT_TYPE

STRING

none

none

none

empty string


OBJECT_UOID

STRING

none

none

none

empty string


ORPHAN_POLICY_OF_REMOVE

STRING

NO_MAINTENANCE

none

none

NO_MAINTENANCE

The policy for invalid level records of REMOVE that is referenced by one or more existing child level records. If No Maintenance is specified, all input level records will be removed from target. If Reject Remove is specified, invalid level records will not be removed from target, but rather reported as errors and redirected into error target. If Cascade Remove is specified, all input level records records will be removed from target in a cascading fashion.

PARENT_OBJECT_LOC_NAME

STRING

none

none

none

empty string


PARENT_OBJECT_LOC_UOID

STRING

none

none

none

empty string


PARENT_OBJECT_NAME

STRING

none

none

none

empty string


PARENT_OBJECT_TYPE

STRING

none

none

none

empty string


PARENT_OBJECT_UOID

STRING

none

none

none

empty string


PARENT_OPERATOR_NAME

STRING

none

none

none

empty string


PARENT_OPERATOR_UOID

STRING

none

none

none

empty string


RECORD_ERROR_ROWS

STRING

NO, YES

none

none

YES

If true, orphan error rows that are encountered in the source rowset will be recorded in the error table.

RUN_AGGREGATION

STRING

NO, YES

none

none

YES

A boolean value to indicate whether to solve the cube or not . Specify YES and cube data will be precomputed for the levels specified in the definition of cube

SLOWLY_CHANGING_TYPE

STRING

TYPE1

none

none

TYPE1

The slowly changing type of this target.

TARGET_LOAD_ORDER

STRING(65535)

none

none

none

empty string

The Target Load Order property allows you to determine the order in which multiple targets within the same mapping get loaded. Warehouse Builder determines a default order based on the FK relationships. However, using the property you can overrule that default order.

TRUNCATE_ERROR_TABLE

STRING(3)

NO, YES

none

none

NO

If YES, then the error table will be truncated prior to use. This is ignored if there are no active data rules applied to the object.

TRUNCATE_LOAD

BOOLEAN

true, false

none

none

false

The truncate flag to indicate whether all existing dimension values should be truncated before load begins (AW only).

WIDTH

NUMBER

none

none

none

180


X_COORDINATE

NUMBER

none

none

none

0


Y_COORDINATE

NUMBER

none

none

none

0



DATA_GENERATOR_OPERATOR Object

Table 8-15 DATA_GENERATOR_OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


HEIGHT

NUMBER

none

none

none

150


IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


WIDTH

NUMBER

none

none

none

180


X_COORDINATE

NUMBER

none

none

none

0


Y_COORDINATE

NUMBER

none

none

none

0



DEDUPLICATOR_OPERATOR Object

Table 8-16 DEDUPLICATOR_OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


HEIGHT

NUMBER

none

none

none

150


INLINEVIEW_HINT

STRING

none

none

none

empty string

Hint used on inline view when extracting using SQL

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


WIDTH

NUMBER

none

none

none

180


X_COORDINATE

NUMBER

none

none

none

0


Y_COORDINATE

NUMBER

none

none

none

0



DIMENSION_OPERATOR Object

Table 8-17 DIMENSION_OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

AUTOMATIC_HINTS_ENABLED

BOOLEAN

true, false

none

none

true

Automatic hints enabled using SQL

AW_LOAD_MODEL

STRING

OTHER, SNOWFLAKE, STAR

none

none

SNOWFLAKE

The loading model for the AW dimension - star, snowflake, or other.

AW_STAGED_LOAD

BOOLEAN

true, false

none

none

false

If true, the set-based AW load data is staged into a temporary table before loading into the AW.

BOUND_NAME

STRING

none

none

none

empty string

The name to be used by the code generator to identify this item. By default it is the same physical name as the item.

CREATE_DEFAULT_RECORDS

STRING

NO, YES

none

none

NO

If true, default records are created for each level, for cube orphan management. If "default parent" orphan management policy is set, the records will be created regardless of this setting.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


DEFAULT_EFFECTIVE_TIME_OF_INITIAL_RECORD

STRING

none

none

none

SYSDATE

A date value to be served as the effective time of the initial record.

DEFAULT_EFFECTIVE_TIME_OF_OPEN_RECORD

STRING

none

none

none

SYSDATE

A date value to be served as the effective time of a newly created open record. The same date value is also served as the expiration time to close an existing open record.

DEFAULT_EXPIRATION_TIME_OF_OPEN_RECORD

STRING

none

none

none

NULL

A date value to be served as the expiration time of a newly created open record.

DIMENSION_ATTRIBUTES

STRING

none

none

none

empty string

Contains list of all Dimension Attributes.

DIMENSION_AWNAME

STRING

none

none

none

empty string

AW Name which contains this Dimension.

DIMENSION_ISAW

STRING(3)

NO, YES

none

none

YES

Flag to indicate whether storage is AW.

DML_ERROR_TABLE_NAME

STRING(32)

none

none

none

empty string

The error table name of this target for DML error logging.

ENABLE_SOURCE_DEDUP

BOOLEAN

true, false

none

none

true

If set, add source business key deduplication using an aggregator operator when loading the dimension, with some extra performance cost. Not applicable if SUPPORT_MULTIPLE_TYPE2_HISTORY_RECORDS is set to true for type 2 dimension.

ERROR_TABLE_NAME

STRING(32)

none

none

none

empty string

The error table name of this target to log invalid records.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150


HIERARCHY_LEVEL_LIST

STRING

none

none

none

empty string

Contains list of all Dimension Attributes.

HISTORY_LOGGING

STRING

NO, YES

none

none

YES

A boolean value to indicate whether history logging will be activated. Specify NO and the loading operation will be rollback to type 1 such that all values will be overwritten directly without logging any history.

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


LEVEL_LIST

STRING

none

none

none

empty string

Contains list of all Level Attributes.

LOADING_HINT

STRING

none

none

none

empty string

Hint used when loading into this table using SQL

LOADING_TYPE

STRING

LOAD, REMOVE

none

none

LOAD

The loading operation to be performed when this is a target. If LOAD is specified, OWB will try to match between the input data and target data to compute new data and existing data; it will then create new data, as well as modify existing data onto target. If REMOVE is specified, OWB will try to match between the input data and target data to compute existing data; it will then remove existing data from target.

LOAD_POLICY_FOR_INVALID_KEY

STRING

DEFAULT_PARENT, NO_MAINTENANCE, REJECT_ORPHAN

none

none

NO_MAINTENANCE

The orphan management policy for loading level records which contain an invalid (unfound) parent natural key reference.

LOAD_POLICY_FOR_NULL_KEY

STRING

DEFAULT_PARENT, NO_MAINTENANCE, REJECT_ORPHAN

none

none

NO_MAINTENANCE

The orphan management policy for loading level records which contain a null parent natural key reference.

MATCHING_CRITERIA

STRING

MATCH_BY_ATTRIBUTES, MATCH_BY_NATURAL_ID

none

none

MATCH_BY_NATURAL_ID

The type of matching criteria between the incoming data and the existing data on the target during the selected operation. If Matching by Attributes is selected, then the matching attributes (specified in the attribute property) will be matched to perform the selected operation. If Matching by Natural Identifier is selected, then the natural identifier attributes will be matched to perform the selected operation.

OBJECT_LOC_NAME

STRING

none

none

none

empty string


OBJECT_LOC_UOID

STRING

none

none

none

empty string


OBJECT_TYPE

STRING

none

none

none

empty string


OBJECT_UOID

STRING

none

none

none

empty string


ORPHAN_POLICY_OF_REMOVE

STRING

NO_MAINTENANCE, REJECT_REMOVAL

none

none

NO_MAINTENANCE

The orphan management policy for removing parent level records.

PARENT_OBJECT_LOC_NAME

STRING

none

none

none

empty string


PARENT_OBJECT_LOC_UOID

STRING

none

none

none

empty string


PARENT_OBJECT_NAME

STRING

none

none

none

empty string


PARENT_OBJECT_TYPE

STRING

none

none

none

empty string


PARENT_OBJECT_UOID

STRING

none

none

none

empty string


PARENT_OPERATOR_NAME

STRING

none

none

none

empty string


PARENT_OPERATOR_UOID

STRING

none

none

none

empty string


RECORD_ERROR_ROWS

STRING

NO, YES

none

none

YES

If true, orphan error rows that are encountered in the source rowset will be recorded in the error table.

SLOWLY_CHANGING_TYPE

STRING

TYPE1, TYPE2, TYPE3

none

none

TYPE2

The slowly changing type of this target.

SUPPORT_MULTIPLE_TYPE2_HISTORY_RECORDS

BOOLEAN

true, false

none

none

false

If true, then multiple history rows can be created for the same business id in a single load execution.

SUPPORT_OUT_OF_ORDER_HISTORY_LOADING

BOOLEAN

true, false

none

none

false

If true, loading of out of order changes to the dimension history in consecutive loads is supported. This may have a performance cost.

SURROGATE_IDENTIFIER_LOADING_POLICY

STRING

none

none

none

empty string

The name of the sequence used to generate surrogate key values when loading the dimension.

TARGET_LOAD_ORDER

STRING(65535)

none

none

none

empty string

The Target Load Order property allows you to determine the order in which multiple targets within the same mapping get loaded. Warehouse Builder determines a default order based on the FK relationships. However, using the property you can overrule that default order.

TRUNCATE_ERROR_TABLE

STRING(3)

NO, YES

none

none

NO

If YES, then the error table target(s) will be truncated prior to use. This applies to the logical orphan management error tables, but not the DML error tables (if defined).

TRUNCATE_LOAD

BOOLEAN

true, false

none

none

false

The truncate flag to indicate whether all existing dimension values should be truncated before load begins (AW only).

TYPE2_MATCH_CURRENT_ONLY

STRING

NO, YES

none

none

YES

If set to YES, only the current record will be used when performing the selected operation (remove or extract) for type 2 dimension.

TYPE2_RECORD_GAP_INTERVAL

NUMBER

none

none

none

1

A numeric value indicating the number of units (see TYPE2_RECORD_GAP_INTERVAL_UNITS property below) that will be added to the expiration date of the previous closed record, to create the effective date of a new open record.

TYPE2_RECORD_GAP_INTERVAL_UNITS

STRING

DAYS, HOURS, MINUTES, SECONDS, WEEKS

none

none

SECONDS

A value indicating the units used for the gap that will be added to the expiration date of the previous closed record, to create the effective date of a new open record.

WIDTH

NUMBER

none

none

none

180


X_COORDINATE

NUMBER

none

none

none

0


Y_COORDINATE

NUMBER

none

none

none

0



EXPAND_OBJECT_OPERATOR Object

Table 8-18 EXPAND_OBJECT_OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

BOUND_NAME

STRING

none

none

none

empty string

The name to be used by the code generator to identify this item. By default it is the same physical name as the item.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


HEIGHT

NUMBER

none

none

none

150


IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


WIDTH

NUMBER

none

none

none

180


X_COORDINATE

NUMBER

none

none

none

0


Y_COORDINATE

NUMBER

none

none

none

0



EXPRESSION_OPERATOR Object

Table 8-19 EXPRESSION_OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


HEIGHT

NUMBER

none

none

none

150


IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


WIDTH

NUMBER

none

none

none

180


X_COORDINATE

NUMBER

none

none

none

0


Y_COORDINATE

NUMBER

none

none

none

0



EXTERNAL_TABLE_OPERATOR Object

Table 8-20 EXTERNAL_TABLE_OPERATOR Object

PropertyTypeChoicesMinMaxDefaultDescription

ADVANCED_MATCH_BY_CONSTRAINT

STRING

none

none

none

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.

AUTOMATIC_HINTS_ENABLED

BOOLEAN

true, false

none

none

true

Automatic hints enabled using SQL

BOUND_NAME

STRING

none

none

none

empty string

The name to be used by the code generator to identify this item. By default it is the same physical name as the item.

CHUNK_FILTER_CONDITION

STRING

none

none

none

get_chunk_iterator = 1

The filter condition used to determine the set of rows that gets processed for a specified chunk. The condition should use variable name get_chunk_iterator, which starts at one and is incremented for each chunk.

DATABASE_FILE_NAME

STRING

none

none

none

empty string

Database file name to allocate extents from

DATABASE_LINK

STRING(128)

none

none

none

empty string

The database link used to access this entity during mapping.

DATA_COLLECTION_FREQUENCY

STRING(16)

DAY, HOUR, MINUTE, MONTH, QUARTER, UNKNOWN, YEAR

none

none

UNKNOWN

New Data Granularity

DB_LOCATION

STRING

none

none

none

empty string

The location used to access this entity during mapping.

DEBUG_BOUND_NAME

STRING

none

none

none

empty string

Physical name used to bind to a physical entity during a debug session

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false


DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false


DEBUG_DB_LINK

STRING(128)

none

none

none

empty string

DB Link name used to bind to a physical entity during a debug session

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string


DEBUG_SCHEMA

STRING(30)

none

none

none

empty string

Schema name used to bind to a physical entity during a debug session

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false


DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false


DIRECT

BOOLEAN

true, false

none

none

false


DML_ERROR_TABLE_NAME

STRING(32)

none

none

none

empty string

The error table name of this target for DML error logging.

ENABLE_CONSTRAINTS

BOOLEAN

true, false

none

none

true

Enable Constraints

ERROR_SELECT_FILTER

STRING(3)

NO, YES

none

none

YES

Rows selected from the error table will contain only errors created by this operator in this map execution

ERROR_SELECT_ROLL_UP

STRING(3)

NO, YES

none

none

YES

'Records selected from the error table will be rolled up by the error name, so all errors generated by a particular input record will be rolled up into a single record with the error names concatenated in the error name attribute.

ERROR_TABLE_NAME

STRING(32)

none

none

none

empty string

The error table name of this target to log invalid records.

EVALUATE_CHECK_CONSTRAINTS

BOOLEAN

true, false

none

none

false

Evaluate check constraints

EXCEPTIONS_TABLE_NAME

STRING

none

none

none

empty string

Exceptions Table Name

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150


IS_CHUNKING_ENABLED

BOOLEAN

true, false

none

none

false

If set, then the map will be called multiple times, processing a different chunk of the source data each time.

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false


IS_MINIMIZED

BOOLEAN

true, false

none

none

false


IS_NUMBER_COLUMN_CHUNKING

BOOLEAN

true, false

none

none

false

If set, then the map will be called multiple times, processing a different chunk of the source data each time using the number column .

IS_TEMP_STAGE_TABLE

BOOLEAN

true, false

none

none

false

If set, specifies that this operator will be bound to a temporary staging table created at map deployment time. The referencing object will be ignored.

IS_USER-DEFINED_DATA

BOOLEAN

true, false

none

none

false

If TRUE, test data for this source or target is user-defined

LEADING_SOURCE

BOOLEAN

true, false

none

none

false

If true, this source is considered the leading source when debugging the map

LOADING_HINT

STRING

none

none

none

empty string

Hint used when loading into this table using SQL

LOADING_TYPE

STRING

none

none

none

NONE

The loading operation to be performed when this is a target.

MATCH_BY_CONSTRAINT

STRING

none

none

none

ALL_CONSTRAINTS

A property to indicate whether unique or primary key information on this target will override the matching criteria obtained from Match by constraint property on the attributes of this target.

METADATA_DBLINK

STRING(128)

none

none

none

empty string

Database link name in OWB repository used to capture metadata during import.

METADATA_DBLINK_IS_NEW

STRING(1)

none

none

none

N

Flag indicating reconciliation of the database link is required.

OBJECT_LOC_NAME

STRING

none

none

none

empty string


OBJECT_LOC_UOID

STRING

none

none

none

empty string


OBJECT_TYPE

STRING

none

none

none

empty string


OBJECT_UOID

STRING

none

none

none

empty string


OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

PARENT_OBJECT_LOC_NAME

STRING

none

none

none

empty string


PARENT_OBJECT_LOC_UOID

STRING

none

none

none

empty string


PARENT_OBJECT_NAME

STRING

none

none

none

empty string


PARENT_OBJECT_TYPE

STRING

none

none

none

empty string


PARENT_OBJECT_UOID

STRING

none

none

none

empty string


PARENT_OPERATOR_NAME

STRING

none

none

none

empty string


PARENT_OPERATOR_UOID

STRING

none

none

none

empty string


PARTITION_NAME

STRING

none

none

none

empty string

Partition Name

PEL_ENABLED

BOOLEAN

true, false

none

none

false

PEL Enabled

PRIMARY_SOURCE

STRING

NO, YES

none

none

NO

A boolean value to indicate whether this is a primary source or not (only used in EDW).

RECORDS_TO_SKIP

NUMBER

none

0

none

0

Number of records to skip

REPLACE_DATA

BOOLEAN

true, false

none

none

false

Replace existing data in target partition if there is any.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SAMPLE_RATE

NUMBER

none

none

none

100

The sampling rate used when selecting from this table

SAMPLE_SEED

NUMBER

none

none

none

1

The sampling seed value. The random number generator is based on this sampling seed.

SAP_TABLE_TYPE

STRING

none

none

none

empty string

SAP Table Type

SCHEMA

STRING(30)

none

none

none

empty string

Schema

SINGLEROW

BOOLEAN

true, false

none

none

false

Singlerow

SORTED_INDEXES_CLAUSE

STRING

none

none

none

empty string

Sorted Indexes Clause

SUBPARTITION_NAME

STRING

none

none

none

empty string

Subpartition Name

TARGET_FILTER_FOR_DELETE

STRING

none

none

none

empty string

A condition on the rows in the target and if evaluated to true, that row will participate in the delete loading operation.

TARGET_FILTER_FOR_UPDATE

STRING

none

none

none

empty string

A condition on the rows in the target and if evaluated to true, that row will participate in the update loading operation.

TARGET_LOAD_ORDER

STRING(65535)

none

none

none

empty string

The Target Load Order property allows you to determine the order in which multiple targets within the same mapping get loaded. Warehouse Builder determines a default order based on the FK relationships. However, using the property you can overrule that default order.

TEMP_STAGE_TABLE_EXTRA_DDL_CLAUSES

STRING

none

none

none

empty string

Extra DDL clauses that will be added to the temp staging table creation DDL, after the column definitions. Example: "TABLESPACE my_tblspc"

TEMP_STAGE_TABLE_ID

STRING

none

none

none

empty string

A String ID which identifies the temp stage table within the map. It can be used to create multiple operator instances of the same temp stage table.

TEST_DATA_COLUMN_LIST

STRING

none

none

none

empty string

Column list for test data VIEW for this source or target

TEST_DATA_WHERE_CLAUSE

STRING

none

none

none

empty string

WHERE clause for test data VIEW for this source or target

TRAILING_NULLCOLS

BOOLEAN

true, false

none

none

false

Trailing Nullcols

TRUNCATE_ERROR_TABLE

STRING(3)

NO, YES

none

none

NO

If YES, then the error table will be truncated prior to use. This is ignored if there are no active data rules applied to the object.

WIDTH

NUMBER

none

none

none

180

<