Contents

List of Tables

Title and Copyright Information

Preface

Audience

Documentation Accessibility

Related Documents

Conventions

1 OMBALTER to OMBALTER CORRECTION_SCHEMA_ACTION_PLAN

OMBALTER

OMBALTER ACTIVITY_TEMPLATE

OMBALTER ACTIVITY_TEMPLATE_FOLDER

OMBALTER ADVANCED_QUEUE

OMBALTER ALTERNATIVE_SORT_ORDER

OMBALTER ANALYZE_ACTION_PLAN

OMBALTER APPLICATION_SERVER_MODULE

OMBALTER BUSINESS_AREA

OMBALTER BUSINESS_DEFINITION_MODULE

OMBALTER CALENDAR

OMBALTER CALENDAR_MODULE

OMBALTER CATALOG_FOLDER

OMBALTER CMI_DEFINITION

OMBALTER CMI_MODULE

OMBALTER COLLECTION

OMBALTER CONFIGURATION

OMBALTER CONFIGURATION_TEMPLATE

OMBALTER CONNECTOR

OMBALTER CONTROL_CENTER

OMBALTER CORRECTION_MAPS_ACTION_PLAN

OMBALTER CORRECTION_SCHEMA_ACTION_PLAN

2 OMBALTER CT to OMBALTER ICONSET

OMBALTER CT

OMBALTER CT_FOLDER

OMBALTER CUBE

OMBALTER DATA_AUDITOR

OMBALTER DATA_PROFILE

OMBALTER DATA_RULE

OMBALTER DATA_RULE_MODULE

OMBALTER DEPLOYMENT

OMBALTER DEPLOYMENT_ACTION_PLAN

OMBALTER DIMENSION

OMBALTER DRILL_PATH

OMBALTER DRILL_TO_DETAIL

OMBALTER EXPERT

OMBALTER EXPERT_MODULE

OMBALTER EXTERNAL_TABLE

OMBALTER FLAT_FILE

OMBALTER FLAT_FILE_MODULE

OMBALTER FOLDER

OMBALTER FUNCTION

OMBALTER GATEWAY_MODULE

OMBALTER ICONSET

3 OMBALTER IMPORT_ACTION_PLAN to OMBALTER PLUGGABLE_MAPPING

OMBALTER IMPORT_ACTION_PLAN

OMBALTER ITEM_FOLDER

OMBALTER LIST_OF_VALUES

OMBALTER LOCATION

OMBALTER LOGICAL_TABLE

OMBALTER MAPPING

OMBALTER MAPPING_MODULE

OMBALTER MATERIALIZED_VIEW

OMBALTER MDL_ACTION_PLAN

OMBALTER MODULE

OMBALTER NESTED_TABLE

OMBALTER OBIEE_BUSINESS_DEFINITION_MODULE

OMBALTER OBJECT_TYPE

OMBALTER ORACLE_EBS_MODULE

OMBALTER ORACLE_MODULE

OMBALTER PACKAGE

OMBALTER PLATFORM

OMBALTER PLSQL_RECORD_TYPE

OMBALTER PLSQL_REF_CURSOR_TYPE

OMBALTER PLSQL_TABLE_TYPE

OMBALTER PLUGGABLE_MAPPING

4 OMBALTER PLUGGABLE_MAPPING_FOLDER to OMBALTER TRANSPORTABLE_MODULE

OMBALTER PLUGGABLE_MAPPING_FOLDER

OMBALTER PROCEDURE

OMBALTER PROCESS_FLOW

OMBALTER PROCESS_FLOW_MODULE

OMBALTER PROCESS_FLOW_PACKAGE

OMBALTER PROFILE_REFERENCE

OMBALTER PROJECT

OMBALTER PSFT_MODULE

OMBALTER QUEUE_PROPAGATION

OMBALTER QUEUE_TABLE

OMBALTER REAL_TIME_MAPPING

OMBALTER REGISTERED_FUNCTION

OMBALTER ROLE

OMBALTER SAP_MODULE

OMBALTER SEQUENCE

OMBALTER SIEBEL_MODULE

OMBALTER SNAPSHOT

OMBALTER TABLE

OMBALTER TABLE_FUNCTION

OMBALTER TIME_DIMENSION

OMBALTER TRANSPORTABLE_MODULE

5 OMBALTER UNQUOTED_STRING to OMBCREATE ADVANCED_QUEUE

OMBALTER UNQUOTED_STRING

OMBALTER USER

OMBALTER VARYING_ARRAY

OMBALTER VIEW

OMBALTER WEB_SERVICE

OMBALTER WEB_SERVICE_PACKAGE

OMBCAC

OMBCC

OMBCDC

OMBCOMMIT

OMBCOMPARE SNAPSHOT

OMBCOMPILE

OMBCONN

OMBCONN CONTROL_CENTER

OMBCONNECT

OMBCONNECT CONTROL_CENTER

OMBCOPY

OMBCREATE

OMBCREATE ACTIVITY_TEMPLATE

OMBCREATE ACTIVITY_TEMPLATE_FOLDER

OMBCREATE ADVANCED_QUEUE

6 OMBCREATE ALTERNATIVE_SORT_ORDER to OMBCREATE CUBE

OMBCREATE ALTERNATIVE_SORT_ORDER

OMBCREATE ANALYZE_ACTION_PLAN

OMBCREATE APPLICATION_SERVER_MODULE

OMBCREATE BUSINESS_AREA

OMBCREATE BUSINESS_DEFINITION_MODULE

OMBCREATE CALENDAR

OMBCREATE CALENDAR_MODULE

OMBCREATE CATALOG_FOLDER

OMBCREATE CDC_CT

OMBCREATE CMI_DEFINITION

OMBCREATE CMI_MODULE

OMBCREATE COLLECTION

OMBCREATE CONFIGURATION

OMBCREATE CONFIGURATION_TEMPLATE

OMBCREATE CONNECTOR

OMBCREATE CONTROL_CENTER

OMBCREATE CONTROL_CT

OMBCREATE CORRECTION_MAPS_ACTION_PLAN

OMBCREATE CORRECTION_SCHEMA_ACTION_PLAN

OMBCREATE CT_FOLDER

OMBCREATE CUBE

7 OMBCREATE DATA_AUDITOR to OMBCREATE INTEGRATION_CT

OMBCREATE DATA_AUDITOR

OMBCREATE DATA_PROFILE

OMBCREATE DATA_RULE

OMBCREATE DATA_RULE_MODULE

OMBCREATE DEPLOYMENT

OMBCREATE DEPLOYMENT_ACTION_PLAN

OMBCREATE DIMENSION

OMBCREATE DRILL_PATH

OMBCREATE DRILL_TO_DETAIL

OMBCREATE EXPERT

OMBCREATE EXPERT_MODULE

OMBCREATE EXTERNAL_TABLE

OMBCREATE FLAT_FILE

OMBCREATE FLAT_FILE_MODULE

OMBCREATE FOLDER

OMBCREATE FUNCTION

OMBCREATE FUNCTION_CT

OMBCREATE GATEWAY_MODULE

OMBCREATE ICONSET

OMBCREATE IMPORT_ACTION_PLAN

OMBCREATE INTEGRATION_CT

8 OMBCREATE ITEM_FOLDER to OMBCREATE PLSQL_REF_CURSOR_TYPE

OMBCREATE ITEM_FOLDER

OMBCREATE J2EE_USER

OMBCREATE LIST_OF_VALUES

OMBCREATE LOAD_CT

OMBCREATE LOCATION

OMBCREATE LOGICAL_TABLE

OMBCREATE MAPPING

OMBCREATE MAPPING_MODULE

OMBCREATE MATERIALIZED_VIEW

OMBCREATE MDL_ACTION_PLAN

OMBCREATE MODULE

OMBCREATE NESTED_TABLE

OMBCREATE OBIEE_BUSINESS_DEFINITION_MODULE

OMBCREATE OBJECT_TYPE

OMBCREATE ORACLE_EBS_MODULE

OMBCREATE ORACLE_MODULE

OMBCREATE ORACLE_TARGET_CT

OMBCREATE PACKAGE

OMBCREATE PLATFORM

OMBCREATE PLSQL_RECORD_TYPE

OMBCREATE PLSQL_REF_CURSOR_TYPE

9 OMBCREATE PLSQL_TABLE_TYPE to OMBCREATE TIME_DIMENSION

OMBCREATE PLSQL_TABLE_TYPE

OMBCREATE PLUGGABLE_MAPPING

OMBCREATE PLUGGABLE_MAPPING_FOLDER

OMBCREATE PROCEDURE

OMBCREATE PROCESS_FLOW

OMBCREATE PROCESS_FLOW_MODULE

OMBCREATE PROCESS_FLOW_PACKAGE

OMBCREATE PROJECT

OMBCREATE PSFT_MODULE

OMBCREATE QUEUE_PROPAGATION

OMBCREATE QUEUE_TABLE

OMBCREATE REAL_TIME_MAPPING

OMBCREATE REGISTERED_FUNCTION

OMBCREATE ROLE

OMBCREATE SAP_MODULE

OMBCREATE SEQUENCE

OMBCREATE SIEBEL_MODULE

OMBCREATE SNAPSHOT

OMBCREATE TABLE

OMBCREATE TABLE_FUNCTION

OMBCREATE TIME_DIMENSION

10 OMBCREATE TRANSPORTABLE_MODULE to OMBDESCRIBE MODEL

OMBCREATE TRANSPORTABLE_MODULE

OMBCREATE UNQUOTED_STRING

OMBCREATE VARYING_ARRAY

OMBCREATE VIEW

OMBCREATE WEB_SERVICE

OMBCREATE WEB_SERVICE_PACKAGE

OMBDAC

OMBDCC

OMBDEBUG MAPPING

OMBDEFINE ASSOCIATION_DEFINITION

OMBDEFINE CLASS_DEFINITION

OMBDEFINE COMPONENT_DEFINITION

OMBDEFINE DOMAIN_DEFINITION

OMBDEFINE FOLDER_DEFINITION

OMBDEINSTALL OWB_REPOSITORY

OMBDEINSTALL WORKSPACE

OMBDEPLOY

OMBDERIVE

OMBDESCRIBE ASSOCIATION_DEFINITION

OMBDESCRIBE CLASS_DEFINITION

OMBDESCRIBE MODEL

11 OMBDISC to OMBDROP CONFIGURATION

OMBDISC

OMBDISC CONTROL_CENTER

OMBDISCONNECT

OMBDISCONNECT CONTROL_CENTER

OMBDISPLAYCURRENTMODE

OMBDROP

OMBDROP ACTIVITY_TEMPLATE

OMBDROP ACTIVITY_TEMPLATE_FOLDER

OMBDROP ADVANCED_QUEUE

OMBDROP ALTERNATIVE_SORT_ORDER

OMBDROP ANALYZE_ACTION_PLAN

OMBDROP APPLICATION_SERVER_MODULE

OMBDROP BUSINESS_AREA

OMBDROP BUSINESS_DEFINITION_MODULE

OMBDROP CALENDAR

OMBDROP CALENDAR_MODULE

OMBDROP CATALOG_FOLDER

OMBDROP CMI_DEFINITION

OMBDROP CMI_MODULE

OMBDROP COLLECTION

OMBDROP CONFIGURATION

12 OMBDROP CONFIGURATION_TEMPLATE to OMBDROP FLAT_FILE_MODULE

OMBDROP CONFIGURATION_TEMPLATE

OMBDROP CONNECTOR

OMBDROP CONTROL_CENTER

OMBDROP CORRECTION_MAPS_ACTION_PLAN

OMBDROP CORRECTION_SCHEMA_ACTION_PLAN

OMBDROP CT

OMBDROP CT_FOLDER

OMBDROP CUBE

OMBDROP DATA_AUDITOR

OMBDROP DATA_PROFILE

OMBDROP DATA_RULE

OMBDROP DEPLOYMENT

OMBDROP DEPLOYMENT_ACTION_PLAN

OMBDROP DIMENSION

OMBDROP DRILL_PATH

OMBDROP DRILL_TO_DETAIL

OMBDROP EXPERT

OMBDROP EXPERT_MODULE

OMBDROP EXTERNAL_TABLE

OMBDROP FLAT_FILE

OMBDROP FLAT_FILE_MODULE

13 OMBDROP FOLDER to OMBDROP PLATFORM

OMBDROP FOLDER

OMBDROP FUNCTION

OMBDROP GATEWAY_MODULE

OMBDROP ICONSET

OMBDROP IMPORT_ACTION_PLAN

OMBDROP ITEM_FOLDER

OMBDROP J2EE_USER

OMBDROP LIST_OF_VALUES

OMBDROP LOCATION

OMBDROP LOGICAL_TABLE

OMBDROP MAPPING

OMBDROP MAPPING_MODULE

OMBDROP MATERIALIZED_VIEW

OMBDROP MDL_ACTION_PLAN

OMBDROP NESTED_TABLE

OMBDROP OBIEE_BUSINESS_DEFINITION_MODULE

OMBDROP OBJECT_TYPE

OMBDROP ORACLE_EBS_MODULE

OMBDROP ORACLE_MODULE

OMBDROP PACKAGE

OMBDROP PLATFORM

14 OMBDROP PLSQL_RECORD_TYPE to OMBDROP TABLE

OMBDROP PLSQL_RECORD_TYPE

OMBDROP PLSQL_REF_CURSOR_TYPE

OMBDROP PLSQL_TABLE_TYPE

OMBDROP PLUGGABLE_MAPPING

OMBDROP PLUGGABLE_MAPPING_FOLDER

OMBDROP PROCEDURE

OMBDROP PROCESS_FLOW

OMBDROP PROCESS_FLOW_MODULE

OMBDROP PROCESS_FLOW_PACKAGE

OMBDROP PROJECT

OMBDROP PSFT_MODULE

OMBDROP QUEUE_PROPAGATION

OMBDROP QUEUE_TABLE

OMBDROP REAL_TIME_MAPPING

OMBDROP REGISTERED_FUNCTION

OMBDROP ROLE

OMBDROP SAP_MODULE

OMBDROP SEQUENCE

OMBDROP SIEBEL_MODULE

OMBDROP SNAPSHOT

OMBDROP TABLE

15 OMBDROP TABLE_FUNCTION to OMBIMPORT CT_FILE

OMBDROP TABLE_FUNCTION

OMBDROP TIME_DIMENSION

OMBDROP TRANSPORTABLE_MODULE

OMBDROP UNQUOTED_STRING

OMBDROP VARYING_ARRAY

OMBDROP VIEW

OMBDROP WEB_SERVICE

OMBDROP WEB_SERVICE_PACKAGE

OMBENV

OMBEXPORT

OMBEXPORT ENTIRE_REPOSITORY

OMBEXPORT MDL_FILE

OMBGRANT DEFAULT_OBJ_PRIV

OMBGRANT J2EE_ROLE

OMBGRANT OBJ_PRIV

OMBGRANT ROLE

OMBGRANT SYS_PRIV

OMBHELP

OMBIMPACT

OMBIMPORT

OMBIMPORT CT_FILE

16 OMBIMPORT ENTIRE_REPOSITORY MDL_FILE to OMBMENU REMOVE EXPERT

OMBIMPORT ENTIRE_REPOSITORY MDL_FILE

OMBIMPORT MDL_FILE

OMBIMPORT METADATA_LOCATION

OMBINSTALL OWB_RAC

OMBINSTALL OWB_REPOSITORY

OMBINSTALL WORKSPACE

OMBLINEAGE

OMBLIST

OMBLIST ALL OBJ_PRIVS

OMBLIST ALL SYS_PRIVS

OMBLIST DEFAULT_OBJ_PRIVS

OMBLIST ICONSETS

OMBLIST OBJ_PRIVS

OMBLIST ROLES

OMBLIST SNAPSHOT

OMBLIST SYS_PRIVS

OMBLIST USERS

OMBLOCK

OMBMENU ADD EXPERT

OMBMENU GET EXPERT

OMBMENU REMOVE EXPERT

17 OMBMLSUPDATE to OMBRETRIEVE CATALOG_FOLDER

OMBMLSUPDATE

OMBMOVE

OMBOPTIMIZE

OMBPROFILE

OMBREDEFINE ASSOCIATION_DEFINITION

OMBREDEFINE CLASS_DEFINITION

OMBREGISTER LOCATION

OMBREGISTER USER

OMBRESTORE SNAPSHOT

OMBRETRIEVE

OMBRETRIEVE ACTIVITY_TEMPLATE

OMBRETRIEVE ACTIVITY_TEMPLATE_FOLDER

OMBRETRIEVE ADVANCED_QUEUE

OMBRETRIEVE ALTERNATIVE_SORT_ORDER

OMBRETRIEVE ANALYZE_ACTION_PLAN

OMBRETRIEVE APPLICATION_SERVER_MODULE

OMBRETRIEVE BUSINESS_AREA

OMBRETRIEVE BUSINESS_DEFINITION_MODULE

OMBRETRIEVE CALENDAR

OMBRETRIEVE CALENDAR_MODULE

OMBRETRIEVE CATALOG_FOLDER

18 OMBRETRIEVE CMI_DEFINITION to OMBRETRIEVE DRILL_TO_DETAIL

OMBRETRIEVE CMI_DEFINITION

OMBRETRIEVE CMI_MODULE

OMBRETRIEVE COLLECTION

OMBRETRIEVE CONFIGURATION

OMBRETRIEVE CONFIGURATION_TEMPLATE

OMBRETRIEVE CONNECTOR

OMBRETRIEVE CONTROL_CENTER

OMBRETRIEVE CORRECTION_MAPS_ACTION_PLAN

OMBRETRIEVE CORRECTION_SCHEMA_ACTION_PLAN

OMBRETRIEVE CT

OMBRETRIEVE CT_FOLDER

OMBRETRIEVE CUBE

OMBRETRIEVE DATA_AUDITOR

OMBRETRIEVE DATA_PROFILE

OMBRETRIEVE DATA_RULE

OMBRETRIEVE DATA_RULE_MODULE

OMBRETRIEVE DEPLOYMENT

OMBRETRIEVE DEPLOYMENT_ACTION_PLAN

OMBRETRIEVE DIMENSION

OMBRETRIEVE DRILL_PATH

OMBRETRIEVE DRILL_TO_DETAIL

19 OMBRETRIEVE EXPERT to OMBRETRIEVE OBIEE_BUSINESS_DEFINITION_MODULE

OMBRETRIEVE EXPERT

OMBRETRIEVE EXPERT_MODULE

OMBRETRIEVE EXTERNAL_TABLE

OMBRETRIEVE FLAT_FILE

OMBRETRIEVE FLAT_FILE_MODULE

OMBRETRIEVE FOLDER

OMBRETRIEVE FUNCTION

OMBRETRIEVE GATEWAY_MODULE

OMBRETRIEVE ICONSET

OMBRETRIEVE IMPORT_ACTION_PLAN

OMBRETRIEVE ITEM_FOLDER

OMBRETRIEVE LIST_OF_VALUES

OMBRETRIEVE LOCATION

OMBRETRIEVE LOGICAL_TABLE

OMBRETRIEVE MAPPING

OMBRETRIEVE MAPPING_MODULE

OMBRETRIEVE MATERIALIZED_VIEW

OMBRETRIEVE MDL_ACTION_PLAN

OMBRETRIEVE MODULE

OMBRETRIEVE NESTED_TABLE

OMBRETRIEVE OBIEE_BUSINESS_DEFINITION_MODULE

20 OMBRETRIEVE OBJECT_TYPE to OMBRETRIEVE REGISTERED_FUNCTION

OMBRETRIEVE OBJECT_TYPE

OMBRETRIEVE ORACLE_EBS_MODULE

OMBRETRIEVE ORACLE_MODULE

OMBRETRIEVE PACKAGE

OMBRETRIEVE PLATFORM

OMBRETRIEVE PLSQL_RECORD_TYPE

OMBRETRIEVE PLSQL_REF_CURSOR_TYPE

OMBRETRIEVE PLSQL_TABLE_TYPE

OMBRETRIEVE PLUGGABLE_MAPPING

OMBRETRIEVE PLUGGABLE_MAPPING_FOLDER

OMBRETRIEVE PROCEDURE

OMBRETRIEVE PROCESS_FLOW

OMBRETRIEVE PROCESS_FLOW_MODULE

OMBRETRIEVE PROCESS_FLOW_PACKAGE

OMBRETRIEVE PROFILE_REFERENCE

OMBRETRIEVE PROJECT

OMBRETRIEVE PSFT_MODULE

OMBRETRIEVE QUEUE_PROPAGATION

OMBRETRIEVE QUEUE_TABLE

OMBRETRIEVE REAL_TIME_MAPPING

OMBRETRIEVE REGISTERED_FUNCTION

21 OMBRETRIEVE ROLE to OMBREVOKE SYS_PRIV

OMBRETRIEVE ROLE

OMBRETRIEVE SAP_MODULE

OMBRETRIEVE SEQUENCE

OMBRETRIEVE SIEBEL_MODULE

OMBRETRIEVE SNAPSHOT

OMBRETRIEVE TABLE

OMBRETRIEVE TABLE_FUNCTION

OMBRETRIEVE TIME_DIMENSION

OMBRETRIEVE TRANSPORTABLE_MODULE

OMBRETRIEVE UNQUOTED_STRING

OMBRETRIEVE USER

OMBRETRIEVE VARYING_ARRAY

OMBRETRIEVE VIEW

OMBRETRIEVE WEB_SERVICE

OMBRETRIEVE WEB_SERVICE_PACKAGE

OMBREVERT

OMBREVOKE DEFAULT_OBJ_PRIV

OMBREVOKE J2EE_ROLE

OMBREVOKE OBJ_PRIV

OMBREVOKE ROLE

OMBREVOKE SYS_PRIV

22 OMBROLLBACK to OMUCOMPILE

OMBROLLBACK

OMBSAVE

OMBSEED

OMBSHOW

OMBSTART

OMBSTATS

OMBSTOP

OMBSWITCHMODE

OMBSYNCHRONIZE

OMBUNDEFINE ASSOCIATION_DEFINITION

OMBUNDEFINE CLASS_DEFINITION

OMBUNLOCK

OMBUNREGISTER CONTROL_CENTER

OMBUNREGISTER LOCATION

OMBUNREGISTER USER

OMBUPGRADEREPOS

OMBUPGRADEREPOSITORY

OMBVALIDATE

OMBWORKSPACEMODE ZDT

OMUALTER

OMUCOMPILE

23 OMUCONFIGURE to OMUSTART EXPERT

OMUCONFIGURE

OMUCONNECT

OMUCONTROLCENTERJOBS

OMUCREATE

OMUDATAVIEWER

OMUDEPLOY

OMUDERIVE

OMUEXPORT MDL_FILE

OMUIMPACT

OMUIMPORT

OMUIMPORT MDL_FILE

OMULINEAGE

OMULIST

OMUNAVIGATE

OMUPROMPT

OMUPROPERTIES

OMUSELECTSOURCE

OMUSELECTTARGET

OMUSHOWCHANGECONSOLE

OMUSTART

OMUSTART EXPERT

24 OMUSTARTJOB to OMUVALIDATE

OMUSTARTJOB

OMUVALIDATE

List of Tables

1-1 PARAMETER Object

1-2 ADVANCED_QUEUE Object

1-3 ALTERNATIVE_SORT_ORDER Object

1-4 BUSINESS_AREA Object

1-5 BUSINESS_DEFINITION_MODULE Object

1-6 CALENDAR Object

1-7 CALENDAR_MODULE Object

1-8 CATALOG_FOLDER Object

1-9 CMI_DEFINITION Object

1-10 CONNECTOR Object

1-11 CONTROL_CENTER Object

2-1 CT Object

2-2 CUBE Object

2-3 DATA_AUDITOR Object

2-4 OPERATOR Object

2-5 DATA_PROFILE Object

2-6 DATA_RULE Object

2-7 DIMENSION Object

2-8 DRILL_PATH Object

2-9 DRILL_TO_DETAIL Object

2-10 EXPERT Object

2-11 EXTERNAL_TABLE Object

2-12 EXTERNAL_TABLE_COLUMN Object

2-13 DATA_FILE Object

2-14 FUNCTION Object

2-15 GATEWAY_MODULE Object

2-16 ICONSET Object

3-1 ITEM_FOLDER Object

3-2 LIST_OF_VALUES Object

3-3 LOCATION Object

3-4 LOGICAL_TABLE Object

3-5 MAPPING Object

3-6 OPERATOR Object

3-7 GROUP Object

3-8 ATTRIBUTE Object

3-9 AGGREGATOR_OPERATOR Object

3-10 ANYDATA_CAST_OPERATOR Object

3-11 CONSTANT_OPERATOR Object

3-12 CONSTRUCT_OBJECT_OPERATOR Object

3-13 CUBE_OPERATOR Object

3-14 DATA_GENERATOR_OPERATOR Object

3-15 DEDUPLICATOR_OPERATOR Object

3-16 DIMENSION_OPERATOR Object

3-17 EXPAND_OBJECT_OPERATOR Object

3-18 EXPRESSION_OPERATOR Object

3-19 EXTERNAL_TABLE_OPERATOR Object

3-20 FILTER_OPERATOR Object

3-21 SUBQUERY_FILTER_OPERATOR Object

3-22 FLAT_FILE_OPERATOR Object

3-23 INPUT_PARAMETER_OPERATOR Object

3-24 INPUT_SIGNATURE_OPERATOR Object

3-25 ITERATOR_OPERATOR Object

3-26 JOINER_OPERATOR Object

3-27 LOOKUP_OPERATOR Object

3-28 LCRCAST_OPERATOR Object

3-29 LCRSPLITTER_OPERATOR Object

3-30 MATCHMERGE_OPERATOR Object

3-31 MATERIALIZED_VIEW_OPERATOR Object

3-32 NAME_AND_ADDRESS_OPERATOR Object

3-33 OUTPUT_PARAMETER_OPERATOR Object

3-34 OUTPUT_SIGNATURE_OPERATOR Object

3-35 PIVOT_OPERATOR Object

3-36 PLUGGABLE_MAPPING_OPERATOR Object

3-37 POSTMAPPING_PROCESS_OPERATOR Object

3-38 PREMAPPING_PROCESS_OPERATOR Object

3-39 QUEUE_OPERATOR Object

3-40 SEQUENCE_OPERATOR Object

3-41 SET_OPERATION_OPERATOR Object

3-42 SORTER_OPERATOR Object

3-43 SPLITTER_OPERATOR Object

3-44 TABLE_FUNCTION_OPERATOR Object

3-45 TABLE_OPERATOR Object

3-46 TRANSFORMATION_OPERATOR Object

3-47 UNPIVOT_OPERATOR Object

3-48 VIEW_OPERATOR Object

3-49 MAPPING_MODULE Object

3-50 MATERIALIZED_VIEW Object

3-51 COLUMN Object

3-52 UNIQUE_KEY Object

3-53 FOREIGN_KEY Object

3-54 CHECK_CONSTRAINT Object

3-55 INDEX Object

3-56 PARTITION Object

3-57 NESTED_TABLE Object

3-58 OBIEE_BUSINESS_DEFINITION_MODULE Object

3-59 OBJECT_TYPE Object

3-60 OBJECT_TYPE_ATTRIBUTE Object

3-61 ORACLE_MODULE Object

3-62 PACKAGE Object

3-63 PLSQL_RECORD_TYPE Object

3-64 ATTRIBUTE Object

3-65 PLSQL_REF_CURSOR_TYPE Object

3-66 ATTRIBUTE Object

3-67 PLSQL_TABLE_TYPE Object

3-68 ATTRIBUTE Object

3-69 PLUGGABLE_MAPPING Object

3-70 OPERATOR Object

3-71 GROUP Object

3-72 ATTRIBUTE Object

3-73 AGGREGATOR_OPERATOR Object

3-74 ANYDATA_CAST_OPERATOR Object

3-75 CONSTANT_OPERATOR Object

3-76 CONSTRUCT_OBJECT_OPERATOR Object

3-77 CUBE_OPERATOR Object

3-78 DATA_GENERATOR_OPERATOR Object

3-79 DEDUPLICATOR_OPERATOR Object

3-80 DIMENSION_OPERATOR Object

3-81 EXPAND_OBJECT_OPERATOR Object

3-82 EXPRESSION_OPERATOR Object

3-83 EXTERNAL_TABLE_OPERATOR Object

3-84 FILTER_OPERATOR Object

3-85 SUBQUERY_FILTER_OPERATOR Object

3-86 FLAT_FILE_OPERATOR Object

3-87 INPUT_PARAMETER_OPERATOR Object

3-88 INPUT_SIGNATURE_OPERATOR Object

3-89 ITERATOR_OPERATOR Object

3-90 JOINER_OPERATOR Object

3-91 LOOKUP_OPERATOR Object

3-92 LCRCAST_OPERATOR Object

3-93 LCRSPLITTER_OPERATOR Object

3-94 MATCHMERGE_OPERATOR Object

3-95 MATERIALIZED_VIEW_OPERATOR Object

3-96 NAME_AND_ADDRESS_OPERATOR Object

3-97 OUTPUT_PARAMETER_OPERATOR Object

3-98 OUTPUT_SIGNATURE_OPERATOR Object

3-99 PIVOT_OPERATOR Object

3-100 PLUGGABLE_MAPPING_OPERATOR Object

3-101 POSTMAPPING_PROCESS_OPERATOR Object

3-102 PREMAPPING_PROCESS_OPERATOR Object

3-103 QUEUE_OPERATOR Object

3-104 SEQUENCE_OPERATOR Object

3-105 SET_OPERATION_OPERATOR Object

3-106 SORTER_OPERATOR Object

3-107 SPLITTER_OPERATOR Object

3-108 TABLE_FUNCTION_OPERATOR Object

3-109 TABLE_OPERATOR Object

3-110 TRANSFORMATION_OPERATOR Object

3-111 UNPIVOT_OPERATOR Object

3-112 VIEW_OPERATOR Object

4-1 PROCEDURE Object

4-2 PROCESS_FLOW Object

4-3 PROCESS_FLOW_MODULE Object

4-4 PROCESS_FLOW_PACKAGE Object

4-5 PROFILE_REFERENCE Object

4-6 QUEUE_PROPAGATION Object

4-7 QUEUE_TABLE Object

4-8 MAPPING Object

4-9 OPERATOR Object

4-10 GROUP Object

4-11 ATTRIBUTE Object

4-12 AGGREGATOR_OPERATOR Object

4-13 ANYDATA_CAST_OPERATOR Object

4-14 CONSTANT_OPERATOR Object

4-15 CONSTRUCT_OBJECT_OPERATOR Object

4-16 CUBE_OPERATOR Object

4-17 DATA_GENERATOR_OPERATOR Object

4-18 DEDUPLICATOR_OPERATOR Object

4-19 DIMENSION_OPERATOR Object

4-20 EXPAND_OBJECT_OPERATOR Object

4-21 EXPRESSION_OPERATOR Object

4-22 EXTERNAL_TABLE_OPERATOR Object

4-23 FILTER_OPERATOR Object

4-24 SUBQUERY_FILTER_OPERATOR Object

4-25 FLAT_FILE_OPERATOR Object

4-26 INPUT_PARAMETER_OPERATOR Object

4-27 INPUT_SIGNATURE_OPERATOR Object

4-28 ITERATOR_OPERATOR Object

4-29 JOINER_OPERATOR Object

4-30 LOOKUP_OPERATOR Object

4-31 LCRCAST_OPERATOR Object

4-32 LCRSPLITTER_OPERATOR Object

4-33 MATCHMERGE_OPERATOR Object

4-34 MATERIALIZED_VIEW_OPERATOR Object

4-35 NAME_AND_ADDRESS_OPERATOR Object

4-36 OUTPUT_PARAMETER_OPERATOR Object

4-37 OUTPUT_SIGNATURE_OPERATOR Object

4-38 PIVOT_OPERATOR Object

4-39 PLUGGABLE_MAPPING_OPERATOR Object

4-40 POSTMAPPING_PROCESS_OPERATOR Object

4-41 PREMAPPING_PROCESS_OPERATOR Object

4-42 QUEUE_OPERATOR Object

4-43 SEQUENCE_OPERATOR Object

4-44 SET_OPERATION_OPERATOR Object

4-45 SORTER_OPERATOR Object

4-46 SPLITTER_OPERATOR Object

4-47 TABLE_FUNCTION_OPERATOR Object

4-48 TABLE_OPERATOR Object

4-49 TRANSFORMATION_OPERATOR Object

4-50 UNPIVOT_OPERATOR Object

4-51 VIEW_OPERATOR Object

4-52 REGISTERED_FUNCTION Object

4-53 SEQUENCE Object

4-54 TABLE Object

4-55 COLUMN Object

4-56 PRIMARY_KEY Object

4-57 UNIQUE_KEY Object

4-58 FOREIGN_KEY Object

4-59 CHECK_CONSTRAINT Object

4-60 PARTITION Object

4-61 INDEX Object

4-62 TABLE_FUNCTION Object

4-63 DIMENSION Object

4-64 HIERARCHY Object

4-65 TRANSPORTABLE_MODULE Object

4-66 TRANSPORTABLE_MODULE_TABLESPACE Object

4-67 TRANSPORTABLE_MODULE_DATAFILE Object

5-1 VARYING_ARRAY Object

5-2 VIEW Object

5-3 COLUMN Object

5-4 UNIQUE_KEY Object

5-5 FOREIGN_KEY Object

5-6 WEB_SERVICE Object

5-7 WEB_SERVICE_PACKAGE Object

5-8 PARAMETER Object

5-9 ADVANCED_QUEUE Object

6-1 ALTERNATIVE_SORT_ORDER Object

6-2 BUSINESS_AREA Object

6-3 BUSINESS_DEFINITION_MODULE Object

6-4 CALENDAR Object

6-5 CALENDAR_MODULE Object

6-6 CATALOG_FOLDER Object

6-7 CDC_CT Object

6-8 CMI_MODULE Object

6-9 CONNECTOR Object

6-10 CONTROL_CENTER Object

6-11 CONTROL_CT Object

6-12 CUBE Object

7-1 DATA_AUDITOR Object

7-2 OPERATOR Object

7-3 DIMENSION Object

7-4 DRILL_PATH Object

7-5 DRILL_TO_DETAIL Object

7-6 EXPERT Object

7-7 EXTERNAL_TABLE Object

7-8 EXTERNAL_TABLE_COLUMN Object

7-9 DATA_FILE Object

7-10 FUNCTION Object

7-11 FUNCTION_CT Object

7-12 GATEWAY_MODULE Object

7-13 ICONSET Object

7-14 INTEGRATION_CT Object

8-1 ITEM_FOLDER Object

8-2 LIST_OF_VALUES Object

8-3 LOAD_CT Object

8-4 LOCATION Object

8-5 LOGICAL_TABLE Object

8-6 MAPPING Object

8-7 OPERATOR Object

8-8 GROUP Object

8-9 ATTRIBUTE Object

8-10 AGGREGATOR_OPERATOR Object

8-11 ANYDATA_CAST_OPERATOR Object

8-12 CONSTANT_OPERATOR Object

8-13 CONSTRUCT_OBJECT_OPERATOR Object

8-14 CUBE_OPERATOR Object

8-15 DATA_GENERATOR_OPERATOR Object

8-16 DEDUPLICATOR_OPERATOR Object

8-17 DIMENSION_OPERATOR Object

8-18 EXPAND_OBJECT_OPERATOR Object

8-19 EXPRESSION_OPERATOR Object

8-20 EXTERNAL_TABLE_OPERATOR Object

8-21 FILTER_OPERATOR Object

8-22 SUBQUERY_FILTER_OPERATOR Object

8-23 FLAT_FILE_OPERATOR Object

8-24 INPUT_PARAMETER_OPERATOR Object

8-25 INPUT_SIGNATURE_OPERATOR Object

8-26 ITERATOR_OPERATOR Object

8-27 JOINER_OPERATOR Object

8-28 LOOKUP_OPERATOR Object

8-29 LCRCAST_OPERATOR Object

8-30 LCRSPLITTER_OPERATOR Object

8-31 MATCHMERGE_OPERATOR Object

8-32 MATERIALIZED_VIEW_OPERATOR Object

8-33 NAME_AND_ADDRESS_OPERATOR Object

8-34 OUTPUT_PARAMETER_OPERATOR Object

8-35 OUTPUT_SIGNATURE_OPERATOR Object

8-36 PIVOT_OPERATOR Object

8-37 PLUGGABLE_MAPPING_OPERATOR Object

8-38 POSTMAPPING_PROCESS_OPERATOR Object

8-39 PREMAPPING_PROCESS_OPERATOR Object

8-40 QUEUE_OPERATOR Object

8-41 SEQUENCE_OPERATOR Object

8-42 SET_OPERATION_OPERATOR Object

8-43 SORTER_OPERATOR Object

8-44 SPLITTER_OPERATOR Object

8-45 TABLE_FUNCTION_OPERATOR Object

8-46 TABLE_OPERATOR Object

8-47 TRANSFORMATION_OPERATOR Object

8-48 UNPIVOT_OPERATOR Object

8-49 VIEW_OPERATOR Object

8-50 MAPPING_MODULE Object

8-51 MATERIALIZED_VIEW Object

8-52 COLUMN Object

8-53 UNIQUE_KEY Object

8-54 FOREIGN_KEY Object

8-55 CHECK_CONSTRAINT Object

8-56 INDEX Object

8-57 PARTITION Object

8-58 NESTED_TABLE Object

8-59 OBIEE_BUSINESS_DEFINITION_MODULE Object

8-60 OBJECT_TYPE Object

8-61 OBJECT_TYPE_ATTRIBUTE Object

8-62 ORACLE_MODULE Object

8-63 ORACLE_TARGET_CT Object

8-64 PACKAGE Object

8-65 PLSQL_RECORD_TYPE Object

8-66 ATTRIBUTE Object

8-67 PLSQL_REF_CURSOR_TYPE Object

8-68 PLSQL_REF_CURSOR_TYPE Object

9-1 PLSQL_TABLE_TYPE Object

9-2 PLSQL_TABLE_TYPE Object

9-3 PLUGGABLE_MAPPING Object

9-4 OPERATOR Object

9-5 GROUP Object

9-6 ATTRIBUTE Object

9-7 AGGREGATOR_OPERATOR Object

9-8 ANYDATA_CAST_OPERATOR Object

9-9 CONSTANT_OPERATOR Object

9-10 CONSTRUCT_OBJECT_OPERATOR Object

9-11 CUBE_OPERATOR Object

9-12 DATA_GENERATOR_OPERATOR Object

9-13 DEDUPLICATOR_OPERATOR Object

9-14 DIMENSION_OPERATOR Object

9-15 EXPAND_OBJECT_OPERATOR Object

9-16 EXPRESSION_OPERATOR Object

9-17 EXTERNAL_TABLE_OPERATOR Object

9-18 FILTER_OPERATOR Object

9-19 SUBQUERY_FILTER_OPERATOR Object

9-20 FLAT_FILE_OPERATOR Object

9-21 INPUT_PARAMETER_OPERATOR Object

9-22 INPUT_SIGNATURE_OPERATOR Object

9-23 ITERATOR_OPERATOR Object

9-24 JOINER_OPERATOR Object

9-25 LOOKUP_OPERATOR Object

9-26 LCRCAST_OPERATOR Object

9-27 LCRSPLITTER_OPERATOR Object

9-28 MATCHMERGE_OPERATOR Object

9-29 MATERIALIZED_VIEW_OPERATOR Object

9-30 NAME_AND_ADDRESS_OPERATOR Object

9-31 OUTPUT_PARAMETER_OPERATOR Object

9-32 OUTPUT_SIGNATURE_OPERATOR Object

9-33 PIVOT_OPERATOR Object

9-34 PLUGGABLE_MAPPING_OPERATOR Object

9-35 POSTMAPPING_PROCESS_OPERATOR Object

9-36 PREMAPPING_PROCESS_OPERATOR Object

9-37 QUEUE_OPERATOR Object

9-38 SEQUENCE_OPERATOR Object

9-39 SET_OPERATION_OPERATOR Object

9-40 SORTER_OPERATOR Object

9-41 SPLITTER_OPERATOR Object

9-42 TABLE_FUNCTION_OPERATOR Object

9-43 TABLE_OPERATOR Object

9-44 TRANSFORMATION_OPERATOR Object

9-45 UNPIVOT_OPERATOR Object

9-46 VIEW_OPERATOR Object

9-47 PROCEDURE Object

9-48 PROCESS_FLOW Object

9-49 PROCESS_FLOW_MODULE Object

9-50 PROCESS_FLOW_PACKAGE Object

9-51 QUEUE_PROPAGATION Object

9-52 QUEUE_TABLE Object

9-53 MAPPING Object

9-54 OPERATOR Object

9-55 GROUP Object

9-56 ATTRIBUTE Object

9-57 AGGREGATOR_OPERATOR Object

9-58 ANYDATA_CAST_OPERATOR Object

9-59 CONSTANT_OPERATOR Object

9-60 CONSTRUCT_OBJECT_OPERATOR Object

9-61 CUBE_OPERATOR Object

9-62 DATA_GENERATOR_OPERATOR Object

9-63 DEDUPLICATOR_OPERATOR Object

9-64 DIMENSION_OPERATOR Object

9-65 EXPAND_OBJECT_OPERATOR Object

9-66 EXPRESSION_OPERATOR Object

9-67 EXTERNAL_TABLE_OPERATOR Object

9-68 FILTER_OPERATOR Object

9-69 SUBQUERY_FILTER_OPERATOR Object

9-70 FLAT_FILE_OPERATOR Object

9-71 INPUT_PARAMETER_OPERATOR Object

9-72 INPUT_SIGNATURE_OPERATOR Object

9-73 ITERATOR_OPERATOR Object

9-74 JOINER_OPERATOR Object

9-75 LOOKUP_OPERATOR Object

9-76 LCRCAST_OPERATOR Object

9-77 LCRSPLITTER_OPERATOR Object

9-78 MATCHMERGE_OPERATOR Object

9-79 MATERIALIZED_VIEW_OPERATOR Object

9-80 NAME_AND_ADDRESS_OPERATOR Object

9-81 OUTPUT_PARAMETER_OPERATOR Object

9-82 OUTPUT_SIGNATURE_OPERATOR Object

9-83 PIVOT_OPERATOR Object

9-84 PLUGGABLE_MAPPING_OPERATOR Object

9-85 POSTMAPPING_PROCESS_OPERATOR Object

9-86 PREMAPPING_PROCESS_OPERATOR Object

9-87 QUEUE_OPERATOR Object

9-88 SEQUENCE_OPERATOR Object

9-89 SET_OPERATION_OPERATOR Object

9-90 SORTER_OPERATOR Object

9-91 SPLITTER_OPERATOR Object

9-92 TABLE_FUNCTION_OPERATOR Object

9-93 TABLE_OPERATOR Object

9-94 TRANSFORMATION_OPERATOR Object

9-95 UNPIVOT_OPERATOR Object

9-96 VIEW_OPERATOR Object

9-97 REGISTERED_FUNCTION Object

9-98 SEQUENCE Object

9-99 TABLE Object

9-100 COLUMN Object

9-101 PRIMARY_KEY Object

9-102 UNIQUE_KEY Object

9-103 FOREIGN_KEY Object

9-104 CHECK_CONSTRAINT Object

9-105 PARTITION Object

9-106 INDEX Object

9-107 TABLE_FUNCTION Object

9-108 DIMENSION Object

9-109 HIERARCHY Object

10-1 TRANSPORTABLE_MODULE Object

10-2 VARYING_ARRAY Object

10-3 VIEW Object

10-4 COLUMN Object

10-5 UNIQUE_KEY Object

10-6 FOREIGN_KEY Object

10-7 WEB_SERVICE Object

10-8 WEB_SERVICE_PACKAGE Object

17-1 PARAMETER Object

17-2 ADVANCED_QUEUE Object

17-3 ALTERNATIVE_SORT_ORDER Object

17-4 BUSINESS_AREA Object

17-5 BUSINESS_DEFINITION_MODULE Object

17-6 CATALOG_FOLDER Object

18-1 CMI_DEFINITION Object

18-2 CMI_MODULE Object

18-3 CONNECTOR Object

18-4 CONTROL_CENTER Object

18-5 EXPERT Object

18-6 CUBE Object

18-7 DATA_AUDITOR Object

18-8 OPERATOR Object

18-9 DATA_PROFILE Object

18-10 DATA_RULE Object

18-11 DIMENSION Object

18-12 DRILL_PATH Object

18-13 DRILL_TO_DETAIL Object

19-1 EXPERT Object

19-2 EXTERNAL_TABLE Object

19-3 FUNCTION Object

19-4 ITEM_FOLDER Object

19-5 LIST_OF_VALUES Object

19-6 LOCATION Object

19-7 LOGICAL_TABLE Object

19-8 MAPPING Object

19-9 OPERATOR Object

19-10 GROUP Object

19-11 ATTRIBUTE Object

19-12 AGGREGATOR_OPERATOR Object

19-13 ANYDATA_CAST_OPERATOR Object

19-14 CONSTANT_OPERATOR Object

19-15 CONSTRUCT_OBJECT_OPERATOR Object

19-16 CUBE_OPERATOR Object

19-17 DATA_GENERATOR_OPERATOR Object

19-18 DEDUPLICATOR_OPERATOR Object

19-19 DIMENSION_OPERATOR Object

19-20 EXPAND_OBJECT_OPERATOR Object

19-21 EXPRESSION_OPERATOR Object

19-22 EXTERNAL_TABLE_OPERATOR Object

19-23 FILTER_OPERATOR Object

19-24 SUBQUERY_FILTER_OPERATOR Object

19-25 FLAT_FILE_OPERATOR Object

19-26 INPUT_PARAMETER_OPERATOR Object

19-27 INPUT_SIGNATURE_OPERATOR Object

19-28 ITERATOR_OPERATOR Object

19-29 JOINER_OPERATOR Object

19-30 LOOKUP_OPERATOR Object

19-31 LCRCAST_OPERATOR Object

19-32 LCRSPLITTER_OPERATOR Object

19-33 MATCHMERGE_OPERATOR Object

19-34 MATERIALIZED_VIEW_OPERATOR Object

19-35 NAME_AND_ADDRESS_OPERATOR Object

19-36 OUTPUT_PARAMETER_OPERATOR Object

19-37 OUTPUT_SIGNATURE_OPERATOR Object

19-38 PIVOT_OPERATOR Object

19-39 PLUGGABLE_MAPPING_OPERATOR Object

19-40 POSTMAPPING_PROCESS_OPERATOR Object

19-41 PREMAPPING_PROCESS_OPERATOR Object

19-42 QUEUE_OPERATOR Object

19-43 SEQUENCE_OPERATOR Object

19-44 SET_OPERATION_OPERATOR Object

19-45 SORTER_OPERATOR Object

19-46 SPLITTER_OPERATOR Object

19-47 TABLE_FUNCTION_OPERATOR Object

19-48 TABLE_OPERATOR Object

19-49 TRANSFORMATION_OPERATOR Object

19-50 UNPIVOT_OPERATOR Object

19-51 VIEW_OPERATOR Object

19-52 MAPPING_MODULE Object

19-53 MATERIALIZED_VIEW Object

19-54 COLUMN Object

19-55 UNIQUE_KEY Object

19-56 FOREIGN_KEY Object

19-57 INDEX Object

19-58 PARTITION Object

19-59 MODULE Object

19-60 NESTED_TABLE Object

19-61 OBIEE_BUSINESS_DEFINITION_MODULE Object

20-1 OBJECT_TYPE Object

20-2 OBJECT_TYPE_ATTRIBUTE Object

20-3 ORACLE_MODULE Object

20-4 PACKAGE Object

20-5 PLSQL_RECORD_TYPE Object

20-6 ATTRIBUTE Object

20-7 PLSQL_REF_CURSOR_TYPE Object

20-8 ATTRIBUTE Object

20-9 PLSQL_TABLE_TYPE Object

20-10 ATTRIBUTE Object

20-11 PLUGGABLE_MAPPING Object

20-12 OPERATOR Object

20-13 GROUP Object

20-14 ATTRIBUTE Object

20-15 AGGREGATOR_OPERATOR Object

20-16 ANYDATA_CAST_OPERATOR Object

20-17 CONSTANT_OPERATOR Object

20-18 CONSTRUCT_OBJECT_OPERATOR Object

20-19 CUBE_OPERATOR Object

20-20 DATA_GENERATOR_OPERATOR Object

20-21 DEDUPLICATOR_OPERATOR Object

20-22 DIMENSION_OPERATOR Object

20-23 EXPAND_OBJECT_OPERATOR Object

20-24 EXPRESSION_OPERATOR Object

20-25 EXTERNAL_TABLE_OPERATOR Object

20-26 FILTER_OPERATOR Object

20-27 SUBQUERY_FILTER_OPERATOR Object

20-28 FLAT_FILE_OPERATOR Object

20-29 INPUT_PARAMETER_OPERATOR Object

20-30 INPUT_SIGNATURE_OPERATOR Object

20-31 ITERATOR_OPERATOR Object

20-32 JOINER_OPERATOR Object

20-33 LOOKUP_OPERATOR Object

20-34 LCRCAST_OPERATOR Object

20-35 LCRSPLITTER_OPERATOR Object

20-36 MATCHMERGE_OPERATOR Object

20-37 MATERIALIZED_VIEW_OPERATOR Object

20-38 NAME_AND_ADDRESS_OPERATOR Object

20-39 OUTPUT_PARAMETER_OPERATOR Object

20-40 OUTPUT_SIGNATURE_OPERATOR Object

20-41 PIVOT_OPERATOR Object

20-42 PLUGGABLE_MAPPING_OPERATOR Object

20-43 POSTMAPPING_PROCESS_OPERATOR Object

20-44 PREMAPPING_PROCESS_OPERATOR Object

20-45 QUEUE_OPERATOR Object

20-46 SEQUENCE_OPERATOR Object

20-47 SET_OPERATION_OPERATOR Object

20-48 SORTER_OPERATOR Object

20-49 SPLITTER_OPERATOR Object

20-50 TABLE_FUNCTION_OPERATOR Object

20-51 TABLE_OPERATOR Object

20-52 TRANSFORMATION_OPERATOR Object

20-53 UNPIVOT_OPERATOR Object

20-54 VIEW_OPERATOR Object

20-55 PROCEDURE Object

20-56 PROCESS_FLOW_MODULE Object

20-57 PROFILE_REFERENCE Object

20-58 QUEUE_PROPAGATION Object

20-59 QUEUE_TABLE Object

20-60 MAPPING Object

20-61 OPERATOR Object

20-62 GROUP Object

20-63 ATTRIBUTE Object

20-64 AGGREGATOR_OPERATOR Object

20-65 ANYDATA_CAST_OPERATOR Object

20-66 CONSTANT_OPERATOR Object

20-67 CONSTRUCT_OBJECT_OPERATOR Object

20-68 CUBE_OPERATOR Object

20-69 DATA_GENERATOR_OPERATOR Object

20-70 DEDUPLICATOR_OPERATOR Object

20-71 DIMENSION_OPERATOR Object

20-72 EXPAND_OBJECT_OPERATOR Object

20-73 EXPRESSION_OPERATOR Object

20-74 EXTERNAL_TABLE_OPERATOR Object

20-75 FILTER_OPERATOR Object

20-76 SUBQUERY_FILTER_OPERATOR Object

20-77 FLAT_FILE_OPERATOR Object

20-78 INPUT_PARAMETER_OPERATOR Object

20-79 INPUT_SIGNATURE_OPERATOR Object

20-80 ITERATOR_OPERATOR Object

20-81 JOINER_OPERATOR Object

20-82 LOOKUP_OPERATOR Object

20-83 LCRCAST_OPERATOR Object

20-84 LCRSPLITTER_OPERATOR Object

20-85 MATCHMERGE_OPERATOR Object

20-86 MATERIALIZED_VIEW_OPERATOR Object

20-87 NAME_AND_ADDRESS_OPERATOR Object

20-88 OUTPUT_PARAMETER_OPERATOR Object

20-89 OUTPUT_SIGNATURE_OPERATOR Object

20-90 PIVOT_OPERATOR Object

20-91 PLUGGABLE_MAPPING_OPERATOR Object

20-92 POSTMAPPING_PROCESS_OPERATOR Object

20-93 PREMAPPING_PROCESS_OPERATOR Object

20-94 QUEUE_OPERATOR Object

20-95 SEQUENCE_OPERATOR Object

20-96 SET_OPERATION_OPERATOR Object

20-97 SORTER_OPERATOR Object

20-98 SPLITTER_OPERATOR Object

20-99 TABLE_FUNCTION_OPERATOR Object

20-100 TABLE_OPERATOR Object

20-101 TRANSFORMATION_OPERATOR Object

20-102 UNPIVOT_OPERATOR Object

20-103 VIEW_OPERATOR Object

20-104 REGISTERED_FUNCTION Object

21-1 SEQUENCE Object

21-2 TABLE Object

21-3 COLUMN Object

21-4 PRIMARY_KEY Object

21-5 UNIQUE_KEY Object

21-6 FOREIGN_KEY Object

21-7 CHECK_CONSTRAINT Object

21-8 INDEX Object

21-9 PARTITION Object

21-10 TABLE_FUNCTION Object

21-11 DIMENSION Object

21-12 HIERARCHY Object

21-13 VARYING_ARRAY Object

21-14 VIEW Object

21-15 COLUMN Object

21-16 UNIQUE_KEY Object

21-17 FOREIGN_KEY Object

21-18 WEB_SERVICE Object

21-19 WEB_SERVICE_PACKAGE Object

Oracle® Warehouse Builder

OMB*Plus Command Reference

11g Release 2 (11.2)

E14406-01

August 2009

Oracle Warehouse Builder OMB*Plus Command Reference, 11g Release 2 (11.2)

E14406-01

Copyright © 2009, Oracle and/or its affiliates. All rights reserved.

Primary Author: Colin McGregor

Contributing Author: Vishwanath Sreeraman

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Preface

Welcome to Oracle Warehouse Builder OMB*Plus Command Reference. This document describes how to use the OMB*Plus command scripting language.

Audience

This document is intended for Oracle Warehouse Builder application developers.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at

http://www.oracle.com/accessibility/

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Deaf/Hard of Hearing Access to Oracle Support Services

To reach Oracle Support Services, use a telecommunications relay service (TRS) to call Oracle Support at 1.800.223.1711. An Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process. Information about TRS is available at http://www.fcc.gov/cgb/consumerfacts/trs.html, and a list of phone numbers is available at http://www.fcc.gov/cgb/dro/trsphonebk.html.

Related Documents

For more information, see the following documents in the Oracle Other Product One Release 7.0 documentation set or in the Oracle Other Product Two Release 6.1 documentation set:

Oracle Database Sample Schemas describes the sample schemas provided in a basic installation of Oracle Database. Many of the examples in the Oracle Database Documentation Library use these schemas.

Oracle Other Product One Configuration Guide

Conventions

The following text conventions are used in this document:

Convention | Meaning
boldface | Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.
italic | Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.
monospace | Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

1 OMBALTER to OMBALTER CORRECTION_SCHEMA_ACTION_PLAN

OMBALTER

OMBALTER ACTIVITY_TEMPLATE

OMBALTER ACTIVITY_TEMPLATE_FOLDER

OMBALTER ADVANCED_QUEUE

OMBALTER ALTERNATIVE_SORT_ORDER

OMBALTER ANALYZE_ACTION_PLAN

OMBALTER APPLICATION_SERVER_MODULE

OMBALTER BUSINESS_AREA

OMBALTER BUSINESS_DEFINITION_MODULE

OMBALTER CALENDAR

OMBALTER CALENDAR_MODULE

OMBALTER CATALOG_FOLDER

OMBALTER CMI_DEFINITION

OMBALTER CMI_MODULE

OMBALTER COLLECTION

OMBALTER CONFIGURATION

OMBALTER CONFIGURATION_TEMPLATE

OMBALTER CONNECTOR

OMBALTER CONTROL_CENTER

OMBALTER CORRECTION_MAPS_ACTION_PLAN

OMBALTER CORRECTION_SCHEMA_ACTION_PLAN

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

OMBALTER ACTIVITY_TEMPLATE

Purpose

To alter activity template folder.

Prerequisites

Should be in the context of an Activity Template Folder.

Syntax

parseAlterTemplate =  "QUOTED_STRING" ( ( "renameClause" [
          "alterTemplatePropertiesOrIconSetClause" ] [ "modifyParametersClause"
          ] ) | ( "alterTemplatePropertiesOrIconSetClause" [
          "modifyParametersClause" ] ) | "modifyParametersClause" )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterTemplatePropertiesOrIconSetClause =  ( ( SET "setPropertiesClause" ) |
           "setReferenceIconSetClause" | "unsetReferenceIconSetClause" )+
     modifyParametersClause =  ( "addParameterClause" | "modifyParameterClause"
          | "deleteParameterClause" )+
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  SET ( REFERENCE | REF ) ICONSET
          "QUOTED_STRING"
     unsetReferenceIconSetClause =  UNSET ( REFERENCE | REF ) ICONSET
     addParameterClause =  ( ADD PARAMETER "QUOTED_STRING" ) [ SET
          "setPropertiesClause" ]
     modifyParameterClause =  MODIFY PARAMETER "QUOTED_STRING" ( (
          "renameClause" [ SET "setPropertiesClause" ] ) | ( SET
          "setPropertiesClause" ) )
     deleteParameterClause =  DELETE PARAMETER "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseAlterTemplate

Alter the specified activity template.

renameClause

Rename the specified object.

alterTemplatePropertiesOrIconSetClause

Alter existing activity template properties and/or Icon Set.

modifyParametersClause

Modify the parameters of this activity template.

setPropertiesClause

This clause sets properties for the corresponding object.

getTemplatePropertiesClause

Basic properties for ACTIVITY_TEMPLATE:

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

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

getParameterPropertiesClause

Description of the Activity Template Core properties for Activity Parameter:

Name: DATATYPE
Type: STRING
Valid Values: INTEGER, FLOAT, DATE, STRING, BOOLEAN
Default: STRING
Sets the datatype of a Parameter

Name: DIRECTION
Type: STRING
Valid Values: IN
Default: IN
Sets the direction of a Parameter

Name: DEFAULT_VALUE
Type: STRING
Valid Values: Examples '123', '123.456', 'Jan-08-2003', 'I am String', 'true'
Default: Empty string
Sets the default value of a Parameter

setReferenceIconSetClause

Set icon set for the activity template.

unsetReferenceIconSetClause

Unset icon set for the activity template.

addParameterClause

Add a parameter to this activity template.

modifyParameterClause

Modify the definition of a parameter.

deleteParameterClause

Delete a parameter.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

propertyKey

A property key for an object.

propertyValue

Value of a property.

PARAMETER Object

Table 1-1 PARAMETER Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBALTER

OMBCREATE ACTIVITY_TEMPLATE

OMBDROP ACTIVITY_TEMPLATE

OMBALTER ACTIVITY_TEMPLATE_FOLDER

Purpose

To alter activity template folder.

Prerequisites

Should be in the context of a Project.

Syntax

parseAlterTemplateFolder =  "QUOTED_STRING" ( ( RENAME TO "QUOTED_STRING" [
           "alterTemplateFolderPropertiesOrIconSetClause" ] ) |
          "alterTemplateFolderPropertiesOrIconSetClause" )
     alterTemplateFolderPropertiesOrIconSetClause =  ( ( SET
          "setPropertiesClause" ) | "setReferenceIconSetClause" |
          "unsetReferenceIconSetClause" )+
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  SET ( REFERENCE | REF ) ICONSET
          "QUOTED_STRING"
     unsetReferenceIconSetClause =  UNSET ( REFERENCE | REF ) ICONSET
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseAlterTemplateFolder

Alter the specified activity template folder.

alterTemplateFolderPropertiesOrIconSetClause

Alter existing activity template folder properties and/or Icon Set.

setPropertiesClause

This clause sets properties for the corresponding object.

getTemplateFolderPropertiesClause

Basic properties for ACTIVITY_TEMPLATE_FOLDER:

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

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

setReferenceIconSetClause

Set icon set for the activity template folder.

unsetReferenceIconSetClause

Unset icon set for the activity template folder.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

propertyKey

A property key for an object.

propertyValue

Value of a property.

See Also

OMBALTER

OMBCREATE ACTIVITY_TEMPLATE_FOLDER

OMBDROP ACTIVITY_TEMPLATE_FOLDER

OMBALTER ADVANCED_QUEUE

Purpose

Alter the Advanced Queue by resetting its properties.

Prerequisites

Should be in the context of an Oracle Module. The Queue Table should exist in the same Oracle Module.

Syntax

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

Parameters

alterAQCommand

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

renameClause

Renames the Advanced Queue to the given name.

alterPropertiesOrIconSetClause

Set properties or change the Icon Set.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Advanced Queue. Valid properties are shown below:

getPropertiesClause

Basic properties for ADVANCED_QUEUE:

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

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

Name: QTABLE
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Queue Table for the Advanced Queue. This has to be the name of a Queue Table(QUEUE_TABLE) existing in the same Oracle Module.

setReferenceIconSetClause

Set the specified Icon Set.

unsetReferenceIconSetClause

Unset the Icon Set.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

ADVANCED_QUEUE Object

Table 1-2 ADVANCED_QUEUE Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

DEQUEUE_ENABLED

BOOLEAN

true, false

none

none

true

ENQUEUE_ENABLED

BOOLEAN

true, false

none

none

true

GENERATE_ADVANCED_QUEUE

BOOLEAN

true, false

none

none

true

GENERATE_TEMPORARY_TABLE

BOOLEAN

true, false

none

none

true

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

MAX_RETRIES

NUMBER

none

none

none

5

RETENTION_TIME

NUMBER

none

none

none

0

RETRY_DELAY

NUMBER

none

none

none

0

See Also

OMBALTER

OMBCREATE ADVANCED_QUEUE

OMBRETRIEVE ADVANCED_QUEUE

OMBDROP ADVANCED_QUEUE

OMBALTER ALTERNATIVE_SORT_ORDER

Purpose

Alters an alternative sort order.

Prerequisites

Should be in the context of a business definition module or use the full path.

Syntax

alterAlternativeSortOrderCommand =  ( OMBALTER ALTERNATIVE_SORT_ORDER
          "QUOTED_STRING" ( ( "renameClause" [ SET
          "setPropertiesClauseforLOVandD2D" ] [ SET "setReferenceIconSetClause"
          ] [ UNSET "unsetReferenceIconSetClause" ] {
          "alterAlternativeSortOrderClauses" } ) | ( SET
          "setPropertiesClauseforLOVandD2D" [ SET "setReferenceIconSetClause" ]
          [ UNSET "unsetReferenceIconSetClause" ] {
          "alterAlternativeSortOrderClauses" } ) | ( SET
          "setReferenceIconSetClause" [ UNSET "unsetReferenceIconSetClause" ] {
          "alterAlternativeSortOrderClauses" } ) | ( UNSET
          "unsetReferenceIconSetClause" { "alterAlternativeSortOrderClauses" } )
           | ( "alterAlternativeSortOrderClauses" {
          "alterAlternativeSortOrderClauses" } ) ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClauseforLOVandD2D =  PROPERTIES "("
          "propertyNameListforLOVandD2D" ")" VALUES "(" "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterAlternativeSortOrderClauses =  SET ( REF | REFERENCE )
          "addAlternativeSortOrderClauseforAlter" | UNSET ( REF | REFERENCE )
          "deleteAlternativeSortOrderClauses" |
          "addAlternativeSortOrderReferenceClause"
     propertyNameListforLOVandD2D =  ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
          "," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addAlternativeSortOrderClauseforAlter =  ( DEFINING ITEM "QUOTED_STRING" OF
           ITEM_FOLDER "QUOTED_STRING" ) | ( ORDERED ITEM "QUOTED_STRING" OF
          ITEM_FOLDER "QUOTED_STRING" )
     deleteAlternativeSortOrderClauses =  ( DEFINING ITEM ) | ( ORDERED ITEM ) |
           ( ITEM "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING" )
     addAlternativeSortOrderReferenceClause =  SET ( REF | REFERENCE ) ITEM
          "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterAlternativeSortOrderCommand

This clause alters an alternative sort order.

QUOTED_STRING

name of the alternative sort order.

renameClause

Renames an alternative sort order with a different name.

setPropertiesClauseforLOVandD2D

This clause sets the properties of the object.

getPropertiesClauseforLOVandD2D

Basic properties for ALTERNATIVE_SORT_ORDER:

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

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

Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the alternative sort order enables drilling between the item folders containing the items that use the alternative sort order

Name: RETRIEVE_VALUES_GROUP_SIZE
Type: Number
Valid Values: Any valid character string in supported character set.
Default: '100'
The number of rows to be fetched from the database at a time

Name: CACHE_VALUES
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the list of values should be cached in memory

Name: REQUIRE_SEARCH
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether search criteria should be requested

Name: SHOW_IN_NAVIGATOR
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be shown in the item navigator

Name: SORTED_DISTINCT
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be displayed sorted with duplicates hidden

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set.

alterAlternativeSortOrderClauses

This clause modifies an alternative sort order.

propertyNameListforLOVandD2D

This is the list of property names.

propertyValueList

This is the list of property values.

addAlternativeSortOrderClauseforAlter

This clause sets the defining item or ordering item for the alternative sort order.

DEFINING

This sets the defining item for the alternative sort order.

ORDERED

This sets the ordered item for the alternative sort order.

deleteAlternativeSortOrderClauses

This deletes specific item references from an alternative sort order.

DEFINING

This deletes the defining item from an alternative sort order.

ITEM

This deletes a reference to an item from an alternative sort order.

ORDERED

This deletes the ordered item from an alternative sort order.

addAlternativeSortOrderReferenceClause

This adds a reference to an item to an alternative sort order.

propertyValue

This is a property value.

ALTERNATIVE_SORT_ORDER Object

Table 1-3 ALTERNATIVE_SORT_ORDER Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBCREATE ALTERNATIVE_SORT_ORDER

OMBRETRIEVE ALTERNATIVE_SORT_ORDER

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.

See Also

OMBCREATE ANALYZE_ACTION_PLAN

OMBPROFILE

OMBALTER APPLICATION_SERVER_MODULE

Purpose

Alter the Application Server Module by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of a project.

Syntax

alterApplicationServerModuleCommand =  OMBALTER ( APPLICATION_SERVER_MODULE
           "QUOTED_STRING" ( "renameClause" [ "alterPropertiesOrReferenceClause"
           ] | "alterPropertiesOrReferenceClause" ) )
     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

alterApplicationServerModuleCommand

Alter the content of the application server module.

renameClause

Rename the application server module.

alterPropertiesOrReferenceClause

Alter the properties or reference (location or iconset) of the application server module.

setPropertiesClause

Set values of properties of the application server module.

setReferenceClause

Set reference location or iconset for the application server module.

unsetReferenceClause

Unset the 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.

unsetReferenceLocationClause

Specify the ref location to unset it for the application server module.

unsetReferenceIconSetClause

Unset the ref icon set for the application server module.

propertyValue

The property value of the object.

See Also

OMBDROP APPLICATION_SERVER_MODULE

OMBCREATE APPLICATION_SERVER_MODULE

OMBALTER APPLICATION_SERVER_MODULE

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

Property
Type
Choices
Min
Max
Default
Description

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

OMBCREATE BUSINESS_AREA

OMBRETRIEVE BUSINESS_AREA

OMBALTER BUSINESS_DEFINITION_MODULE

Purpose

Alter a business definition module by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of project.

Syntax

alterEULModuleCommand =  OMBALTER ( BUSINESS_DEFINITION_MODULE
          "QUOTED_STRING" ( "renameClause" [
          "alterPropertiesOrReferenceClauseForDataOnlyModule" ] |
          "alterPropertiesOrReferenceClauseForDataOnlyModule" |
          "addOrRemoveOrModifyModuleReferenceLocationClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceClauseForDataOnlyModule =  ( ( SET ( (
          "setPropertiesClause" [ ( SET "setReferenceClauseForDataOnlyModule" [
          UNSET "unsetReferenceClauseForDataOnlyModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataOnlyModule" [ SET
          "setReferenceClauseForDataOnlyModule" ] ) ] ) | (
          "setReferenceClauseForDataOnlyModule" [ UNSET
          "unsetReferenceClauseForDataOnlyModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataOnlyModule" [ SET
          "setReferenceClauseForDataOnlyModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataOnlyModule =  ( "setReferenceLocationClause" [ SET
           "setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
     unsetReferenceClauseForDataOnlyModule =  ( "unsetReferenceLocationClause" [
           UNSET "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause"
           )
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" SET AS DEFAULT
     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

alterEULModuleCommand

This command modifies an existing business definition module.

QUOTED_STRING

Name of the existing business definition module in single quotes.

renameClause

Rename a business definition module.

alterPropertiesOrReferenceClauseForDataOnlyModule

Alter existing business definition module's properties and/or locations and/or icon sets.

addOrRemoveOrModifyModuleReferenceLocationClause

Add/remove/modify data location for the business definition module.

setPropertiesClause

Associate a set of properties with the existing business definition module.

getPropertiesClause

Basic properties for 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 business definition module

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

setReferenceClauseForDataOnlyModule

Set location and/or icon set for the new business definition module.

unsetReferenceClauseForDataOnlyModule

Unset location and/or icon set for the business definition module.

addReferenceLocationClause

Add a data location to the new business definition module.

removeReferenceLocationClause

Remove a data location from the business definition module.

modifyReferenceLocationClause

Modify a data location of the business definition module.

propertyNameList

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

propertyValueList

Comma-separated list of property values.

setReferenceLocationClause

Set a data location for the existing business definition module as the new configuration default.

setReferenceIconSetClause

Set icon set for the new business definition module.

unsetReferenceLocationClause

Unset a data location for the existing business definition module.

unsetReferenceIconSetClause

Unset icon set for the business definition module.

propertyValue

Value for a specified property.

BUSINESS_DEFINITION_MODULE Object

Table 1-5 BUSINESS_DEFINITION_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

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

OBJECT_MATCHING

STRING

BY_IDENTIFIER, BY_NAME

none

none

BY_IDENTIFIER

Whether import should match up objects by identifier or by name

See Also

OMBALTER

OMBCREATE BUSINESS_DEFINITION_MODULE

OMBDROP BUSINESS_DEFINITION_MODULE

OMBALTER CALENDAR

Purpose

To alter calendar.

Prerequisites

Should be in the context of a CalendarFolder.

Syntax

parseAlterCalendar =  OMBALTER CALENDAR "QUOTED_STRING" ( ( "renameClause"
          [ "alterCalendarPropertiesOrIconSetClause" ] [ "modifySchedulesClause"
           ] ) | ( "alterCalendarPropertiesOrIconSetClause" [
          "modifySchedulesClause" ] ) | "modifySchedulesClause" )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterCalendarPropertiesOrIconSetClause =  ( SET ( ( "setPropertiesClause" [
           SET "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause"
           ] ) | "setReferenceIconSetClause" ) ) | UNSET
          "unsetReferenceIconSetClause"
     modifySchedulesClause =  ( "addScheduleClause" | "modifyScheduleClause" )+
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     addScheduleClause =  ADD SCHEDULE
     modifyScheduleClause =  MODIFY SCHEDULE "QUOTED_STRING" ( SET
          "setPropertiesClause" )
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseAlterCalendar

Alter the specified calendar.

renameClause

Rename the object.

alterCalendarPropertiesOrIconSetClause

Alter calendar or icon set.

modifySchedulesClause

Modify the schedule associated with the calendar.

setPropertiesClause

Describe the keys of properties for the calendar.

setPropertiesClause

Basic properties for CALENDAR:

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

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

Each calendar contains a single schedule with the name 'LOCALWINDOW'
which has the following properties which define the various aspects
of the schedule
Basic properties for SCHEDULE:

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

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

setPropertiesClause

Basic properties for the owned SCHEDULE OBJECT :

Name: START_TIME
Type: STRING(4000)
Valid Values: Start time in the format specified by property DATE_FORMAT. The value NULL can also be passed if a schedule that takes on a start time of ASAP ie. upon deployment.
Default: Empty string
Start time for the schedule

Name: END_TIME
Type: STRING(4000)
Valid Values: End time in the format specified by property DATE_FORMAT. The value NULL can also be passed if a schedule that repeats forever is to be created..
Default: Empty string
End time for the schedule

Name: TIMEZONE
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Time zone which times refer to.

Name: REPEAT_EXPRESSION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
iCal format of a repeat expression. If no REPEAT_EXPRESSION is supplied, the scheduled activity is only performed once. The REPEAT_EXPRESSION includes the following:
FREQ
This specifies the type of recurrence. It must be specified. The possible predefined frequency values are YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, and SECONDLY. Alternatively, specifies an existing schedule to use as a user-defined frequency.
INTERVAL
This specifies a positive integer representing how often the recurrence repeats. The default is 1, which means every second for secondly, every day for daily, and so on. The maximum value is 999.
BYMONTH
This specifies which month or months you want the job to execute in. You can use numbers such as 1 for January and 3 for March, as well as three-letter abbreviations such as FEB for February and JUL for July.
BYWEEKNO
This specifies the week of the year as a number. byweekno is only valid for YEARLY.
BYYEARDAY
This specifies the day of the year as a number. Valid values are 1 to 366. An example is 69, which is March 10 (31 for January, 28 for February, and 10 for March). 69 evaluates to March 10 for non-leap years and March 9 in leap years. -2 will always evaluate to December 30th independent of whether it is a leap year.
BYMONTHDAY
This specifies the day of the month as a number. Valid values are 1 to 31. An example is 10, which means the 10th day of the selected month. You can use the minus sign (-) to count backward from the last day, so, for example, BYMONTHDAY=-1 means the last day of the month and BYMONTHDAY=-2 means the next to last day of the month.
BYDAY
This specifies the day of the week from Monday to Sunday in the form MON, TUE, and so on. Using numbers, you can specify the 26th Friday of the year, if using a YEARLY frequency, or the 4th THU of the month, using a MONTHLY frequency. Using the minus sign, you can say the second to last Friday of the month. For example, -1 FRI is the last Friday of the month.
BYHOUR
This specifies the hour on which the job is to run. Valid values are 0 to 23. As an example, 10 means 10 a.m.
BYMINUTE
This specifies the minute on which the job is to run. Valid values are 0 to 59. As an example, 45 means 45 minutes past the chosen hour.
BYSECOND
This specifies the second on which the job is to run. Valid values are 0 to 59. As an example, 30 means 30 seconds past the chosen minute.

BYSETPOS (10gR2 only)
This selects one or more items by position in the list of timestamps that result after the whole calendaring expression is evaluated. It is useful for requirements such as running a job on the last workday of the month. Rather than attempting to express this with the other BY clauses, you can code the calendaring expression to evaluate to a list of every workday of the month, and then add the BYSETPOS clause to select only the last item of that list.

All of the above properties can be used in the SET PROPERTIES clause as well.

setPropertiesClause

The following properties are supported for the GET PROPERTIES clause only
Name: DATE_FORMAT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N//A
Region specific time format string, eg MMM/dd/yy:HH:mm:ss.
Name: AVAILABLE_TIMEZONES
Type: STRING ARRAY
Valid Values: Any valid character string in supported character set.
Default: N//A
List of available time zone ids that can be used to set the TIMEZONE property. This property is for information purposes only.
Name: PREVIEW_DATES
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Preview of dates that this schedule includes. This property is only valid for OMBRETRIEVE.

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set

addScheduleClause

Add a schedule to the calendar.

modifyScheduleClause

Update the schedule for this calendar.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

propertyKey

A property key for an object.

propertyValue

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

CALENDAR Object

Table 1-6 CALENDAR Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBALTER

OMBCREATE CALENDAR

OMBDROP CALENDAR

OMBALTER CALENDAR_MODULE

Purpose

To alter a calendar module.

Prerequisites

Should be in the context of a Project.

Syntax

parseAlterModule =  OMBALTER CALENDAR_MODULE "QUOTED_STRING" ( ( RENAME TO
          "QUOTED_STRING" [ "alterModulePropertiesOrIconSetClause" ] ) |
          "alterModulePropertiesOrIconSetClause" )
     alterModulePropertiesOrIconSetClause =  ( SET ( ( "setPropertiesClause" [ (
           ( SET ( "setReferenceLocationClause" [ ( SET
          "setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
          ) ] ) ) | ( UNSET "unsetReferenceLocationClause" [ ( SET
          "setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
          ) ] ) ) | ( ( SET "setReferenceIconSetClause" ) | ( UNSET
          "unsetReferenceIconSetClause" ) ) ] ) | ( "setReferenceLocationClause"
           [ ( SET "setReferenceIconSetClause" ) | ( UNSET
          "unsetReferenceIconSetClause" ) ] ) | "setReferenceIconSetClause" ) )
          | ( UNSET ( "unsetReferenceLocationClause" [ ( SET
          "setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
          ) ] ) | "unsetReferenceIconSetClause" )
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseAlterModule

Alter the specified calendar module.

alterModulePropertiesOrIconSetClause

Alter the properties or icon set of the module.

setPropertiesClause

Describe the keys of properties for the calendar module.

setPropertiesClause

Basic properties for CALENDAR_MODULE:

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

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

setReferenceLocationClause

Set the referenced location.

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set

unsetReferenceLocationClause

Unset the referenced location.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

propertyKey

A property key for an object.

propertyValue

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

CALENDAR_MODULE Object

Table 1-7 CALENDAR_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

DB_LOCATION

STRING

none

none

none

empty string

The location to which the schedule will be deployed.

EVAL_LOCATION

STRING

none

none

none

empty string

The location in which the scheduled object will be evaluated.

See Also

OMBALTER

OMBCREATE CALENDAR_MODULE

OMBDROP CALENDAR_MODULE

OMBALTER CATALOG_FOLDER

Purpose

Alters a catalog folder.

Prerequisites

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

Syntax

alterCatalogFolderCommand =  ( OMBALTER CATALOG_FOLDER "QUOTED_STRING" ( (
          "renameClause" [ SET "setPropertiesClause" ] [ SET
          "setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
          { "alterCatalogFolderClauses" } ) | ( SET "setPropertiesClause" [ SET
          "setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
          { "alterCatalogFolderClauses" } ) | ( SET "setReferenceIconSetClause"
          [ UNSET "unsetReferenceIconSetClause" ] { "alterCatalogFolderClauses"
          } ) | ( UNSET "unsetReferenceIconSetClause" {
          "alterCatalogFolderClauses" } ) | ( "alterCatalogFolderClauses" {
          "alterCatalogFolderClauses" } ) ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterCatalogFolderClauses =  ( SET ( REF | REFERENCE ) LOGICAL_TABLES "("
          "setLogicalTableNameList" ")" | SET ( REF | REFERENCE ) DRILL_PATHS
          "(" "setDrillPathNameList" ")" | UNSET ( REF | REFERENCE )
          LOGICAL_TABLES "(" "unsetLogicalTableNameList" ")" | UNSET ( REF |
          REFERENCE ) DRILL_PATHS "(" "unsetDrillPathNameList" ")" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setLogicalTableNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     setDrillPathNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     unsetLogicalTableNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     unsetDrillPathNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterCatalogFolderCommand

This clause alters a catalog folder.

QUOTED_STRING

name of the catalog folder.

renameClause

Renames a catalog folder with a different name.

setPropertiesClause

This clause sets the properties of the object.

getPropertiesClause

Basic properties for CATALOG_FOLDER:

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

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

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set.

alterCatalogFolderClauses

This clause adds or deletes catalog folder shortcuts.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

setLogicalTableNameList

Used to set logical table references for this catalog folder.

setDrillPathNameList

Used to set logical table references for this catalog folder.

unsetLogicalTableNameList

Used to remove logical table references for this catalog folder.

unsetDrillPathNameList

Used to remove logical table references for this catalog folder.

propertyValue

This is a property value.

CATALOG_FOLDER Object

Table 1-8 CATALOG_FOLDER Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBCREATE CATALOG_FOLDER

OMBRETRIEVE CATALOG_FOLDER

OMBALTER CMI_DEFINITION

Purpose

Alter the CMI definition by renaming it, and/or reset its properties.

Prerequisites

Should be in the root context.

Syntax

alterMIVDefinitionCommand =  OMBALTER ( CMI_DEFINITION "QUOTED_STRING" (
          "renameClause" [ SET "setPropertiesClause" ] | ( SET
          "setPropertiesClause" ) | ( USING DEFINITION_FILE "QUOTED_STRING" ) )
          )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterMIVDefinitionCommand

This command modifies an existing CMI definition.

QUOTED_STRING

Name of the existing CMI definition in single quotes.

renameClause

Rename an CMI definition.

setPropertiesClause

Associate a set of properties with the existing CMI definition.

setPropertiesClause

Basic properties for CMI_DEFINITION:

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

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

Name: MIV_TYPE
Type: STRING(40)
Valid Values: Applications,Databases
Default: N/A
Type of an CMI Definition

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

CMI_DEFINITION Object

Table 1-9 CMI_DEFINITION Object

Property
Type
Choices
Min
Max
Default
Description

LOCATION_UOID

STRING

none

none

none

empty string

Location Warehouse Builder should use to retrieve the data.

See Also

OMBALTER

OMBCREATE CMI_DEFINITION

OMBDROP CMI_DEFINITION

OMBALTER CMI_MODULE

Purpose

Alter the CMI module by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of project.

Syntax

alterMIVModuleCommand =  OMBALTER ( CMI_MODULE "QUOTED_STRING" (
          "renameClause" [
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( (
          "alterPropertiesClause" [ ( SET
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | (
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  (
          "unsetReferenceLocationClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "setJournalCodeTemplateClause" [ SET
          "setReferenceMetadataLocationOrIconSetClause" ] |
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "unsetJournalCodeTemplateClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetClause" ] |
          "unsetReferenceMetadataLocationOrIconSetClause" )
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( 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" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     unsetReferenceMetadataLocationOrIconSetClause =  (
          "unsetReferenceMetadataLocationClause" [ UNSET
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceMetadataLocationClause =  ( REFERENCE | REF )
          METADATA_LOCATION "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

alterMIVModuleCommand

This command modifies an existing CMI module.

QUOTED_STRING

Name of the existing CMI module in single quotes.

renameClause

Rename an CMI module.

alterPropertiesOrReferenceClauseForDataMetadataModule

Alter existing CMI module's properties and/or locations and/or icon sets.

For example, to associate the SQL Server platform to a CMI module:

OMBALTER CMI_MODULE 'PPLSOFT' SET PROPERTIES (TYPE) VALUES ('SQLSERVER')

Similarly, to associate a DB2 platform to a CMI module:

OMBALTER CMI_MODULE 'PPLSOFT' SET PROPERTIES (TYPE) VALUES ('DB2UDB')

setReferenceClauseForDataMetadataModule

Set data location and/or icon set for the CMI module.

unsetReferenceClauseForDataMetadataModule

Unset location and/or icon set for the CMI module.

addOrRemoveOrModifyModuleReferenceLocationClause

Add/remove/modify data location for the CMI 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 existing CMI module as the new configuration default.

unsetReferenceLocationClause

Unset a data location to the existing CMI module.

addReferenceLocationClause

Add a data location to the CMI module.

removeReferenceLocationClause

Remove a data location from the CMI module.

modifyReferenceLocationClause

Modify a data location of the CMI module.

propertyValue

Value of a property.

setReferenceMetadataLocationOrIconSetClause

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

unsetReferenceMetadataLocationOrIconSetClause

Unset metadata location and/or icon set for the CMI module.

setReferenceMetadataLocationClause

Set metadata location for the CMI module.

setReferenceIconSetClause

Set icon set for the CMI module.

unsetReferenceMetadataLocationClause

Unset metadata location for the CMI module.

unsetReferenceIconSetClause

Unset icon set for the CMI module.

See Also

OMBALTER

OMBCREATE CMI_MODULE

OMBDROP CMI_MODULE

OMBALTER COLLECTION

Purpose

Alter the collection by adding, removing or modifying shortcuts.

Prerequisites

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

Syntax

alterCollectionCommand =  OMBALTER ( COLLECTION "QUOTED_STRING" ( [
          "renameClause" ] [ SET "setPropertiesClause" [ SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
          SET "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause"
          ] [ "alterCollectionReferences" ] ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterCollectionReferences =  ( "addReferenceClause" |
          "removeReferenceClause" | "reconcileReferenceClause" )+
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addReferenceClause =  ADD REFERENCE TO "componentRefClause"
     removeReferenceClause =  REMOVE REFERENCE TO "componentRefClause"
     reconcileReferenceClause =  RECONCILE
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     componentRefClause =  ( "UNQUOTED_STRING" "QUOTED_STRING" )

Parameters

alterCollectionCommand

Alter a collection of objects.

QUOTED_STRING

Name of the existing collection in quotes.

renameClause

Rename a collection.

setPropertiesClause

Associate a set of properties with a collection.

propertiesClause

Basic properties for COLLECTION:

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

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

setReferenceIconSetClause

Set icon set for the collection.

unsetReferenceIconSetClause

Unset icon set for the collection.

alterCollectionReferences

Alter the collections references, includes adding, dropping and reconciling the collection.

propertyNameList

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

propertyValueList

Comma separated list of property values.

addReferenceClause

Add a reference to the collection.

removeReferenceClause

Remove a reference from the collection.

reconcileReferenceClause

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

propertyValue

Value of a property.

componentRefClause

Specify the type of the object to reference.

See Also

OMBALTER

OMBCREATE COLLECTION

OMBALTER CONFIGURATION

Purpose

Alter the Configuration by renaming it, and/or reset its properties and Icon Set.

Prerequisites

Should be in the context of a project.

Syntax

alterConfigurationCommand =  OMBALTER ( CONFIGURATION "QUOTED_STRING" (
          "renameClause" [ "alterPropertiesOrIconSetOrConfigTemplateClause" ] |
          "alterPropertiesOrIconSetOrConfigTemplateClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetOrConfigTemplateClause =  SET (
          "setPropertiesClause" [ SET ( "setReferenceIconSetClause" [ SET
          "setReferenceConfigTemplateClause" | UNSET
          "unsetReferenceConfigTemplateClause" ] |
          "setReferenceConfigTemplateClause" ) | UNSET (
          "unsetReferenceIconSetClause" [ SET "setReferenceConfigTemplateClause"
           | UNSET "unsetReferenceConfigTemplateClause" ] |
          "unsetReferenceConfigTemplateClause" ) ] | "setReferenceIconSetClause"
           [ SET "setReferenceConfigTemplateClause" | UNSET
          "unsetReferenceConfigTemplateClause" ] |
          "setReferenceConfigTemplateClause" ) | UNSET (
          "unsetReferenceIconSetClause" [ SET "setReferenceConfigTemplateClause"
           | UNSET "unsetReferenceConfigTemplateClause" ] |
          "unsetReferenceConfigTemplateClause" )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setReferenceConfigTemplateClause =  ( REFERENCE | REF )
          CONFIGURATION_TEMPLATE "QUOTED_STRING"
     unsetReferenceConfigTemplateClause =  ( REFERENCE | REF )
          CONFIGURATION_TEMPLATE
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterConfigurationCommand

This command modifies an existing Configuration.

renameClause

Rename Configuration.

alterPropertiesOrIconSetOrConfigTemplateClause

Alter existing Configuration properties and/or Icon Set and/or set a Configuration Template.

setPropertiesClause

Associate a set of properties with the existing Configuration.

getPropertiesClause

Basic properties for CONFIGURATION:

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

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

setReferenceIconSetClause

Set an Icon Set to the existing Configuration.

setReferenceConfigTemplateClause

Set a Configuration Template to a Configuration.

unsetReferenceConfigTemplateClause

Unset a Configuration Template for a configuration.

unsetReferenceIconSetClause

Unset an Icon Set from the existing Configuration.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

See Also

OMBALTER

OMBCREATE CONFIGURATION

OMBALTER CONFIGURATION_TEMPLATE

Purpose

To modify an existing configuration template.

Prerequisites

None.

Syntax

alterConfigurationTemplateCommand =  OMBALTER ( CONFIGURATION_TEMPLATE
          "QUOTED_STRING" ( "renameClause" [
          "alterPropertiesOrIconSetOrTemplateValuesClause" ] |
          "alterPropertiesOrIconSetOrTemplateValuesClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetOrTemplateValuesClause =  SET (
          "setPropertiesClause" [ SET ( "setReferenceIconSetClause" [ SET
          "setTemplateValuesClause" | UNSET "unsetTemplateValuesClause" ] |
          "setTemplateValuesClause" ) | UNSET ( "unsetReferenceIconSetClause" [
          SET "setTemplateValuesClause" | UNSET "unsetTemplateValuesClause" ] |
          "unsetTemplateValuesClause" ) ] | "setReferenceIconSetClause" [ SET
          "setTemplateValuesClause" | UNSET "unsetTemplateValuesClause" ] |
          "setTemplateValuesClause" ) | UNSET ( "unsetReferenceIconSetClause" [
          SET "setTemplateValuesClause" | UNSET "unsetTemplateValuesClause" ] |
          "unsetTemplateValuesClause" )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setTemplateValuesClause =  ( TEMPLATE_VALUES "(" "propertyNameList" ")" TO
          "(" "propertyValueList" ")" FOR "getType" )+ ON PLATFORM
          "QUOTED_STRING"
     unsetTemplateValuesClause =  ( TEMPLATE_VALUES "(" "propertyNameList" ")"
          FOR "getType" )+ ON PLATFORM "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     getType =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterConfigurationTemplateCommand

This command modifies an existing configuration template.

renameClause

Rename configuration template.

alterPropertiesOrIconSetOrTemplateValuesClause

Modifies the property or icon set of the configuration template, or modify the overrides the configuration template contains.

setPropertiesClause

Associate a set of properties with the existing configuration template.

getPropertiesClause

Basic properties for CONFIGURATION_TEMPLATE:

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

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

setReferenceIconSetClause

Set an Icon Set to the existing configuration template.

setTemplateValuesClause

Specifies the configuration properties that will be overriden in this template for objects of a certain type on a certain platform.
The following is a list of configuration properties and their seeded default values:

Platform ObjectType {UI category}
  {UI name} ScriptingName {Default value}

DB2UDB DB2UDB_MODULE {GENERATION_TARGET_DIRECTORIES}
  {8i.DB2UDB.1.CTLDIRECTORY} LOADER_DIRECTORY {ctl\}
  {8i.DB2UDB.1.CTLEXTENSION} LOADER_EXTENSION {.ctl}
  {8i.DB2UDB.1.CTLRUNPRM} LOADER_RUN_PARAMETER_FILE {_run.ini}

DB2UDB FUNCTION {Identification}
  {Deployable} DEPLOYABLE {true}

DB2UDB FUNCTION {Options}
  {Deterministic} DETERMINISTIC_STATE {}
  {Language} LANGUAGE_SQL {}
  {SPECIFIC} SPECIFIC {}
  {Call On Null Input} CALLED_ON_NULL_INPUT {}
  {External Action} EXTERNAL_ACTION {}
  {Inherit Isolation Level} INHERIT_ISOLATION_LEVEL {}
  {Inherit Special Registers} INHERIT_SPECIAL_REGISTERS {}
  {Parameter Ccsid} PARAMETER_CCSID {}
  {SQL Data} SQL_DATA {}
  {Static Dispatch} STATIC_DISPATCH {}

DB2UDB FUNCTION {}
  {Generation Comments} GENERATION_COMMENTS {}

DB2UDB TABLE {Change Data Capture}
  {Enable} IS_CDC {false}
  {Table Position} CDC_POSITION {0}

GENERIC ALTERNATIVE_SORT_ORDER {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC BUSINESS_AREA {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC BUSINESS_DEFINITION_MODULE {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC BUSINESS_DEFINITION_MODULE {Discoverer Import Options}
  {Object Matching} OBJECT_MATCHING {BY_IDENTIFIER}

GENERIC CATALOG_FOLDER {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC DRILL_TO_DETAIL {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC EJB {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC FOR_LOOP {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC JAVA {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC LIST_OF_VALUES {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC OBIEEDRILL_PATH {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC OBIEEQUERY_OBJECT_SIMPLE {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC OBIEE_BUSINESS_DEFINITION_MODULE {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC OBISEDRILL_PATH {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC OBISEQUERY_OBJECT_SIMPLE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Optimizer Hint} OPTIMIZER_HINT {}

GENERIC OMBPLUS {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC PROCESS_ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC PROCESS_FLOW {}
  {Generation Comments} GENERATION_COMMENTS {}
  {Referred Calendar} REFERRED_CALENDAR {}

GENERIC PROCESS_FLOW_PACKAGE {IDENTIFICATION}
  {OWF.PACKAGES.DEPLOYABLE} DEPLOYABLE {true}

GENERIC PROCESS_FLOW_PACKAGE {}
  {Generation Comments} GENERATION_COMMENTS {}

GENERIC REGISTERED_FUNCTION {Identification}
  {Deployable} DEPLOYABLE {true}
  {Package} PACKAGE {}

GENERIC REGISTERED_FUNCTION {Options}
  {AUTHID} AUTHID {}
  {Deterministic} IS_DETERMINISTIC {}
  {Parallel Enable} IS_PARALLEL_ENABLE {}
  {Pragma Autonomous Transaction} PRAGMA_AUTONOMOUS_TRANSACTION {}

GENERIC REGISTERED_FUNCTION {}
  {Generation Comments} GENERATION_COMMENTS {}

GENERIC SEQUENCE {}
  {Generation Comments} GENERATION_COMMENTS {}

GENERIC TABLE {Change Data Capture}
  {Enable} IS_CDC {false}

GENERIC VIEW {}
  {Generation Comments} GENERATION_COMMENTS {}

GENERIC WEBSERVICE {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC AND ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC ASSIGN ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC DATA_AUDITOR ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC EMAIL ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC END ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC END_ERROR ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC END_LOOP ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC END_SUCCESS ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC END_WARNING ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC EVENT_LISTENER ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC FILE_EXISTS ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC FORK ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC FTP ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC MANUAL ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC MAPPING ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC NOTIFICATION ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC OR ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC PREDICT ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC ROUTE ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC SET_STATUS ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC SQLPLUS ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC START ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC SUBPROCESS ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC TRANSFORMATION ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC USER_DEFINED ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC WAIT ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC WHILE_LOOP ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

J2EE WEB_SERVICE {IDENTIFICATION}
  {Deployable} DEPLOYABLE {true}

J2EE WEB_SERVICE_PACKAGE {IDENTIFICATION}
  {Deployable} DEPLOYABLE {true}

ORACLE BATCH_MAPPING {CODE_GENERATION_OPTIONS}
  {MAP.AUTHID} AUTHID {None}
  {Analyze table statements} ANALYZE_TABLE_STATEMENTS {false}
  {ANSI SQL Syntax } ANSI_SQL_SYNTAX {true}
  {Bulk processing code} BULK_PROCESSING_CODE {true}
  {Commit Control} COMMIT_CONTROL {AUTO_COMMIT}
  {Enable Parallel DML} ENABLE_PARALLEL_DML {false}
  {Error Trigger} ERROR_TRIGGER {}
  {Generation Mode} GENERATION_MODE {ALL_MODES}
  {Optimized code} OPTIMIZED_CODE {true}
  {Use Target Load Ordering} TARGET_LOAD_ORDERING {true}

ORACLE BATCH_MAPPING {TDF}
  {Backports} BACKPORT_TRANSFORMS {}
  {Extends} EXTENDED_TRANSFORMS {}
  {Fixes} FIXED_TRANSFORMS {}
  {Handler} HANDLER_TRANSFORM {}
  {Release} TRANSFORM_RELEASE {}
  {Replaces} REPLACED_TRANSFORMS {}
  {ADXML Comments} ADXML_COMMENTS {}
  {Associated Partial Backport } ASSOCIATED_PARTIAL_BACKPORT_TRANSFORMS {}
  {Customer Notes} CUSTOMER_NOTES {}
  {Deploy Condition} DEPLOY_CONDITION {}
  {Dev Version} DEV_VERSION {}
  {Developer Notes} DEVELOPER_NOTES {}
  {Handler Of} HANDLER_OF_TRANSFORMS {}
  {Must Run After} MUST_RUN_AFTER_TRANSFORMS {}
  {Partial Backports} PARTIAL_BACKPORT_TRANSFORMS {}

ORACLE BATCH_MAPPING {PL/SQL mapping debugger properties for stage}
  {Debug runtime connection.} DEBUG_RUNTIME_CONNECTION {}

ORACLE BATCH_MAPPING {Runtime parameters}
  {Audit} AUDIT {true}
  {ABAP Report Name} ABAP_REPORT_NAME {}
  {Analyze table sample percentage} ANALYZE_TABLE_SAMPLE_PERCENTAGE {5}
  {Background Job} BACKGROUND {false}
  {Bulk size} BULK_SIZE {1000}
  {Commit frequency} COMMIT_FREQUENCY {1000}
  {Data File Name} DATA_FILE_NAME {}
  {Default audit level} DEFAULT_AUDIT_LEVEL {ERROR_DETAILS}
  {Default Operating Mode} DEFAULT_OPERATING_MODE {SET_BASED_FAIL_OVER_TO_ROW_BASED}
  {Default purge group} DEFAULT_PURGE_GROUP {WB}
  {File Delimiter for Staging File} FILE_DELIMITER_FOR_STAGING_FILE {~}
  {Include FTP} SAP_FTP {true}
  {Maximum number of errors} MAXIMUM_NUMBER_OF_ERRORS {50}
  {Nested Loop} NESTED_LOOP {TRUE_DEFAULT}
  {Primary Foreign Key for Join} PRIMARY_FOREIGN_KEY_FOR_JOIN {DEFAULT}
  {SAP System Version} SAP_SYSTEM_VERSION {SAP_R3_4X}
  {Sql Join Collapsing} SQL_JOIN_COLLAPSING {TRUE_DEFAULT}
  {Staging File Directory} STAGING_FILE_DIRECTORY {C:\temp\}
  {Use Select Single} USE_SELECT_SINGLE {TRUE_DEFAULT}

ORACLE BATCH_MAPPING {SQL Loader Settings}
  {Multithreading} MULTITHREADING {USE_DEFAULT}
  {Resumable} RESUMABLE {false}
  {Bind Size} BIND_SIZE {50000}
  {Byte Order Mark} BYTE_ORDER_MARK {NOT_APPLICABLE}
  {Column Array Rows} COLUMNARRAYROWS {0}
  {Continue Load} CONTINUE_LOAD {false}
  {Control File Name} CONTROL_FILE_NAME {}
  {Database File Name} DATABASE_FILE_NAME {}
  {Delimited File Record Termination} DELIMITED_FILE_RECORD_TERMINATION {}
  {Direct Mode} DIRECT_MODE {false}
  {Endian (Byte Order)} BYTE_ORDER {DEFAULT_TO_PLATFORM}
  {Errors Allowed} ERRORS_ALLOWED {50}
  {Load Last Field As Pieced} LOAD_LAST_FIELD_AS_PIECED {false}
  {Log File Name} LOG_FILE_NAME {}
  {Nls Characterset} NLS_CHARACTERSET {}
  {Operation Recoverable} OPERATION_RECOVERABLE {true}
  {Perform Parallel Load} PERFORM_PARALLEL_LOAD {false}
  {Preserve Blanks} PRESERVE_BLANKS {false}
  {Read Buffers} READ_BUFFERS {0}
  {Read Size} READ_SIZE {65536}
  {Records to Load} RECORDS_TO_LOAD {0}
  {Records to Skip} RECORDS_TO_SKIP {0}
  {Resumable Name} RESUMABLE_NAME {}
  {Resumeable Timeout} RESUMABLE_TIMEOUT {7200}
  {Rows per Commit} ROWS_PER_COMMIT {200}
  {Skip Index Maintenance} SKIP_INDEX_MAINTENANCE {false}
  {Skip Unusable Indexes} SKIP_UNUSABLE_INDEXES {USE_DATABASE_CONFIG}
  {Stream size} STREAM_SIZE {0}
  {Supress discards} SUPRESS_DISCARDS {false}
  {Supress Errors} SUPRESS_ERRORS {false}
  {Supress Feedback} SUPRESS_FEEDBACK {false}
  {Supress Header} SUPRESS_HEADER {false}
  {Supress partitions} SUPRESS_PARTITIONS {false}

ORACLE BATCH_MAPPING {SQL*Plus Settings}
  {ARRAYSIZE} ARRAYSIZE {15}
  {COPYCOMMIT} COPYCOMMIT {0}
  {LONG} LONG_SIZE {2000000}
  {LOG File Directory} LOG_FILE_DIRECTORY {}
  {LOG File Name} LOG_FILE_NAME_SQLPLUS {}
  {SQL File Directory} SQL_FILE_DIRECTORY {}
  {SQL File Name} SQL_FILE_NAME {}

ORACLE BATCH_MAPPING {}
  {Deployable} DEPLOYABLE {true}
  {Language} GENERATION_LANGUAGE {UNDEFINED}
  {Generation Comments} GENERATION_COMMENTS {}
  {Referred Calendar} REFERRED_CALENDAR {}

ORACLE CUBE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Visible} VISIBLE {true}
  {Deployment Options} DEPLOYMENT_OPTIONS {DEPLOY_DATA_OBJECTS_ONLY}
  {Materialized View Index Tablespace} MATERIALIZED_VIEW_INDEX_TABLESPACE {USERS}
  {Materialized View Tablespace} MATERIALIZED_VIEW_TABLESPACE {USERS}

ORACLE CUBE {Summary Management}
  {Cost Based Aggregation} COSTBASEDPERCENTAGE {0}
  {Enable MV Refresh} ENABLE_MV_REFRESH {false}
  {Enable Query Rewrite} QUERY_REWRITE {DISABLE}
  {MV Constraints} MVCONSTRAINTS {TRUSTED}
  {Refresh Mode} REFRESH {FORCE}
  {Refresh Next Date} NEXTDATE {}
  {Refresh On} REFRESH_ON {DEMAND}
  {Refresh Start Date} STARTWITH {}

ORACLE CUBE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE DATA_AUDITOR {Code generation options}
  {Analyze table statements} ANALYZE_TABLE_STATEMENTS {true}
  {ANSI SQL Syntax } ANSI_SQL_SYNTAX {true}
  {Bulk processing code} BULK_PROCESSING_CODE {true}
  {Commit Control} COMMIT_CONTROL {AUTO_COMMIT}
  {Enable Parallel DML} ENABLE_PARALLEL_DML {true}
  {Error Trigger} ERROR_TRIGGER {}
  {Generation Mode} GENERATION_MODE {SET_BASED}
  {Optimized code} OPTIMIZED_CODE {true}
  {Use Target Load Ordering} TARGET_LOAD_ORDERING {true}

ORACLE DATA_AUDITOR {PL/SQL mapping debugger properties for stage}
  {Debug runtime connection.} DEBUG_RUNTIME_CONNECTION {}

ORACLE DATA_AUDITOR {Runtime parameters}
  {Analyze table sample percentage} ANALYZE_TABLE_SAMPLE_PERCENTAGE {90}
  {Bulk size} BULK_SIZE {50}
  {Commit frequency} COMMIT_FREQUENCY {1000}
  {Default audit level} DEFAULT_AUDIT_LEVEL {STATISTICS}
  {Default Operating Mode} DEFAULT_OPERATING_MODE {SET_BASED}
  {Default purge group} DEFAULT_PURGE_GROUP {WB}
  {Maximum number of errors} MAXIMUM_NUMBER_OF_ERRORS {50}

ORACLE DATA_AUDITOR {}
  {Deployable} DEPLOYABLE {true}
  {Language} GENERATION_LANGUAGE {UNDEFINED}
  {Generation Comments} GENERATION_COMMENTS {}
  {Referred Calendar} REFERRED_CALENDAR {}
  {Threshold Mode} THRESHOLD_MODE {PERCENTAGE}

ORACLE DATA_PROFILE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Application Short Name} APPLICATION_SHORT_NAME {WB}
  {Main Application Short Name} MAIN_APPLICATION_SHORT_NAME {ora}
  {Top Directory} TOP_DIRECTORY {..\..\codegen\}

ORACLE DATA_PROFILE {Deployment System Type}
  {PL/SQL Generation Mode} PLSQL_GENERATION_MODE {Default}

ORACLE DATA_PROFILE {Generation Preferences}
  {End of Line} END_OF_LINE {\r\n}

ORACLE DATA_PROFILE {Generation Target Directories}
  {8i.ORACLE8.1.SQLPLUSDIRECTORY} SQLPLUS_DIRECTORY {sqlplus\}
  {8i.ORACLE8.1.SQLPLUSEXTENSION} SQLPLUS_EXTENSION {.sql}
  {8i.ORACLE8.1.SQLPLUSRUNPRM} SQLPLUS_RUN_PARAMETER_FILE {_run.ini}
  {8i.ORACLE8.1.ZDTTDFEXTENSION} ZDT_EXTENSION {.tdf}
  {ABAP Extension} ABAP_EXTENSION {.abap}
  {ABAP Run Parameter File} ABAP_RUN_PARAMETER_FILE {_run.ini}
  {ABAP Spool Directory} ABAP_SPOOL_DIRECTORY {abap\log\}
  {DDL Directory} DDL_DIRECTORY {ddl\}
  {DDL Extension} DDL_EXTENSION {.ddl}
  {DDL Spool Directory} DDL_SPOOL_DIRECTORY {ddl\log\}
  {LIB Directory} LIB_DIRECTORY {lib\}
  {LIB Extension} LIB_EXTENSION {.lib}
  {LIB Spool Directory} LIB_SPOOL_DIRECTORY {lib\log\}
  {LOADER Directory} LOADER_DIRECTORY {ctl\}
  {LOADER Extension} LOADER_EXTENSION {.ctl}
  {LOADER Run Parameter File} LOADER_RUN_PARAMETER_FILE {_run.ini}
  {PL/SQL Directory} PLSQL_DIRECTORY {pls\}
  {PL/SQL Extension} PLSQL_EXTENSION {.pls}
  {PL/SQL Run Parameter File} PLSQL_RUN_PARAMETER_FILE {_run.ini}
  {PL/SQL Spool Directory} PLSQL_SPOOL_DIRECTORY {pls\log\}
  {Staging File Directory} ABAP_DIRECTORY {/tmp}
  {TCL Directory} TCL_DIRECTORY {tcl\}

ORACLE DATA_PROFILE {Run Time Directories}
  {Archive Directory} ARCHIVE_DIRECTORY {archive\}
  {Input Directory} INPUT_DIRECTORY {input\}
  {Invalid Directory} INVALID_DIRECTORY {invalid\}
  {Log Directory} LOG_DIRECTORY {log\}
  {Receive Directory} RECEIVE_DIRECTORY {receive\}
  {Sort Directory} SORT_DIRECTORY {sort\}
  {Work Directory} WORK_DIRECTORY {work\}

ORACLE DATA_PROFILE {Tablespace Defaults}
  {Default Index Tablespace} DEFAULT_INDEX_TABLESPACE {}
  {Default Object Tablespace} DEFAULT_OBJECT_TABLESPACE {}

ORACLE DIMENSION {Identification}
  {Deployable} DEPLOYABLE {true}
  {Visible} VISIBLE {true}
  {Deployment Options} DEPLOYMENT_OPTIONS {DEPLOY_DATA_OBJECTS_ONLY}
  {View Name} VIEW_NAME {}

ORACLE DIMENSION {Summary Management}
  {Enable MV Refresh} ENABLE_MV_REFRESH {false}
  {MV Constraints} MVCONSTRAINTS {TRUSTED}
  {Refresh Mode} REFRESH {FORCE}
  {Refresh Next Date} NEXTDATE {}
  {Refresh On} REFRESH_ON {DEMAND}
  {Refresh Start Date} STARTWITH {}

ORACLE DIMENSION {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE EXTERNAL_TABLE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Error Table Only} GENERATE_ERROR_TABLE_ONLY {false}

ORACLE EXTERNAL_TABLE {Parallel}
  {Parallel Access Drivers} PARALLEL_ACCESS_DRIVERS {1}
  {Parallel Access Mode} PARALLEL_ACCESS_MODE {false}

ORACLE EXTERNAL_TABLE {Reject}
  {Number Of Rejects Allowed} NUMBER_OF_REJECTS_ALLOWED {0}
  {Rejects Are Unlimited} REJECTS_ARE_UNLIMITED {true}

ORACLE EXTERNAL_TABLE {Access Specification}
  {Bad File Name} BAD_FILE_NAME {}
  {Discard File Name} DISCARD_FILE_NAME {}
  {Log File Name} LOG_FILE_NAME {}

ORACLE EXTERNAL_TABLE {Data Characteristics}
  {Endian} ENDIAN {PLATFORM}
  {String Sizes In} STRING_SIZES_IN {BYTES}

ORACLE EXTERNAL_TABLE {Error Table}
  {Error Table Name} ERROR_TABLE_NAME {}
  {Error Tablespace} ERROR_TABLESPACE {}

ORACLE EXTERNAL_TABLE {Field Editing}
  {Trim} TRIM {NONE}
  {Load Nulls When Missing Values} LOAD_NULLS_WHEN_MISSING_VALUES {false}

ORACLE EXTERNAL_TABLE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE FUNCTION {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE FUNCTION {Options}
  {AUTHID} AUTHID {}
  {Deterministic} IS_DETERMINISTIC {}
  {Parallel Enable} IS_PARALLEL_ENABLE {}
  {Pragma Autonomous Transaction} PRAGMA_AUTONOMOUS_TRANSACTION {}

ORACLE FUNCTION {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE MATERIALIZED_VIEW {Identification}
  {Deployable} DEPLOYABLE {true}
  {Error Table Only} GENERATE_ERROR_TABLE_ONLY {false}

ORACLE MATERIALIZED_VIEW {Parallel}
  {9i.MATERIALIZEDVIEWS.PARALLELDEGREE} PARALLEL_DEGREE {}
  {Parallel Access Mode} PARALLEL_ACCESS_MODE {}

ORACLE MATERIALIZED_VIEW {Default Index Options}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXBUFFERPOOL} DEFAULTINDEXBUFFERPOOL {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXFREELISTGROUPS} DEFAULTINDEXFREELISTGROUPS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXFREELISTS} DEFAULTINDEXFREELISTS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXINITIAL} DEFAULTINDEXINITIAL {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXINITRANS} DEFAULTINDEXINITRANS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXMAXEXTENTS} DEFAULTINDEXMAXEXTENTS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXMAXTRANS} DEFAULTINDEXMAXTRANS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXMINEXTENTS} DEFAULTINDEXMINEXTENTS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXNEXT} DEFAULTINDEXNEXT {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXPCTINCREASE} DEFAULTINDEXPCTINCREASE {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXSTOREIN} DEFAULT_INDEX_TABLESPACE {}
  {Using Index Mode} USING_INDEX_MODE {}

ORACLE MATERIALIZED_VIEW {Error Table}
  {9i.MATERIALIZEDVIEWS.SHADOWTABLE.TABLENAME} ERROR_TABLE_NAME {}
  {9i.MATERIALIZEDVIEWS.SHADOWTABLE.TABLESPACE} ERROR_TABLESPACE {}

ORACLE MATERIALIZED_VIEW {Hash Partition Parameters}
  {Hash Partition Tablespace List} HASH_PARTITION_TABLESPACE_LIST {}

ORACLE MATERIALIZED_VIEW {Materialized View Parameters}
  {9i.MATERIALIZEDVIEWS.FORUPDATE} FOR_UPDATE {}
  {9i.MATERIALIZEDVIEWS.NEXTDATE} NEXTDATE {}
  {Build} BUILD {}
  {Constraints} CONSTRAINTS {}
  {On} REFRESH_ON {}
  {Refresh} REFRESH {}
  {Rollback} ROLLBACK {DEFAULT LOCAL}
  {Rollbacksegmentlocal} ROLLBACKSEGMENTLOCAL {}
  {Rollbacksegmentmaster} ROLLBACKSEGMENTMASTER {}
  {Startwith} STARTWITH {}
  {With} WITH_KEY {}
  {9i.MATERIALIZEDVIEWS.QUERY REWRITE} QUERY_REWRITE {}
  {Base Tables} BASE_TABLES {}
  {Reduced Precision} REDUCED_PRECISION {}

ORACLE MATERIALIZED_VIEW {Performance Parameters}
  {Buffer Cache } CACHE_MODE {}
  {Data Segment Compression} DATA_SEGMENT_COMPRESSION {}
  {Logging Mode} LOGGING_MODE {}

ORACLE MATERIALIZED_VIEW {Physical Attributes}
  {9i.MATERIALIZEDVIEWS.INITRANS} INITRANS {}
  {9i.MATERIALIZEDVIEWS.MAXTRANS} MAXTRANS {}
  {9i.MATERIALIZEDVIEWS.PCTFREE} PCTFREE {}
  {9i.MATERIALIZEDVIEWS.PCTUSED} PCTUSED {}

ORACLE MATERIALIZED_VIEW {Storage Space}
  {9i.MATERIALIZEDVIEWS.BUFFERPOOL} BUFFER_POOL {}
  {9i.MATERIALIZEDVIEWS.FREELISTGROUPS} FREELISTGROUPS {}
  {9i.MATERIALIZEDVIEWS.FREELISTS} FREELISTS {}
  {9i.MATERIALIZEDVIEWS.INITIAL} INITIAL {}
  {9i.MATERIALIZEDVIEWS.MAXEXTENTS} MAXEXTENTS {}
  {9i.MATERIALIZEDVIEWS.MINEXTENTS} MINEXTENTS {}
  {9i.MATERIALIZEDVIEWS.PCTINCREASE} PCTINCREASE {}
  {Next} NEXT {}
  {Tablespace} TABLESPACE {}

ORACLE MATERIALIZED_VIEW {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE NESTED_TABLE {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE NESTED_TABLE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE OBJECT_TYPE {IDENTIFICATION}
  {Deployable} DEPLOYABLE {true}

ORACLE OBJECT_TYPE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE ORACLE_MODULE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Application Short Name} APPLICATION_SHORT_NAME {WB}
  {Main Application Short Name} MAIN_APPLICATION_SHORT_NAME {ora}
  {Top Directory} TOP_DIRECTORY {..\..\codegen\}

ORACLE ORACLE_MODULE {Deployment System Type}
  {PL/SQL Generation Mode} PLSQL_GENERATION_MODE {Default}

ORACLE ORACLE_MODULE {Generation Preferences}
  {End of Line} END_OF_LINE {\r\n}

ORACLE ORACLE_MODULE {Generation Target Directories}
  {8i.ORACLE8.1.SQLPLUSDIRECTORY} SQLPLUS_DIRECTORY {sqlplus\}
  {8i.ORACLE8.1.SQLPLUSEXTENSION} SQLPLUS_EXTENSION {.sql}
  {8i.ORACLE8.1.SQLPLUSRUNPRM} SQLPLUS_RUN_PARAMETER_FILE {_run.ini}
  {8i.ORACLE8.1.ZDTTDFEXTENSION} ZDT_EXTENSION {.tdf}
  {ABAP Extension} ABAP_EXTENSION {.abap}
  {ABAP Run Parameter File} ABAP_RUN_PARAMETER_FILE {_run.ini}
  {ABAP Spool Directory} ABAP_SPOOL_DIRECTORY {abap\log\}
  {DDL Directory} DDL_DIRECTORY {ddl\}
  {DDL Extension} DDL_EXTENSION {.ddl}
  {DDL Spool Directory} DDL_SPOOL_DIRECTORY {ddl\log\}
  {LIB Directory} LIB_DIRECTORY {lib\}
  {LIB Extension} LIB_EXTENSION {.lib}
  {LIB Spool Directory} LIB_SPOOL_DIRECTORY {lib\log\}
  {LOADER Directory} LOADER_DIRECTORY {ctl\}
  {LOADER Extension} LOADER_EXTENSION {.ctl}
  {LOADER Run Parameter File} LOADER_RUN_PARAMETER_FILE {_run.ini}
  {PL/SQL Directory} PLSQL_DIRECTORY {pls\}
  {PL/SQL Extension} PLSQL_EXTENSION {.pls}
  {PL/SQL Run Parameter File} PLSQL_RUN_PARAMETER_FILE {_run.ini}
  {PL/SQL Spool Directory} PLSQL_SPOOL_DIRECTORY {pls\log\}
  {Staging File Directory} ABAP_DIRECTORY {abap\}
  {TCL Directory} TCL_DIRECTORY {tcl\}

ORACLE ORACLE_MODULE {Run Time Directories}
  {Archive Directory} ARCHIVE_DIRECTORY {archive\}
  {Input Directory} INPUT_DIRECTORY {input\}
  {Invalid Directory} INVALID_DIRECTORY {invalid\}
  {Log Directory} LOG_DIRECTORY {log\}
  {Receive Directory} RECEIVE_DIRECTORY {receive\}
  {Sort Directory} SORT_DIRECTORY {sort\}
  {Work Directory} WORK_DIRECTORY {work\}

ORACLE ORACLE_MODULE {Tablespace Defaults}
  {Default Index Tablespace} DEFAULT_INDEX_TABLESPACE {}
  {Default Object Tablespace} DEFAULT_OBJECT_TABLESPACE {}

ORACLE PACKAGE {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE PACKAGE {Options}
  {AUTHID} AUTHID {}

ORACLE PACKAGE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE PLSQL_RECORD_TYPE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE PROCEDURE {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE PROCEDURE {Options}
  {AUTHID} AUTHID {}
  {Deterministic} IS_DETERMINISTIC {}
  {Parallel Enable} IS_PARALLEL_ENABLE {}
  {Pragma Autonomous Transaction} PRAGMA_AUTONOMOUS_TRANSACTION {}

ORACLE PROCEDURE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE QUEUE_PROPAGATION {Generation Options}
  {Generate Database Link} GENERATE_DBLINK {true}
  {Generate Queue Propagation} GENERATE_QUEUE_PROPAGATION {true}
  {Generate Ruleset and Rule for Replication } GENERATE_REPLICATION_RULE {false}
  {Generate Schedule Propagation} GENERATE_SCHEDULE_PROPAGATION {true}

ORACLE QUEUE_PROPAGATION {Replication Option (Only for Streams queues)}
  {Not Permitted Tag Values} NOT_PERMITTED_TAG_VALUES {}
  {Permitted Tag Values} PERMITTED_TAG_VALUES {}

ORACLE QUEUE_PROPAGATION {Scheduling Options}
  {Duration} DURATION {}
  {Latency} LATENCY {60}
  {Next Time} NEXT_TIME {}
  {Start Time} START_TIME {SYSDATE}

ORACLE QUEUE_PROPAGATION {}
  {Deployable} DEPLOYABLE {true}
  {Transformation} SUBCRIBER_TRANSFORMATION {}
  {Generation Comments} GENERATION_COMMENTS {}
  {Rule Condition} SUBSCRIBER_RULE_CONDITION {}

ORACLE QUEUE_TABLE {Generation Options}
  {Generate Queue Table} GENERATE_QUEUE_TABLE {true}

ORACLE QUEUE_TABLE {Storage Space}
  {Tablespace} TABLESPACE {}

ORACLE QUEUE_TABLE {}
  {Deployable} DEPLOYABLE {true}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE SEQUENCE {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE SEQUENCE {Sequence Parameters}
  {Increment By} INCREMENT_BY {1}
  {Start With} START_WITH {1}

ORACLE SEQUENCE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE TABLE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Error Table Only} GENERATE_ERROR_TABLE_ONLY {false}

ORACLE TABLE {Parallel}
  {Parallel Access Mode} PARALLEL_ACCESS_MODE {}
  {Parallel Degree} PARALLEL_DEGREE {}

ORACLE TABLE {Change Data Capture}
  {Enable} IS_CDC {false}
  {Table Position} CDC_POSITION {0}

ORACLE TABLE {Error Table}
  {Tablespace} ERROR_TABLESPACE {}
  {Error Table Name } ERROR_TABLE_NAME {}

ORACLE TABLE {Partition Parameters}
  {Overflow Tablespace List} OVERFLOW {}
  {Partition Tablespace List} PARTITION_TABLESPACE_LIST {}

ORACLE TABLE {Performance Parameters}
  {Buffer Cache} CACHE_MODE {}
  {Data Segment Compression} DATA_SEGMENT_COMPRESSION {}
  {Estimate Percent To Analyze Table} ANALYZE_TABLE_ESTIMATE_PERCENT {}
  {Logging Mode} LOGGING_MODE {}
  {Row Movement} ROW_MOVEMENT {}
  {Row-level Dependency} ROWDEPENDENCIES_MODE {}
  {Statistics Collection} MONITORING_MODE {}

ORACLE TABLE {Physical Attributes}
  {INITRANS} INITRANS {}
  {MAXTRANS} MAXTRANS {}
  {PCTFREE} PCTFREE {}
  {PCTUSED} PCTUSED {}

ORACLE TABLE {Storage Space}
  {BUFFER_POOL} BUFFER_POOL {}
  {FREELISTS} FREELISTS {}
  {INITIAL} INITIAL {}
  {MAXEXTENTS} MAXEXTENTS {}
  {MINEXTENTS} MINEXTENTS {}
  {NEXT} NEXT {}
  {PCTINCREASE} PCTINCREASE {}
  {Tablespace} TABLESPACE {}
  {FREELIST GROUPS} FREELISTGROUPS {}

ORACLE TABLE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE TABLE_FUNCTION {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE TABLE_FUNCTION {Options}
  {AUTHID} AUTHID {}
  {Deterministic} IS_DETERMINISTIC {}
  {Parallel Enable} IS_PARALLEL_ENABLE {}
  {Pragma Autonomous Transaction} PRAGMA_AUTONOMOUS_TRANSACTION {}

ORACLE TABLE_FUNCTION {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE TYPED_QUEUE {Generation Options}
  {9i.ADVANCEDQUEUES.GENERATEAQ} GENERATE_ADVANCED_QUEUE {true}
  {9i.ADVANCEDQUEUES.GENERATETEMPTABLE} GENERATE_TEMPORARY_TABLE {true}

ORACLE TYPED_QUEUE {}
  {9i.ADVANCEDQUEUES.DEFAULT.DEPLOYABLE} DEPLOYABLE {true}
  {9i.ADVANCEDQUEUES.DEFAULT.MAXRETRIES} MAX_RETRIES {5}
  {9i.ADVANCEDQUEUES.DEFAULT.RETENTIONTIME} RETENTION_TIME {0}
  {9i.ADVANCEDQUEUES.DEFAULT.RETRYDELAY} RETRY_DELAY {0}
  {Dequeue Enabled} DEQUEUE_ENABLED {true}
  {Enqueue Enabled} ENQUEUE_ENABLED {true}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE VARYING_ARRAY {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE VARYING_ARRAY {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE VIEW {Identification}
  {Deployable} DEPLOYABLE {true}
  {Error Table Only} GENERATE_ERROR_TABLE_ONLY {false}

ORACLE VIEW {Error Table}
  {Tablespace} ERROR_TABLESPACE {}
  {Error Table Name } ERROR_TABLE_NAME {}

ORACLE VIEW {}
  {Generation Comments} GENERATION_COMMENTS {}

SQLSERVER FUNCTION {Identification}
  {Deployable} DEPLOYABLE {true}

SQLSERVER FUNCTION {Options}
  {Encryption} ENCRYPTION {}
  {Execute As} EXECUTE_AS {}
  {Schema Binding} SCHEMABINDING {}
  {With Null Input} WITH_NULL_INPUT {}

SQLSERVER FUNCTION {}
  {Generation Comments} GENERATION_COMMENTS {}

SQLSERVER SQLSERVER_MODULE {GENERATION_TARGET_DIRECTORIES}
  {8i.SQLSERVER.1.CTLDIRECTORY} LOADER_DIRECTORY {ctl\}
  {8i.SQLSERVER.1.CTLEXTENSION} LOADER_EXTENSION {.ctl}
  {8i.SQLSERVER.1.CTLRUNPRM} LOADER_RUN_PARAMETER_FILE {_run.ini}

SQLSERVER TABLE {Change Data Capture}
  {Enable} IS_CDC {false}
  {Table Position} CDC_POSITION {0}

unsetTemplateValuesClause

Unset an override.

unsetReferenceIconSetClause

Unset an Icon Set from the existing configuration template.

propertyNameList

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

propertyValueList

Comma separated list of property values. Property values are quoted.

getType

The object type that contains the property. (See setTemplateValuesClause for possible values.)

propertyValue

The new value for the property.

See Also

OMBALTER

OMBCREATE CONFIGURATION_TEMPLATE

OMBALTER CONNECTOR

Purpose

Alter the connector by renaming it, and/or reset its referenced location or properties or icon set.

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

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

Parameters

alterConnectorCommand

Alter the connector specified by the quoted string. Connector name is specified as parent location name and a connector name separated by a '/' as follows: 'LOCATION_NAME/CONNECTOR_NAME'.

renameClause

Rename the connector.

alterPropertiesOrReferenceClause

Set the properties and/or reference location, and/or reference icon set of the connector.

setPropertiesClause

Set specified properties of the connector.

setReferenceClause

Set the reference location, and/or reference icon set of the connector.

unsetReferenceIconSetClause

Unset specified 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.

propertyValueList

The values for the named properties.

setReferenceToLocationClause

Set the name of the location which the connector references.

setReferenceIconSetClause

Set specified Icon Set.

propertyValue

A property value.

CONNECTOR Object

Table 1-10 CONNECTOR Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER

OMBCREATE CONNECTOR

OMBDROP CONNECTOR

OMBALTER CONTROL_CENTER

Purpose

Alter the control center by renaming it, and/or reseting its properties, and/or adding/removing a referenced location, and/or resetting properties of a referenced location.

Prerequisites

Can be in any context.

Syntax

alterControlCenterCommand =  OMBALTER ( CONTROL_CENTER "QUOTED_STRING" (
          "renameClause" [ SET "setPropertiesClause" [ "alterIconSetClause" ] {
          "alterReferenceLocationClause" } ] | SET "setPropertiesClause" [
          "alterIconSetClause" ] { "alterReferenceLocationClause" } |
          "alterIconSetClause" { "alterReferenceLocationClause" } | {
          "alterReferenceLocationClause" } ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     alterIconSetClause =  SET "setReferenceIconSetClause" [ UNSET
          "unsetReferenceIconSetClause" ] | UNSET "unsetReferenceIconSetClause"
          [ SET "setReferenceIconSetClause" ]
     alterReferenceLocationClause =  "addReferenceLocationClause" |
          "modifyReferenceLocationClause" | "deleteReferenceLocationClause"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     addReferenceLocationClause =  ADD ( REF | REFERENCE ) LOCATION
          "QUOTED_STRING" [ SET "setPropertiesClause" ]
     modifyReferenceLocationClause =  MODIFY ( REF | REFERENCE ) LOCATION
          "QUOTED_STRING" SET "setPropertiesClause"
     deleteReferenceLocationClause =  DELETE ( REF | REFERENCE ) LOCATION
          "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterControlCenterCommand

Alter a control center.

renameClause

Rename the control center to the value of the following quoted string.

setPropertiesClause

Set the specified properties of the control center.

alterIconSetClause

Set or unset the Icon Set.

alterReferenceLocationClause

Alter the referenced location.

propertyNameList

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

propertyNameList

Properties for CONTROL_CENTER:

Name: HOST
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The host machine the control center is installed on.

Name: PORT
Type: NUMBER
Valid Values: 1 - 65535
Default: 1521
The port number of the database in which the control center is installed.

Name: SERVICE_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The service name of the database in which the control center is installed.

Name: USER
Synonym: USER_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The name of the database user you wish to connect to the control center as.

Name: PASSWORD
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The password.

Name: WORKSPACE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The name of the workspace to which to connect.

All of the preceding properties (except of PASSWORD) are mandatory for OMBCREATE CONTROL_CENTER.

Basic properties for CONTROL_CENTER:

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

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

Properties for a referenced location of the control center:

Name: IS_SOURCE
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, then a referenced location is a source location.

Name: IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, then a referenced location is a target location.

Name: CONNECTION_TYPE
Type: STRING
Valid Values: 'HOST_PORT_SERVICE', 'SQL_NET_CONNECTION'
Default: 'HOST_PORT_SERVICE'
The control center connection details format.

propertyValueList

The values for the named properties.

setReferenceIconSetClause

Set the icon set.

unsetReferenceIconSetClause

Unset the icon set.

addReferenceLocationClause

Add a referenced location to the control center and/or set its properties.

modifyReferenceLocationClause

Set/reset properties of the referenced location.

deleteReferenceLocationClause

Delete a referenced location from the control center.

propertyValue

A property value.

CONTROL_CENTER Object

Table 1-11 CONTROL_CENTER Object

Property
Type
Choices
Min
Max
Default
Description

CONNECTION_TYPE

STRING

HOST:PORT:SERVICE, SQL*NET Connection

none

none

HOST:PORT:SERVICE

Type of J2EE connection to use

DISPLAY_TYPE

STRING

none

none

none

CMPLocation_RuntimeRepository

Type of the location

HOST

STRING

none

none

none

empty string

Host of the location

NET_SERVICE_NAME

STRING(2000)

none

none

none

empty string

Net Service Name of the location

PASSWORD

STRING(30)

none

none

none

empty string

PLATFORM_NAME

STRING

none

none

none

empty string

Platform for the location.

PORT

NUMBER

none

none

none

1521

SCHEMA

STRING

none

none

none

empty string

Workspace owner.name to use for deployment

SERVICE_NAME

STRING

none

none

none

empty string

Service name of the web service activity

USER

STRING

none

none

none

empty string

VERSION

STRING

none

none

none

0

Version of the location

See Also

OMBALTER

OMBCREATE CONTROL_CENTER

OMBDROP CONTROL_CENTER

OMBALTER CORRECTION_MAPS_ACTION_PLAN

Purpose

Alter an action plan for creating a correction map.

Prerequisites

In the context of a data profile.

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.

QUOTED_STRING

Action plan name.

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 an 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.

See Also

OMBCREATE CORRECTION_MAPS_ACTION_PLAN

OMBPROFILE

OMBALTER CORRECTION_SCHEMA_ACTION_PLAN

Purpose

Alter an action plan for creating a correction schema, identifying the tables that will be mapped to that schema.

Prerequisites

In the context of a data profile.

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

Name of data rule usage.

propertyValue

Value of a property.

See Also

OMBCREATE CORRECTION_SCHEMA_ACTION_PLAN

OMBPROFILE

2 OMBALTER CT to OMBALTER ICONSET

OMBALTER CT

OMBALTER CT_FOLDER

OMBALTER CUBE

OMBALTER DATA_AUDITOR

OMBALTER DATA_PROFILE

OMBALTER DATA_RULE

OMBALTER DATA_RULE_MODULE

OMBALTER DEPLOYMENT

OMBALTER DEPLOYMENT_ACTION_PLAN

OMBALTER DIMENSION

OMBALTER DRILL_PATH

OMBALTER DRILL_TO_DETAIL

OMBALTER EXPERT

OMBALTER EXPERT_MODULE

OMBALTER EXTERNAL_TABLE

OMBALTER FLAT_FILE

OMBALTER FLAT_FILE_MODULE

OMBALTER FOLDER

OMBALTER FUNCTION

OMBALTER GATEWAY_MODULE

OMBALTER ICONSET

OMBALTER CT

Purpose

To alter a Code Template.

Prerequisites

In the context of an CT module.

Syntax

alterCTCommand =  OMBALTER CT "QUOTED_STRING" ( "renameClause" {
          "kmAlterOptionsOptionsClause" } | "kmAlterOptionsOptionsClause"+ )
     renameClause =  RENAME TO "QUOTED_STRING"
     kmAlterOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET
          "unsetReferenceIconSetClause" | SET "setPropertiesClause" | ADD (
          "addParameterClause" | "addVariableClause" | "addCTTaskClause" |
          "addNestedCTTaskClause" | "addTransitionClause" ) | MODIFY (
          "modifyParameterClause" | "modifyVariableClause" |
          "modifyCTTaskClause" | "modifyTransitionClause" ) | DELETE (
          "deleteParameterClause" | "deleteVariableClause" | "deleteTaskClause"
          | "deleteTransitionClause" )
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     addParameterClause =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
           [ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
     addVariableClause =  VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
     addCTTaskClause =  "TASK_TYPE" TASK "QUOTED_STRING" {
          "kmTaskAddOptionsOptionsClause" }
     addNestedCTTaskClause =  NESTED_CT TASK "QUOTED_STRING" SET [
          "collectPropertiesClause" SET ] ( REF | REFERENCE ) CT "QUOTED_STRING"
           [ SET "setReferenceIconSetClause" ]
     addTransitionClause =  TRANSITION "QUOTED_STRING" FROM TASK "QUOTED_STRING"
           TO "QUOTED_STRING" [ SET "setPropertiesClause" ]
     modifyParameterClause =  "parameterLocator" ( "renameClause" [ SET
          "setPropertiesClause" ] [ "parameterBindingClause" ] | SET
          "setPropertiesClause" [ "parameterBindingClause" ] |
          "parameterBindingClause" )
     modifyVariableClause =  "variableLocator" ( "renameClause" [ SET
          "setPropertiesClause" ] | SET "setPropertiesClause" )
     modifyCTTaskClause =  TASK "QUOTED_STRING" ( ( "renameClause" {
          "kmTaskAlterOptionsOptionsClause" } ) |
          "kmTaskAlterOptionsOptionsClause"+ )
     modifyTransitionClause =  TRANSITION "QUOTED_STRING" ( "renameClause" [ SET
           "setPropertiesClause" ] | SET "setPropertiesClause" )
     deleteParameterClause =  "parameterLocator"
     deleteVariableClause =  "variableLocator"
     deleteTaskClause =  TASK "QUOTED_STRING"
     deleteTransitionClause =  TRANSITION "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     parameterBindingClause =  UNBIND | BIND TO ( "parameterLocator" |
          "variableLocator" )
     kmTaskAddOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET
          "unsetReferenceIconSetClause" | SET "setPropertiesClause"
     collectPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     parameterLocator =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
     variableLocator =  VARIABLE "QUOTED_STRING"
     kmTaskAlterOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET
          "unsetReferenceIconSetClause" | SET "setPropertiesClause"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterCTCommand

Alter the definition of a CT. The following lists all the default ct parameters:

{0}

renameClause

Rename the CT.

setReferenceIconSetClause

Set icon set for the expert module.

unsetReferenceIconSetClause

Unset icon set for a CT.

setPropertiesClause

This clause sets properties for the corresponding object.

setPropertiesClause

Basic properties for Code Template:

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

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

Basic properties for TASK:

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

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

addParameterClause

Add a parameter to the expert or one of it's tasks.

addVariableClause

Add a variable to the expert.

addTransitionClause

Add a transition to the expert.

modifyParameterClause

Modify the definition of a parameter.

modifyVariableClause

Modify the definition of a variable.

modifyTransitionClause

Modify the definition of a transition.

deleteParameterClause

Delete a parameter.

deleteVariableClause

Delete a variable.

deleteTaskClause

Delete a task.

deleteTransitionClause

Delete a transition.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

parameterBindingClause

Bind or unbind two parameters. Note that this is setting the binding attribute of the parameter object and is not necessarily the same as the direction of data flow. The parameter to be set should be the one whose binding attribute is modified via the Object Inspector in the expert editor.

collectPropertiesClause

This clause sets properties for the corresponding object.

parameterLocator

Specify a parameter, either one of the expert or of a task.

variableLocator

Specify a variable in the expert.

propertyValue

Value of a property.

CT Object

Table 2-1 CT Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBALTER

OMBRETRIEVE CT

OMBDROP CT

OMBALTER CT_FOLDER

Purpose

To alter a CT (Code Template) folder.

Prerequisites

In the context of a project.

Syntax

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

Parameters

alterCTModuleCommand

Alter the definition of a CT (Code Template) folder.

renameClause

Rename the CT folder.

alterPropertiesOrIconSetClause

Alter existing CT folder properties and/or Icon Set.

setPropertiesClause

Set properties for the CT folder.

getPropertiesClause

Basic properties for CT_FOLDER:

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

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

setReferenceIconSetClause

Set icon set for the CT folder.

unsetReferenceIconSetClause

Unset icon set for the CT folder.

propertyNameList

The list of properties to set.

propertyValueList

The list of property values to set.

propertyValue

The value of the property.

See Also

OMBALTER

OMBALTER CUBE

Purpose

This command alters a Cube.

Prerequisites

Should be in Oracle Module context.

Syntax

alterCubeCommand =  OMBALTER CUBE "cubeName" ( ( "renameClause" [
          "alterPropertiesOrIconSetClause" ] [ "setCubeAggFunctionClause" ] [
          "alterCubeDescendentsClause" ] [ "cubeImplementationClause" ] ) |
          "cubePartitionClause" | ( "alterPropertiesOrIconSetClause" [
          "setCubeAggFunctionClause" ] [ "alterCubeDescendentsClause" ] [
          "cubeImplementationClause" ] ) | ( "setCubeAggFunctionClause" [
          "alterCubeDescendentsClause" ] [ "cubeImplementationClause" ] ) | (
          "alterCubeDescendentsClause" [ "cubeImplementationClause" ] ) |
          "cubeImplementationClause" | "alterCubeUnBindingClause" )
     cubeName =  "QUOTED_STRING"
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( ( "setPropertiesClause" [ ( SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ) ]
          ) | "setReferenceIconSetClause" ) | UNSET
          "unsetReferenceIconSetClause"
     setCubeAggFunctionClause =  SET AGGREGATE_FUNCTION TO "aggFunctionName"
     alterCubeDescendentsClause =  ( ADD ( "addMeasureClause" |
          "addDimensionUseClause" | "addCompositeDimensionClause" ) | MODIFY (
          "modifyMeasureClause" | "modifyDimensionUseClause" |
          "modifyCompositeDimensionClause" ) | DELETE ( "measureLocator" |
          "compositeDimensionLocator" | "dimensionUseLocator" ) )+
     cubeImplementationClause =  IMPLEMENTED BY ( ( "cubeBindingClause" {
          "measureBindingClause" | "dimensionUseBindingClause" } ) |
          "cubeAutoBindingClause" )
     cubePartitionClause =  ( SET PARTITION LEVEL "levelName" OF HIERARCHY
          "hierName" OF DIMENSION "dimensionName" )
     alterCubeUnBindingClause =  DELETE BINDING
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     aggFunctionName =  "QUOTED_STRING"
     addMeasureClause =  MEASURE "measureName" [ SET "setPropertiesClause" ] [
          "setAggFunctionClause" ] [ "setPreComputedLevelsClause" ] [
          "setCalcExprClause" ]
     addDimensionUseClause =  DIMENSION_USE "dimensionUseName" [ SET
          "setPropertiesClause" ] [ "setDimensionUseReferenceClause" ] [ AT
          POSITION "INTEGER_LITERAL" ]
     addCompositeDimensionClause =  COMPOSITE_DIMENSION "compositeDimensionName"
           [ SET "setPropertiesClause" ] [
          "setCompositeDimensionReferenceClause" ]
     modifyMeasureClause =  "measureLocator" ( "renameClause" | SET
          "setPropertiesClause" | "setAggFunctionClause" |
          "setPreComputedLevelsClause" | "setCalcExprClause" )
     modifyDimensionUseClause =  "dimensionUseLocator" ( "renameClause" |
          "moveToClause" | SET "setPropertiesClause" |
          "modifyDimensionUseRoleClause" )
     modifyCompositeDimensionClause =  "compositeDimensionLocator" (
          "renameClause" | SET "setPropertiesClause" |
          "setCompositeDimensionReferenceClause" )
     measureLocator =  MEASURE "measureName"
     compositeDimensionLocator =  COMPOSITE_DIMENSION "compositeDimensionName"
     dimensionUseLocator =  DIMENSION_USE "dimensionUseName"
     cubeBindingClause =  ( TABLE "tableName" | VIEW "viewName" )
     measureBindingClause =  "measureLocator" BOUND TO COLUMN "columnName"
     dimensionUseBindingClause =  "dimensionUseLocator" BOUND TO COLUMN
          "columnName"
     cubeAutoBindingClause =  SYSTEM
     levelName =  "QUOTED_STRING"
     hierName =  "QUOTED_STRING"
     dimensionName =  "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     measureName =  "QUOTED_STRING"
     setAggFunctionClause =  SET AGGREGATE_FUNCTIONS "aggFunctionList" FOR
          DIMENSIONS "dimensionList"
     setPreComputedLevelsClause =  SET PRECOMPUTE_LEVELS "preComputedLevelList"
     setCalcExprClause =  SET CALCULATED_EXPRESSION "(" "calcExpr" ")"
     dimensionUseName =  "QUOTED_STRING"
     setDimensionUseReferenceClause =  [ USE ROLE "roleName" ] SET ( REF |
          REFERENCE ) [ LEVEL "levelName" OF ] DIMENSION "dimensionName"
     compositeDimensionName =  "QUOTED_STRING"
     setCompositeDimensionReferenceClause =  SET ( REF | REFERENCE ) DIMENSIONS
          "(" "dimensionName" { "," "dimensionName" } ")"
     moveToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     modifyDimensionUseRoleClause =  SET "roleLocator" | UNSET "roleLocator"
     tableName =  "QUOTED_STRING"
     viewName =  "QUOTED_STRING"
     columnName =  "QUOTED_STRING"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     aggFunctionList =  "(" "aggFunction" { "," "aggFunction" } ")"
     dimensionList =  "(" "dimension" { "," "dimension" } ")"
     preComputedLevelList =  "(" "preComputedLevel" { "," "preComputedLevel" }
          ")"
     calcExpr =  "QUOTED_STRING"
     roleName =  "QUOTED_STRING"
     roleLocator =  ROLE "roleName"
     aggFunction =  "QUOTED_STRING"
     dimension =  "QUOTED_STRING"
     preComputedLevel =  "QUOTED_STRING"

Parameters

alterCubeCommand

This clause alters properties of a CUBE.

cubeName

The name of the cube in QUOTED_STRING.

renameClause

The name of the cube to be renamed in QUOTED_STRING.

alterPropertiesOrIconSetClause

This clause alters properties or Iconsets.

setCubeAggFunctionClause

The clause sets new AGGREGATE_FUNCTION.

alterCubeDescendentsClause

This clause alter sub clauses.

cubeImplementationClause

The clause alter the cube IMPLEMENTED BY clause.

cubePartitionClause

The clause alters PARTITION, LEVEL, HIERARCHY, and DIMENSION.

alterCubeUnBindingClause

This clause unbinds a cube.

setPropertiesClause

This clause set PROPERTIES.

setPropertiesClause

Basic properties for CUBE, MEASURE and  DIMENSION_USE:

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

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

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: 'true', 'false'
Default: 'true'
The dimension is visible to OLAP end user

Name: UNIQUE_KEY_CONSTRAINT
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
set the Unique Key constraint on the Business Key

Name: STORAGE
Type: STRING
Valid Values: 'RELATIONAL', 'MOLAP'
Default: 'RELATIONAL'
The storage of a cube can be relational or molap

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

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

Name: USE_GLOBAL_INDEX
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Sets the flag to say whether to generate a composite for measure partition combination

Name: BITMAP_INDEX
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Sets the flag to say whether to generate a bitmap for a cube

Name: SUMMARY_REFRESH_METHOD
Type: STRING
Valid Values: 'On Demand', 'On Commit'
Default: 'On Commit'
Sets the Solve flag for Relational Cube whether to solve the cube 'On Demand' or 'On Commit'

Name: SPARSITY_ULTRA_COMPRESS
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Sets the flag to say whether its a compressed cube. Only valid for Molap cube.

setPropertiesClause

Name: LOAD_POLICY_FOR_NULL_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_DIMENSION_RECORD'
Default: 'NO_MAINTENANCE'
Data policy for loading cube where OWB mapping code relies on
database constraints to detect the orphans (null parent references).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_DIMENSION_RECORD', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

Name: LOAD_POLICY_FOR_INVALID_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_DIMENSION_RECORD'
Default: 'NO_MAINTENANCE'
Data policy for loading cube where OWB mapping code relies on
database constraints to detect the orphans (could contain a value that is not actually found in the parent).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_DIMENSION_RECORD', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

setReferenceIconSetClause

This clause sets the reference to ICONSET.

unsetReferenceIconSetClause

This clause unsets ICONSET.

aggFunctionName

The name of the aggregation function.

addMeasureClause

The clause adds a measure.

addDimensionUseClause

The clause adds a DIMENSION_USE.

addCompositeDimensionClause

This clause adds COMPOSITE_DIMENSION

modifyMeasureClause

This clause modifies a measure, uses sub clauses.

modifyDimensionUseClause

This clause modifies a dimension use.

modifyCompositeDimensionClause

This clause modifies a composite dimension.

measureLocator

This clause finds a measure.

compositeDimensionLocator

This clause finds a COMPOSITE_DIMENSION.

dimensionUseLocator

The clause finds a DIMENSION_USE.

cubeBindingClause

This clause binds cube to a TABLE or VIEW.

measureBindingClause

This clause binds a measure to a COLUMN.

dimensionUseBindingClause

This clause binds a dimension use to a COLUMN.

cubeAutoBindingClause

This clause automatically binds cube to a table/View.

levelName

The name of level in QUOTED_STRING.

hierName

The name of hierarchy in QUOTED_STRING.

dimensionName

The name of the dimension in QUOTED_STRING.

propertyKeyList

The list of properties.

propertyValueList

The list of values of properties in corresponding order.

measureName

The name of the measure in QUOTED_STRING.

setAggFunctionClause

This clause sets AGGREGATE_FUNCTIONS FOR DIMENSIONS.

setPreComputedLevelsClause

This clause sets PRECOMPUTE_LEVELS.

setCalcExprClause

This clause sets CALCULATED_EXPRESSION.

dimensionUseName

The name of the dimension use in QUOTED_STRING.

setDimensionUseReferenceClause

This clause ROLE, LEVEL, DIMENSION.

compositeDimensionName

The name of the composite dimension as a QUOTED_STRING.

setCompositeDimensionReferenceClause

This clause sets reference to Composite Dimension.

moveToClause

The is clause moves to a POSITION given by an INTEGER_LITERAL.

modifyDimensionUseRoleClause

This clause modifies dimension use's role.

tableName

The name of the table in QUOTED_STRING.

viewName

The name of the view in QUOTED_STRING.

columnName

The name of the column in QUOTED_STRING.

propertyKey

The name of property key in UNQUOTED_STRING

propertyValue

The property values are given by QUOTED_STRING, INTEGER_LITERAL, FLOATING_POINT_LITERAL.

aggFunctionList

The list of aggregation functions.

dimensionList

The list of dimensions.

preComputedLevelList

The list of precomputed levels.

calcExpr

The name of the calculated expression in QUOTED_STRING.

roleName

The name of the role in QUOTED_STRING.

roleLocator

This clause if for finding the role.

aggFunction

The name of the aggregation function given in QUOTED_STRING.

dimension

The name of the dimension given in QUOTED_STRING.

preComputedLevel

The name of the precomputed level given in QUOTED_STRING.

CUBE Object

Table 2-2 CUBE Object

Property
Type
Choices
Min
Max
Default
Description

COSTBASEDPERCENTAGE

NUMBER

none

none

none

0

Cost Based Aggregation

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_AGGREGATION, DEPLOY_ALL, DEPLOY_DATA_OBJECTS_ONLY, DEPLOY_TO_CATALOG_ONLY

none

none

DEPLOY_DATA_OBJECTS_ONLY

Warehouse Builder generates a set of scripts for cube, they are DDL Scripts for Relational Cube or Scripts for OLAP API-II or Scripts for AW.

ENABLE_MV_REFRESH

BOOLEAN

true, false

none

none

false

Enable MV Refresh

ERROR_TABLE_COLUMN_NAMES

STRING

none

none

none

empty string

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

MATERIALIZED_VIEW_INDEX_TABLESPACE

STRING

none

none

none

USERS

Tablespace for materialized view indexes.

MATERIALIZED_VIEW_TABLESPACE

STRING

none

none

none

USERS

Tablespace for materialized view.

MVCONSTRAINTS

STRING

, ENFORCED, TRUSTED

none

none

TRUSTED

MV Constraints

NEXTDATE

STRING

none

none

none

empty string

Refresh Next Date

QUERY_REWRITE

STRING

, DISABLE, ENABLE

none

none

DISABLE

Enable Query Rewrite

REFRESH

STRING

, COMPLETE, FAST, FORCE

none

none

FORCE

Refresh Mode

REFRESH_ON

STRING

, COMMIT, DEMAND, ONDATE

none

none

DEMAND

Refresh On

STARTWITH

STRING

none

none

none

empty string

Refresh Start Date

VISIBLE

BOOLEAN

true, false

none

none

true

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

See Also

OMBALTER

OMBCREATE CUBE

OMBRETRIEVE CUBE

OMBDROP CUBE

OMBALTER DATA_AUDITOR

Purpose

Alter the content of a data auditor.

Prerequisites

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

2. No concurrent user should be modifying the data auditor

Syntax

alterDataAuditorCommand =  OMBALTER DATA_AUDITOR "dataAuditorName" (
          "renameClause" [ "alterPropertiesOrIconSetClause" ] [
          "alterDataAuditorDecendantsClause" ] |
          "alterPropertiesOrIconSetClause" [ "alterDataAuditorDecendantsClause"
          ] | "alterDataAuditorDecendantsClause" )
     dataAuditorName =  "QUOTED_STRING"
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  ( SET ( ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] )
          | "setReferenceIconSetClause" ) ) | UNSET
          "unsetReferenceIconSetClause"
     alterDataAuditorDecendantsClause =  ( ADD "addOperatorClause" | MODIFY (
          "modifyOperatorClause" | "modifyChildClause" ) | DELETE
          "operatorLocator" )+
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     addOperatorClause =  "operatorType" OPERATOR "operatorName" [ SET
          "setPropertiesClause" ] [ BOUND TO "setBindingClause" ]
     modifyOperatorClause =  "operatorLocator" ( SET "setPropertiesClause" )
     modifyChildClause =  "childBottomUpLocator" ( "renameClause" | SET
          "setPropertiesClause" )
     operatorLocator =  OPERATOR "operatorName"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     operatorType =  "UNQUOTED_STRING"
     operatorName =  "QUOTED_STRING"
     setBindingClause =  "bindableLocator"
     childBottomUpLocator =  "childType" "childName" { OF "childType"
          "childName" } [ OF "mappableBottomUpLocator" ]
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     bindableLocator =  "bindableType" "bindableName"
     childType =  "UNQUOTED_STRING"
     childName =  "QUOTED_STRING"
     mappableBottomUpLocator =  "operatorLocator"
     bindableType =  "UNQUOTED_STRING"
     bindableName =  "QUOTED_STRING"

Parameters

alterDataAuditorCommand

Alter the content of a data auditor.

dataAuditorName

Name of data auditor.

renameClause

Rename a data auditor

alterPropertiesOrIconSetClause

Alter properties or the icon set.

alterDataAuditorDecendantsClause

Add, modify, delete or alter operators.

setPropertiesClause

Set the properties of the data auditor.

setReferenceIconSetClause

Set icon set for the data auditor.

unsetReferenceIconSetClause

Unset icon set for the data auditor.

addOperatorClause

Adds an operator to a data auditor.OMBCREATE DATA_AUDITOR 'MAP1'

SET PROPERTIES (business_name, description)

VALUES ('My map', 'Audit table foo')

ADD TABLE OPERATOR 'CUST_SRC'

BOUND TO TABLE '../SRC_MODULE/CUST_SRC'

modifyOperatorClause

Modify operator.

modifyChildClause

Modify a child that belongs to a data auditor.

operatorLocator

Locate operator.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

operatorType

Type of a mapping operator. The following operator types are available: CUBE, DIMENSION, MATERIALIZED_VIEW, TABLE, VIEW.

operatorName

Name of an operator.

setBindingClause

Set the binding during the creation of a operator.

childBottomUpLocator

Locate object in data auditor.

propertyKey

A property key for an object.

propertyKey

Basic properties for DATA_AUDITOR:

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

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

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

#

propertyValue

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

bindableLocator

Location of the object to be bound to an operator.

childType

Type of a child that belongs to data auditor or operator

childName

Name of a child that belongs to data auditor, operator.

mappableBottomUpLocator

Locate mappable object in data auditor.

bindableType

Type of object bound to an operator.

bindableName

Name of the object bound to operator.

DATA_AUDITOR Object

Table 2-3 DATA_AUDITOR Object

Property
Type
Choices
Min
Max
Default
Description

ANALYZE_TABLE_SAMPLE_PERCENTAGE

NUMBER

none

none

none

90

The default percentage of rows to be sampled when the target tables are analyzed for statistics to improve performance during insertion.

ANALYZE_TABLE_STATEMENTS

BOOLEAN

true, false

none

none

true

Generate statistics collection statement if this is true.

ANSI_SQL_SYNTAX

BOOLEAN

true, false

none

none

true

A switch between ANSI and Oracle SQL Syntax.

BULK_PROCESSING_CODE

BOOLEAN

true, false

none

none

true

Generate bulk processing code if this is true.

BULK_SIZE

NUMBER

none

none

none

50

COMMIT_CONTROL

STRING

AUTO_COMMIT, AUTO_CORR_COMMIT, MANUAL_COMMIT

none

none

AUTO_COMMIT

Options for how commit is performed

COMMIT_FREQUENCY

NUMBER

none

none

none

1000

DEBUG_RUNTIME_CONNECTION

STRING

none

none

none

empty string

Runtime schema connection info for debug.

DEFAULT_AUDIT_LEVEL

STRING

COMPLETE, ERROR_DETAILS, NONE, STATISTICS

none

none

STATISTICS

The default audit level when the step is executed.

DEFAULT_OPERATING_MODE

STRING

ROW_BASED, ROW_BASED_TARGET_ONLY, SET_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY

none

none

SET_BASED

The default operating mode.

DEFAULT_PURGE_GROUP

STRING

none

none

none

WB

The default purge group to be used when the step is executed.

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

ENABLE_PARALLEL_DML

BOOLEAN

true, false

none

none

false

Determine if PDML is enabled at runtime.

ERROR_TRIGGER

STRING

none

none

none

empty string

Error trigger procedure name.

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

PLSQL, UNDEFINED

none

none

UNDEFINED

The language used when generating code for the mapping.

GENERATION_MODE

STRING

ALL_MODES, ROW_BASED, ROW_BASED_TARGET_ONLY, SET_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY

none

none

SET_BASED

The operating modes for which code should be generated.

MAXIMUM_NUMBER_OF_ERRORS

NUMBER

none

none

none

50

The default maximum number of errors encountered before aborting the step execution.

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.

OPTIMIZED_CODE

BOOLEAN

true, false

none

none

true

Attempt to generate optimized code if this is true.

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.

TARGET_LOAD_ORDERING

BOOLEAN

true, false

none

none

true

Generate target load ordering code.

THRESHOLD_MODE

STRING

PERCENTAGE, SIX_SIGMA

none

none

PERCENTAGE

Use six sigma or percentage for failure thresholds.

OPERATOR Object

Table 2-4 OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBALTER

OMBCREATE DATA_AUDITOR

OMBRETRIEVE DATA_AUDITOR

OMBDROP DATA_AUDITOR

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

Property
Type
Choices
Min
Max
Default
Description

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

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

See Also

OMBALTER

OMBCREATE DATA_PROFILE

OMBDROP DATA_PROFILE

OMBALTER DATA_RULE

Purpose

= Alter the content of a data rule.

Prerequisites

1. The current context of scripting must be an DataRule Rule Module

2. No concurrent user should be modifying the data rule

Syntax

alterDataRuleCommand =  OMBALTER ( DATA_RULE "QUOTED_STRING" (
          "ruleRenameClause" [ "alterPropertiesOrIconSetClause" ] |
          "alterPropertiesOrIconSetClause" | ( ADD "addDomainValueClause" )+ | (
           REMOVE "removeDomainValueClause" )+ | "alterGroupClause"+ |
          "alterDomainValueClause"+ ) )
     ruleRenameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
     addDomainValueClause =  ( DOMAIN_VALUE "QUOTED_STRING" )
     removeDomainValueClause =  DOMAIN_VALUE "QUOTED_STRING"
     alterGroupClause =  GROUP "QUOTED_STRING" ( "setGroupPropertiesClause" |
          "addAttributeClause"+ | "removeAttributeClause"+ |
          "alterAttributeClause"+ )
     alterDomainValueClause =  DOMAIN_VALUE "QUOTED_STRING"
          "domainValueRenameClause"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     setGroupPropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")"
          VALUES "(" "propertyValueList" ")"
     addAttributeClause =  ADD ATTRIBUTE ( "QUOTED_STRING" [ SET
          "setPropertiesClause" ] )
     removeAttributeClause =  REMOVE ATTRIBUTE "QUOTED_STRING"
     alterAttributeClause =  ATTRIBUTE ( "QUOTED_STRING" SET
          "setPropertiesClause" )
     domainValueRenameClause =  RENAME TO "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterDataRuleCommand

Alter a data rule.

QUOTED_STRING

Data rule name.

ruleRenameClause

Rename a data rule.

QUOTED_STRING

New name.

alterPropertiesOrIconSetClause

Alter properties or the icon set.

addDomainValueClause

Add a domain value.

QUOTED_STRING

Domain value.

removeDomainValueClause

Remove a domain value.

QUOTED_STRING

Domain value.

alterGroupClause

Alter a data rule group.

QUOTED_STRING

Data rule group name.

alterDomainValueClause

Alter a domain value.

QUOTED_STRING

Domain value name.

setPropertiesClause

Set the properties of the data rule.

getPropertiesClause

Properties of Data Rule are:

Basic properties for DATA_RULE:

Name: DATA_NAME

Type: STRING(200)

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

Default: Empty string

Business name of the Data Rule

Name: DESCRIPTION

Type: STRING(4000)

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

Default: Empty string

Description of the Data Rule

Name: RULE_TYPE

Type: STRING

Valid Values: ATTR_VALUE_RULE

DOMAIN_NO_NULL_RULE

DOMAIN_LIST_RULE

DOMAIN_PATTERN_LIST_RULE

DOMAIN_RANGE_RULE

DOMAIN_FORMAT_TELEPHONE_RULE

DOMAIN_FORMAT_IP_RULE

DOMAIN_FORMAT_SSN_RULE

DOMAIN_FORMAT_DATE_RULE

DOMAIN_FORMAT_NUMBER_RULE

DOMAIN_FORMAT_URL_RULE

DOMAIN_FORMAT_EMAIL_RULE

FUNCTIONAL_DEP_RULE

SET_RULE

IDENTITY_RULE

REFERENCE_RULE

Default: ATTR_VALUE_RULE

Data Rule type

Name: ATTR_VALUE_CLAUSE

Type: STRING(4000)

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

Default: Empty string

Expression used in the ATTR_VALUE_RULE

Name: LOCAL_MIN_COUNT

Type: STRING

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

Default: 1

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: LOCAL_MAX_COUNT

Type: STRING

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

Default: n

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: REMOTE_MIN_COUNT

Type: STRING

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

Default: 0

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: REMOTE_MAX_COUNT

Type: STRING

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

Default: 'n'

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: MAX_VALUE

Type: STRING

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

Default: Empty string

Used in the DOMAIN_RANGE_RULE. Leave the min or max value blank is not used. For instance, the rule: attr &gt;= 10 would have a max value and no min_value.

Name: MIN_VALUE

Type: STRING

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

Default: Empty string

Used in the DOMAIN_RANGE_RULE. Leave the min or max value blank is not used. For instance, the rule: attr &gt;= 10 would have a max value and no min_value.

Name: IGNORE_NULLS

Type: BOOLEAN

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

Default: false

Used in identity and reference rules. If set, then records containing null values will not evaluated.

Properties of Data Rule Attribute are:

Name: DATATYPE

Type: STRING

Valid Values: DATE, NUMBER, VARCHAR2

Default: NUMBER

Set the data type for Parameter. Should be set for attributes on ATTR_VALUE and DOMAIN_RANGE rules

setReferenceIconSetClause

Set icon set for the data rule.

unsetReferenceIconSetClause

Unset icon set for the data rule.

setGroupPropertiesClause

Set the properties in a group.

addAttributeClause

Add an attribute to a group.

removeAttributeClause

Remove an attribute from a group.

alterAttributeClause

ALter an attribute.

domainValueRenameClause

Rename a domain value.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

DATA_RULE Object

Table 2-6 DATA_RULE Object

Property
Type
Choices
Min
Max
Default
Description

ATTR_VALUE_CLAUSE

STRING

none

none

none

empty string

Description not available.

DIAGRAM_LAYOUT

STRING

none

none

none

empty string

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

Description not available.

FUNCTIONAL_DEP_THRESHOLD

NUMBER

none

none

none

0

Description not available.

IGNORE_NULLS

BOOLEAN

true, false

none

none

false

Description not available.

LOCAL_MAX_COUNT

STRING

none

none

none

n

Description not available.

LOCAL_MIN_COUNT

STRING

none

none

none

1

Description not available.

MAX_VALUE

STRING

none

none

none

empty string

Description not available.

MIN_VALUE

STRING

none

none

none

empty string

Description not available.

NAMEADDR_PASS_CONDITION

STRING

PASS_PARSED, PASS_POSTALMATCHED_AVAIL

none

none

PASS_PARSED

Description not available.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Description not available.

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Description not available.

REMOTE_MAX_COUNT

STRING

none

none

none

n

Description not available.

REMOTE_MIN_COUNT

STRING

none

none

none

empty string

Description not available.

RULE_TYPE

STRING

, ATTR_VALUE_RULE, DOMAIN_FORMAT_DATE_RULE, DOMAIN_FORMAT_EMAIL_RULE, DOMAIN_FORMAT_IP_RULE, DOMAIN_FORMAT_NUMBER_RULE, DOMAIN_FORMAT_SSN_RULE, DOMAIN_FORMAT_TELEPHONE_RULE, DOMAIN_FORMAT_URL_RULE, DOMAIN_LIST_RULE, DOMAIN_NO_NULL_RULE, DOMAIN_PATTERN_LIST_RULE, DOMAIN_RANGE_RULE, FUNCTIONAL_DEP_RULE, IDENTITY_RULE, NAMEADDRESS_RULE, REFERENCE_RULE, SET_RULE

none

none

empty string

Description not available.

See Also

OMBALTER

OMBCREATE DATA_RULE

OMBDROP DATA_RULE

OMBALTER DATA_RULE_MODULE

Purpose

To create a data rule module.

Prerequisites

Should be in the context of project.

Syntax

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

Parameters

alterDataRuleModuleCommand

Alter data rule module.

QUOTED_STRING

Data rule module name.

renameClause

Rename a data rule.

QUOTED_STRING

New name.

alterPropertiesOrIconSetClause

Alter properties or the icon set.

setPropertiesClause

Set the properties of the data rule module.

setPropertiesClause

Basic properties for DATA_RULE_MODULE:

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

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

setReferenceIconSetClause

Set icon set for the data rule module.

unsetReferenceIconSetClause

Unset icon set for the data rule module.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

See Also

OMBALTER

OMBCREATE DATA_RULE_MODULE

OMBALTER DEPLOYMENT

Purpose

Alter the Deployment by renaming it, and/or reset its properties and referenced Control Center.

Prerequisites

Should be in the context of a Configuration.

Syntax

alterDeploymentCommand =  OMBALTER ( DEPLOYMENT "QUOTED_STRING" (
          "renameClause" [ SET "setPropertiesClause" ] [
          "setReferenceControlCenterClause" ] [ "setReferenceRemoteAgentClause"
          ] [ "setAsActiveClause" ] | SET "setPropertiesClause" [
          "setReferenceControlCenterClause" ] [ "setReferenceRemoteAgentClause"
          ] [ "setAsActiveClause" ] | "setReferenceControlCenterClause" [
          "setReferenceRemoteAgentClause" ] [ "setAsActiveClause" ] |
          "setReferenceRemoteAgentClause" [ "setAsActiveClause" ] |
          "setAsActiveClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceControlCenterClause =  SET ( REFERENCE | REF ) CONTROL_CENTER
          "QUOTED_STRING"
     setReferenceRemoteAgentClause =  SET ( REFERENCE | REF ) AGENT
          "QUOTED_STRING"
     setAsActiveClause =  SET AS ACTIVE
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterDeploymentCommand

This command modifies an existing Deployment.

renameClause

Rename Deployment.

setPropertiesClause

Associate a set of properties with the existing Deployment.

setPropertiesClause

Basic properties for DEPLOYMENT:

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

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

setReferenceControlCenterClause

Set a reference of a Control Center to the existing Deployment.

setReferenceRemoteAgentClause

Sets the Remote Agent for the Deployment.

setAsActiveClause

Set this Deployment as Active.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

See Also

OMBALTER

OMBCREATE DEPLOYMENT

OMBALTER DEPLOYMENT_ACTION_PLAN

Purpose

Modify an existing deployment action plan.

Prerequisites

There must be a current working project.

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

Modify an existing deployment action plan.

renameActionPlanClause

Rename an action plan.

addActionClause

Add an action to an action plan.

modifyActionClause

Modify an action of an action plan.

deleteActionClause

Remove an action from an action plan.

setClause

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

renameActionClause

Rename an action.

setUnsetClause

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

propertiesClause

Associate a set of properties with an action.

PROPERTIES

OPERATION, which specifies the type of action to be taken. DEPLOYMENT_LOCATION, which sets the target location for a Code Template.

setReferenceClause

Associate an object with an action.

ObjType

Object type. Valid values are ADVANCED_QUEUE, CUBE, DIMENSION, EXTERNAL_TABLE, CONNECTOR, FUNCTION, MAPPING, MATERIALIZED_VIEW, PROCEDURE, PROCESS_FLOW_PACKAGE, SCHEDULABLE, SEQUENCE, TABLE, and VIEW.

QUOTED_STRING

Absolute or relative path name of an object (e.g. '/MY_PROJECT/MODULE_X/TABLE_Y'). Global objects (for example public transforms), require a relative path.

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. Valid values for OPERATION are DROP, CREATE, REPLACE and UPGRADE.

See Also

OMBCREATE DEPLOYMENT_ACTION_PLAN

OMBDEPLOY

OMBALTER DIMENSION

Purpose

This command alters a dimension.

Prerequisites

Should be in Oracle Module context.

Syntax

alterDimensionCommand =  OMBALTER DIMENSION "dimensionName" (
          "renameClause" [ "setPropertiesClause" ] [ "setReferenceIconSetClause"
           [ "setDimensionKeySequenceClause" ] | "unsetReferenceIconSetClause" [
           "setDimensionKeySequenceClause" ] | "setDimensionKeySequenceClause" ]
           [ ( ADD "addSurrogateKeyDimensionAttributeClause" | MODIFY
          "modifySurrogateKeyDimensionAttributeClause" ) ] [ ( ADD
          "addParentKeyDimensionAttributeClause" | MODIFY
          "modifyParentKeyDimensionAttributeClause" ) ] [ ( ADD
          "addBusinessKeyDimensionAttributeClause" | MODIFY
          "modifyBusinessKeyDimensionAttributeClause" ) ] [
          "alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
          | "setPropertiesClause" [ "setReferenceIconSetClause" [
          "setDimensionKeySequenceClause" ] | "unsetReferenceIconSetClause" [
          "setDimensionKeySequenceClause" ] | "setDimensionKeySequenceClause" ]
          [ ( ADD "addSurrogateKeyDimensionAttributeClause" | MODIFY
          "modifySurrogateKeyDimensionAttributeClause" ) ] [ ( ADD
          "addParentKeyDimensionAttributeClause" | MODIFY
          "modifyParentKeyDimensionAttributeClause" ) ] [ ( ADD
          "addBusinessKeyDimensionAttributeClause" | MODIFY
          "modifyBusinessKeyDimensionAttributeClause" ) ] [
          "alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
          | ( "setReferenceIconSetClause" [ "setDimensionKeySequenceClause" ] |
          "unsetReferenceIconSetClause" [ "setDimensionKeySequenceClause" ] |
          "setDimensionKeySequenceClause" ) [ ( ADD
          "addSurrogateKeyDimensionAttributeClause" | MODIFY
          "modifySurrogateKeyDimensionAttributeClause" ) ] [ ( ADD
          "addParentKeyDimensionAttributeClause" | MODIFY
          "modifyParentKeyDimensionAttributeClause" ) ] [ ( ADD
          "addBusinessKeyDimensionAttributeClause" | MODIFY
          "modifyBusinessKeyDimensionAttributeClause" ) ] [
          "alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
          | ( ADD "addSurrogateKeyDimensionAttributeClause" | MODIFY
          "modifySurrogateKeyDimensionAttributeClause" ) [ ( ADD
          "addParentKeyDimensionAttributeClause" | MODIFY
          "modifyParentKeyDimensionAttributeClause" ) ] [ ( ADD
          "addBusinessKeyDimensionAttributeClause" | MODIFY
          "modifyBusinessKeyDimensionAttributeClause" ) ] [
          "alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
          | ( ADD "addParentKeyDimensionAttributeClause" | MODIFY
          "modifyParentKeyDimensionAttributeClause" ) [ ( ADD
          "addBusinessKeyDimensionAttributeClause" | MODIFY
          "modifyBusinessKeyDimensionAttributeClause" ) ] [
          "alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
          | ( ADD "addBusinessKeyDimensionAttributeClause" | MODIFY
          "modifyBusinessKeyDimensionAttributeClause" ) [
          "alterDimensionDescendantsClause" ] [ "alterDimensionBindingClause" ]
          | "alterDimensionDescendantsClause" [ "alterDimensionBindingClause" ]
          | "alterDimensionBindingClause" | "alterDimensionUnBindingClause" |
          "alterLevelRelationshipClause" )
     dimensionName =  "QUOTED_STRING"
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  SET PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  SET ( REFERENCE | REF ) ICONSET
          "QUOTED_STRING"
     setDimensionKeySequenceClause =  SET ( REF | REFERENCE ) SEQUENCE
          "sequenceName"
     unsetReferenceIconSetClause =  UNSET ( REFERENCE | REF ) ICONSET
     addSurrogateKeyDimensionAttributeClause =  DIMENSION_ATTRIBUTE
          "dimensionAttributeName" SET AS SURROGATE_KEY [ "setPropertiesClause"
          ]
     modifySurrogateKeyDimensionAttributeClause =  DIMENSION_ATTRIBUTE
          "dimensionAttributeName" SET AS SURROGATE_KEY [ "setPropertiesClause"
          ]
     addParentKeyDimensionAttributeClause =  DIMENSION_ATTRIBUTE
          "dimensionAttributeName" SET AS PARENT_KEY [ "setPropertiesClause" ]
     modifyParentKeyDimensionAttributeClause =  DIMENSION_ATTRIBUTE
          "dimensionAttributeName" SET AS PARENT_KEY [ "setPropertiesClause" ]
     addBusinessKeyDimensionAttributeClause =  DIMENSION_ATTRIBUTE
          "dimensionAttributeName" SET AS BUSINESS_KEY [ "setPropertiesClause" ]
     modifyBusinessKeyDimensionAttributeClause =  DIMENSION_ATTRIBUTE
          "dimensionAttributeName" SET AS BUSINESS_KEY [ "setPropertiesClause" ]
     alterDimensionDescendantsClause =  ( ADD ( "addDimensionAttributeClause" |
          "addDimensionRoleClause" | "addLevelClause" |
          "addLevelAttributeClause" | "addHierarchyClause" |
          "addSkipLevelsClause" ) | MODIFY ( "modifyDimensionAttributeClause" |
          "modifyDimensionRoleClause" | "modifyLevelClause" |
          "modifyLevelAttributeClause" | "modifyHierarchyClause" |
          "modifySkipLevelsClause" ) | DELETE ( "dimensionAttributeLocator" |
          "roleLocator" | "levelLocator" | "levelAttributeBottomUpLocator" |
          "hierarchyLocator" | "skipLevelLocator" ) )+
     alterDimensionBindingClause =  IMPLEMENTED BY ( SYSTEM ( STAR  | SNOWFLAKE
           ) | STAR ( ( [ DIMENSION_KEY BOUND TO COLUMN "columnName" ] (
          "levelBindingClause" | "levelAttributeBindingClause" |
          "setBindRelationshipClause" | "setSkipBindRelationshipClause" )+ ) ) |
           SNOWFLAKE ( ( "levelBindingClause" | "levelAttributeBindingClause" |
          "setBindRelationshipClause" | "setSkipBindRelationshipClause" )+ ) )
     alterDimensionUnBindingClause =  DELETE BINDING
     alterLevelRelationshipClause =  MODIFY ( LEVEL_RELATIONSHIP OF
          "levelLocator" IN "hierarchyLocator" "setPropertiesClause" |
          SKIP_LEVEL_RELATIONSHIP OF "levelLocator" IN "hierarchyLocator"
          "setPropertiesClause" )
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     sequenceName =  "QUOTED_STRING"
     dimensionAttributeName =  "QUOTED_STRING"
     addDimensionAttributeClause =  DIMENSION_ATTRIBUTE "dimensionAttributeName"
           [ SET AS BUSINESS_KEY ] [ "setPropertiesClause" ]
     addDimensionRoleClause =  DIMENSION_ROLE "roleName" [ "setPropertiesClause"
           ]
     addLevelClause =  LEVEL "levelName" [ "setPropertiesClause" ]
     addLevelAttributeClause =  LEVEL_ATTRIBUTE "levelAttributeName" OF
          "levelLocator" [ "setPropertiesClause" ]
          "setLevelAttributeReferenceClause"
     addHierarchyClause =  HIERARCHY "hierarchyName" [ "setPropertiesClause" ] [
           "hierarchyLevelReferenceClause" ]
     addSkipLevelsClause =  SKIP_LEVELS FROM "levelLocator" TO "levelLocator" IN
           "hierarchyLocator"
     modifyDimensionAttributeClause =  "dimensionAttributeLocator" (
          "renameClause" | "setPropertiesClause" )
     modifyDimensionRoleClause =  "roleLocator" ( "renameClause" |
          "setPropertiesClause" )
     modifyLevelClause =  "levelLocator" ( "renameClause" |
          "setPropertiesClause" )
     modifyLevelAttributeClause =  "levelAttributeBottomUpLocator" (
          "renameClause" | "setPropertiesClause" |
          "setLevelAttributeReferenceClause" )
     modifyHierarchyClause =  "hierarchyLocator" ( "renameClause" |
          "setPropertiesClause" | "hierarchyLevelReferenceClause" )
     modifySkipLevelsClause =  SKIP_LEVELS FROM "levelLocator" TO "levelLocator"
           IN "hierarchyLocator"
     dimensionAttributeLocator =  DIMENSION_ATTRIBUTE "dimensionAttributeName"
     roleLocator =  DIMENSION_ROLE "roleName"
     levelLocator =  LEVEL "levelName"
     levelAttributeBottomUpLocator =  LEVEL_ATTRIBUTE "levelAttributeName" OF
          "levelLocator"
     hierarchyLocator =  HIERARCHY "hierarchyName"
     skipLevelLocator =  SKIP_LEVELS FROM "levelLocator" TO "levelLocator" IN
          "hierarchyLocator"
     columnName =  "QUOTED_STRING"
     levelBindingClause =  "levelLocator" BOUND TO ( TABLE "tableName" | VIEW
          "viewName" )
     levelAttributeBindingClause =  LEVEL_ATTRIBUTE "levelAttributeName" OF
          LEVEL "levelName" BOUND TO COLUMN "columnName"
     setBindRelationshipClause =  LEVEL_RELATIONSHIP OF "levelLocator" IN
          "hierarchyLocator" BOUND TO COLUMN "columnName"
     setSkipBindRelationshipClause =  SKIP_LEVEL_RELATIONSHIP OF "levelLocator"
          IN "hierarchyLocator" BOUND TO COLUMN "columnName"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     roleName =  "QUOTED_STRING"
     levelName =  "QUOTED_STRING"
     levelAttributeName =  "QUOTED_STRING"
     setLevelAttributeReferenceClause =  SET ( REF | REFERENCE ) (
          "dimensionAttributeLocator" [ TYPE_THREE_SCD_PREVIOUS
          "levelAttributeLocator" ] )
     hierarchyName =  "QUOTED_STRING"
     hierarchyLevelReferenceClause =  SET ( REF | REFERENCE ) LEVELS "("
          "levelName" { "," "levelName" } ")"
     tableName =  "QUOTED_STRING"
     viewName =  "QUOTED_STRING"
     levelAttributeLocator =  LEVEL_ATTRIBUTE "levelAttributeName"

Parameters

alterDimensionCommand

This clause alter the properties of a dimension.

dimensionName

The name of the dimension in QUOTED_STRING.

renameClause

This clause helps to rename the dimension.

setPropertiesClause

This clause sets the PROPERTIES.

setPropertiesClause

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

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

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

Name: SCD_TYPE
Type: INTEGER
Valid Values: 1, 2, 3
Default: 1
Slowly changing policy to be applied on the dimension. Give Integer values 1, 2, 3
for Slowly changing type one, two and three

Name: LOAD_POLICY_FOR_NULL_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_PARENT'
Default: 'NO_MAINTENANCE'
Data policy for loading dimension where OWB mapping code relies on
database constraints to detect the orphans (null parent references).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_PARENT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

Name: LOAD_POLICY_FOR_INVALID_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_PARENT'
Default: 'NO_MAINTENANCE'
Data policy for loading dimension where OWB mapping code relies on
database constraints to detect the orphans (could contain a value that is not actually found in the parent).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_PARENT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

Name: REMOVE_POLICY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT'
Default: 'NO_MAINTENANCE'
Data policy for remove dimension data where OWB relies on database
constraints to detect removal of parent records who still have child records.
'NO_MAINTENANCE', does not actively enforce the parentage integrity rule that requires
every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', data policy for loading dimension where OWB mapping code will actively
reject the removal of parent records who still have child records.
#'CASCADE', data policy for removing dimension data where OWB mapping code will
#actively detect the removal of parent records who still have child records,
#and remove all of the descendents.

setPropertiesClause

Name: TYPE
Type: STRING
Valid Values: 'NONE', 'TIME'
Default: 'NONE'
'NONE'  it does not recognize it as any specific type of dimension.
'TIME' dimension is a time dimension

Name: OLAP_TYPE
Type: STRING
Valid Values: NONE, TIME
Default: NONE
Dimension type for OLAP, get regular dimension 'NONE' and for OLAP Time Dimension 'TIME'

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The dimension is visible to OLAP end user

Name: UNIQUE_KEY_CONSTRAINT
Type: STRING
Valid Values: true, false
Default: false
set the Unique Key constraint on the Business Key

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

Name: AW_NAME
Type: STRING(32)
Valid Values: 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

Name: USE_BUSINESS_KEYS
Type: STRING
Valid Values: true, false
Default: false
Set the flag for Analytical Workspace dimension to use Business Keys as data source

setPropertiesClause

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
Description of the Dimension_Attribute

Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH TIME ZONE, TIMESTAMP WITH LOCAL TIME ZONE, VARCHAR, VARCHAR2
Default: NUMBER
Sets the datatype of a Dimension_Attribute

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

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

Name: PRECISION
Type: NUMBER
Valid Values: 0 - 39
Default: 1
The precision of a number.

setPropertiesClause

Name: DESCRIPTOR
Type: STRING
Valid Values: NONE, SHORT_DESCRIPTION, LONG_DESCRIPTION, END_DATE, TIME_SPAN, PRIOR_PERIOD, YEAR_AGO_PERIOD
Default: NONE
The following properties are set on dimension attribute so that it is recognized by OLAP service
'NONE' it is not specially recognized type by OLAP service
'SHORT_DESCRIPTION' sets as a short description
'LONG_DESCRIPTION' sets as a long description
'END_DATE' sets as a last date of a period.
'TIME_SPAN' sets as a number of days in a period.
'PRIOR_PERIOD' sets as the prior period number.
'YEAR_AGO_PERIOD' sets as the time period a year before this period

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The dimension attribute is visible to OLAP end user

setPropertiesClause

Name: TYPE
Type: STRING
Valid Values: NONE, START_DATE, END_DATE, TIME_SPAN
Default: NONE
'NONE'  dimension attribute so OWB does not recognize it as any specific type.
'START_DATE' dimension attribute of time dimension as the start date of a period
'END_DATE' dimension attribute of time dimension as the end date of a period
'TIME_SPAN' dimension attribute of time dimension as the time span

Name: AW_ATTRIBUTE_NAME
Type: STRING(32)
Valid Values: Any valid character string in supported character set.
Default: Empty string
set the AW object name implementing the dimension attribute

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

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

Name: TYPE
Type: STRING
Valid Values: NONE, DAY, FISCAL_WEEK, FISCAL_MONTH, FISCAL_QUARTER, FISCAL_YEAR, CALENDAR_WEEK, CALENDAR_MONTH, CALENDAR_QUARTER, CALENDAR_YEAR
Default: NONE
For regular relational dimension level (non-time dimension level) use 'NONE'. For relational time dimension use other values.

Name: OLAP_TYPE
Type: STRING
Valid Values: NONE,DAY,MONTH,QUARTER,YEAR,TOTAL
Default: NONE
Level has an olap-type for OLAP-based levels; use 'NONE' for regular levels, and other values for OLAP Time Dimension

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The level is visible to OLAP end user

Basic properties for Level_Attribute :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string

setPropertiesClause

Business name of the Level_Attribute

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

Name: DEFAULT_VALUE
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
This is used to construct the default parent policy for loading data into dimesion.

Name: OLAP_TYPE
Type: STRING
Valid Values: NONE, SHORT_DESCRIPTION, END_DATE, TIME_SPAN, PRIOR_PERIOD, YEAR_AGO_PERIOD
Default: NONE
The following properties are set on level attribute so that it is recognized by OLAP service
'NONE' it is not specially recognized type by OLAP service
'SHORT_DESCRIPTION' sets as a short description
'END_DATE' sets as a last date of a period.
'TIME_SPAN' sets as a number of days in a period.
'PRIOR_PERIOD' sets as the prior period number.
'YEAR_AGO_PERIOD' sets as the time period a year before this period

setPropertiesClause

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The level attribute is visible to OLAP end user

Name: TYPE
Type: STRING
Valid Values: NONE, START_DATE, END_DATE, TIME_SPAN
Default: 'NONE'
'NONE'  level attribute so OWB does not recognize it as any specific type.
'START_DATE' level attribute of time dimension as the start date of a period
'END_DATE' level attribute of time dimension as the end date of a period
'TIME_SPAN' level attribute of time dimension as the time span

Name: TYPE_TWO_SCD_EFFECTIVE_DATE
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Effective Date for Slowly changing type 2

Name: TYPE_TWO_SCD_EXPIRATION_DATE
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Expiration Date for Slowly changing type 2

Name: TYPE_TWO_SCD_TRIGGER
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Trigger for saving history for Slowly changing type 2

Name: TYPE_THREE_SCD_EFFECTIVE_DATE
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Effective Date for Slowly changing type 3

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

setPropertiesClause

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

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The hierarchy is visible to OLAP end user

Name: TYPE
Type: STRING
Valid Values: NONE, FISCAL, CALENDAR_YEAR, CALENDAR_WEEK
Default: NONE
'NONE'  hierarchy so OWB does not recognize it as any specific type.
'FISCAL' fiscal hierarchy for time dimension
'CALENDAR_YEAR' calendar year hierarchy time dimension
'CALENDAR_WEEK' calendar week hierarchy time dimension

Name: DEFAULT_DISPLAY
Type: STRING
Valid Values: true, false
Default: false
The hierarchy is set as Default display hierarchy

Name: VALUE_BASED
Type: STRING
Valid Values: true, false
Default: false
Sets the flag to define a Value Based Hierarchy for AW only

setReferenceIconSetClause

This clause sets the reference to an ICONSET.

setDimensionKeySequenceClause

This clause sets the dimension key SEQUENCE.

unsetReferenceIconSetClause

This clause unsets the reference ICONSET.

addSurrogateKeyDimensionAttributeClause

This clause adds DIMENSION_ATTRIBUTE as a SURROGATE_KEY.

modifySurrogateKeyDimensionAttributeClause

This clause modifies DIMENSION_ATTRIBUTE as a SURROGATE_KEY.

addParentKeyDimensionAttributeClause

This clause adds a DIMENSION_ATTRIBUTE as a PARENT_KEY.

modifyParentKeyDimensionAttributeClause

This clause modifies a DIMENSION_ATTRIBUTE as a PARENT_KEY.

addBusinessKeyDimensionAttributeClause

This clause adds a DIMENSION_ATTRIBUTE as a BUSINESS_KEY.

modifyBusinessKeyDimensionAttributeClause

This clause modifies a DIMENSION_ATTRIBUTE as a BUSINESS_KEY.

alterDimensionDescendantsClause

This clause alters dimension descendent clause.

alterDimensionBindingClause

This clause alters dimension binding clauses.

alterDimensionUnBindingClause

This clause alters dimension unbinding clauses.

alterLevelRelationshipClause

This clause alters LEVEL_RELATIONSHIP and SKIP_LEVEL_RELATIONSHIP.

propertyKeyList

The property list clause.

propertyValueList

The property value list clause.

sequenceName

The sequence name in QUOTED_STRING.

dimensionAttributeName

The dimension attribute name in QUOTED_STRING.

addDimensionAttributeClause

This clause adds DIMENSION_ATTRIBUTE as a BUSINESS_KEY.

addDimensionRoleClause

This clause adds a DIMENSION_ROLE.

addLevelClause

This clause adds a LEVEL.

addLevelAttributeClause

This clause adds a LEVEL_ATTRIBUTE.

addHierarchyClause

This clause adds a HIERARCHY.

addSkipLevelsClause

This clause adds SKIP_LEVELS.

modifyDimensionAttributeClause

This clause modifies

modifyDimensionRoleClause

This clause modifies dimension roles.

modifyLevelClause

This clause modifies levels.

modifyLevelAttributeClause

This clause modifies level attributes.

modifyHierarchyClause

This clause modifies hierarchies.

modifySkipLevelsClause

This clause modifies SKIP_LEVELS.

dimensionAttributeLocator

This clause finds a DIMENSION_ATTRIBUTE.

roleLocator

This clause finds a DIMENSION_ROLE

levelLocator

This clause finds a LEVEL

levelAttributeBottomUpLocator

This clause finds a LEVEL_ATTRIBUTE

hierarchyLocator

This clause finds a HIERARCHY

skipLevelLocator

This clause finds a SKIP_LEVELS

columnName

The name of the column in QUOTED_STRING

levelBindingClause

This clause binds a level to a table or view.

levelAttributeBindingClause

This clause binds a LEVEL_ATTRIBUTE to a column.

setBindRelationshipClause

This clause binds LEVEL_RELATIONSHIP to a COLUMN.

setSkipBindRelationshipClause

This clause binds SKIP_LEVEL_RELATIONSHIP to a COLUMN.

propertyKey

The property key.

propertyValue

The property key value: QUOTED_STRING, INTEGER_LITERAL, FLOATING_POINT_LITERAL

roleName

The name of the role in QUOTED_STRING.

levelName

The name of the level in a QUOTED_STRING

levelAttributeName

The name of the level attribute in a QUOTED_STRING

setLevelAttributeReferenceClause

This clause sets level attribute reference clause.

hierarchyName

The name of the hierarchy in QUOTED_STRING.

hierarchyLevelReferenceClause

This clause sets hierarchy reference.

tableName

The name of the bound table in QUOTED_STRING.

viewName

The name of the bound view in QUOTED_STRING.

levelAttributeLocator

This clause finds the LEVEL_ATTRIBUTE.

DIMENSION Object

Table 2-7 DIMENSION Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER

OMBCREATE DIMENSION

OMBRETRIEVE DIMENSION

OMBDROP DIMENSION

OMBALTER DRILL_PATH

Purpose

Alters a drill path.

Prerequisites

Should be in the context of a business definition module or use the full path.

Syntax

alterDrillPathCommand =  ( OMBALTER DRILL_PATH "QUOTED_STRING" ( (
          "renameClause" [ SET "setPropertiesClause" ] [ SET
          "setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
          { "alterDrillPathLevelClauses" } ) | ( SET "setPropertiesClause" [ SET
           "setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
           { "alterDrillPathLevelClauses" } ) | ( SET
          "setReferenceIconSetClause" [ UNSET "unsetReferenceIconSetClause" ] {
          "alterDrillPathLevelClauses" } ) | ( UNSET
          "unsetReferenceIconSetClause" { "alterDrillPathLevelClauses" } ) | (
          "alterDrillPathLevelClauses" { "alterDrillPathLevelClauses" } ) ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterDrillPathLevelClauses =  ADD ( "addDrillPathLevelClauseForAlter" |
          "addDrillLevelLinkClauseForAlter" ) | MODIFY
          "modifyDrillPathLevelClause" | DELETE ( "deleteDrillPathLevelClause" |
           "deleteDrillLevelLinkClause" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addDrillPathLevelClauseForAlter =  [ ROOT ] DRILL_LEVEL "QUOTED_STRING" [
          DEFAULT_ROOT ] [ SET "setPropertiesClause" ] { "setDrillItemClause" }
          { "addDrillLevelKey" }
     addDrillLevelLinkClauseForAlter =  DRILL_LEVEL_LINK PARENT DRILL_LEVEL
          "QUOTED_STRING" CHILD DRILL_LEVEL "QUOTED_STRING"
     modifyDrillPathLevelClause =  DRILL_LEVEL "QUOTED_STRING" [ PARENT
          DRILL_LEVEL "QUOTED_STRING" ] [ "renameClause" ] [ "moveDrillLevel" ]
          [ SET "setPropertiesClause" ] { "setDrillItemClause" |
          "unsetDrillItemClause" | "unsetJoinUsage" } {
          "alterDrillLevelKeyClauses" }
     deleteDrillPathLevelClause =  DRILL_LEVEL "QUOTED_STRING" [ CASCADE ]
     deleteDrillLevelLinkClause =  DRILL_LEVEL_LINK PARENT DRILL_LEVEL
          "QUOTED_STRING" CHILD DRILL_LEVEL "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setDrillItemClause =  SET ( REF | REFERENCE ) ITEM "QUOTED_STRING" OF ( (
          ITEM_FOLDER "QUOTED_STRING" "itemJoinUsages" ) | ( LOGICAL_TABLE
          "QUOTED_STRING" ) )
     addDrillLevelKey =  ADD DRILL_LEVEL_KEY "QUOTED_STRING" [ SET
          "setPropertiesClause" ] { "setDrillItemKeyClause" }
     moveDrillLevel =  MOVE BELOW DRILL_LEVEL "QUOTED_STRING"
     unsetDrillItemClause =  UNSET ( REF | REFERENCE ) ITEM "QUOTED_STRING" OF (
           ( ITEM_FOLDER "QUOTED_STRING" ) | ( LOGICAL_TABLE "QUOTED_STRING" ) )
     unsetJoinUsage =  UNSET USING JOIN "QUOTED_STRING" OF ITEM_FOLDER
          "QUOTED_STRING"
     alterDrillLevelKeyClauses =  ADD "addDrillLevelKeyforAlter" | MODIFY
          "modifyDrillLevelKeyClause" | DELETE "deleteDrillLevelKeyClause"
     itemJoinUsages =  { USING JOIN "QUOTED_STRING" OF ITEM_FOLDER
          "QUOTED_STRING" }
     setDrillItemKeyClause =  SET ( REF | REFERENCE ) ITEM "QUOTED_STRING" OF
          LOGICAL_TABLE "QUOTED_STRING"
     addDrillLevelKeyforAlter =  DRILL_LEVEL_KEY "QUOTED_STRING" [ SET
          "setPropertiesClause" ] { "setDrillItemKeyClause" }
     modifyDrillLevelKeyClause =  DRILL_LEVEL_KEY "QUOTED_STRING" [
          "renameClause" ] [ SET "setPropertiesClause" ] {
          "setDrillItemKeyClause" | "unsetDrillItemKeyClause" }
     deleteDrillLevelKeyClause =  DRILL_LEVEL_KEY "QUOTED_STRING"
     unsetDrillItemKeyClause =  UNSET ( REF | REFERENCE ) ITEM "QUOTED_STRING"
          OF LOGICAL_TABLE "QUOTED_STRING"

Parameters

alterDrillPathCommand

This clause alters a drill path.

QUOTED_STRING

name of the drill path.

renameClause

Renames a drill path with a different name.

setPropertiesClause

This clause sets the properties of the object.

getPropertiesClause

Basic properties for DRILL_PATH:

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

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

Name: TIMEDIMENSION
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the drill path represents a time dimension. Oracle Business Intelligence Modules (OBIEE) only

Basic properties for DRILL_LEVEL:

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

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

Name: DEFAULT_ROOT_LEVEL
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level is a default root. Oracle Business Intelligence Modules (OBIEE) only

Name: GRAND_TOTAL_LEVEL
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level is a grand total level. Oracle Business Intelligence Modules (OBIEE) only

Name: SUPPORTS_ROLLUP
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the level supports rollup to a higher level of aggregation. Oracle Business Intelligence Modules (OBIEE) only

Basic properties for DRILL_LEVEL_KEY (Oracle Business Intelligence (OBIEE):

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

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

Name: PRIMARYKEY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level key is the primary key for the drill level. Oracle Business Intelligence Modules (OBIEE) only

Name: CHRONOLOGICALKEY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level key is the chronological key for a time dimension. Oracle Business Intelligence Modules (OBIEE) only

Name: USE_FOR_DRILLDOWN
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the level key is used for drill down. Oracle Business Intelligence Modules (OBIEE) only

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set.

alterDrillPathLevelClauses

This clause modifies a drill path.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

addDrillPathLevelClauseForAlter

This adds a drill level to a drill path.

QUOTED_STRING

name of the drill level.

addDrillLevelLinkClauseForAlter

This adds a drill level link from a parent to child level.

modifyDrillPathLevelClause

This modifies a drill level in a drill path.

QUOTED_STRING

name of the drill level.

deleteDrillPathLevelClause

This deletes a drill level from a drill path.

QUOTED_STRING

name of the drill level.

deleteDrillLevelLinkClause

This deletes a drill level link between parent and child levels.

propertyValue

This is a property value.

setDrillItemClause

This clause adds a reference to an item for the level.

addDrillLevelKey

This clause adds a level key to the level.

moveDrillLevel

Moves a drill level below another drill level.

unsetDrillItemClause

This clause removes a reference to an item for the level.

unsetJoinUsage

removes a join usage.

alterDrillLevelKeyClauses

Alters the drill level key.

itemJoinUsages

The specific joins to be used.

setDrillItemKeyClause

Associates an item with a drill level key.

addDrillLevelKeyforAlter

Adds a drill level key.

modifyDrillLevelKeyClause

Modifies a drill level key.

deleteDrillLevelKeyClause

Deletes a drill level key.

unsetDrillItemKeyClause

Removes the associaton to an item for a drill level key.

DRILL_PATH Object

Table 2-8 DRILL_PATH Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBCREATE DRILL_PATH

OMBRETRIEVE DRILL_PATH

OMBALTER DRILL_TO_DETAIL

Purpose

Alters a drill to detail.

Prerequisites

Should be in the context of a business definition module or use the full path.

Syntax

alterDrillToDetailCommand =  ( OMBALTER DRILL_TO_DETAIL "QUOTED_STRING" ( (
           "renameClause" [ SET "setPropertiesClause" ] [ SET
          "setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
          { "alterDrillToDetailClauses" } ) | ( SET "setPropertiesClause" [ SET
          "setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
          { "alterDrillToDetailClauses" } ) | ( SET "setReferenceIconSetClause"
          [ UNSET "unsetReferenceIconSetClause" ] { "alterDrillToDetailClauses"
          } ) | ( UNSET "unsetReferenceIconSetClause" {
          "alterDrillToDetailClauses" } ) | ( "alterDrillToDetailClauses" {
          "alterDrillToDetailClauses" } ) ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterDrillToDetailClauses =  "addDrillToDetailReferenceClause" | UNSET (
          REF | REFERENCE ) "deleteDrillToDetailClauses"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addDrillToDetailReferenceClause =  SET ( REF | REFERENCE ) ITEM
          "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
     deleteDrillToDetailClauses =  ( ITEM "QUOTED_STRING" OF ITEM_FOLDER
          "QUOTED_STRING" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterDrillToDetailCommand

This clause alters a drill to detail.

QUOTED_STRING

name of the drill to detail.

renameClause

Renames a drill to detail with a different name.

setPropertiesClause

This clause sets the properties of the object.

getPropertiesClause

Basic properties for DRILL_TO_DETAIL:

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

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

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set.

alterDrillToDetailClauses

This clause modifies a drill to detail.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

addDrillToDetailReferenceClause

This adds a reference to an item to a drill to detail.

deleteDrillToDetailClauses

This deletes a reference to an item from a drill to detail.

propertyValue

This is a property value.

DRILL_TO_DETAIL Object

Table 2-9 DRILL_TO_DETAIL Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBCREATE DRILL_TO_DETAIL

OMBRETRIEVE DRILL_TO_DETAIL

OMBALTER EXPERT

Purpose

To alter an expert.

Prerequisites

In the context of an expert module.

Syntax

alterExpertCommand =  OMBALTER EXPERT "QUOTED_STRING" ( "renameClause" {
          "alterPropertiesOrIconSetClause" } { "alterExpertDetailClauses" } |
          "alterPropertiesOrIconSetClause"+ { "alterExpertDetailClauses" } |
          "alterExpertDetailClauses"+ )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET "setPropertiesClause" | SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause"
     alterExpertDetailClauses =  ( ADD ( "addParameterClause" |
          "addVariableClause" | "addNestedExpertClause" | "addTaskClause" |
          "addTransitionClause" ) | MODIFY ( "modifyParameterClause" |
          "modifyVariableClause" | "modifyTaskClause" | "modifyTransitionClause"
           ) | DELETE ( "deleteParameterClause" | "deleteVariableClause" |
          "deleteTaskClause" | "deleteTransitionClause" ) )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     addParameterClause =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
           [ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
     addVariableClause =  VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
     addNestedExpertClause =  NESTED_EXPERT TASK "QUOTED_STRING" SET [
          "collectPropertiesClause" SET ] ( REF | REFERENCE ) EXPERT
          "QUOTED_STRING" [ SET "setReferenceIconSetClause" ]
     addTaskClause =  "TASK_TYPE" TASK "QUOTED_STRING" [ SET (
          "setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) ]
     addTransitionClause =  TRANSITION "QUOTED_STRING" FROM TASK "QUOTED_STRING"
           TO "QUOTED_STRING" [ SET "setPropertiesClause" ]
     modifyParameterClause =  "parameterLocator" ( "renameClause" [ SET
          "setPropertiesClause" ] [ "parameterBindingClause" ] | SET
          "setPropertiesClause" [ "parameterBindingClause" ] |
          "parameterBindingClause" )
     modifyVariableClause =  "variableLocator" ( "renameClause" [ SET
          "setPropertiesClause" ] | SET "setPropertiesClause" )
     modifyTaskClause =  TASK "QUOTED_STRING" ( "renameClause" {
          "alterPropertiesOrIconSetClause" } | "alterPropertiesOrIconSetClause"+
           )
     modifyTransitionClause =  TRANSITION "QUOTED_STRING" ( "renameClause" [ SET
           "setPropertiesClause" ] | SET "setPropertiesClause" )
     deleteParameterClause =  "parameterLocator"
     deleteVariableClause =  "variableLocator"
     deleteTaskClause =  TASK "QUOTED_STRING"
     deleteTransitionClause =  TRANSITION "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     parameterBindingClause =  UNBIND | BIND TO ( "parameterLocator" |
          "variableLocator" )
     collectPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     parameterLocator =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
     variableLocator =  VARIABLE "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterExpertCommand

Alter the definition of an expert.  The following lists all the default expert parameters:

1) EXP_LAUNCH_CONTEXT, type: STRING, direction: IN
The console context in which this expert is being launched.
2) EXP_LAUNCH_CONTEXT_TYPE, type: STRING, direction: IN
The type of the console context in which this expert is being launched.
3) EXP_OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) EXP_TYPE_TO_CREATE, type: STRING, direction: IN
The object type selected to be created when this expert is launched.

renameClause

Rename the expert.

alterPropertiesOrIconSetClause

Alter existing expert module properties and/or Icon Set.

alterExpertDetailClauses

Alter child objects of an expert.

setPropertiesClause

This clause sets properties for the corresponding object.

getPropertiesClause

Basic properties for EXPERT:

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

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

Basic properties for TASK:

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

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the task.  This is equivalent to the Goal of task in the expert editor.

Name: INSTRUCTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The instruction for the task

Name: PREPROCESSING
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The pre-processing script for the task

Name: MAIN
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The main script for the task

Name: POSTPROCESSING
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The post-processing script for the task

Basic propeties for START TASK:

Name: PROC_DECL
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The procedure declaration for the expert.

Basic properties for TRANSITION:

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

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

Name: TRANSITION_CONDITION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Condition of the transition

Name: TRANSITION_ORDER
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: N/A
Order of the transition

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: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the parameter

Name: DIRECTION
Type: STRING
Valid Values: IN, OUT, INOUT
Default: IN
Direction of the parameter.
Direction of custom expert parameter can only be IN or OUT.
For some tasks, direction of custom parameter can be IN, OUT or INOUT.

Name: VALUE
Type: Same as datatype of the parameter
Valid Values: Any valid character string in supported character set.
Default: N/A
The static value of the parameter

Basic properties for VARIABLE:

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

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

Name: DATATYPE
Type: STRING
Valid Values: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the variable

Name: VALUE
Type: Same as datatype of the variable
Valid Values: Any valid character string in supported character set.
Default: N/A
The static value of the variable

setReferenceIconSetClause

Set icon set for the expert module.

unsetReferenceIconSetClause

Unset icon set for expert.

addParameterClause

Add a parameter to the expert or one of it's tasks.

addVariableClause

Add a variable to the expert.

addNestedExpertClause

Add a nested expert to the expert. The nested expert is added by reference.

addTaskClause

Add a task to the expert.  Valid task types include: ADVANCED_QUEUE, ALTERNATIVE_SORT_ORDER, ANALYZE_IMPACT, ANALYZE_LINEAGE, BUSINESS_AREA, CATALOG_FOLDER, CHANGE_MANAGER, COMMIT, CONTROLCENTERJOBS, CUBE, CUSTOM_DIALOG, DATA_AUDITOR, DATA_PROFILE, DATA_RULE, DATA_VIEWER, DEPLOY, DERIVATION, DIMENSION, DIMENSION_DRILL_PATH, DRILL_PATH, DRILL_TO_DETAIL, END, EXTERNAL_TABLE, FLAT_FILE, FUNCTION, GENERATION, ITEM_FOLDER, JACL, JAVA, JDBC, JYTHON, LIST_OF_VALUES, LOGICAL_TABLE, MAPPING, MATERIALIZED_VIEW, NESTED_EXPERT, NESTED_KM, OBJECT_SELECTOR, OMB, OS, PLUGGABLE_MAPPING, PRESENTATION_TEMPLATE, PROCEDURE, PROCESS_FLOW, REGISTERED_FUNCTION, RUNTIME_API, SELECT_SOURCE, SELECT_TARGET, SEQUENCE, SOURCE_IMPORT, START, STARTJOB, TABLE, VALIDATION, VIEW, WEB_SERVICE.

Definition of each task is as follow:

Task type  : ADVANCED_QUEUE
Group      : MML
Description: A task to create or alter an advanced queue.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : ALTERNATIVE_SORT_ORDER
Group      : MML
Description: A task to create or alter an alternative sort order.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : ANALYZE_IMPACT
Group      : Service
Description: A task to analyze impact of an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object for analyzing impact.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object whose impact will be analyzed.

Task type  : ANALYZE_LINEAGE
Group      : Service
Description: A task to analyze lineage of an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object for analyzing lineage.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object whose lineage will be analyzed.

Task type  : BUSINESS_AREA
Group      : MML
Description: A task to create or alter a business area.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : CATALOG_FOLDER
Group      : MML
Description: A task to create or alter a catalog folder.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : CHANGE_MANAGER
Group      : Service
Description: A task to invoke the change manager.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : COMMIT
Group      : Service
Description: A task to perform commit in the design repository.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : CONTROLCENTERJOBS
Group      : Service
Description: A task to launch the Control Center Job Monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) CONTROL_CENTER_NAME, type: STRING, direction: IN
The Control Center to use.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : CUBE
Group      : MML
Description: A task to create or alter a cube.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : CUSTOM_DIALOG
Group      : UI
Description: A task to show a custom dialog for user interaction.
Built-in parameters:
1) GUI_RETURN_VALUE, type: ARRAY, direction: OUT
The return value of type ARRAY that stores the name and return value pair for each UI component.
2) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
3) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : DATA_AUDITOR
Group      : MML
Description: A task to create or alter a data auditor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DATA_PROFILE
Group      : MML
Description: A task to create or alter a data profile.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DATA_RULE
Group      : MML
Description: A task to create or alter a data rule.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DATA_VIEWER
Group      : Service
Description: A task to launch the data viewer.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of the OWB FCO, such as TABLE.
4) OBJECT_NAME, type: STRING, direction: IN
The name of the OWB FCO.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : DEPLOY
Group      : Service
Description: A task to launch the Control Center deployment monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) ACTION_PLAN_NAME, type: STRING, direction: IN
The deployment action plan to use.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : DERIVATION
Group      : Service
Description: A task to run derivation service.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to derive.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be derived.

Task type  : DIMENSION
Group      : MML
Description: A task to create or alter a dimension.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DIMENSION_DRILL_PATH
Group      : MML
Description: A task to create or alter a dimension drill path.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DRILL_PATH
Group      : MML
Description: A task to create or alter a drill path.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DRILL_TO_DETAIL
Group      : MML
Description: A task to create or alter a drill to detail.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : END
Group      : FlowControl
Description: A task that marks the end of the flow.
Built-in parameters:

Task type  : EXTERNAL_TABLE
Group      : MML
Description: A task to create or alter an external table.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : FLAT_FILE
Group      : MML
Description: A task to create or alter a file.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : FUNCTION
Group      : MML
Description: A task to create or alter a function.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : GENERATION
Group      : Service
Description: A task to invoke the generation dialog.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to generate.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be generated.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : ITEM_FOLDER
Group      : MML
Description: A task to create or alter an item folder.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : JACL
Group      : Runtime
Description: A task to execute Jacl code.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : JAVA
Group      : Integration
Description: A task to execute a Java program.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) CLASS_URL, type: STRING, direction: IN
The URL specification of the Jar file.  An example for a local jar file xyz.jar can be specified as file:/xyz.jar
4) CLASS_NAME, type: STRING, direction: IN
The class to load.  This includes the package as well in dotted notation.  For example, oracle.owb.Test
5) METHOD_NAME, type: STRING, direction: IN
The static method to execute.
6) ARGUMENT_LIST, type: STRING, direction: IN
The argument list to be passed into the static method.

Task type  : JDBC
Group      : Runtime
Description: A task to connect to a database and execute SQL DDL and DML statements.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : JYTHON
Group      : Runtime
Description: A task to execute Jython code.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : LIST_OF_VALUES
Group      : MML
Description: A task to create or alter a list of values.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : LOGICAL_TABLE
Group      : MML
Description: A task to create or alter an item folder.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : MAPPING
Group      : MML
Description: A task to create or alter a mapping.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : MATERIALIZED_VIEW
Group      : MML
Description: A task to create or alter a materialized view.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : NESTED_EXPERT
Group      : FlowControl
Description: A task that references another expert.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : NESTED_KM
Group      : FlowControl
Description: A task that references another knowledge module.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : OBJECT_SELECTOR
Group      : UI
Description: A task that shows a dialog for user to select an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) OBJECT_TYPE, type: STRING, direction: IN
The type of object for selection.

Task type  : OMB
Group      : Integration
Description: A task to launch a generic OMB script.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : OS
Group      : Runtime
Description: A task to execute an OS call.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : PLUGGABLE_MAPPING
Group      : MML
Description: A task to create or alter a pluggable mapping.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : PRESENTATION_TEMPLATE
Group      : MML
Description: A task to create or alter a presentation template.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : PROCEDURE
Group      : MML
Description: A task to create or alter a procedure.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : PROCESS_FLOW
Group      : MML
Description: A task to create or alter a process flow.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : REGISTERED_FUNCTION
Group      : MML
Description: A task to create or alter a registered function.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : RUNTIME_API
Group      : Runtime
Description: A task to execute a runtime API call.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : SELECT_SOURCE
Group      : UI
Description: A task that allows users to pick a metadata source.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) MODULE_NAME, type: STRING, direction: OUT
The name of the module.
5) LOCATION_NAME, type: STRING, direction: OUT
The name of the location for this connection.
6) OBJECT_TYPE, type: STRING, direction: OUT
The type of object selected as the source.
7) SOURCE_TYPE, type: STRING, direction: INOUT
The type of the source, e.g. file or database.

Task type  : SELECT_TARGET
Group      : UI
Description: A task that allows users to pick a target.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) MODULE_NAME, type: STRING, direction: OUT
The name of the module.
5) LOCATION_NAME, type: STRING, direction: OUT
The name of the location for this connection.
6) OBJECT_TYPE, type: STRING, direction: OUT
The type of object selected as the target.
7) SOURCE_TYPE, type: STRING, direction: INOUT
The type of the source, e.g. file or database.

Task type  : SEQUENCE
Group      : MML
Description: A task to create or alter a sequence.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : SOURCE_IMPORT
Group      : Service
Description: A task to invoke the import wizard.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) OBJECT_TYPE, type: STRING, direction: IN
The type of object to import.
5) IMPORT_MODE, type: STRING, direction: IN
The mode for import.  Select FULL_MODE for importing multiple objects, or MINIMAL_MODE for single import.

Task type  : START
Group      : FlowControl
Description: A task that marks the beginning of the flow.
Built-in parameters:

Task type  : STARTJOB
Group      : Service
Description: A task to launch the start job monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to be started.
4) OBJECT_PATH, type: STRING, direction: IN
The context path of the object to be started.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : TABLE
Group      : MML
Description: A task to create or alter a table.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : VALIDATION
Group      : Service
Description: A task to invoke the validation dialog.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to validate.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be validated.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : VIEW
Group      : MML
Description: A task to create or alter a view.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : WEB_SERVICE
Group      : MML
Description: A task to create or alter a web service.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

addTransitionClause

Add a transition to the expert.

modifyParameterClause

Modify the definition of a parameter.

modifyVariableClause

Modify the definition of a variable.

modifyTaskClause

Modify the definition of a task.

modifyTransitionClause

Modify the definition of a transition.

deleteParameterClause

Delete a parameter.

deleteVariableClause

Delete a variable.

deleteTaskClause

Delete a task expert.

deleteTransitionClause

Delete a transition.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

parameterBindingClause

Bind or unbind two parameters. Note that this is setting the binding attribute of the parameter object and is not necessarily the same as the direction of data flow. The parameter to be set should be the one whose binding attribute is modified via the Object Inspector in the expert editor.

collectPropertiesClause

This clause sets properties for the corresponding object.

parameterLocator

Specify a parameter, either one of the expert or of a task.

variableLocator

Specify a variable in the expert.

propertyValue

Value of a property.

EXPERT Object

Table 2-10 EXPERT Object

Property
Type
Choices
Min
Max
Default
Description

CLOSE_ASSISTANT_ON_COMPLETION

BOOLEAN

true, false

none

none

true

Sets whether the task assistant should be automatically closed after the expert has been run.

CLOSE_WINDOWS_ON_EXECUTION

BOOLEAN

true, false

none

none

true

Close all open windows when this expert is run.

FINISH_DIALOG_ON_COMPLETION

BOOLEAN

true, false

none

none

true

Shows the finish dialog upon completion of expert.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

LOGGING

BOOLEAN

true, false

none

none

false

MENU_ITEM_DISPLAY_STRING

STRING

none

none

none

empty string

The display string when this expert is added as a menu item.

ONLY_RUN_FROM_MENU

BOOLEAN

true, false

none

none

false

Only allow this expert to be run when it is attached to a menu item.

REVERT_TO_SAVED_ON_ERROR

BOOLEAN

true, false

none

none

false

Revert to saved metadata if error occurs when the expert is run.

RUN_STANDALONE

BOOLEAN

true, false

none

none

true

Sets whether the expert should be run as a standalone in expert assistant mode or not.

SAVE_ALL_BEFORE_START

BOOLEAN

true, false

none

none

false

Save all metadata before running the expert.

SHOW_BUSY_DIALOG

BOOLEAN

true, false

none

none

true

Sets whether busy dialog should be shown when OMB or Java tasks are executed in non-standalone mode.

SHOW_LOG_WINDOW

BOOLEAN

true, false

none

none

false

Sets whether the log window should be shown when running the expert.

SHOW_PROGRESS_GRAPH

BOOLEAN

true, false

none

none

true

Sets whether the progress graph dialog should be shown when running the expert.

SHOW_TASK_ASSISTANT

BOOLEAN

true, false

none

none

true

Sets whether the task assistant should be shown when running the expert.

See Also

OMBALTER

OMBCREATE EXPERT

OMBRETRIEVE EXPERT

OMBDROP EXPERT

OMBALTER EXPERT_MODULE

Purpose

To alter an expert module.

Prerequisites

In the context of a project.

Syntax

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

Parameters

alterExpertModuleCommand

Alter the definition of an expert module.

renameClause

Rename the expert module.

alterPropertiesOrIconSetClause

Alter existing expert module properties and/or Icon Set.

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.

unsetReferenceIconSetClause

Unset 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.

See Also

OMBALTER

OMBCREATE EXPERT_MODULE

OMBDROP EXPERT_MODULE

OMBALTER EXTERNAL_TABLE

Purpose

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

Prerequisites

Should be in the context of an Oracle Module.

Syntax

alterExternalTableCommand =  OMBALTER ( EXTERNAL_TABLE "QUOTED_STRING" (
          "renameClause" [ "alterExternalTablePropertiesAndReferencesClause" ] [
           "alterExternalTableObjectClauses" ] |
          "alterExternalTablePropertiesAndReferencesClause" [
          "alterExternalTableObjectClauses" ] |
          "alterExternalTableObjectClauses" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterExternalTablePropertiesAndReferencesClause =  SET (
          "setPropertiesClause" [ SET ( REF | REFERENCE )
          "alterReferencesToRecordAndLocationClauses" | UNSET ( REF | REFERENCE
          ) "unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
          "alterReferencesToRecordAndLocationClauses" ) | UNSET ( REF |
          REFERENCE ) "unsetReferenceIconSetClause"
     alterExternalTableObjectClauses =  ADD ( "addExternalTableObjectClause" [
          "alterExternalTableObjectClauses" ] | "addDataRuleUsageClause" {
          "alterDataRuleUsageClauses" } ) | MODIFY (
          "modifyExternalTableObjectClause" [ "alterExternalTableObjectClauses"
          ] | "addDataRuleUsageClause" { "alterDataRuleUsageClauses" } ) |
          DELETE ( "deleteExternalTableObjectClause" [
          "alterExternalTableObjectClauses" ] | "deleteDataRuleUsageClause" {
          "alterDataRuleUsageClauses" } )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     alterReferencesToRecordAndLocationClauses =
          "setReferencesToRecordFileModuleClause" [
          "setReferencesToLocationClause" ] [ SET ( REF | REFERENCE )
          "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause" ] | "setReferencesToFileAndModuleClause"
           [ "setReferencesToLocationClause" ] [ SET ( REF | REFERENCE )
          "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause" ] | "setReferencesToLocationClause" [
          SET ( REF | REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF |
          REFERENCE ) "unsetReferenceIconSetClause" ] |
          "setReferenceIconSetClause"
     unsetReferenceIconSetClause =  ICONSET
     addExternalTableObjectClause =  COLUMN "QUOTED_STRING" [ AT POSITION
          "INTEGER_LITERAL" ] [ SET "setPropertiesAndReferencesToFieldClauses" ]
           | "addExternalTableDatafileClause"
     addDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" SET REF DATA_RULE
           "QUOTED_STRING" ( GROUP "QUOTED_STRING" SET REF ( TABLE | VIEW |
          MATERIALIZED_VIEW | EXTERNAL_TABLE ) "QUOTED_STRING" ( ATTRIBUTE
          "QUOTED_STRING" SET REF COLUMN "QUOTED_STRING" )+ )+ [ SET
          "setPropertiesClause" ]
     alterDataRuleUsageClauses =  ADD "addDataRuleUsageClause" | MODIFY
          "modifyDataRuleUsageClause" | DELETE "deleteDataRuleUsageClause"
     modifyExternalTableObjectClause =  COLUMN "QUOTED_STRING" ( "renameClause"
          [ "moveExternalTableColumnToClause" ] [ SET
          "setPropertiesAndReferencesToFieldClauses" ] |
          "moveExternalTableColumnToClause" [ SET
          "setPropertiesAndReferencesToFieldClauses" ] | SET
          "setPropertiesAndReferencesToFieldClauses" ) | DATA_FILE
          "QUOTED_STRING" ( "renameClause" [ SET "setPropertiesClause" ] | SET
          "setPropertiesClause" )
     deleteExternalTableObjectClause =  COLUMN "QUOTED_STRING" | DATA_FILE
          "QUOTED_STRING"
     deleteDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferencesToRecordFileModuleClause =  RECORD "QUOTED_STRING" OF
          FLAT_FILE "QUOTED_STRING"
     setReferencesToLocationClause =  DEFAULT_LOCATION "QUOTED_STRING"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     setReferencesToFileAndModuleClause =  FLAT_FILE "QUOTED_STRING"
     setPropertiesAndReferencesToFieldClauses =  "setPropertiesClause" [ SET (
          REF | REFERENCE ) "setReferencesToFieldClause" ] | ( REF | REFERENCE )
           "setReferencesToFieldClause"
     addExternalTableDatafileClause =  DATA_FILE "QUOTED_STRING" [ SET
          "setPropertiesClause" ]
     modifyDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" (
          "renameClause" [ SET "setPropertiesClause" ] | SET
          "setPropertiesClause" )
     moveExternalTableColumnToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setReferencesToFieldClause =  FIELD "QUOTED_STRING"

Parameters

alterExternalTableCommand

Alter the existing external table.

QUOTED_STRING

The name of the external table to alter.

renameClause

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

alterExternalTablePropertiesAndReferencesClause

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

alterExternalTableObjectClauses

Add, modify, or delete columns or data files.

setPropertiesClause

Set specified properties of the external table.

alterReferencesToRecordAndLocationClauses

Set the referenced record and/or default location and/or references to iconset.

unsetReferenceIconSetClause

Set specified Icon Set.

addExternalTableObjectClause

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

addDataRuleUsageClause

Add a data rule usage to the relation.

alterDataRuleUsageClauses

Add, modify, or delete data rule usages.

modifyExternalTableObjectClause

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

deleteExternalTableObjectClause

Delete a column or data file.

deleteDataRuleUsageClause

Delete a data rule usage.

propertyNameList

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

propertyNameList

propertyNameList

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: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2
Default: NUMBER
The datatype of a column

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

Name: PRECISION
Type: NUMBER
Valid Values: 0 - 38
Default: 1
The precision of a number. Use 0 to specify floating-point numbers.

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

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

propertyValueList

The values for the named properties.

setReferencesToRecordFileModuleClause

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

setReferencesToLocationClause

Specify the default location for the external table.

setReferenceIconSetClause

Set specified Icon Set.

setReferencesToFileAndModuleClause

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

setPropertiesAndReferencesToFieldClauses

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

addExternalTableDatafileClause

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

modifyDataRuleUsageClause

Rename or modify the properties of a data rule usage.

moveExternalTableColumnToClause

Move a column of the external table.

propertyValue

A property value.

setReferencesToFieldClause

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

EXTERNAL_TABLE Object

Table 2-11 EXTERNAL_TABLE Object

Property
Type
Choices
Min
Max
Default
Description

BAD_FILE_LOCATION

STRING

none

none

none

USE_DEFAULT_LOCATION

BAD_FILE_NAME

STRING

none

none

none

empty string

CONFIGURATION_DEFAULT_LOCATION

STRING

none

none

none

empty string

Customized location default within each configuration of an external table. If not defined, overall default location of an external table is used.

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Description not available.

DISCARD_FILE_LOCATION

STRING

none

none

none

USE_DEFAULT_LOCATION

DISCARD_FILE_NAME

STRING

none

none

none

empty string

ENDIAN

STRING

BIG, LITTLE, PLATFORM

none

none

PLATFORM

Description not available.

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string

Description not available.

ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string

Description not available.

GENERATE_ERROR_TABLE_ONLY

BOOLEAN

true, false

none

none

false

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

LOAD_NULLS_WHEN_MISSING_VALUES

BOOLEAN

true, false

none

none

false

Description not available.

LOG_FILE_LOCATION

STRING

none

none

none

USE_DEFAULT_LOCATION

LOG_FILE_NAME

STRING

none

none

none

empty string

The name of the file that will store the log messages

NLS_CHARACTERSET

STRING

none

none

none

empty string

NLS Characterset of the file. When the Access Parameters property is specified for the External Table, this configuration parameter is ignored.

NUMBER_OF_REJECTS_ALLOWED

NUMBER

none

0

2147483647

0

Description not available.

PARALLEL_ACCESS_DRIVERS

NUMBER

none

1

63999

1

Description not available.

PARALLEL_ACCESS_MODE

BOOLEAN

true, false

none

none

false

Description not available.

REJECTS_ARE_UNLIMITED

BOOLEAN

true, false

none

none

true

Description not available.

STRING_SIZES_IN

STRING

BYTES, CHARACTERS

none

none

BYTES

Description not available.

TRIM

STRING

BOTH, LEFT, NONE, RIGHT, SQL*LOADER

none

none

NONE

EXTERNAL_TABLE_COLUMN Object

Table 2-12 EXTERNAL_TABLE_COLUMN Object

Property
Type
Choices
Min
Max
Default
Description

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

DATA_FILE Object

Table 2-13 DATA_FILE Object

Property
Type
Choices
Min
Max
Default
Description

DATA_FILE_LOCATION

STRING

none

none

none

USE_DEFAULT_LOCATION

DATA_FILE_NAME

STRING

none

none

none

empty string

SOURCE_DATA_FILE_DIRECTORY

STRING

none

none

none

empty string

SOURCE_DATA_FILE_NAME

STRING

none

none

none

empty string

See Also

OMBALTER

OMBCREATE EXTERNAL_TABLE

OMBDROP EXTERNAL_TABLE

OMBRETRIEVE EXTERNAL_TABLE

OMBALTER FLAT_FILE

Purpose

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

Prerequisites

Should be in the context of a flat file module.

Syntax

alterFlatFileCommand =  OMBALTER ( FLAT_FILE "QUOTED_STRING" (
          "renameClause" [ "alterPropertiesOrIconSetClause" ] [
          "importCopybookClause" ] { "alterRecordClauses" } | "renameClause" [
          "alterPropertiesOrIconSetClause" ] { "alterRecordClauses" } |
          "alterPropertiesOrIconSetClause" [ "importCopybookClause" ] {
          "alterRecordClauses" } | "alterPropertiesOrIconSetClause" {
          "alterRecordClauses" } | "alterRecordClauses" { "alterRecordClauses" }
           | "importCopybookClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
     importCopybookClause =  IMPORT ( COPYBOOK "QUOTED_STRING" { EXCLUDE
          "excludeGroupsClause" | EXCLUDE "excludeRedefinesClause" |
          STORAGE_BOUNDARY "storageBoundaryClause" | ON_ERROR "onErrorClause" |
          MESSAGE_LEVEL "messageLevelClause" } )
     alterRecordClauses =  ADD "addRecordClauseForAlter" | MODIFY
          "modifyRecordClause" | DELETE "deleteRecordClause"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     excludeGroupsClause =  GROUPS
     excludeRedefinesClause =  REDEFINES
     storageBoundaryClause =  "INTEGER_LITERAL"
     onErrorClause =  ( CHECK | LOAD_VALID | CANCEL )
     messageLevelClause =  ( NONE | ERROR | WARNING | INFO )
     addRecordClauseForAlter =  RECORD "QUOTED_STRING" [ SET
          "setPropertiesClause" ] { ADD "addFieldClauseForAlter" }
     modifyRecordClause =  RECORD "QUOTED_STRING" ( "renameClause" [ SET
          "setPropertiesClause" ] { "alterFieldClauses" } | SET
          "setPropertiesClause" { "alterFieldClauses" } | "alterFieldClauses" {
          "alterFieldClauses" } )
     deleteRecordClause =  RECORD "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addFieldClauseForAlter =  FIELD "QUOTED_STRING" [ AT POSITION
          "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     alterFieldClauses =  ADD "addFieldClauseForAlter" | MODIFY
          "modifyFieldClause" | DELETE "deleteFieldClause"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     modifyFieldClause =  FIELD "QUOTED_STRING" ( "renameClause" [
          "moveFieldToClause" ] [ SET "setPropertiesClause" ] |
          "moveFieldToClause" [ SET "setPropertiesClause" ] | SET
          "setPropertiesClause" )
     deleteFieldClause =  FIELD "QUOTED_STRING"
     moveFieldToClause =  MOVE TO POSITION "INTEGER_LITERAL"

Parameters

alterFlatFileCommand

Alter a flat file.

QUOTED_STRING

The name of the flat file to alter.

renameClause

Rename the flat file to the following quoted string.

alterPropertiesOrIconSetClause

Set the properties and/or reference icon set of the flat file.

importCopybookClause

Import a COBOL copybook.

QUOTED_STRING

The file containing the copybook.

alterRecordClauses

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

setPropertiesClause

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

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set.

excludeGroupsClause

Indicates that fields should not be created for group items.

excludeRedefinesClause

Indicates that fields should not be created for redefined items or items subordinate to redefined items.

storageBoundaryClause

Specifies the storage boundary for the data in the file.

onErrorClause

Specifies how the processing should continue if an error is encountered.

messageLevelClause

Specifies the types of messages to be shown.

addRecordClauseForAlter

Add a record named by the following quoted string.

modifyRecordClause

Modify a record specified by the following quoted string.

deleteRecordClause

Delete a record specified by the following quoted string.

propertyNameList

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

propertyNameList

Properties for FLAT_FILE:

Name: DATA_FILE_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default ''
The name of the "sampled" file.  Also the default data file value used in SQL*Loader maps and External Tables.

Name: IS_DELIMITED
Type: BOOLEAN
Valid Values: true, false, 1, 0
Default: true
True indicates that this flat file is delimited.  False indicates that its fields are defined by fixed lengths

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

Name: RECORD_DELIMITER
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The character(s) which denote the end of a physical record in a data file.  A hex value may be entered by entering embedded single quotes twice as:   'x''0f''' (all are single quotes).  The outside single quote indicates a quoted string and the inside single quotes  single-quote  x  single-quote single-quote   0F  single-quote single-quote single-quote.  (Please note that this is not the FIELD_DELIMITER.

Name: RECORD_LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0 (Records are delimited by default)
The length (in characters) of the records in the data file.

Name: RECORD_TYPE_COLUMN_NUMBER
Type: NUMBER
Valid Values: 0+
Default: 0
The column which contains the record type values for a delimited, multi-record type file.

Name: RECORD_TYPE_START_POSITION
Type: NUMBER
Valid Values: 0+
Default: 0
The starting position of the field (relative to 0) which contains the record type values for a fixed-length, multi-record type file.

Name: RECORD_TYPE_END_POSITION
Type: NUMBER
Valid Values: 0+
Default: 0
The ending position of the field (relative to 0) which contains the record type values for a fixed-length, multi-record type file.

propertyNameList

Name: NUMBER_OF_RECORDS_TO_SKIP
Type: NUMBER
Valid Values: 0 - 1000
Default: 0
The default number of records to skip when loading this file.

Name: FIELD_DELIMITER
Type: STRING
Valid Values: Any single character
Default: ',' (Comma)
The character to divide the fields in a delimited file.

Name: FIELD_LEFT_ENCLOSURE
Type: STRING
Valid Values: Any single character
Default: None
A character to enclose fields which may contain the field delimiter.

Name: FIELD_RIGHT_ENCLOSURE
Type: STRING
Valid Values: Any single character
Default: None
A character to enclose fields which may contain the field delimiter.

Name: NUMBER_OF_PHYSICAL_RECORDS_PER_LOGICAL
Type: Number
Valid Values: 0+
Default: 0
Set this value if you wish to concatenate a fixed number of physical records to form a single logical record.

Name: CONTINUE_IF_ENDS_WITH
Type: STRING
Valid Values: Any single character
Default: None
Set this value if you wish to concatenate a variable number of physical records to form a single logical record, determined by records ending with this character.

Name: CONTINUE_IF_STARTS_WITH
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: None
Set this value if you wish to concatenate a variable number of physical records to form a single logical record, determined by records beginning with this character.

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

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

Properties for RECORD:

Name: RECORD_TYPE_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: None
This is a mandatory property for each record of a multi-record type file.  It is the string which will identify this record type in the data file.

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

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

Properties for FIELD:

Name: DATATYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE, FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARRAW, VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
This is the SQL*Loader data type for the field.

Name: MAXIMUM_LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0
This is the maximum length of the field.

Name: LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0
Depreciated.  This is the length of the field in a fixed length file.  This is the max length of the field in a delimited file.

Name: PRECISION
Type: NUMBER
Valid Values: Depends on data type
Default: 0
Precision of the field.

Name SCALE
Type: NUMBER
Valid Values: Depends on data type
Default: 0
Scale of the field

Name: START_POSITION
Type: NUMBER
Valid Values: 1+
Default: 1
The starting position of a field for a fixed length file.

Name: END_POSITION
Type: NUMBER
Valid Values: 1+
Default: 1
The ending position of a field for a fixed length file.

propertyNameList

Name: SQL_DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: DEFAULT.  This will derive the SQL_DATATYPE from the value of DATATYPE.
The data type which the field will be treated as in mapping and for External Tables.

Name: SQL_LENGTH
Type: NUMBER
Valid Values: 1 - 4000
Default: 0

Name: SQL_PRECISION
Type: NUMBER
Valid Values: 1 - 38
Default: 1

Name: SQL_SCALE
Type: NUMBER
Valid Values: -84 - 127
Default: 0

Name: MASK
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: None
This is the mask used to define the format of DATE fields in the data file.

Name: NULL_IF
Type: STRING
Valid Values: Either = or != followed by either 'BLANKS', a single quoted string, or a hexadecimal string
Default: None
If this condition is true for a field, the value loaded will be NULL.

Name: DEFAULT_IF
Type: STRING
Valid Values: Either = or != followed by either 'BLANKS', a single quoted string, or a hexadecimal string
Default: None
If this condition is true for a field, the value loaded will be either NULL or 0, dependent on data type.

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

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

propertyValueList

The values for the named properties.

addFieldClauseForAlter

Add a field to the record.

alterFieldClauses

Add, modify, or drop a field.

propertyValue

A property value.

modifyFieldClause

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

deleteFieldClause

Delete a field specified by the following quoted string.

moveFieldToClause

Move a field to a new position in the record.

See Also

OMBALTER

OMBCREATE FLAT_FILE

OMBDROP FLAT_FILE

OMBALTER FLAT_FILE_MODULE

Purpose

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

Prerequisites

Should be in the context of a project.

Syntax

alterFlatFileModuleCommand =  OMBALTER ( FLAT_FILE_MODULE "QUOTED_STRING" (
           "renameClause" [
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule =  (
          "alterJournalCodeTemplateClause" [
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceClauseForDataMetadataModule" )
     alterJournalCodeTemplateClause =  SET "setJournalCodeTemplateClause" |
          UNSET "unsetJournalCodeTemplateClause"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( (
          "alterPropertiesClause" [ ( SET
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | (
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     setJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT "QUOTED_STRING"
          | ( ( REFERENCE | REF ) CDC_CT OPTIONS "(" "propertyValueList" ")"
          VALUES "(" "propertyValueList" ")" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  (
          "unsetReferenceLocationClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "setJournalCodeTemplateClause" [ SET
          "setReferenceMetadataLocationOrIconSetClause" ] |
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "unsetJournalCodeTemplateClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetClause" ] |
          "unsetReferenceMetadataLocationOrIconSetClause" )
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" SET AS DEFAULT
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setReferenceMetadataLocationOrIconSetClause =  (
          "setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
           ] | "setReferenceIconSetClause" )
     unsetReferenceMetadataLocationOrIconSetClause =  (
          "unsetReferenceMetadataLocationClause" [ UNSET
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceMetadataLocationClause =  ( REFERENCE | REF )
          METADATA_LOCATION "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

alterFlatFileModuleCommand

Alter a flat file module.

QUOTED_STRING

The name of the flat file module to alter.

renameClause

Rename the flat file module.

QUOTED_STRING

The new name for the flat file module.

alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule

Set properties and/or metadata location and/or icon set and/or journal code template for the flat file module.

alterPropertiesOrReferenceClauseForDataMetadataModule

Set properties and/or metadata location for the flat file module.

alterPropertiesClause

Set the properties for the flat file module.

setReferenceClauseForDataMetadataModule

Set data location and/or icon set for the flat file module.

unsetReferenceClauseForDataMetadataModule

Unset location and/or icon set for the flat file module.

addOrRemoveOrModifyModuleReferenceLocationClause

Add/remove/modify data location for the flat file module.

propertyValueList

The values for the named properties.

propertyNameList

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

propertyNameList

Basic properties for FLAT_FILE_MODULE:

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

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

setReferenceLocationClause

Set a data location to the existing flat file module as the new configuration default.

setReferenceMetadataLocationOrIconSetOrJCTClause

Set metadata location and/or icon set and/or journal code template for the flat file module.

unsetReferenceLocationClause

Unset a data location to the existing flat file module.

unsetReferenceMetadataLocationOrIconSetOrJCTClause

Unset metadata location and/or icon set and/or journal code template for the flat file module.

addReferenceLocationClause

Add a data location to the flat file module.

removeReferenceLocationClause

Remove a data location from the flat file module.

modifyReferenceLocationClause

Modify a data location of the flat file module.

propertyValue

A property value.

setReferenceMetadataLocationOrIconSetClause

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

unsetReferenceMetadataLocationOrIconSetClause

Unset metadata location and/or icon set for the flat file module.

setReferenceMetadataLocationClause

Set metadata location for the flat file module.

setReferenceIconSetClause

Set icon set for the flat file module.

unsetReferenceMetadataLocationClause

Unset metadata location for the flat file module.

unsetReferenceIconSetClause

Unset icon set for the flat file module.

See Also

OMBALTER

OMBCREATE FLAT_FILE_MODULE

OMBDROP FLAT_FILE_MODULE

OMBALTER FOLDER

Purpose

Alter the folder by renaming it, and/or reset its properties, and/or adding/removing contained objects..

Prerequisites

Should be in the context of a module (Oracle, Non-Oracle, Aplications, Process Flow types) or a folder.

Syntax

alterUserFolderCommand =  OMBALTER ( FOLDER "QUOTED_STRING" ( [
          "renameClause" ] [ SET "setPropertiesClause" [ SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
          SET "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause"
          ] [ "alterContainedObjects" ] ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterContainedObjects =  ( "addContainedObjClause" |
          "removeContainedObjClause" )+
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addContainedObjClause =  ADD CONTAINED_OBJECT "containedObjTypeClause"
          "QUOTED_STRING"
     removeContainedObjClause =  REMOVE CONTAINED_OBJECT
          "containedObjTypeClause" "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     containedObjTypeClause =  ( TABLE | VIEW | PACKAGE | DIMENSION |
          MATERIALIZED_VIEW | SEQUENCE | CUBE | DATA_AUDITOR | ADVANCED_QUEUE |
          QUEUE_TABLE | EXTERNAL_TABLE | VARYING_ARRAY | OBJECT_TYPE |
          NESTED_TABLE | MAPPING | PLUGGABLE_MAPPING | PROCESS_FLOW_PACKAGE |
          FUNCTION | TABLE_FUNCTION | PROCEDURE )

Parameters

alterUserFolderCommand

This command modifies an existing folder.

QUOTED_STRING

Name of the existing folder in single quotes.

renameClause

Rename a folder.

setPropertiesClause

Associate a set of properties with the existing folder.

propertiesClause

Basic properties for FOLDER:

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

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

setReferenceIconSetClause

Set icon set for the folder.

unsetReferenceIconSetClause

Unset icon set for the folder.

alterContainedObjects

Adds or removes a contained object to/from the folder.

propertyNameList

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

propertyValueList

Comma separated list of property values.

addContainedObjClause

Adds a contained object to the folder.

removeContainedObjClause

Removes a contained object from the folder.

propertyValue

Value of a property.

containedObjTypeClause

The type of the contained object to be added or removed. Valid object types are: TABLE | VIEW | PACKAGE | DIMENSION | MATERIALIZED_VIEW | SEQUENCE | CUBE | ADVANCED_QUEUE | STREAMS_QUEUE | QUEUE_TABLE | EXTERNAL_TABLE | VARYING_ARRAY | OBJECT_TYPE | NESTED_TABLE | MAPPING | PROCESS_FLOW_PACKAGE | FUNCTION | PROCEDURE.

See Also

OMBALTER

OMBCREATE FOLDER

OMBALTER FUNCTION

Purpose

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

Prerequisites

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

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

alterFunctionCommand =  OMBALTER ( FUNCTION "QUOTED_STRING" (
          "renameClause" [ "alterPropertiesOrIconSetClause" ] [
          "alterFuncProcParameterImplementationSCOClause" ] |
          "alterPropertiesOrIconSetClause" [
          "alterFuncProcParameterImplementationSCOClause" ] |
          "alterFuncProcParameterImplementationSCOClause" |
          "alterFunctionCodeTemplateClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
     alterFuncProcParameterImplementationSCOClause =  ( ADD (
          "alterFuncProcParameterClause" | "addRelationalDependentClause" |
          "addFuncImplementationClause" ) | MODIFY (
          "modifyFuncProcParameterClause" | "modifyFuncProcImplementationClause"
           ) | DELETE ( "deleteFuncProcParameterClause" |
          "deleteRelationalDependentClause" |
          "deleteFuncProcImplementationClause" ) ) [
          "alterFuncProcParameterImplementationSCOClause" ]
     alterFunctionCodeTemplateClause =  SET "setFunctionCodeTemplateClause" |
          UNSET "unsetFunctionCodeTemplateClause"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterFuncProcParameterClause =  PARAMETER "QUOTED_STRING" [ AT POSITION
          "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     addRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
          "QUOTED_STRING"
     addFuncImplementationClause =  FUNCTION_IMPLEMENTATION "QUOTED_STRING" [
          SET "setFuncImplPropertiesClause" ]
     modifyFuncProcParameterClause =  ( PARAMETER "QUOTED_STRING" (
          "renameClause" | "moveToClause" | [ SET "setPropertiesClause" ] ) )
     modifyFuncProcImplementationClause =  ( FUNCTION_IMPLEMENTATION
          "QUOTED_STRING" ( "renameClause" [ SET "setFuncImplPropertiesClause" ]
           | [ SET "setFuncImplPropertiesClause" ] ) )
     deleteFuncProcParameterClause =  ( PARAMETER "QUOTED_STRING" )
     deleteRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
          "QUOTED_STRING"
     deleteFuncProcImplementationClause =  ( FUNCTION_IMPLEMENTATION
          "QUOTED_STRING" )
     setFunctionCodeTemplateClause =  ( REFERENCE | REF ) CODE_TEMPLATE
          "QUOTED_STRING" FOR PLATFORM "QUOTED_STRING" | ( ( REFERENCE | REF )
          CODE_TEMPLATE FOR PLATFORM "QUOTED_STRING" OPTIONS "("
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")" )
     unsetFunctionCodeTemplateClause =  ( REFERENCE | REF ) CODE_TEMPLATES | (
          REFERENCE | REF ) CODE_TEMPLATE FOR PLATFORM "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setFuncImplPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES
           "(" "propertyValueList" ")"
     moveToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterFunctionCommand

This command modifies an existing Function.

QUOTED_STRING

Name of the existing Function in single quotes.

renameClause

Rename a Function.

alterPropertiesOrIconSetClause

Alter function properties or icon set.

alterFuncProcParameterImplementationSCOClause

Used to alter, modify or delete function parameter, implementation or dependency.

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 function reference icon set.

unsetReferenceIconSetClause

Unset reference icon set to this function.

alterFuncProcParameterClause

This clause alters Parameter of a Function.

addRelationalDependentClause

This clause adds referential dependencies to other relational objects.

addFuncImplementationClause

Add implementation to this function.

modifyFuncProcParameterClause

Modify one or more Parameters to this Function/Procedure.

modifyFuncProcImplementationClause

Used to modify function implementation.

deleteFuncProcParameterClause

Delete one or more Parameters to this Function/Procedure.

deleteRelationalDependentClause

This clause deletes referential dependencies to other relational objects.

deleteFuncProcImplementationClause

Used to delete a function implementation.

propertyNameList

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

propertyValueList

Comma separated list of property values.

setFuncImplPropertiesClause

Used to set function implementation properties.

moveToClause

Move a Parameters of this Function/Procedure.

propertyValue

Value of a property.

FUNCTION Object

Table 2-14 FUNCTION Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER

OMBCREATE FUNCTION

OMBDROP FUNCTION

OMBALTER GATEWAY_MODULE

Purpose

Alter the Gateway module by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of project.

Syntax

alterGatewayModuleCommand =  OMBALTER ( GATEWAY_MODULE "QUOTED_STRING" (
          "renameClause" [
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( (
          "alterPropertiesClause" [ ( SET
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | (
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  (
          "unsetReferenceLocationClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "setJournalCodeTemplateClause" [ SET
          "setReferenceMetadataLocationOrIconSetClause" ] |
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "unsetJournalCodeTemplateClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetClause" ] |
          "unsetReferenceMetadataLocationOrIconSetClause" )
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( 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" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     unsetReferenceMetadataLocationOrIconSetClause =  (
          "unsetReferenceMetadataLocationClause" [ UNSET
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceMetadataLocationClause =  ( REFERENCE | REF )
          METADATA_LOCATION "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

alterGatewayModuleCommand

This command modifies an existing Gateway module.

QUOTED_STRING

Name of the existing Gateway module in single quotes.

renameClause

Rename the Gateway module.

alterPropertiesOrReferenceClauseForDataMetadataModule

Alter existing Gateway module's properties and/or locations and/or icon sets.

alterPropertiesClause

Associate a set of properties with the existing Oracle module.

alterPropertiesClause

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 Oracle Module

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

addOrRemoveOrModifyModuleReferenceLocationClause

Add/remove/modify data location for the Gateway module.

setReferenceLocationClause

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

unsetReferenceLocationClause

Unset a location to the existing Gateway module.

addReferenceLocationClause

Add a data location to the gateway module.

removeReferenceLocationClause

Remove a data location from the gateway module.

setReferenceMetadataLocationOrIconSetClause

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

unsetReferenceMetadataLocationOrIconSetClause

Unset 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.

unsetReferenceMetadataLocationClause

Unset metadata location for the gateway module.

unsetReferenceIconSetClause

Unset icon set for the gateway module.

GATEWAY_MODULE Object

Table 2-15 GATEWAY_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER

OMBCREATE GATEWAY_MODULE

OMBDROP GATEWAY_MODULE

OMBALTER ICONSET

Purpose

To modify one or more properties of an iconset, including renaming it.

Prerequisites

Any context.

Syntax

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

Parameters

alterIconSetCommand

This command alters the properties of an iconset.

QUOTED_STRING

The name of the iconset to alter.

renameClause

Renames an iconset to a different name.

QUOTED_STRING

New name to set for the iconset.

setPropertiesClause

This clause sets a list properties to the specified values.

getPropertiesClause

Basic properties for ICONSET:

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

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

Name: BELONGS_TO_GROUP
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Name of the Group to which the iconset belongs

Name: CANVAS_ICON
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
URL of the canvas icon (36x36)

Name: PALETTE_ICON
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
URL of the palette icon (18x18)

Name: TREE_ICON
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
URL of the tree icon (16x16)

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

A property value.

ICONSET Object

Table 2-16 ICONSET Object

Property
Type
Choices
Min
Max
Default
Description

BELONGS_TO_GROUP

STRING

Applications, Data Source, Generic, Processes, Tasks

none

none

empty string

Group assignment for this icon..

See Also

OMBALTER

OMBCREATE ICONSET

OMBDROP ICONSET

3 OMBALTER IMPORT_ACTION_PLAN to OMBALTER PLUGGABLE_MAPPING

OMBALTER IMPORT_ACTION_PLAN

OMBALTER ITEM_FOLDER

OMBALTER LIST_OF_VALUES

OMBALTER LOCATION

OMBALTER LOGICAL_TABLE

OMBALTER MAPPING

OMBALTER MAPPING_MODULE

OMBALTER MATERIALIZED_VIEW

OMBALTER MDL_ACTION_PLAN

OMBALTER MODULE

OMBALTER NESTED_TABLE

OMBALTER OBIEE_BUSINESS_DEFINITION_MODULE

OMBALTER OBJECT_TYPE

OMBALTER ORACLE_EBS_MODULE

OMBALTER ORACLE_MODULE

OMBALTER PACKAGE

OMBALTER PLATFORM

OMBALTER PLSQL_RECORD_TYPE

OMBALTER PLSQL_REF_CURSOR_TYPE

OMBALTER PLSQL_TABLE_TYPE

OMBALTER PLUGGABLE_MAPPING

OMBALTER IMPORT_ACTION_PLAN

Purpose

To modify a transient import action plan.

Prerequisites

In the context of a project.

Syntax

alterImportActionPlanCommand =  ( OMBALTER ( IMPORT_ACTION_PLAN )
          "QUOTED_STRING" ( "alterActionPlanClause" { "alterActionPlanClause" }
          ) )
     alterActionPlanClause =  "renameActionPlanClause" | "addActionClause" |
          "deleteActionClause" | "modifyActionClause"
     renameActionPlanClause =  RENAME TO "QUOTED_STRING"
     addActionClause =  ADD ACTION "QUOTED_STRING" ( "setPropertiesClause" [
          "setRefSourceAndTargetClause" ] | "setRefSourceAndTargetClause" )
     deleteActionClause =  DELETE ACTION "QUOTED_STRING"
     modifyActionClause =  MODIFY ACTION "QUOTED_STRING" "modifyActionOperation"
           { "modifyActionOperation" }
     setPropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     setRefSourceAndTargetClause =  SET ( REF | REFERENCE ) "sourcesClause" SET
          ( REF | REFERENCE ) "targetClause"
     modifyActionOperation =  "renameActionClause" | "setPropertiesClause" |
          "setRefSourceClause" | "setRefTargetClause" | "deleteSourceClause" |
          "unsetTargetReferenceClause"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     sourcesClause =  SOURCE "ObjType" "QUOTED_STRING" [ SET ( REF | REFERENCE )
           "sourcesClause" ]
     targetClause =  TARGET "ObjType" "QUOTED_STRING"
     renameActionClause =  RENAME TO "QUOTED_STRING"
     setRefSourceClause =  SET ( REF | REFERENCE ) "sourcesClause"
     setRefTargetClause =  SET ( REF | REFERENCE ) "targetClause"
     deleteSourceClause =  UNSET ( REF | REFERENCE ) SOURCE "ObjType"
          "QUOTED_STRING"
     unsetTargetReferenceClause =  UNSET ( REF | REFERENCE ) TARGET
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterImportActionPlanCommand

This command is for changing the details of an existing import action plan.

QUOTED_STRING

The name of the transient import action plan to be altered.

alterActionPlanClause

One modification to the import action plan.

renameActionPlanClause

For renaming the action plan.

QUOTED_STRING

The new name for the import action plan.

addActionClause

For adding an action to the import action plan.

QUOTED_STRING

The name of the action to be added.

deleteActionClause

For deleting an existing action.

QUOTED_STRING

The name of the action to be deleted.

modifyActionClause

For changing details of an existing action in the import action plan.

setPropertiesClause

For setting any properties for the import action. For the current release, there are no predefined property for import actions.

setRefSourceAndTargetClause

For specifying source and target objects for the import action. The source objects are to be imported into target.

modifyActionOperation

The clause for modifying details of an action.

renameActionClause

For renaming the action.

QUOTED_STRING

The new name for the action.

deleteSourceClause

For deleting a source item from the list of source items of this action.

QUOTED_STRING

The name of the source object. Note that the name of the source object must be qualified with schema name, such as 'SCOTT.EMP'.

unsetTargetReferenceClause

For removing the pointer to target object from the import action.

See Also

OMBCREATE IMPORT_ACTION_PLAN

OMBIMPORT

OMBALTER ITEM_FOLDER

Purpose

Alters an item folder.

Prerequisites

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

Syntax

alterItemFolderCommand =  ( OMBALTER ITEM_FOLDER "QUOTED_STRING" ( (
          "renameClause" [ SET "setpropertiesClauseDelayed" ] [ SET
          "setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
          { "alterItemFolderSCOClauses" } ) | ( SET "setpropertiesClauseDelayed"
           [ SET "setReferenceIconSetClause" ] [ UNSET
          "unsetReferenceIconSetClause" ] { "alterItemFolderSCOClauses" } ) | (
          SET "setReferenceIconSetClause" [ UNSET "unsetReferenceIconSetClause"
          ] { "alterItemFolderSCOClauses" } ) | ( UNSET
          "unsetReferenceIconSetClause" { "alterItemFolderSCOClauses" } ) | (
          "alterItemFolderSCOClauses" { "alterItemFolderSCOClauses" } ) ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setpropertiesClauseDelayed =  PROPERTIES "(" "propertyNameListVector" ")"
          VALUES "(" "propertyValueListVector" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterItemFolderSCOClauses =  ADD ( "addItemClauseForAlter" |
          "addConditionClauseForAlter" | "addJoinClause" ) | MODIFY (
          "modifyItemClause" | "modifyConditionClause" | "modifyJoinClause" ) |
          DELETE ( "deleteItemClause" | "deleteConditionClause" |
          "deleteJoinClause" ) | UNSET USING "unsetJoinUsageClause"
     propertyNameListVector =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueListVector =  "propertyValue" { "," "propertyValue" }
     addItemClauseForAlter =  ITEM "QUOTED_STRING" [ AT POSITION
          "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ] [ SET ( REF |
          REFERENCE ) ( "ItemItemReferencesClause" |
          "ItemListOfValuesReferencesClause" |
          "ItemDrillToDetailReferencesClause" |
          "ItemAlternativeSortOrderReferencesClause" |
          "ItemColumnReferencesClause" ) ]
     addConditionClauseForAlter =  CONDITION "QUOTED_STRING" [ SET
          "setPropertiesClauseforCondition" ]
     addJoinClause =  JOIN "QUOTED_STRING" [ SET "setPropertiesClause" ] [ SET (
           REF | REFERENCE ) "JoinForeignKeyReferencesClause" ] {
          "joinComponentClause" }
     modifyItemClause =  ITEM "QUOTED_STRING" [ "renameClause" ] [
          "moveItemToClause" ] [ SET "setPropertiesClause" ] [ UNSET ( REF |
          REFERENCE ) ( COLUMN | LIST_OF_VALUES | DRILL_TO_DETAIL |
          ALTERNATIVE_SORT_ORDER ) ] [ SET ( REF | REFERENCE ) (
          "ItemItemReferencesClause" | "ItemListOfValuesReferencesClause" |
          "ItemDrillToDetailReferencesClause" |
          "ItemAlternativeSortOrderReferencesClause" |
          "ItemColumnReferencesClause" ) ]
     modifyConditionClause =  CONDITION "QUOTED_STRING" ( [ "renameClause" ] [
          SET "setPropertiesClauseforCondition" ] )
     modifyJoinClause =  JOIN "QUOTED_STRING" ( [ "renameClause" ] [ SET
          "setPropertiesClause" ] [ UNSET ( REF | REFERENCE ) FOREIGN_KEY ] [
          SET ( REF | REFERENCE ) "JoinForeignKeyReferencesClause" ] {
          "alterJoinComponentSCOClauses" } )
     deleteItemClause =  ITEM "QUOTED_STRING"
     deleteConditionClause =  CONDITION "QUOTED_STRING"
     deleteJoinClause =  JOIN "QUOTED_STRING"
     unsetJoinUsageClause =  JOIN "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     ItemItemReferencesClause =  ITEM "QUOTED_STRING" OF ( ( ITEM_FOLDER
          "QUOTED_STRING" "itemJoinUsages" ) | ( LOGICAL_TABLE "QUOTED_STRING" )
           )
     ItemListOfValuesReferencesClause =  LIST_OF_VALUES "QUOTED_STRING"
     ItemDrillToDetailReferencesClause =  DRILL_TO_DETAIL "QUOTED_STRING"
     ItemAlternativeSortOrderReferencesClause =  ALTERNATIVE_SORT_ORDER
          "QUOTED_STRING"
     ItemColumnReferencesClause =  COLUMN "QUOTED_STRING" OF ( TABLE | (
          EXTERNAL_TABLE | ( VIEW | MATERIALIZED_VIEW ) ) ) "QUOTED_STRING" [
          USING FOREIGN_KEY "QUOTED_STRING" OF ( TABLE | ( VIEW |
          MATERIALIZED_VIEW ) ) "QUOTED_STRING" ]
     setPropertiesClauseforCondition =  PROPERTIES "("
          "propertyNameListforCondition" ")" VALUES "(" "propertyValueList" ")"
     JoinForeignKeyReferencesClause =  FOREIGN_KEY "QUOTED_STRING" OF ( TABLE |
          ( VIEW | MATERIALIZED_VIEW ) ) "QUOTED_STRING"
     joinComponentClause =  ADD JOIN_COMPONENT "QUOTED_STRING" [ SET
          "setPropertiesClause" ] { SET ( REF | REFERENCE )
          "setJoinComponentClauseDetails" }
     moveItemToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     alterJoinComponentSCOClauses =  ADD "joinComponentClauseforAlter" | MODIFY
          "modifyJoinComponentClause" | DELETE "deleteJoinComponentClause"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     itemJoinUsages =  { USING JOIN "QUOTED_STRING" OF ITEM_FOLDER
          "QUOTED_STRING" }
     propertyNameListforCondition =  ( "UNQUOTED_STRING" | CONDITION ) { "," (
          "UNQUOTED_STRING" | CONDITION ) }
     setJoinComponentClauseDetails =  LOCAL ITEM "QUOTED_STRING" | REMOTE ITEM
          "QUOTED_STRING" OF ( ( ITEM_FOLDER "QUOTED_STRING" ) | ( LOGICAL_TABLE
           "QUOTED_STRING" ) )
     joinComponentClauseforAlter =  JOIN_COMPONENT "QUOTED_STRING" [ SET
          "setPropertiesClause" ] { SET ( REF | REFERENCE )
          "setJoinComponentClauseDetails" }
     modifyJoinComponentClause =  JOIN_COMPONENT "QUOTED_STRING" [
          "renameClause" ] [ SET "setPropertiesClause" ] [ SET ( REF | REFERENCE
           ) "setJoinComponentClauseDetails" ] [ UNSET ( REF | REFERENCE )
          "unsetJoinComponentClauseDetails" ]
     deleteJoinComponentClause =  JOIN_COMPONENT "QUOTED_STRING"
     unsetJoinComponentClauseDetails =  LOCAL ITEM | REMOTE ITEM

Parameters

alterItemFolderCommand

This clause alters an item folder.

QUOTED_STRING

name of the item folder.

renameClause

Renames an item folder with a different name.

setpropertiesClauseDelayed

This clause sets the properties.

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set.

alterItemFolderSCOClauses

This clause modifies the contents of the item folder.

propertyNameListVector

This clause holds the names of the properties.

propertyValueListVector

This clause holds the values of the properties.

addItemClauseForAlter

This clause adds an item to an item folder.

QUOTED_STRING

name of the item.

addConditionClauseForAlter

This clause adds a condition to an item folder.

QUOTED_STRING

name of the condition.

addJoinClause

This clause adds a join to an item folder.

QUOTED_STRING

name of the join.

modifyItemClause

This clause modifies an item in an item folder.

QUOTED_STRING

name of the item.

modifyConditionClause

This clause modifies a condition in an item folder.

QUOTED_STRING

name of the condition.

modifyJoinClause

This clause modifies a join in an item folder.

QUOTED_STRING

name of the join.

deleteItemClause

This clause deletes an item from an item folder.

QUOTED_STRING

name of the item.

deleteConditionClause

This clause deletes a condition from an item folder.

QUOTED_STRING

name of the condition.

deleteJoinClause

This clause deletes a join from an item folder.

QUOTED_STRING

name of the join.

unsetJoinUsageClause

removes a join usage.

propertyValue

This is a property value.

setPropertiesClause

This clause sets 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

ItemItemReferencesClause

This clause is used to reference another item.

QUOTED_STRING

name of the referenced item.

ItemListOfValuesReferencesClause

This clause is used to reference a list of values.

QUOTED_STRING

name of the list of values.

ItemDrillToDetailReferencesClause

This clause is used to reference a drill to detail.

QUOTED_STRING

name of the drill to detail.

ItemAlternativeSortOrderReferencesClause

This clause is used to reference an alternative sort order.

QUOTED_STRING

name of the alternative sort order.

ItemColumnReferencesClause

This clause is used to reference a column.

QUOTED_STRING

name of the referenced column.

setPropertiesClauseforCondition

Sets the properties of a condition.

JoinForeignKeyReferencesClause

The foreign key reference.

joinComponentClause

The join components.

moveItemToClause

This clause is for positioning an item in an item folder.

alterJoinComponentSCOClauses

This clause alters the structure of the join component.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

itemJoinUsages

The specific joins to be used.

propertyNameListforCondition

Names of the condition properties.

setJoinComponentClauseDetails

The structure of the join component.

joinComponentClauseforAlter

This clause adds a join component.

modifyJoinComponentClause

This clause modifies a join component for a join.

deleteJoinComponentClause

This clause deletes a join component.

unsetJoinComponentClauseDetails

This clause updates the join component details.

ITEM_FOLDER Object

Table 3-1 ITEM_FOLDER Object

Property
Type
Choices
Min
Max
Default
Description

DB_LOCATION

STRING

none

none

none

empty string

Location for the referenced database object

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

EXTERNAL_TABLE_NAME

STRING

none

none

none

empty string

The physical name for the corresponding table or view.

OBJECT_TYPE

STRING

none

none

none

empty string

OPTIMIZER_HINT

STRING

none

none

none

empty string

Optimizer Hint to be added when this Item Folder is used in a query

VISIBLE

BOOLEAN

true, false

none

none

false

Whether this object is visible for use in query definitions.

See Also

OMBCREATE ITEM_FOLDER

OMBRETRIEVE ITEM_FOLDER

OMBALTER LIST_OF_VALUES

Purpose

Alters a list of values.

Prerequisites

Should be in the context of a business definition module or use the full path.

Syntax

alterListOfValuesCommand =  ( OMBALTER LIST_OF_VALUES "QUOTED_STRING" ( (
          "renameClause" [ SET "setPropertiesClauseforLOVandD2D" ] [ SET
          "setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
          { "alterListOfValuesClauses" } ) | ( SET
          "setPropertiesClauseforLOVandD2D" [ SET "setReferenceIconSetClause" ]
          [ UNSET "unsetReferenceIconSetClause" ] { "alterListOfValuesClauses" }
           ) | ( SET "setReferenceIconSetClause" [ UNSET
          "unsetReferenceIconSetClause" ] { "alterListOfValuesClauses" } ) | (
          UNSET "unsetReferenceIconSetClause" { "alterListOfValuesClauses" } ) |
           ( "alterListOfValuesClauses" { "alterListOfValuesClauses" } ) ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClauseforLOVandD2D =  PROPERTIES "("
          "propertyNameListforLOVandD2D" ")" VALUES "(" "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterListOfValuesClauses =  SET ( REF | REFERENCE ) DEFINING ITEM
          "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING" | UNSET ( REF |
          REFERENCE ) "deleteListOfValuesClauses" |
          "addListOfValuesReferenceClause"
     propertyNameListforLOVandD2D =  ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
          "," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     deleteListOfValuesClauses =  ( DEFINING ITEM ) | ( ITEM "QUOTED_STRING" OF
          ITEM_FOLDER "QUOTED_STRING" )
     addListOfValuesReferenceClause =  SET ( REF | REFERENCE ) ITEM
          "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterListOfValuesCommand

This clause alters a list of values.

QUOTED_STRING

name of the list of values.

renameClause

Renames a list of values with a different name.

setPropertiesClauseforLOVandD2D

This clause sets the properties of the object.

getPropertiesClauseforLOVandD2D

Basic properties for LIST_OF_VALUES:

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

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

Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the list of values enables drilling between the item folders containing the items that use the list of values

Name: RETRIEVE_VALUES_GROUP_SIZE
Type: Number
Valid Values: Any valid character string in supported character set.
Default: '100'
The number of rows to be fetched from the database at a time

Name: CACHE_VALUES
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the list of values should be cached in memory

Name: REQUIRE_SEARCH
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether search criteria should be requested

Name: SHOW_IN_NAVIGATOR
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be shown in the item navigator

Name: SORTED_DISTINCT
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be displayed sorted with duplicates hidden

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set.

alterListOfValuesClauses

This clause modifies a list of values.

DEFINING

This sets the defining item for the list of values.

propertyNameListforLOVandD2D

This is the list of property names.

propertyValueList

This is the list of property values.

deleteListOfValuesClauses

This deletes a reference to an item from a list of values.

addListOfValuesReferenceClause

This adds a reference to an item to a list of values.

propertyValue

This is a property value.

LIST_OF_VALUES Object

Table 3-2 LIST_OF_VALUES Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBCREATE LIST_OF_VALUES

OMBRETRIEVE LIST_OF_VALUES

OMBALTER LOCATION

Purpose

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

Prerequisites

Can be in any context.

Syntax

alterLocationCommand =  OMBALTER ( LOCATION "QUOTED_STRING" (
          "renameClause" [ "setPropertiesForModifyClause" [ "alterIconSetClause"
           ] ] | "setPropertiesForModifyClause" [ "alterIconSetClause" ] |
          "alterIconSetClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesForModifyClause =  SET PROPERTIES "(" "propertyNameList" ")"
          VALUES "(" "propertyValueList" ")"
     alterIconSetClause =  SET "setReferenceIconSetClause" [ UNSET
          "unsetReferenceIconSetClause" ] | UNSET "unsetReferenceIconSetClause"
          [ SET "setReferenceIconSetClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterLocationCommand

Alter the location specified by the quoted string.

renameClause

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

setPropertiesForModifyClause

Set or alter specified properties of the location.

alterIconSetClause

Set or unset the Icon Set of the location.

propertyNameList

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

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.

propertyValueList

The values for the named properties.

setReferenceIconSetClause

Set the Icon Set for the location.

unsetReferenceIconSetClause

Unset the Icon Set for the location.

propertyValue

A property value.

LOCATION Object

Table 3-3 LOCATION Object

Property
Type
Choices
Min
Max
Default
Description

PLATFORM_NAME

STRING

none

none

none

empty string

Platform for the location.

VERSION

STRING

none

none

none

0

Version of the location

See Also

OMBALTER

OMBCREATE LOCATION

OMBDROP LOCATION

OMBALTER LOGICAL_TABLE

Purpose

Alters a logical table.

Prerequisites

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

Syntax

alterLogicalTableCommand =  ( OMBALTER LOGICAL_TABLE "QUOTED_STRING" ( (
          "renameClause" [ SET "setpropertiesClauseDelayed" ] [ SET
          "setReferenceIconSetClause" ] [ UNSET "unsetReferenceIconSetClause" ]
          { "alterLogicalTableSCOClauses" } ) | ( SET
          "setpropertiesClauseDelayed" [ SET "setReferenceIconSetClause" ] [
          UNSET "unsetReferenceIconSetClause" ] { "alterLogicalTableSCOClauses"
          } ) | ( SET "setReferenceIconSetClause" [ UNSET
          "unsetReferenceIconSetClause" ] { "alterLogicalTableSCOClauses" } ) |
          ( UNSET "unsetReferenceIconSetClause" { "alterLogicalTableSCOClauses"
          } ) | ( "alterLogicalTableSCOClauses" { "alterLogicalTableSCOClauses"
          } ) ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setpropertiesClauseDelayed =  PROPERTIES "(" "propertyNameListVector" ")"
          VALUES "(" "propertyValueListVector" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterLogicalTableSCOClauses =  ADD ( "addItemClauseForAlter" |
          "addJoinClause" ) | MODIFY ( "modifyItemClause" | "modifyJoinClause" )
           | DELETE ( "deleteItemClause" | "deleteJoinClause" ) | UNSET USING
          "unsetFKUsageClause"
     propertyNameListVector =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueListVector =  "propertyValue" { "," "propertyValue" }
     addItemClauseForAlter =  ITEM "QUOTED_STRING" [ AT POSITION
          "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ] [ SET ( REF |
          REFERENCE ) ( "ItemItemReferencesClause" |
          "ItemListOfValuesReferencesClause" |
          "ItemDrillToDetailReferencesClause" |
          "ItemAlternativeSortOrderReferencesClause" |
          "ItemColumnReferencesClause" ) ]
     addJoinClause =  JOIN "QUOTED_STRING" [ SET "setPropertiesClause" ] [ SET (
           REF | REFERENCE ) "JoinForeignKeyReferencesClause" ] {
          "joinComponentClause" }
     modifyItemClause =  ITEM "QUOTED_STRING" [ "renameClause" ] [
          "moveItemToClause" ] [ SET "setPropertiesClause" ] [ UNSET ( REF |
          REFERENCE ) ( COLUMN | LIST_OF_VALUES | DRILL_TO_DETAIL |
          ALTERNATIVE_SORT_ORDER ) ] [ SET ( REF | REFERENCE ) (
          "ItemItemReferencesClause" | "ItemListOfValuesReferencesClause" |
          "ItemDrillToDetailReferencesClause" |
          "ItemAlternativeSortOrderReferencesClause" |
          "ItemColumnReferencesClause" ) ]
     modifyJoinClause =  JOIN "QUOTED_STRING" ( [ "renameClause" ] [ SET
          "setPropertiesClause" ] [ UNSET ( REF | REFERENCE ) FOREIGN_KEY ] [
          SET ( REF | REFERENCE ) "JoinForeignKeyReferencesClause" ] {
          "alterJoinComponentSCOClauses" } )
     deleteItemClause =  ITEM "QUOTED_STRING"
     deleteJoinClause =  JOIN "QUOTED_STRING"
     unsetFKUsageClause =  FOREIGN_KEY "QUOTED_STRING" OF ( TABLE | ( VIEW |
          MATERIALIZED_VIEW ) ) "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     ItemItemReferencesClause =  ITEM "QUOTED_STRING" OF ( ( ITEM_FOLDER
          "QUOTED_STRING" "itemJoinUsages" ) | ( LOGICAL_TABLE "QUOTED_STRING" )
           )
     ItemListOfValuesReferencesClause =  LIST_OF_VALUES "QUOTED_STRING"
     ItemDrillToDetailReferencesClause =  DRILL_TO_DETAIL "QUOTED_STRING"
     ItemAlternativeSortOrderReferencesClause =  ALTERNATIVE_SORT_ORDER
          "QUOTED_STRING"
     ItemColumnReferencesClause =  COLUMN "QUOTED_STRING" OF ( TABLE | (
          EXTERNAL_TABLE | ( VIEW | MATERIALIZED_VIEW ) ) ) "QUOTED_STRING" [
          USING FOREIGN_KEY "QUOTED_STRING" OF ( TABLE | ( VIEW |
          MATERIALIZED_VIEW ) ) "QUOTED_STRING" ]
     JoinForeignKeyReferencesClause =  FOREIGN_KEY "QUOTED_STRING" OF ( TABLE |
          ( VIEW | MATERIALIZED_VIEW ) ) "QUOTED_STRING"
     joinComponentClause =  ADD JOIN_COMPONENT "QUOTED_STRING" [ SET
          "setPropertiesClause" ] { SET ( REF | REFERENCE )
          "setJoinComponentClauseDetails" }
     moveItemToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     alterJoinComponentSCOClauses =  ADD "joinComponentClauseforAlter" | MODIFY
          "modifyJoinComponentClause" | DELETE "deleteJoinComponentClause"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     itemJoinUsages =  { USING JOIN "QUOTED_STRING" OF ITEM_FOLDER
          "QUOTED_STRING" }
     setJoinComponentClauseDetails =  LOCAL ITEM "QUOTED_STRING" | REMOTE ITEM
          "QUOTED_STRING" OF ( ( ITEM_FOLDER "QUOTED_STRING" ) | ( LOGICAL_TABLE
           "QUOTED_STRING" ) )
     joinComponentClauseforAlter =  JOIN_COMPONENT "QUOTED_STRING" [ SET
          "setPropertiesClause" ] { SET ( REF | REFERENCE )
          "setJoinComponentClauseDetails" }
     modifyJoinComponentClause =  JOIN_COMPONENT "QUOTED_STRING" [
          "renameClause" ] [ SET "setPropertiesClause" ] [ SET ( REF | REFERENCE
           ) "setJoinComponentClauseDetails" ] [ UNSET ( REF | REFERENCE )
          "unsetJoinComponentClauseDetails" ]
     deleteJoinComponentClause =  JOIN_COMPONENT "QUOTED_STRING"
     unsetJoinComponentClauseDetails =  LOCAL ITEM | REMOTE ITEM

Parameters

alterLogicalTableCommand

This clause alters a logical table.

QUOTED_STRING

name of the logical table.

renameClause

Renames a logical table with a different name.

setpropertiesClauseDelayed

This clause sets the properties.

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set.

alterLogicalTableSCOClauses

This clause modifies the contents of the logical table.

propertyNameListVector

This clause holds the names of the properties.

propertyValueListVector

This clause holds the values of the properties.

addItemClauseForAlter

This clause adds an item to a logical table.

QUOTED_STRING

name of the item.

addJoinClause

This clause adds a join to a logical table.

QUOTED_STRING

name of the join.

modifyItemClause

This clause modifies an item in a logical table.

QUOTED_STRING

name of the item.

modifyJoinClause

This clause modifies a join in a logical table.

QUOTED_STRING

name of the join.

deleteItemClause

This clause deletes an item from a logical table.

QUOTED_STRING

name of the item.

deleteJoinClause

This clause deletes a join from a logical table.

QUOTED_STRING

name of the join.

unsetFKUsageClause

This clause removes the association to a foreign key.

propertyValue

This is a property value.

setPropertiesClause

This clause sets 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

ItemItemReferencesClause

This clause is used to reference another item.

QUOTED_STRING

name of the referenced item.

ItemListOfValuesReferencesClause

This clause is used to reference a list of values.

QUOTED_STRING

name of the list of values.

ItemDrillToDetailReferencesClause

This clause is used to reference a drill to detail.

QUOTED_STRING

name of the drill to detail.

ItemAlternativeSortOrderReferencesClause

This clause is used to reference an alternative sort order.

QUOTED_STRING

name of the alternative sort order.

ItemColumnReferencesClause

This clause is used to reference a column.

QUOTED_STRING

name of the referenced column.

JoinForeignKeyReferencesClause

The foreign key reference.

joinComponentClause

The join components.

moveItemToClause

This clause is for positioning an item in a logical table.

alterJoinComponentSCOClauses

This clause alters the structure of the join component.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

itemJoinUsages

The specific joins to be used.

setJoinComponentClauseDetails

The structure of the join component.

joinComponentClauseforAlter

This clause adds a join component.

modifyJoinComponentClause

This clause modifies a join component for a join.

deleteJoinComponentClause

This clause deletes a join component.

unsetJoinComponentClauseDetails

This clause updates the join component details.

LOGICAL_TABLE Object

Table 3-4 LOGICAL_TABLE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE LOGICAL_TABLE

OMBRETRIEVE LOGICAL_TABLE

OMBALTER MAPPING

Purpose

Alter the content of a mapping.

Prerequisites

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

2. No concurrent user should be modifying the mapping

3. 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

alterMappingCommand =  OMBALTER MAPPING "mappingName"
          "alterMapDetailClause"
     mappingName =  "QUOTED_STRING"
     alterMapDetailClause =  "renameClause" [ "alterPropertiesOrIconSetClause" ]
           [ "alterOperatorOwnerDescendantsClause"+ ] |
          "alterPropertiesOrIconSetClause" [
          "alterOperatorOwnerDescendantsClause"+ ] |
          "alterOperatorOwnerDescendantsClause"+ |
          "setDefaultExecutionUnitClause"
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  ( SET ( ( "setPropertiesClause" [ ( SET
          "setCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) | (
          UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) |
           ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( UNSET
          "unsetCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) | (
          UNSET "unsetReferenceIconSetClause" ) ] ) | ( UNSET
          "unsetControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" )
           | ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
          ) ] ) | ( "setCodeTemplateClause" [ ( SET "setReferenceIconSetClause"
          ) | ( UNSET "unsetReferenceIconSetClause" ) ] ) | (
          "setControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) |
           ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setReferenceIconSetClause" ) ) ) | UNSET ( "unsetCodeTemplateClause"
          | "unsetControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause"
           ) | ( UNSET "unsetReferenceIconSetClause" ) ] |
          "unsetReferenceIconSetClause" )
     alterOperatorOwnerDescendantsClause =  ADD ( "addOperatorClause" |
          "addGroupClause" | "addAttributeClause" | "addChildClause" |
          "addConnectionClause" | "addExecutionUnitClause" ) | MODIFY (
          "modifyOperatorClause" | "modifyGroupClause" | "modifyAttributeClause"
           | "modifyChildClause" | "modifyExecutionUnitClause" ) | DELETE (
          "operatorBottomUpLocator" | "groupBottomUpLocator" |
          "attributeBottomUpLocator" | "childBottomUpLocator" |
          "deleteConnectionLocator" | "deleteExecutionUnitClause" )
     setDefaultExecutionUnitClause =  SET DEFAULT_EXECUTION_UNIT
     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"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     setControlCodeTemplateClause =  ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE
          "QUOTED_STRING" | ( ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE OPTIONS
          "(" "optionValueList" ")" VALUES "(" "optionValueList" ")" )
     unsetCodeTemplateClause =  ( REFERENCE | REF ) CODE_TEMPLATE
     unsetControlCodeTemplateClause =  ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE
     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" ]
     modifyOperatorClause =  "operatorBottomUpLocator" ( "renameClause" | SET
          "setPropertiesClause" )
     modifyGroupClause =  "groupBottomUpLocator" ( "renameClause" | SET
          "setPropertiesClause" | "setBindingClause" |
          "internallyConnectToClause" )+
     modifyAttributeClause =  "attributeBottomUpLocator" ( "renameClause" |
          "moveToClause" | SET "setPropertiesClause" )
     modifyChildClause =  "childBottomUpLocator" ( "renameClause" | SET
          "setPropertiesClause" )
     modifyExecutionUnitClause =  EXECUTION_UNIT "executionUnitName" ( (
          OPERATORS "operatorNameList" [ ( SET ( REFERENCE | REF ) CODE_TEMPLATE
           "setEUCodeTemplateClause" ) ] [ ( SET ( REFERENCE | REF )
          CONTROL_CODE_TEMPLATE "setEUControlCodeTemplateClause" ) ] ) |
          "addDeleteExecutionUnitOperatorClause"+ [ ( SET ( REFERENCE | REF )
          CODE_TEMPLATE "setEUCodeTemplateClause" ) ] | ( SET ( REFERENCE | REF
          ) CODE_TEMPLATE "setEUCodeTemplateClause" ) | ( SET ( REFERENCE | REF
          ) CONTROL_CODE_TEMPLATE "setEUControlCodeTemplateClause" ) )
     operatorBottomUpLocator =  OPERATOR "operatorName" [
          "pluggableMapBottomUpLocator" ]
     groupBottomUpLocator =  GROUP "groupName" OF "operatorBottomUpLocator"
     attributeBottomUpLocator =  ATTRIBUTE "attributeName" OF
          "groupBottomUpLocator"
     childBottomUpLocator =  "childType" "childName" { OF "childType"
          "childName" } [ OF "mappableBottomUpLocator" ]
     deleteConnectionLocator =  CONNECTION ( FROM "mappableBottomUpLocator" [ TO
           "mappableBottomUpLocator" ] | TO "mappableBottomUpLocator" )
     deleteExecutionUnitClause =  EXECUTION_UNIT "executionUnitName"
     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"
     internallyConnectToClause =  SET REF "groupLocator"
     attributeName =  "QUOTED_STRING"
     childType =  "UNQUOTED_STRING"
     childName =  "QUOTED_STRING"
     childOwnerBottomUpLocator =  { OF "childType" "childName" } [ OF
          "mappableBottomUpLocator" ]
     groupToGroupConnectType =  COPY ALL | BY ( NAME [ IGNORE ( SPECIAL_CHARS
          "QUOTED_STRING" | SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX
          "QUOTED_STRING" | TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX
          "QUOTED_STRING" ) { "," IGNORE ( SPECIAL_CHARS "QUOTED_STRING" |
          SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX "QUOTED_STRING" |
          TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX "QUOTED_STRING" ) } ] |
          POSITION )
     attributesBottomUpLocator =  ATTRIBUTES "attributeNameList" OF
          "groupBottomUpLocator"
     executionUnitName =  "QUOTED_STRING"
     operatorNameList =  "(" "operatorName" { "," "operatorName" } ")"
     setEUCodeTemplateClause =  "QUOTED_STRING" | OPTIONS "(" "optionValueList"
          ")" VALUES "(" "optionValueList" ")"
     setEUControlCodeTemplateClause =  "QUOTED_STRING" | OPTIONS "("
          "optionValueList" ")" VALUES "(" "optionValueList" ")"
     moveToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     addDeleteExecutionUnitOperatorClause =  ADD OPERATOR "operatorName" |
          DELETE OPERATOR "operatorName"
     mappableBottomUpLocator =  "operatorBottomUpLocator" |
          "groupBottomUpLocator" | "attributeBottomUpLocator"
     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"
     attributeNameList =  "(" "attributeName" { "," "attributeName" } ")"
     bindableType =  PLUGGABLE_MAPPING | OBJECT_TYPE | "UNQUOTED_STRING"
     bindableName =  "QUOTED_STRING"

Parameters

alterMappingCommand

Alter the content of a mapping.

mappingName

Name of the mapping.

alterMapDetailClause

Alter the detail of the mapping.

renameClause

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

alterPropertiesOrIconSetClause

Alter the properties, code template or icon set settings of the map.

alterOperatorOwnerDescendantsClause

Alter the desired child objects applicable to a mapping or a pluggable mapping.

setDefaultExecutionUnitClause

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

setPropertiesClause

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

setReferenceIconSetClause

Set icon set for the map.

unsetReferenceIconSetClause

Unset 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.

modifyOperatorClause

Modify a mapping operator.

modifyGroupClause

Modify a mapping group.

modifyAttributeClause

Modify a mapping attribute.

modifyChildClause

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

modifyExecutionUnitClause

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

operatorBottomUpLocator

Location of a mapping operator.

groupBottomUpLocator

Location of a mapping group.

attributeBottomUpLocator

Location of a mapping attribute.

childBottomUpLocator

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

deleteConnectionLocator

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

deleteExecutionUnitClause

Delete the specified execution unit.

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.

internallyConnectToClause

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

attributeName

Name of a mapping attribute.

childType

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

childName

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

childOwnerBottomUpLocator

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

groupToGroupConnectType

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

attributesBottomUpLocator

Location of a list of mapping attributes.

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.

moveToClause

Modify the position of the specified attribute within its attribute group.

addDeleteExecutionUnitOperatorClause

Add or delete operator(s) that are contained in the execution unit.

mappableBottomUpLocator

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

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.

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 3-5 MAPPING Object

Property
Type
Choices
Min
Max
Default
Description

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 3-6 OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-7 GROUP Object

Property
Type
Choices
Min
Max
Default
Description

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

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 3-8 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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 3-9 AGGREGATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

none

none

none

0

ANYDATA_CAST_OPERATOR Object

Table 3-10 ANYDATA_CAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-11 CONSTANT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-12 CONSTRUCT_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-13 CUBE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-14 DATA_GENERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-15 DEDUPLICATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-16 DIMENSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-17 EXPAND_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-18 EXPRESSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-19 EXTERNAL_TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FILTER_OPERATOR Object

Table 3-20 FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

FILTER_CONDITION

STRING

none

none

none

empty string

The boolean filtering condition that identifies what data is to be processed. Any row with a false condition will be ignored.

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

SUBQUERY_FILTER_OPERATOR Object

Table 3-21 SUBQUERY_FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SUBQUERY_FILTER_CONDITION

STRING

none

none

none

empty string

The Filter Condition for the subquery operator, if blank then the subquery stands alone with no join to the top-level query.

SUBQUERY_INPUT_ROLE

STRING(16)

EXISTS, IN, NOT_EXISTS, NOT_IN

none

none

EXISTS

The role the input stream plays in the subquery filter condition.

SUBQUERY_JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FLAT_FILE_OPERATOR Object

Table 3-22 FLAT_FILE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CONCATENATE_RECORDS

NUMBER

none

none

none

0

Number of Physical Records per Logical Record.

CONTINUATION_CHARACTER

STRING

none

none

none

empty string

Character that indicates the record is continued on the next line.

CONTINUATION_CHARACTER_ON_NEXT_LINE

BOOLEAN

true, false

none

none

FALSE

If there is a continuation character, is it at the start of the line.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The name of the directory in which to open the target data file. The directory must be deployed before the file can be created.

DEBUG_TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

ESCAPE_CHARACTER_FOR_ENCLOSURE

STRING

none

none

none

empty string

Escape character for data containing the enclosure character. This is only applicable with delimited files having enclosure characters.

FIELD_ENCLOSURE_CHARACTERS

STRING

none

none

none

empty string

Characters that wrap fields. Example ' or ".

FIELD_NAMES_IN_THE_FIRST_ROW

BOOLEAN

true, false

none

none

FALSE

Indicates whether file contains a header row.

FIELD_TERMINATION_CHARACTER

STRING

none

none

none

,

Character that separates the fields of a delimited file.

FILE_FORMAT

STRING

DELIMITED, FIXED

none

none

DELIMITED

File Format (Fixed or Delimited).

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LOADING_TYPE

STRING(16)

INSERT, NONE, UPDATE

none

none

INSERT

The loading operation to be performed

NLS_CHARACTERSET

STRING

none

none

none

WE8MSWIN1252

NLS Characterset

OUTPUT_AS_XML

BOOLEAN

true, false

none

none

false

Output data to file in XML format.

RECORDS_TO_SKIP

NUMBER

none

0

none

0

Number of logical records to skip

RECORD_DELIMITER

STRING

none

none

none

empty string

Character that indicates the end of the record.

RECORD_SIZE

NUMBER

none

none

none

0

Size of a fixed length record.

RECORD_TYPE_LENGTH

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the length of the data that identifies the type of record. It is used with the Record Type Position.

RECORD_TYPE_POSITION

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the position of the field that identifies the type of record.

SAMPLED_FILE_NAME

STRING

none

none

none

empty string

The default name of the physical file to be used by sqlloader. If the file was sampled, the default was set from sampled file name.

SOURCE_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The Location of the File Module of this Flat File at the time of reconciliation. Stored as UOID.

TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The location used to access referenced entity.

TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

INPUT_PARAMETER_OPERATOR Object

Table 3-23 INPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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

INPUT_SIGNATURE_OPERATOR Object

Table 3-24 INPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ITERATOR_OPERATOR Object

Table 3-25 ITERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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

JOINER_OPERATOR Object

Table 3-26 JOINER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

JOIN_CONDITION

STRING

none

none

none

empty string

The Join Condition for the join operator

JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

LOOKUP_OPERATOR Object

Table 3-27 LOOKUP_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRCAST_OPERATOR Object

Table 3-28 LCRCAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRSPLITTER_OPERATOR Object

Table 3-29 LCRSPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCHMERGE_OPERATOR Object

Table 3-30 MATCHMERGE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCH_KEYS

STRING

none

none

none

empty string

Ordered list of attributes that control the set of records to be matched at any at any particular time.

MATCH_NEW_RECORDS

BOOLEAN

true, false

none

none

false

MATCH_NEW_RECORD_CONDITION

STRING

none

none

none

empty string

MERGED_PREFIX

STRING

none

none

none

empty string

Set the prefix used for the merged attributes in the cross-reference group.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

MATERIALIZED_VIEW_OPERATOR Object

Table 3-31 MATERIALIZED_VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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).

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.

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

NAME_AND_ADDRESS_OPERATOR Object

Table 3-32 NAME_AND_ADDRESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

ADDRESS_LINE_1

STRING

none

none

none

empty string

Address line 1

ADDRESS_LINE_2

STRING

none

none

none

empty string

Address line 2

ADDRESS_LINE_3

STRING

none

none

none

empty string

Address line 3

ADDRESS_LINE_4

STRING

none

none

none

empty string

Address line 4

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

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

A dual address refers to two address lines for the same destination. For example, a record contains both a street address and a P.O. Box; this is common with business data. Select which of the two address lines should be assigned in these cases.

GENERATE_CASS_REPORT

STRING

NA_NO, NA_YES

none

none

NA_NO

Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS report is a text file specified by the United States Postal Service. The report is written to the [nas/bin/admin/reports] folder under the home folder of the name/address server.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LIST_NAME

STRING

none

none

none

empty string

The list name is optional and provides a reference for tracking multiple CASS reports.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Select a name-address parsing type to be performed on the input data

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Select the primary parsing country which best represents the input data. Input addresses having the same country as the primary parsing country will only need to be parsed once. Input addresses having a different country than the primary parsing country may be reparsed by a different parser. For performance reasons, it is best to minimize the percentage of 2-pass parses by selecting the optimal parser.

PROCESSOR_NAME

STRING

none

none

none

empty string

The processor name is the name of the organization submitting the CASS report.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

OUTPUT_PARAMETER_OPERATOR Object

Table 3-33 OUTPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

The name to use when refering to this entity in generated code.

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

OUTPUT_SIGNATURE_OPERATOR Object

Table 3-34 OUTPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_OPERATOR Object

Table 3-35 PIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_GROUP_SIZE

NUMBER

none

1

1000

2

A number specifying the pivot group size for the pivot operation. Pivot group size determines the number of output rows that are produced from each input row.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PLUGGABLE_MAPPING_OPERATOR Object

Table 3-36 PLUGGABLE_MAPPING_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

POSTMAPPING_PROCESS_OPERATOR Object

Table 3-37 POSTMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

POSTMAPPING_PROCESS_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING

none

none

ON_SUCCESS

Indicates under what condition of the mapping the post-mapping process will be run.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PREMAPPING_PROCESS_OPERATOR Object

Table 3-38 PREMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

MAPPING_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS

none

none

ON_SUCCESS

Indicates under what condition of the pre-mapping process the mapping will be run.

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

QUEUE_OPERATOR Object

Table 3-39 QUEUE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_AQ_UOID

STRING

none

none

none

empty string

The UOID of the Advanced Qeue object to which this stage component is bound to.

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.

DB_LOCATION

STRING

none

none

none

empty string

The location used to access this entity during mapping.

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

GENERATE_SUBSCRIBER

BOOLEAN

true, false

none

none

true

This only applies to batch mappings. This specifies whether the subscriber is generated. The name of the subscriber is the owning map. If the queue being sourced is a propagation queue with the same name as the owning map, then set to false.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

IS_REALTIME_SOURCE

BOOLEAN

true, false

none

none

false

IS_STREAMS_QUEUE

BOOLEAN

true, false

none

none

false

PAYLOAD_NAME

STRING

none

none

none

empty string

The name of payload type.

QUEUE_TABLE_NAME

STRING

none

none

none

empty string

The name of the queue table that is used to perist the messages in this Advanced Queue.

REAL_TIME_DATA_FORMAT

STRING

LOGICAL_CHANGE_RECORD, MESSAGE

none

none

MESSAGE

The format for this message, either user-defined or LCR

SOURCE_TABLES

STRING

none

none

none

empty string

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.

TEMPORARY_TABLE_NAME

STRING

none

none

none

empty string

The name of the temporary table that will stage the messages from the Advanced Queue.

UDT

STRING

none

none

none

empty string

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SEQUENCE_OPERATOR Object

Table 3-40 SEQUENCE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SET_OPERATION_OPERATOR Object

Table 3-41 SET_OPERATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SET_OPERATION

STRING

INTERSECT, MINUS, UNION, UNIONALL

none

none

UNION

Specifies the set operation that is to be performed by this operator.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SORTER_OPERATOR Object

Table 3-42 SORTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ORDER_BY_CLAUSE

STRING

none

none

none

empty string

The Order By Clause

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SPLITTER_OPERATOR Object

Table 3-43 SPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

TABLE_FUNCTION_OPERATOR Object

Table 3-44 TABLE_FUNCTION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

TABLE_FUNCTION_IS_TARGET

BOOLEAN

true, false

none

none

false

Description not available.

TABLE_FUNCTION_NAME

STRING

none

none

none

empty string

The name of the Table Function

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

TABLE_OPERATOR Object

Table 3-45 TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

Description not available.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

CONFLICT_RESOLUTION

BOOLEAN

true, false

none

none

true

Detect and resolve any conflicts that may arise during DML using the LCR APIs

CONTROL_CK

STRING

none

none

none

empty string

Set Control Code Template Params for Check Constraint.

CONTROL_DATA_RULES

STRING

none

none

none

empty string

Set Control Code Template Params for Data Rules.

CONTROL_FK

STRING

none

none

none

empty string

Set Control Code Template Params for Foreign Keys.

CONTROL_NN

STRING

none

none

none

empty string

Set Control Code Template Params for Not Null attributes.

CONTROL_PK

STRING

none

none

none

empty string

Set Control Code Template Params for Primary Keys.

CONTROL_UK

STRING

none

none

none

empty string

Set Control Code Template Params for Unique Keys.

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_LOCATION

STRING(30)

none

none

none

empty string

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

ISAPPLYSOURCE

BOOLEAN

true, false

none

none

false

Generate Non Trigger Apply uptime script considering this is a leading source for the map

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_ERROR_TABLE

BOOLEAN

true, false

none

none

false

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_STATIC_TABLE

BOOLEAN

true, false

none

none

false

Check source table operator static

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

IS_USER-DEFINED_DATA

BOOLEAN

true, false

none

none

false

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

JOINRANK

FLOAT

none

none

none

0

Join Rank

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

OPTIMIZE_MERGE

BOOLEAN

true, false

none

none

false

Optimize the execution of expressions by deferring them until really needed

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.

USE_LCR_API

BOOLEAN

true, false

none

none

true

Use LCR APIs if possible to perform the DML

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

ZDT_DOWNTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Downtime Extraction Index Hints

ZDT_DOWNTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

ZDT_UPTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Uptime Extraction Index Hints

ZDT_UPTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

TRANSFORMATION_OPERATOR Object

Table 3-46 TRANSFORMATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

RETURN_TYPE

STRING

none

none

none

empty string

Description not available.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

UNPIVOT_OPERATOR Object

Table 3-47 UNPIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

VIEW_OPERATOR Object

Table 3-48 VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

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_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150

INLINED

BOOLEAN

true, false

none

none

false

If set to true, the view query will be used as an inline subquery in the generated code.

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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

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.

VIEW_QUERY

STRING

none

none

none

empty string

The query text for this view.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

See Also

OMBALTER

OMBCREATE MAPPING

OMBRETRIEVE MAPPING

OMBDROP MAPPING

OMBALTER MAPPING_MODULE

Purpose

Alter the mapping module by renaming it, and/or reseting its properties.

Prerequisites

Should be in the context of a project.

Syntax

alterMapModuleCommand =  OMBALTER ( MAPPING_MODULE "QUOTED_STRING" (
          "renameClause" [
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" |
          "addOrRemoveOrModifyModuleReferenceLocationClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule =  (
          "alterJournalCodeTemplateClause" [
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceClauseForDataMetadataModule" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     alterJournalCodeTemplateClause =  SET "setJournalCodeTemplateClause" |
          UNSET "unsetJournalCodeTemplateClause"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( (
          "alterPropertiesClause" [ ( SET
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | (
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" SET AS DEFAULT
     setJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT "QUOTED_STRING"
          | ( ( REFERENCE | REF ) CDC_CT OPTIONS "(" "propertyValueList" ")"
          VALUES "(" "propertyValueList" ")" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  (
          "unsetReferenceLocationClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "setJournalCodeTemplateClause" [ SET
          "setReferenceMetadataLocationOrIconSetClause" ] |
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "unsetJournalCodeTemplateClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetClause" ] |
          "unsetReferenceMetadataLocationOrIconSetClause" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setReferenceMetadataLocationOrIconSetClause =  (
          "setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
           ] | "setReferenceIconSetClause" )
     unsetReferenceMetadataLocationOrIconSetClause =  (
          "unsetReferenceMetadataLocationClause" [ UNSET
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceMetadataLocationClause =  ( REFERENCE | REF )
          METADATA_LOCATION "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

alterMapModuleCommand

This command modifies an existing mapping module.

QUOTED_STRING

Name of the existing mapping module in single quotes.

renameClause

Rename a mapping module.

alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule

Set properties and/or metadata location and/or icon set and/or journal code template for the mapping module.

addOrRemoveOrModifyModuleReferenceLocationClause

Add/remove/modify data location for the mapping module.

alterPropertiesOrReferenceClauseForDataMetadataModule

Set properties and/or metadata location for the mapping module.

addReferenceLocationClause

Add a data location to the mapping module.

removeReferenceLocationClause

Remove a data location from the mapping module.

modifyReferenceLocationClause

Modify a data location of the mapping module.

alterPropertiesClause

Set the properties for the mapping module.

getPropertiesClause

Basic properties for MAPPING_MODULE:

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

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

setReferenceClauseForDataMetadataModule

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

unsetReferenceClauseForDataMetadataModule

Unset location and/or icon set for the mapping module.

propertyValueList

The values for the named properties.

propertyNameList

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

setReferenceLocationClause

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

setReferenceMetadataLocationOrIconSetOrJCTClause

Set metadata location and/or icon set and/or journal code template for the mapping module.

unsetReferenceLocationClause

Unset a data location to the existing mapping module.

unsetReferenceMetadataLocationOrIconSetOrJCTClause

Unset metadata location and/or icon set and/or journal code template for the mapping module.

propertyValue

A property value.

setReferenceMetadataLocationOrIconSetClause

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

unsetReferenceMetadataLocationOrIconSetClause

Unset metadata location and/or icon set for the mapping module.

setReferenceMetadataLocationClause

Set metadata location for the mapping module.

setReferenceIconSetClause

Set icon set for the mapping module.

unsetReferenceMetadataLocationClause

Unset metadata location for the mapping module.

unsetReferenceIconSetClause

Unset icon set for the mapping module.

MAPPING_MODULE Object

Table 3-49 MAPPING_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

ABAP_DIRECTORY

STRING

none

none

none

abap\

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

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.

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

none

empty string

END_OF_LINE

STRING

none

none

none

\r\n

End of Line

INPUT_DIRECTORY

STRING

none

none

none

input\

Input Directory

INVALID_DIRECTORY

STRING

none

none

none

invalid\

Directory for SQL*Loader errors and rejected records

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

PLSQL_DIRECTORY

STRING

none

none

none

pls\

Location where PL/SQL scripts are stored.

PLSQL_EXTENSION

STRING

none

none

none

.pls

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

SORT_DIRECTORY

STRING

none

none

none

sort\

Sort Directory

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

WORK_DIRECTORY

STRING

none

none

none

work\

Work Directory

See Also

OMBALTER

OMBCREATE MAPPING_MODULE

OMBDROP MAPPING_MODULE

OMBALTER MATERIALIZED_VIEW

Purpose

To alter properties and definition of a materialized view.

Prerequisites

In the context of an Oracle Module.

Syntax

alterMaterializedViewCommand =  OMBALTER ( MATERIALIZED_VIEW
          "QUOTED_STRING" ( "renameClause" [ "alterPropertiesOrIconSetClause" ]
          [ "alterMaterializedViewSCOandDependentClauses" ] |
          "alterPropertiesOrIconSetClause" [
          "alterMaterializedViewSCOandDependentClauses" ] |
          "alterMaterializedViewSCOandDependentClauses" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET ( REF |
           REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
          "setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause"
     alterMaterializedViewSCOandDependentClauses =  ADD (
          "addColumnClauseForAlter" [
          "alterMaterializedViewSCOandDependentClauses" ] |
          "addViewConstraintClause" { "alterViewConstraintClauses" } |
          "addSCOClause" { "alterMaterializedViewSCOClauses" } |
          "addDataRuleUsageClause" { "alterDataRuleUsageClauses" } |
          "addRelationalDependentClause" [
          "alterMaterializedViewSCOandDependentClauses" ] ) | MODIFY (
          "modifyColumnClause" [ "alterMaterializedViewSCOandDependentClauses" ]
           | "modifyViewConstraintClause" { "alterViewConstraintClauses" } |
          "modifySCOClause" { "alterMaterializedViewSCOClauses" } |
          "modifyDataRuleUsageClause" { "alterDataRuleUsageClauses" } ) | DELETE
           ( "deleteColumnClause" [
          "alterMaterializedViewSCOandDependentClauses" ] |
          "deleteViewConstraintClause" { "alterViewConstraintClauses" } |
          "deleteSCOClause" { "alterMaterializedViewSCOClauses" } |
          "deleteDataRuleUsageClause" { "alterDataRuleUsageClauses" } |
          "deleteRelationalDependentClause" [
          "alterMaterializedViewSCOandDependentClauses" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ICONSET
     addColumnClauseForAlter =  COLUMN "QUOTED_STRING" [ AT POSITION
          "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     addViewConstraintClause =  "addUkPkClause" | "addFkClause"
     alterViewConstraintClauses =  ADD "addViewConstraintClause" | MODIFY
          "modifyViewConstraintClause" | DELETE "deleteViewConstraintClause"
     addSCOClause =  "addIndexClause" | "addIndexPartitionClause" |
          "addIndexPartitionKeyClause" | "addPartitionClause" |
          "addPartitionKeyClause" | "addSubpartitionClause" |
          "addaddMaterializedViewSCOandDependentClauseClause" |
          "addSubPartitionKeyClause" | "addIndexColumnClause" |
          "addAttributeSetClause"
     alterMaterializedViewSCOClauses =  ADD "addSCOClause" | MODIFY
          "modifySCOClause" | DELETE "deleteSCOClause"
     addDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" SET REF DATA_RULE
           "QUOTED_STRING" ( GROUP "QUOTED_STRING" SET REF ( TABLE | VIEW |
          MATERIALIZED_VIEW | EXTERNAL_TABLE ) "QUOTED_STRING" ( ATTRIBUTE
          "QUOTED_STRING" SET REF COLUMN "QUOTED_STRING" )+ )+ [ SET
          "setPropertiesClause" ]
     alterDataRuleUsageClauses =  ADD "addDataRuleUsageClause" | MODIFY
          "modifyDataRuleUsageClause" | DELETE "deleteDataRuleUsageClause"
     addRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW ) "QUOTED_STRING"
     modifyColumnClause =  COLUMN "QUOTED_STRING" ( "renameClause" [
          "moveToClause" ] [ SET "setPropertiesClause" ] | "moveToClause" [ SET
          "setPropertiesClause" ] | SET "setPropertiesClause" )
     modifyViewConstraintClause =  "modifyUkPkClause" | "modifyFkClause"
     modifySCOClause =  "modifyIndexClause" | "modifyIndexPartitionClause" |
          "modifyIndexPartitionKeyClause" | "modifyPartitionClause" |
          "modifyPartitionKeyClause" |
          "modifyaddMaterializedViewSCOandDependentClauseClause" |
          "modifySubPartitionClause" | "modifySubPartitionKeyClause" |
          "modifyIndexColumnClause" | "modifyAttributeSetClause"
     modifyDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" (
          "renameClause" [ SET "setPropertiesClause" ] | SET
          "setPropertiesClause" )
     deleteColumnClause =  COLUMN "QUOTED_STRING"
     deleteViewConstraintClause =  UNIQUE_KEY "QUOTED_STRING" | PRIMARY_KEY
          "QUOTED_STRING" | FOREIGN_KEY "QUOTED_STRING"
     deleteSCOClause =  INDEX "QUOTED_STRING" | PARTITION "QUOTED_STRING" |
          PARTITION_KEY "QUOTED_STRING" | TEMPLATE_SUBPARTITION "QUOTED_STRING"
          | SUBPARTITION_KEY "QUOTED_STRING" | INDEX_COLUMN "QUOTED_STRING" OF
          INDEX "QUOTED_STRING" | INDEX_PARTITION "QUOTED_STRING" OF INDEX
          "QUOTED_STRING" | INDEX_PARTITION_KEY "QUOTED_STRING" OF INDEX
          "QUOTED_STRING" | SUBPARTITION "QUOTED_STRING" OF PARTITION
          "QUOTED_STRING" | ATTRIBUTE_SET "QUOTED_STRING"
     deleteDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING"
     deleteRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW ) "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     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"
     moveToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     modifyUkPkClause =  ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" (
          "renameClause" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ]
          | SET "setUkPkPropertiesAndReferencesColumnsClauses" )
     modifyFkClause =  FOREIGN_KEY "QUOTED_STRING" ( "renameClause" [ SET
          "setFkSubClauses" ] | SET "setFkSubClauses" )
     modifyIndexClause =  INDEX "QUOTED_STRING" ( "renameSCOConfigurationClause"
           [ SET "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyIndexPartitionClause =  INDEX_PARTITION "QUOTED_STRING" OF INDEX
          "QUOTED_STRING" ( "renameSCOConfigurationClause" [
          "moveToClauseIndexPartition" ] [ SET
          "setSCOConfigurationPropertiesClauses" ] |
          "moveToClauseIndexPartition" [ SET
          "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyIndexPartitionKeyClause =  INDEX_PARTITION_KEY "QUOTED_STRING" OF
          INDEX "QUOTED_STRING" ( SET "setSCOConfigurationPropertiesClauses" )
     modifyPartitionClause =  PARTITION "QUOTED_STRING" (
          "renameSCOConfigurationClause" [ "moveToClausePartition" ] [ SET
          "setSCOConfigurationPropertiesClauses" ] | "moveToClausePartition" [
          SET "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyPartitionKeyClause =  PARTITION_KEY "QUOTED_STRING" (
          "renameSCOConfigurationClause" [ SET
          "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyaddMaterializedViewSCOandDependentClauseClause =
          TEMPLATE_SUBPARTITION "QUOTED_STRING" ( "renameSCOConfigurationClause"
           [ "moveToClauseTemplateSubPartition" ] [ SET
          "setSCOConfigurationPropertiesClauses" ] |
          "moveToClauseTemplateSubPartition" [ SET
          "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifySubPartitionClause =  SUBPARTITION "QUOTED_STRING" OF PARTITION
          "QUOTED_STRING" ( "renameSCOConfigurationClause" [
          "moveToClauseSubPartition" ] [ SET
          "setSCOConfigurationPropertiesClauses" ] | "moveToClauseSubPartition"
          [ SET "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifySubPartitionKeyClause =  SUBPARTITION_KEY "QUOTED_STRING" (
          "renameSCOConfigurationClause" [ SET
          "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyIndexColumnClause =  INDEX_COLUMN "QUOTED_STRING" OF INDEX
          "QUOTED_STRING" ( "renameSCOConfigurationClause" [
          "moveToClauseForIndexColumn" ] [ SET
          "setSCOConfigurationPropertiesClauses" ] |
          "moveToClauseForIndexColumn" [ SET
          "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyAttributeSetClause =  ATTRIBUTE_SET "QUOTED_STRING" ( "renameClause"
          [ SET "setAttributeSetSubClauses" ] | SET "setAttributeSetSubClauses"
          )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     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"
     moveToClauseIndexPartition =  MOVE TO POSITION "INTEGER_LITERAL"
     moveToClausePartition =  MOVE TO POSITION "INTEGER_LITERAL"
     moveToClauseTemplateSubPartition =  MOVE TO POSITION "INTEGER_LITERAL"
     moveToClauseSubPartition =  MOVE TO POSITION "INTEGER_LITERAL"
     moveToClauseForIndexColumn =  MOVE TO POSITION "INTEGER_LITERAL"
     setAttributeSetSubClauses =  "setPropertiesClause" [ SET
          "attributeSetAttributesClause" ] | "attributeSetAttributesClause"
     constraintColumnReferencesClause =  COLUMNS "(" "quotedNameList" ")"
     setFkReferencesClauses =  "constraintColumnReferencesClause" [ SET ( REF |
          REFERENCE ) "constraintUkReferencesClause" ] |
          "constraintUkReferencesClause" [ SET ( REF | REFERENCE )
          "constraintColumnReferencesClause" ]
     attributeSetAttributesClause =  ATTRIBUTES "(" "quotedNameList" ")"
     quotedNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     constraintUkReferencesClause =  ( UNIQUE_KEY | PRIMARY_KEY )
          "QUOTED_STRING" [ OF ( TABLE | VIEW ) "QUOTED_STRING" ]

Parameters

alterMaterializedViewCommand

This clause alters a materialized view.

QUOTED_STRING

name of the materialized view.

renameClause

renames a table with a different name.

setPropertiesClause

Used to set properties (core, logical, physical, user-defined) for 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.

addColumnClauseForAlter

This clause adds a column at a particular position.

When you alter a table and add columns to it, the position you specify for a new column must be less than or equal to the number of columns added up to that point in the OMBALTER command.

For example, a table TEMP_TAB contains three columns. You use the following

OMBALTER TABLE command to add three more columns:

OMBALTER TABLE 'TEMP_TAB' \

ADD COLUMN 'C4' AT POSITION 4 \

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

ADD COLUMN 'C5' AT POSITION 6 \

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

ADD COLUMN 'C6' AT POSITION 5 \

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

This command does not execute successfully because at the point when you specify the position of the column C5 as 6, the table is contains only 5 columns.

QUOTED_STRING

The column name.

addViewConstraintClause

This clause adds the view's configuration clause.

alterViewConstraintClauses

This clause alters the view's constraint clause.

addSCOClause

This clause will add SCOs.

addDataRuleUsageClause

Add a data rule usage to the relation.

alterDataRuleUsageClauses

Add, modify, or delete data rule usages.

addRelationalDependentClause

This clause adds referential dependencies to other relational objects.

modifyColumnClause

This clause renames, set properties, and move columns.

modifyViewConstraintClause

This clause modifies the view's constraint clause.

modifySCOClause

This clause will modify SCOs.

modifyDataRuleUsageClause

Rename or modify the properties of a data rule usage.

deleteColumnClause

This clause deletes a column.

deleteViewConstraintClause

This clause deletes the view's constraint.

deleteSCOClause

This clause deletes a SCO(Second Class Object).

QUOTED_STRING

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

deleteDataRuleUsageClause

Delete a data rule usage.

deleteRelationalDependentClause

This clause deletes referential dependencies to other relational objects.

propertyNameList

The list of properties.

propertyValueList

The list of 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.

moveToClause

This clause will move the column to given position.

modifyUkPkClause

This clause modifies a unique or primary key.

modifyFkClause

This clause modifies the foreign key.

modifyIndexClause

This clause modifies the Index.

QUOTED_STRING

Name of the index.

modifyPartitionClause

This clause modifies a partition.

QUOTED_STRING

Name of the partition.

modifyPartitionKeyClause

This clause modifies a partition key.

QUOTED_STRING

Name of the partition key.

modifyIndexColumnClause

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

modifyAttributeSetClause

This clause modifies an attribute set.

propertyValue

This clause adds the property values.

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.

setAttributeSetSubClauses

This clause is used to set up an attribute set.

constraintColumnReferencesClause

This clause provides names of all columns.

setFkReferencesClauses

This clause sets foreign key references.

attributeSetAttributesClause

This clause is used to specify attributes belonging to an attribute set.

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 3-50 MATERIALIZED_VIEW Object

Property
Type
Choices
Min
Max
Default
Description

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 3-51 COLUMN Object

Property
Type
Choices
Min
Max
Default
Description

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 3-52 UNIQUE_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 3-53 FOREIGN_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 3-54 CHECK_CONSTRAINT Object

Property
Type
Choices
Min
Max
Default
Description

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 3-55 INDEX Object

Property
Type
Choices
Min
Max
Default
Description

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 3-56 PARTITION Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBALTER

OMBCREATE MATERIALIZED_VIEW

OMBDROP MATERIALIZED_VIEW

OMBRETRIEVE MATERIALIZED_VIEW

OMBALTER MDL_ACTION_PLAN

Purpose

Modify an existing metadata loader action plan.

Prerequisites

Connection must be established to the repository.

Syntax

alterMDLActionPlanCommand =  ( OMBALTER ( MDL_ACTION_PLAN ) "QUOTED_STRING"
           ( "alterActionPlanClause" { "alterActionPlanClause" } ) )
     alterActionPlanClause =  "renameActionPlanClause" | "addActionClause" |
          "deleteActionClause" | "modifyActionClause"
     renameActionPlanClause =  RENAME TO "QUOTED_STRING"
     addActionClause =  ADD ACTION "QUOTED_STRING" "setReferenceClause"
     deleteActionClause =  DELETE ACTION "QUOTED_STRING"
     modifyActionClause =  MODIFY ACTION "QUOTED_STRING" "modifyActionOperation"
           { "modifyActionOperation" }
     setReferenceClause =  SET ( REF | REFERENCE ) ( "referenceValueClause" )
     modifyActionOperation =  "renameActionClause" | "setReferenceClause" |
          "deleteReferenceClause"
     referenceValueClause =  "objectTypeValue" "QUOTED_STRING" [ SET ( REF |
          REFERENCE ) "referenceValueClause" ]
     renameActionClause =  RENAME TO "QUOTED_STRING"
     deleteReferenceClause =  DELETE REFERENCE "objectTypeValue" "QUOTED_STRING"
     objectTypeValue =  ( PROJECT | ORACLE_MODULE | TABLE | VIEW | SEQUENCE |
          MATERIALIZED_VIEW | FUNCTION | PROCEDURE | PACKAGE | DIMENSION | CUBE
          | ADVANCED_QUEUE | MAPPING | REAL_TIME_MAPPING | PROCESS_FLOW_MODULE |
           PROCESS_FLOW_PACKAGE | PROCESS_FLOW | APPLICATION_SERVER_MODULE |
          WEB_SERVICE_PACKAGE | WEB_SERVICE | SAP_MODULE | CMI_MODULE |
          GATEWAY_MODULE | EXTERNAL_TABLE | FLAT_FILE_MODULE | FLAT_FILE |
          BUSINESS_DEFINITION_MODULE | OBIEE_BUSINESS_DEFINITION_MODULE |
          ITEM_FOLDER | LOGICAL_TABLE | LIST_OF_VALUES | DRILL_TO_DETAIL |
          ALTERNATIVE_SORT_ORDER | DRILL_PATH | BUSINESS_AREA | CATALOG_FOLDER |
           LOCATION | CONNECTOR | CONTROL_CENTER | CONFIGURATION | COLLECTION |
          SNAPSHOT | ROLE | USER | ICONSET | TRANSFORMATION_MODULE |
          CALENDAR_MODULE | CALENDAR_FOLDER | CALENDAR | EXPERT_MODULE | EXPERT
          | CT_FOLDER | CT | DATA_RULE_MODULE | DATA_RULE | DATA_AUDITOR |
          QUEUE_TABLE | QUEUE_PROPAGATION | OBJECT_TYPE | NESTED_TABLE |
          VARYING_ARRAY | DEPLOYMENT | DATA_PROFILE | PROFILE_REFERENCE |
          PLSQL_TABLE_TYPE | PLSQL_RECORD_TYPE | PLSQL_REF_CURSOR_TYPE |
          PLUGGABLE_MAPPING | PLUGGABLE_MAPPING_FOLDER |
          PLUGGABLE_MAPPING_LIBRARY | CMI_DEFINITION | ACTIVITY_TEMPLATE |
          ACTIVITY_TEMPLATE_FOLDER | TRANSPORTABLE_MODULE | MODULE )

Parameters

alterMDLActionPlanCommand

Modify an existing metadata loader action plan.

alterActionPlanClause

The type of altering that can be performed on the action plan.

renameActionPlanClause

Rename an action plan.

addActionClause

Add an action to an action plan.

deleteActionClause

Removes an action from an action plan.

modifyActionClause

Modify an action of an action plan.

setReferenceClause

Specify the object type and the absolute path name of an object.

modifyActionOperation

The type of operations that can be performed on an action.

referenceValueClause

Specify a first-class object type and the absolute pathname of an object.

QUOTED_STRING

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

renameActionClause

Rename an action of an action plan.

deleteReferenceClause

Remove a reference object from an action plan.

objectTypeValue

The first-class object type that is allowed to be specified in the referenceValueClause.

See Also

OMBCREATE MDL_ACTION_PLAN

OMBDROP MDL_ACTION_PLAN

OMBRETRIEVE MDL_ACTION_PLAN

OMUEXPORT MDL_FILE

OMBALTER MODULE

Purpose

alterModuleCommandPurposeTag??

Prerequisites

alterModuleCommandPreTag??

Syntax

alterModuleCommand =  OMBALTER ( MODULE "QUOTED_STRING" ( "renameClause" [
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" |
          "addOrRemoveOrModifyModuleReferenceLocationClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule =  (
          "alterJournalCodeTemplateClause" [
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceClauseForDataMetadataModule" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     alterJournalCodeTemplateClause =  SET "setJournalCodeTemplateClause" |
          UNSET "unsetJournalCodeTemplateClause"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( (
          "alterPropertiesClause" [ ( SET
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | (
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" SET AS DEFAULT
     setJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT "QUOTED_STRING"
          | ( ( REFERENCE | REF ) CDC_CT OPTIONS "(" "propertyValueList" ")"
          VALUES "(" "propertyValueList" ")" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  (
          "unsetReferenceLocationClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "setJournalCodeTemplateClause" [ SET
          "setReferenceMetadataLocationOrIconSetClause" ] |
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "unsetJournalCodeTemplateClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetClause" ] |
          "unsetReferenceMetadataLocationOrIconSetClause" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setReferenceMetadataLocationOrIconSetClause =  (
          "setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
           ] | "setReferenceIconSetClause" )
     unsetReferenceMetadataLocationOrIconSetClause =  (
          "unsetReferenceMetadataLocationClause" [ UNSET
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceMetadataLocationClause =  ( REFERENCE | REF )
          METADATA_LOCATION "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

renameClause

Rename the module.

addOrRemoveOrModifyModuleReferenceLocationClause

Add/remove/modify data location for the module.

alterPropertiesOrReferenceClauseForDataMetadataModule

Alter existing module's properties and/or locations and/or icon sets.

addReferenceLocationClause

Add a data location to the module.

removeReferenceLocationClause

Remove a data location from the module.

modifyReferenceLocationClause

Modify a data location of the module.

alterPropertiesClause

Associate a set of properties with the existing module.

setReferenceClauseForDataMetadataModule

Set location and/or icon set for the module.

unsetReferenceClauseForDataMetadataModule

Unset location and/or icon set for the module.

propertyValueList

Comma separated list of property values.

propertyNameList

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

setReferenceLocationClause

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

unsetReferenceLocationClause

Unset a location to the existing module.

propertyValue

Value of a property.

setReferenceMetadataLocationOrIconSetClause

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

unsetReferenceMetadataLocationOrIconSetClause

Unset metadata location and/or icon set for the module.

setReferenceMetadataLocationClause

Set metadata location for the module.

setReferenceIconSetClause

Set icon set for the module.

unsetReferenceMetadataLocationClause

Unset metadata location for the module.

unsetReferenceIconSetClause

Unset icon set for the module.

See Also

OMBALTER

OMBCREATE MODULE

OMBALTER NESTED_TABLE

Purpose

Alter the Nested Table by resetting its properties.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

alterNestedTableCommand =  OMBALTER ( NESTED_TABLE "QUOTED_STRING" (
          "renameClause" [ "alterPropertiesOrIconSetClause" ] |
          "alterPropertiesOrIconSetClause" ) )
     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

alterNestedTableCommand

Alters a Nested Table of the given name by either renaming it, or by setting it's properties or a combination of these.

renameClause

renames a table with a different name.

alterPropertiesOrIconSetClause

Alters Nested Table properties or icon set.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Nested Table

getPropertiesClause

Basic properties for NESTED_TABLE:

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

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

Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Base Element of the Nested Table

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.

NESTED_TABLE Object

Table 3-57 NESTED_TABLE Object

Property
Type
Choices
Min
Max
Default
Description

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBALTER

OMBCREATE NESTED_TABLE

OMBDROP NESTED_TABLE

OMBALTER OBIEE_BUSINESS_DEFINITION_MODULE

Purpose

Alter an Oracle BI business definition module by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of project.

Syntax

alterOBIEEModuleCommand =  OMBALTER ( OBIEE_BUSINESS_DEFINITION_MODULE
          "QUOTED_STRING" ( "renameClause" [
          "alterPropertiesOrReferenceClauseForDataOnlyModule" ] |
          "alterPropertiesOrReferenceClauseForDataOnlyModule" |
          "addOrRemoveOrModifyModuleReferenceLocationClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceClauseForDataOnlyModule =  ( ( SET ( (
          "setPropertiesClause" [ ( SET "setReferenceClauseForDataOnlyModule" [
          UNSET "unsetReferenceClauseForDataOnlyModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataOnlyModule" [ SET
          "setReferenceClauseForDataOnlyModule" ] ) ] ) | (
          "setReferenceClauseForDataOnlyModule" [ UNSET
          "unsetReferenceClauseForDataOnlyModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataOnlyModule" [ SET
          "setReferenceClauseForDataOnlyModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataOnlyModule =  ( "setReferenceLocationClause" [ SET
           "setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
     unsetReferenceClauseForDataOnlyModule =  ( "unsetReferenceLocationClause" [
           UNSET "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause"
           )
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" SET AS DEFAULT
     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

alterOBIEEModuleCommand

This command modifies an existing Oracle BI business definition module.

renameClause

Rename an Oracle BI business definition module.

alterPropertiesOrReferenceClauseForDataOnlyModule

Alter existing business definition module's properties and/or locations and/or icon sets.

addOrRemoveOrModifyModuleReferenceLocationClause

Add/remove/modify data location for the business definition module.

setPropertiesClause

Associate a set of properties with the existing 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

setReferenceClauseForDataOnlyModule

Set location and/or icon set for the new Oracle BI business definition module.

unsetReferenceClauseForDataOnlyModule

Unset location and/or icon set for the Oracle BI business definition module.

addReferenceLocationClause

Add a data location to the new Oracle BI business definition module.

removeReferenceLocationClause

Remove a data location from the Oracle BI business definition module.

modifyReferenceLocationClause

Modify a data location of the Oracle BI business definition module.

propertyNameList

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

propertyValueList

Comma-separated list of property values.

setReferenceLocationClause

Set a data location for the existing Oracle BI business definition module as the new configuration default.

setReferenceIconSetClause

Set icon set for the new Oracle BI business definition module.

unsetReferenceLocationClause

Unset a data location for the existing Oracle BI business definition module.

unsetReferenceIconSetClause

Unset icon set for the Oracle BI business definition module.

propertyValue

Value for a specified property.

OBIEE_BUSINESS_DEFINITION_MODULE Object

Table 3-58 OBIEE_BUSINESS_DEFINITION_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER

OMBCREATE OBIEE_BUSINESS_DEFINITION_MODULE

OMBDROP OBIEE_BUSINESS_DEFINITION_MODULE

OMBALTER OBJECT_TYPE

Purpose

Alter the Object Type by resetting its properties or adding/removing its attributes.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

alterObjectTypeCommand =  OMBALTER ( OBJECT_TYPE "QUOTED_STRING" (
          "renameClause" [ "alterPropertiesOrIconSetClause" ] [
          "alterAttributesClause" ] | "alterPropertiesOrIconSetClause" [
          "alterAttributesClause" ] | "alterAttributesClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET ( REF |
           REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
          "setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause"
     alterAttributesClause =  ( "addAttributeClause" | "deleteAttributeClause" |
           "modifyAttributeClause" )+
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ICONSET
     addAttributeClause =  ADD OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING" [ AT
          POSITION "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     deleteAttributeClause =  DELETE OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING"
     modifyAttributeClause =  MODIFY OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING" (
          "renameClause" [ "moveToAttributeClause" ] [ SET "setPropertiesClause"
           ] | "moveToAttributeClause" [ SET "setPropertiesClause" ] | SET
          "setPropertiesClause" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     moveToAttributeClause =  MOVE TO POSITION "INTEGER_LITERAL"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterObjectTypeCommand

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

renameClause

renames a table with a different name.

alterPropertiesOrIconSetClause

Alters Object Type properties or icon set.

alterAttributesClause

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

setPropertiesClause

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

getPropertiesClause

Basic properties for OBJECT_TYPE:

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

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

Basic properties for OBJECT_TYPE_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, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Attribute

setReferenceIconSetClause

Sets reference icon set.

unsetReferenceIconSetClause

Unsets reference icon set.

addAttributeClause

Adds an Attribute with the given name and properties.

deleteAttributeClause

Deletes an Attribute with the given name.

modifyAttributeClause

Modifies an Attribute with the given name by either renaming it or changing its properties or both.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

moveToAttributeClause

Modifies an attributes position from current position to given position.

propertyValue

This clause adds the property values.

OBJECT_TYPE Object

Table 3-59 OBJECT_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

OBJECT_TYPE_ATTRIBUTE Object

Table 3-60 OBJECT_TYPE_ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBALTER

OMBRETRIEVE OBJECT_TYPE

OMBCREATE OBJECT_TYPE

OMBDROP OBJECT_TYPE

OMBALTER ORACLE_EBS_MODULE

Purpose

alterOracleEBSModuleCommandPurposeTag??

Prerequisites

alterOracleEBSModuleCommandPreTag??

Syntax

alterOracleEBSModuleCommand =  OMBALTER ( ORACLE_EBS_MODULE "QUOTED_STRING"
           ( "renameClause" [
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule =  (
          "alterJournalCodeTemplateClause" [
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceClauseForDataMetadataModule" )
     alterJournalCodeTemplateClause =  SET "setJournalCodeTemplateClause" |
          UNSET "unsetJournalCodeTemplateClause"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( (
          "alterPropertiesClause" [ ( SET
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | (
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     setJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT "QUOTED_STRING"
          | ( ( REFERENCE | REF ) CDC_CT OPTIONS "(" "propertyValueList" ")"
          VALUES "(" "propertyValueList" ")" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  (
          "unsetReferenceLocationClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "setJournalCodeTemplateClause" [ SET
          "setReferenceMetadataLocationOrIconSetClause" ] |
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "unsetJournalCodeTemplateClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetClause" ] |
          "unsetReferenceMetadataLocationOrIconSetClause" )
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" SET AS DEFAULT
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setReferenceMetadataLocationOrIconSetClause =  (
          "setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
           ] | "setReferenceIconSetClause" )
     unsetReferenceMetadataLocationOrIconSetClause =  (
          "unsetReferenceMetadataLocationClause" [ UNSET
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceMetadataLocationClause =  ( REFERENCE | REF )
          METADATA_LOCATION "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

See Also

OMBALTER

OMBCREATE ORACLE_EBS_MODULE

OMBDROP ORACLE_EBS_MODULE

OMBALTER ORACLE_MODULE

Purpose

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

Prerequisites

Should be in the context of project.

Syntax

alterOracleModuleCommand =  OMBALTER ( ORACLE_MODULE "QUOTED_STRING" (
          "renameClause" [
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" |
          "addOrRemoveOrModifyModuleReferenceLocationClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule =  (
          "alterJournalCodeTemplateClause" [
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceClauseForDataMetadataModule" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     alterJournalCodeTemplateClause =  SET "setJournalCodeTemplateClause" |
          UNSET "unsetJournalCodeTemplateClause"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( (
          "alterPropertiesClause" [ ( SET
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | (
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" SET AS DEFAULT
     setJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT "QUOTED_STRING"
          | ( ( REFERENCE | REF ) CDC_CT OPTIONS "(" "propertyValueList" ")"
          VALUES "(" "propertyValueList" ")" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  (
          "unsetReferenceLocationClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "setJournalCodeTemplateClause" [ SET
          "setReferenceMetadataLocationOrIconSetClause" ] |
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "unsetJournalCodeTemplateClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetClause" ] |
          "unsetReferenceMetadataLocationOrIconSetClause" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setReferenceMetadataLocationOrIconSetClause =  (
          "setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
           ] | "setReferenceIconSetClause" )
     unsetReferenceMetadataLocationOrIconSetClause =  (
          "unsetReferenceMetadataLocationClause" [ UNSET
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceMetadataLocationClause =  ( REFERENCE | REF )
          METADATA_LOCATION "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

alterOracleModuleCommand

This command modifies an existing Oracle module.

QUOTED_STRING

Name of the existing Oracle module in single quotes.

renameClause

Rename an Oracle module.

addOrRemoveOrModifyModuleReferenceLocationClause

Add/remove/modify data location for the Oracle module.

alterPropertiesOrReferenceClauseForDataMetadataModule

Alter existing Oracle module's properties and/or locations and/or icon sets.

addReferenceLocationClause

Add a data location to the Oracle module.

removeReferenceLocationClause

Remove a data location from the Oracle module.

modifyReferenceLocationClause

Modify a data location of the Oracle module.

alterPropertiesClause

Associate a set of properties with the existing Oracle module.

getPropertiesClause

Basic properties for ORACLE_MODULE:

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

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

setReferenceClauseForDataMetadataModule

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

unsetReferenceClauseForDataMetadataModule

Unset location and/or icon set for the Oracle module.

propertyValueList

Comma separated list of property values.

propertyNameList

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

setReferenceLocationClause

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

unsetReferenceLocationClause

Unset a data location to the existing Oracle module.

propertyValue

Value of a property.

setReferenceMetadataLocationOrIconSetClause

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

unsetReferenceMetadataLocationOrIconSetClause

Unset metadata location and/or icon set for the Oracle module.

setReferenceMetadataLocationClause

Set metadata location for the Oracle module.

setReferenceIconSetClause

Set icon set for the Oracle module.

unsetReferenceMetadataLocationClause

Unset metadata location for the Oracle module.

unsetReferenceIconSetClause

Unset icon set for the Oracle module.

ORACLE_MODULE Object

Table 3-61 ORACLE_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

ABAP_DIRECTORY

STRING

none

none

none

abap\

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

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.

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

none

empty string

END_OF_LINE

STRING

none

none

none

\r\n

End of Line

INPUT_DIRECTORY

STRING

none

none

none

input\

Input Directory

INVALID_DIRECTORY

STRING

none

none

none

invalid\

Directory for SQL*Loader errors and rejected records

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

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

SORT_DIRECTORY

STRING

none

none

none

sort\

Sort Directory

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

WORK_DIRECTORY

STRING

none

none

none

work\

Work Directory

See Also

OMBALTER

OMBCREATE ORACLE_MODULE

OMBDROP ORACLE_MODULE

OMBALTER PACKAGE

Purpose

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

Prerequisites

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

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

alterPackageCommand =  OMBALTER ( PACKAGE "QUOTED_STRING" ( "renameClause"
          [ "alterPropertiesOrIconSetClause" ] [
          "alterRelationalDependentsClause" ] | "alterPropertiesOrIconSetClause"
           [ "alterRelationalDependentsClause" ] |
          "alterRelationalDependentsClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
     alterRelationalDependentsClause =  ( ADD "addRelationalDependentClause" |
          DELETE "deleteRelationalDependentClause" ) [
          "alterRelationalDependentsClause" ]
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     addRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
          "QUOTED_STRING"
     deleteRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
          "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterPackageCommand

This command modifies an existing Package.

QUOTED_STRING

Name of the existing Package in single quotes.

renameClause

Rename a Package.

alterPropertiesOrIconSetClause

Used to alter package properties or icon set.

alterRelationalDependentsClause

This clause adds or deletes referential dependencies to other relational objects.

setPropertiesClause

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

setPropertiesClause

Basic properties for PACKAGE:

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

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

Name: PACKAGE_BODY
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Sets the Package Body for a Imported Package

setReferenceIconSetClause

Used to set reference icon set.

unsetReferenceIconSetClause

Used to unset reference icon set associated with current package.

addRelationalDependentClause

This clause adds referential dependencies to other relational objects.

deleteRelationalDependentClause

This clause deletes referential dependencies to other relational objects.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

PACKAGE Object

Table 3-62 PACKAGE Object

Property
Type
Choices
Min
Max
Default
Description

AUTHID

STRING

, Current_User, Definer

none

none

empty string

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

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBALTER

OMBCREATE PACKAGE

OMBDROP PACKAGE

OMBALTER PLATFORM

Purpose

Alters a platform, allowing the properties and platform content to be changed. Use this to add or remove data types, change or add type mappings to and from the core platform.

Prerequisites

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

Syntax

alterPlatformCommand =  OMBALTER ( PLATFORM "QUOTED_STRING" ( [
          "renameClause" ] [ SET "setPropertiesClause" ] ( {
          "addPlatformTypeClause" } ) ( { "addFromPlatformTypeMapClause" } ) ( {
           "addToPlatformTypeMapClause" } ) ( { "modifyPlatformTypeClause" } ) (
           { "modifyFromPlatformTypeMapClause" } ) ( {
          "modifyToPlatformTypeMapClause" } ) ( { "removePlatformTypeClause" } )
           ( { "removeFromPlatformTypeMapClause" } ) ( {
          "removeToPlatformTypeMapClause" } ) [ SET "setMIVForPlatformClause" ]
          [ UNSET "unsetMIVForPlatformClause" ] [ SET
          "setDefaultKMForPlatformClause" ] [ UNSET
          "unsetDefaultKMForPlatformClause" ] ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     addPlatformTypeClause =  ADD ( PLATFORM_TYPE "QUOTED_STRING" [ SET
          "setPropertiesClause" ] )
     addFromPlatformTypeMapClause =  ADD ( FROM_PLATFORM_TYPEMAP "QUOTED_STRING"
           [ SET "setPropertiesClause" ] )
     addToPlatformTypeMapClause =  ADD ( TO_PLATFORM_TYPEMAP "QUOTED_STRING" [
          SET "setPropertiesClause" ] )
     modifyPlatformTypeClause =  MODIFY ( PLATFORM_TYPE "QUOTED_STRING" [ SET
          "setPropertiesClause" ] )
     modifyFromPlatformTypeMapClause =  MODIFY ( FROM_PLATFORM_TYPEMAP
          "QUOTED_STRING" [ SET "setPropertiesClause" ] )
     modifyToPlatformTypeMapClause =  MODIFY ( TO_PLATFORM_TYPEMAP
          "QUOTED_STRING" [ SET "setPropertiesClause" ] )
     removePlatformTypeClause =  REMOVE ( PLATFORM_TYPE "QUOTED_STRING" )
     removeFromPlatformTypeMapClause =  REMOVE ( FROM_PLATFORM_TYPEMAP
          "QUOTED_STRING" )
     removeToPlatformTypeMapClause =  REMOVE ( TO_PLATFORM_TYPEMAP
          "QUOTED_STRING" )
     setMIVForPlatformClause =  ( ( REF | REFERENCE ) CMI_DEFINITION
          "QUOTED_STRING" )
     unsetMIVForPlatformClause =  ( ( REF | REFERENCE ) CMI_DEFINITION )
     setDefaultKMForPlatformClause =  ( DEFAULT_LOAD_CT "kmName" FOR PROJECT
          "projectName" FOR SOURCE_PLATFORM "platformName" |
          DEFAULT_INTEGRATION_CT "kmName" FOR PROJECT "projectName" |
          DEFAULT_ORACLE_TARGET_CT "kmName" FOR PROJECT "projectName" )
     unsetDefaultKMForPlatformClause =  ( DEFAULT_LOAD_CT FOR PROJECT
          "projectName" FOR SOURCE_PLATFORM "platformName" |
          DEFAULT_INTEGRATION_CT FOR PROJECT "projectName" |
          DEFAULT_ORACLE_TARGET_CT FOR PROJECT "projectName" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     kmName =  "QUOTED_STRING"
     projectName =  "QUOTED_STRING"
     platformName =  "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterPlatformCommand

Alter a platform definition in the repository.

renameClause

Rename the platform definitions.

setPropertiesClause

Set the characteristics of the platform, this includes the driver class for connecting to the system and default connection string.

platformTypeProperties

Basic properties for PLATFORM:

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

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

platformTypeProperties

Properties for PLATFORM:
Name: COL_ALIAS_WORD
Type: STRING
Column alias word.

Name: DATE_FCT
Type: STRING
The function allowing the date and time to be returned - for example in Oracle this would by SYSDATE and DB2 UDB would be CURRENT TIMESTAMP

Name: DATE_MASK
Type: STRING
The syntax to be used to describe the Date datatype in DDL, for example in Oracle may be DATE in DB2 UDB TIMESTAMP.

Name: DDLNULL
Type: STRING
The word used to describe a column that can contain empty (null) values. For example in Oracle NULL is used.

Name: DEFAULT_MAX_NAME_LEN
Type: INTEGER
The default max length name of a relational access item (ie. a table).

Name: DEFAULT_NAME_LEN_SEMANTICS
Type: STRING
The name length semantics to be used (CHARACTER or BYTE).

Name: DELETE_IN_OVERRIDE
Type: BOOLEAN
Delete in override property

Name: DRIVER_CLASS
Type: STRING
The driver class name, all locations created for this platform will be created using this driver class.

Name: ENCLOSURE_CHAR
Type: STRING
The character used to delimit names ie. single quote, double quote etc.

Name: ESCAPE_CHAR
Type: STRING
Escape character.

Name: ILLEGAL_CHARS
Type: STRING
The list of illegal characters that can be in a name.

Name: ILLEGAL_LEADING_CHARS
Type: STRING
The list of illegal characters that a name can start with.

Name: LOCAL_OBJECT_MASK
Type: STRING
This determines how an object is named when you are connected to the location the object is based on. For Oracle this should be
%SCHEMA.%OBJECT The list of tags available for the mask include;
%CATALOG to represent the physical catalog name
%SCHEMA to represent the schema name
%OBJECT to represent the object name

Name: NUMERIC_MASK
Type: STRING
The syntax to be used to describe the Numerical datatype in DDL, the tags %L (data length) and %P (precision) can be used.

Name: REMOTE_OBJECT_MASK
Type: STRING
This determines how an object is named when you are not connected to the location the object is based on. For Oracle this should be
%SCHEMA.%OBJECT The list of tags available for the mask include;
%CATALOG to represent the physical catalog name
%SCHEMA to represent the schema name
%OBJECT to represent the object name
%DSERVER to represent the data server

Name: RESERVED_WORDS
Type: STRING
The list of reserved words which cannot be used for names of objects.

Name: SEEDED
Type: BOOLEAN
A flag to indicate if the platform was seeded.

Name: SPECIAL_MAX_NAME_LEN
Type: STRING
Name length for secondary objects such as column, index (the value has the following format INDEX=18:COLUMN=30:PACKAGE=18)

Name: SPECIAL_NAME_LEN_SEMANTICS
Type: STRING
SpecialNameLenSemantics

Name: TAB_ALIAS_WORD
Type: STRING
The element designed to separate a table name from its alias in a SQL FROM clause. This element may be left incomplete.

Name: URI_TEMPLATE
Type: STRING
A sample template URI for accessing the platform.

Name: VARCHAR_MASK
Type: STRING
The syntax to be used to describe the String datatype in DDL, the tags %L (data length) and %P (precision) can be used.

platformTypeProperties

Properties for PLATFORM_TYPE:
Name: IS_DEFAULT
Type: BOOLEAN
Is this the default datatype for the platform.

Name: P1
Type: STRING
Parameter from the following list (leave blank if not applicable);
size: for length
precision: for numbers
scale: for numbers

Name: P1DEFAULT
Type: STRING
Default value for P1; leave blank if not applicable

Name: P1MAX
Type: STRING
Maximum value for P1; leave blank if not applicable

Name: P1MIN
Type: STRING
Minimum value for P1; leave blank if not applicable

Name: P1TYPE
Type: STRING
Parameter type from the following supported list (Leave blank if not applicable): range

Name: SEEDED
Type: BOOLEAN
Seeded indicator for the platform types which are pre-seeded.

Name: SYNTAX
Type: STRING
DDL Syntax for columns of this data type, can use %size %precision %scale. For example CHAR(%size) is the syntax for defining a data type of CHAR which has a particular length

addPlatformTypeClause

Add a type to the platform definition.

addFromPlatformTypeMapClause

Add a mapping from this type to a generic type.

addToPlatformTypeMapClause

Add a mapping from a generic type to the platform type.

modifyPlatformTypeClause

Modify a type definition.

modifyFromPlatformTypeMapClause

Modify a mapping from this type to a generic type.

modifyToPlatformTypeMapClause

Modify a mapping from a generic type to the platform type.

removePlatformTypeClause

Remove a type from the platform definition.

removeFromPlatformTypeMapClause

Remove a mapping from this type to a generic type.

removeToPlatformTypeMapClause

Remove a mapping from a generic type to the platform type.

setMIVForPlatformClause

Set the CMI Definition for this platform. This optional class lets custom metadata import objects be defined to override the use of the JDBC metadata import for example.

unsetMIVForPlatformClause

Unset the CMI Definition for ths removes the custom import and reverts to the JDBC metadata import for example.

setDefaultKMForPlatformClause

Set the default CT for this platform.

unsetDefaultKMForPlatformClause

Unset the default CT for this platform.

propertyNameList

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

propertyValueList

Comma separated list of property values.

kmName

The CT physical name.

projectName

The name for this project.

platformName

The name for this platform definition.

propertyValue

Value of a property.

See Also

OMBALTER

OMBCREATE PLATFORM

OMBALTER PLSQL_RECORD_TYPE

Purpose

Alter the PLSQL Record Type by resetting its properties or adding/removing its attributes.

Prerequisites

Should be in the context of a Package

Syntax

alterPlSqlRecordTypeCommand =  OMBALTER ( PLSQL_RECORD_TYPE "QUOTED_STRING"
           ( "renameClause" [ "alterPropertiesOrIconSetClause" ] [
          "alterRecordTypeAttributeClause" ] | "alterPropertiesOrIconSetClause"
          [ "alterRecordTypeAttributeClause" ] |
          "alterRecordTypeAttributeClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET ( REF |
           REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
          "setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause"
     alterRecordTypeAttributeClause =  ( "addRecordTypeAttributeClause" |
          "deleteRecordTypeAttributeClause" | "modifyRecordTypeAttributeClause"
          )+
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ICONSET
     addRecordTypeAttributeClause =  ADD ATTRIBUTE "QUOTED_STRING" [ AT POSITION
           "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     deleteRecordTypeAttributeClause =  DELETE ATTRIBUTE "QUOTED_STRING"
     modifyRecordTypeAttributeClause =  MODIFY ATTRIBUTE "QUOTED_STRING" (
          "renameClause" [ "moveToPlSqlAttributeClause" ] [ SET
          "setPropertiesClause" ] | "moveToPlSqlAttributeClause" [ SET
          "setPropertiesClause" ] | SET "setPropertiesClause" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     moveToPlSqlAttributeClause =  MOVE TO POSITION "INTEGER_LITERAL"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterPlSqlRecordTypeCommand

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

renameClause

renames a table with a different name.

alterPropertiesOrIconSetClause

Alters PLSQL Record Type properties or icon set.

alterRecordTypeAttributeClause

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

setPropertiesClause

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

getPropertiesClause

Basic properties for PLSQL_RECORD_TYPE:

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

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

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, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Attribute

setReferenceIconSetClause

Sets reference icon set.

unsetReferenceIconSetClause

Unsets reference icon set.

addRecordTypeAttributeClause

Adds an Attribute with the given name and properties.

deleteRecordTypeAttributeClause

Deletes an Attribute with the given name.

modifyRecordTypeAttributeClause

Modifies an Attribute with the given name by either renaming it or changing its properties or both.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

moveToPlSqlAttributeClause

Modifies an attributes position from current position to given position.

propertyValue

This clause adds the property values.

PLSQL_RECORD_TYPE Object

Table 3-63 PLSQL_RECORD_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

ATTRIBUTE Object

Table 3-64 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE PLSQL_RECORD_TYPE

OMBCREATE PLSQL_RECORD_TYPE

OMBDROP PLSQL_RECORD_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

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

ATTRIBUTE Object

Table 3-66 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE PLSQL_REF_CURSOR_TYPE

OMBCREATE PLSQL_REF_CURSOR_TYPE

OMBDROP PLSQL_REF_CURSOR_TYPE

OMBALTER PLSQL_TABLE_TYPE

Purpose

Alter the Table Type by resetting its properties.

Prerequisites

Should be in the context of a Package.

Syntax

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

Parameters

alterPlSqlTableTypeCommand

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

renameClause

renames a table with a different name.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Table Type.

getPropertiesClause

Basic properties for PLSQL_TABLE_TYPE:

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

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

Name: RETURN_TYPE
Type: STRING(20)
Valid Values: NUMBER, VARCHAR2, VARCHAR, DATE, FLOAT
Default: Empty string
Return type of the Table Type. This can be a scalar type or a PLSQL Record Type.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

PLSQL_TABLE_TYPE Object

Table 3-67 PLSQL_TABLE_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

ATTRIBUTE Object

Table 3-68 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE PLSQL_TABLE_TYPE

OMBCREATE PLSQL_TABLE_TYPE

OMBDROP PLSQL_TABLE_TYPE

OMBALTER PLUGGABLE_MAPPING

Purpose

Alter the content of a pluggable mapping.

Prerequisites

1. The current context of scripting must be a project or pluggable map folder.

2. No concurrent user should be modifying the pluggable mapping.

Syntax

alterPluggableMappingCommand =  OMBALTER PLUGGABLE_MAPPING
          "pluggableMapName" "alterOperatorOwnerDetailClause"
     pluggableMapName =  "QUOTED_STRING"
     alterOperatorOwnerDetailClause =  "renameClause" [
          "alterPropertiesOrIconSetClause" ] [
          "alterOperatorOwnerDescendantsClause"+ ] |
          "alterPropertiesOrIconSetClause" [
          "alterOperatorOwnerDescendantsClause"+ ] |
          "alterOperatorOwnerDescendantsClause"+
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  ( SET ( ( "setPropertiesClause" [ ( SET
          "setCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) | (
          UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) |
           ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( UNSET
          "unsetCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) | (
          UNSET "unsetReferenceIconSetClause" ) ] ) | ( UNSET
          "unsetControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" )
           | ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
          ) ] ) | ( "setCodeTemplateClause" [ ( SET "setReferenceIconSetClause"
          ) | ( UNSET "unsetReferenceIconSetClause" ) ] ) | (
          "setControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) |
           ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setReferenceIconSetClause" ) ) ) | UNSET ( "unsetCodeTemplateClause"
          | "unsetControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause"
           ) | ( UNSET "unsetReferenceIconSetClause" ) ] |
          "unsetReferenceIconSetClause" )
     alterOperatorOwnerDescendantsClause =  ADD ( "addOperatorClause" |
          "addGroupClause" | "addAttributeClause" | "addChildClause" |
          "addConnectionClause" | "addExecutionUnitClause" ) | MODIFY (
          "modifyOperatorClause" | "modifyGroupClause" | "modifyAttributeClause"
           | "modifyChildClause" | "modifyExecutionUnitClause" ) | DELETE (
          "operatorBottomUpLocator" | "groupBottomUpLocator" |
          "attributeBottomUpLocator" | "childBottomUpLocator" |
          "deleteConnectionLocator" | "deleteExecutionUnitClause" )
     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"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     setControlCodeTemplateClause =  ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE
          "QUOTED_STRING" | ( ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE OPTIONS
          "(" "optionValueList" ")" VALUES "(" "optionValueList" ")" )
     unsetCodeTemplateClause =  ( REFERENCE | REF ) CODE_TEMPLATE
     unsetControlCodeTemplateClause =  ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE
     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" ]
     modifyOperatorClause =  "operatorBottomUpLocator" ( "renameClause" | SET
          "setPropertiesClause" )
     modifyGroupClause =  "groupBottomUpLocator" ( "renameClause" | SET
          "setPropertiesClause" | "setBindingClause" |
          "internallyConnectToClause" )+
     modifyAttributeClause =  "attributeBottomUpLocator" ( "renameClause" |
          "moveToClause" | SET "setPropertiesClause" )
     modifyChildClause =  "childBottomUpLocator" ( "renameClause" | SET
          "setPropertiesClause" )
     modifyExecutionUnitClause =  EXECUTION_UNIT "executionUnitName" ( (
          OPERATORS "operatorNameList" [ ( SET ( REFERENCE | REF ) CODE_TEMPLATE
           "setEUCodeTemplateClause" ) ] [ ( SET ( REFERENCE | REF )
          CONTROL_CODE_TEMPLATE "setEUControlCodeTemplateClause" ) ] ) |
          "addDeleteExecutionUnitOperatorClause"+ [ ( SET ( REFERENCE | REF )
          CODE_TEMPLATE "setEUCodeTemplateClause" ) ] | ( SET ( REFERENCE | REF
          ) CODE_TEMPLATE "setEUCodeTemplateClause" ) | ( SET ( REFERENCE | REF
          ) CONTROL_CODE_TEMPLATE "setEUControlCodeTemplateClause" ) )
     operatorBottomUpLocator =  OPERATOR "operatorName" [
          "pluggableMapBottomUpLocator" ]
     groupBottomUpLocator =  GROUP "groupName" OF "operatorBottomUpLocator"
     attributeBottomUpLocator =  ATTRIBUTE "attributeName" OF
          "groupBottomUpLocator"
     childBottomUpLocator =  "childType" "childName" { OF "childType"
          "childName" } [ OF "mappableBottomUpLocator" ]
     deleteConnectionLocator =  CONNECTION ( FROM "mappableBottomUpLocator" [ TO
           "mappableBottomUpLocator" ] | TO "mappableBottomUpLocator" )
     deleteExecutionUnitClause =  EXECUTION_UNIT "executionUnitName"
     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"
     internallyConnectToClause =  SET REF "groupLocator"
     attributeName =  "QUOTED_STRING"
     childType =  "UNQUOTED_STRING"
     childName =  "QUOTED_STRING"
     childOwnerBottomUpLocator =  { OF "childType" "childName" } [ OF
          "mappableBottomUpLocator" ]
     groupToGroupConnectType =  COPY ALL | BY ( NAME [ IGNORE ( SPECIAL_CHARS
          "QUOTED_STRING" | SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX
          "QUOTED_STRING" | TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX
          "QUOTED_STRING" ) { "," IGNORE ( SPECIAL_CHARS "QUOTED_STRING" |
          SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX "QUOTED_STRING" |
          TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX "QUOTED_STRING" ) } ] |
          POSITION )
     attributesBottomUpLocator =  ATTRIBUTES "attributeNameList" OF
          "groupBottomUpLocator"
     executionUnitName =  "QUOTED_STRING"
     operatorNameList =  "(" "operatorName" { "," "operatorName" } ")"
     setEUCodeTemplateClause =  "QUOTED_STRING" | OPTIONS "(" "optionValueList"
          ")" VALUES "(" "optionValueList" ")"
     setEUControlCodeTemplateClause =  "QUOTED_STRING" | OPTIONS "("
          "optionValueList" ")" VALUES "(" "optionValueList" ")"
     moveToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     addDeleteExecutionUnitOperatorClause =  ADD OPERATOR "operatorName" |
          DELETE OPERATOR "operatorName"
     mappableBottomUpLocator =  "operatorBottomUpLocator" |
          "groupBottomUpLocator" | "attributeBottomUpLocator"
     propertyKey =  "UNQUOTED_STRING" | FILE_FORMAT
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     bindableLocator =  "bindableType" "bindableName" [ OF "bindableType"
          "bindableName" ]
     groupLocator =  GROUP "groupName"
     attributeNameList =  "(" "attributeName" { "," "attributeName" } ")"
     bindableType =  PLUGGABLE_MAPPING | OBJECT_TYPE | "UNQUOTED_STRING"
     bindableName =  "QUOTED_STRING"

Parameters

alterPluggableMappingCommand

Alter the content of a pluggable mapping.

pluggableMapName

Name of the pluggable map.

alterOperatorOwnerDetailClause

Alter the detail of the pluggable mapping.

renameClause

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

alterPropertiesOrIconSetClause

Alter the properties, code template or icon set settings of the map.

alterOperatorOwnerDescendantsClause

Alter the desired child objects applicable to 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 pluggable map.

unsetReferenceIconSetClause

Unset icon set for the pluggable 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.

modifyOperatorClause

Modify a mapping operator.

modifyGroupClause

Modify a mapping group.

modifyAttributeClause

Modify a mapping attribute.

modifyChildClause

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

modifyExecutionUnitClause

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

operatorBottomUpLocator

Location of a mapping operator.

groupBottomUpLocator

Location of a mapping group.

attributeBottomUpLocator

Location of a mapping attribute.

childBottomUpLocator

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

deleteConnectionLocator

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

deleteExecutionUnitClause

Delete the specified execution unit.

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.

internallyConnectToClause

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

attributeName

Name of a mapping attribute.

childType

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

childName

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

childOwnerBottomUpLocator

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

groupToGroupConnectType

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

attributesBottomUpLocator

Location of a list of mapping attributes.

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.

moveToClause

Modify the position of the specified attribute within its attribute group.

addDeleteExecutionUnitOperatorClause

Add or delete operator(s) that are contained in the execution unit.

mappableBottomUpLocator

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

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.

bindableLocator

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

groupLocator

Location of a mapping group.

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.

PLUGGABLE_MAPPING Object

Table 3-69 PLUGGABLE_MAPPING Object

Property
Type
Choices
Min
Max
Default
Description

DIAGRAM_LAYOUT

STRING

none

none

none

empty string

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 3-70 OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-71 GROUP Object

Property
Type
Choices
Min
Max
Default
Description

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

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 3-72 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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 3-73 AGGREGATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

none

none

none

0

ANYDATA_CAST_OPERATOR Object

Table 3-74 ANYDATA_CAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-75 CONSTANT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-76 CONSTRUCT_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-77 CUBE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-78 DATA_GENERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-79 DEDUPLICATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-80 DIMENSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-81 EXPAND_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-82 EXPRESSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 3-83 EXTERNAL_TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FILTER_OPERATOR Object

Table 3-84 FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

FILTER_CONDITION

STRING

none

none

none

empty string

The boolean filtering condition that identifies what data is to be processed. Any row with a false condition will be ignored.

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

SUBQUERY_FILTER_OPERATOR Object

Table 3-85 SUBQUERY_FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SUBQUERY_FILTER_CONDITION

STRING

none

none

none

empty string

The Filter Condition for the subquery operator, if blank then the subquery stands alone with no join to the top-level query.

SUBQUERY_INPUT_ROLE

STRING(16)

EXISTS, IN, NOT_EXISTS, NOT_IN

none

none

EXISTS

The role the input stream plays in the subquery filter condition.

SUBQUERY_JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FLAT_FILE_OPERATOR Object

Table 3-86 FLAT_FILE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CONCATENATE_RECORDS

NUMBER

none

none

none

0

Number of Physical Records per Logical Record.

CONTINUATION_CHARACTER

STRING

none

none

none

empty string

Character that indicates the record is continued on the next line.

CONTINUATION_CHARACTER_ON_NEXT_LINE

BOOLEAN

true, false

none

none

FALSE

If there is a continuation character, is it at the start of the line.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The name of the directory in which to open the target data file. The directory must be deployed before the file can be created.

DEBUG_TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

ESCAPE_CHARACTER_FOR_ENCLOSURE

STRING

none

none

none

empty string

Escape character for data containing the enclosure character. This is only applicable with delimited files having enclosure characters.

FIELD_ENCLOSURE_CHARACTERS

STRING

none

none

none

empty string

Characters that wrap fields. Example ' or ".

FIELD_NAMES_IN_THE_FIRST_ROW

BOOLEAN

true, false

none

none

FALSE

Indicates whether file contains a header row.

FIELD_TERMINATION_CHARACTER

STRING

none

none

none

,

Character that separates the fields of a delimited file.

FILE_FORMAT

STRING

DELIMITED, FIXED

none

none

DELIMITED

File Format (Fixed or Delimited).

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LOADING_TYPE

STRING(16)

INSERT, NONE, UPDATE

none

none

INSERT

The loading operation to be performed

NLS_CHARACTERSET

STRING

none

none

none

WE8MSWIN1252

NLS Characterset

OUTPUT_AS_XML

BOOLEAN

true, false

none

none

false

Output data to file in XML format.

RECORDS_TO_SKIP

NUMBER

none

0

none

0

Number of logical records to skip

RECORD_DELIMITER

STRING

none

none

none

empty string

Character that indicates the end of the record.

RECORD_SIZE

NUMBER

none

none

none

0

Size of a fixed length record.

RECORD_TYPE_LENGTH

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the length of the data that identifies the type of record. It is used with the Record Type Position.

RECORD_TYPE_POSITION

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the position of the field that identifies the type of record.

SAMPLED_FILE_NAME

STRING

none

none

none

empty string

The default name of the physical file to be used by sqlloader. If the file was sampled, the default was set from sampled file name.

SOURCE_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The Location of the File Module of this Flat File at the time of reconciliation. Stored as UOID.

TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The location used to access referenced entity.

TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

INPUT_PARAMETER_OPERATOR Object

Table 3-87 INPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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

INPUT_SIGNATURE_OPERATOR Object

Table 3-88 INPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ITERATOR_OPERATOR Object

Table 3-89 ITERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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

JOINER_OPERATOR Object

Table 3-90 JOINER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

JOIN_CONDITION

STRING

none

none

none

empty string

The Join Condition for the join operator

JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

LOOKUP_OPERATOR Object

Table 3-91 LOOKUP_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRCAST_OPERATOR Object

Table 3-92 LCRCAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRSPLITTER_OPERATOR Object

Table 3-93 LCRSPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCHMERGE_OPERATOR Object

Table 3-94 MATCHMERGE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCH_KEYS

STRING

none

none

none

empty string

Ordered list of attributes that control the set of records to be matched at any at any particular time.

MATCH_NEW_RECORDS

BOOLEAN

true, false

none

none

false

MATCH_NEW_RECORD_CONDITION

STRING

none

none

none

empty string

MERGED_PREFIX

STRING

none

none

none

empty string

Set the prefix used for the merged attributes in the cross-reference group.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

MATERIALIZED_VIEW_OPERATOR Object

Table 3-95 MATERIALIZED_VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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).

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.

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

NAME_AND_ADDRESS_OPERATOR Object

Table 3-96 NAME_AND_ADDRESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

ADDRESS_LINE_1

STRING

none

none

none

empty string

Address line 1

ADDRESS_LINE_2

STRING

none

none

none

empty string

Address line 2

ADDRESS_LINE_3

STRING

none

none

none

empty string

Address line 3

ADDRESS_LINE_4

STRING

none

none

none

empty string

Address line 4

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

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

A dual address refers to two address lines for the same destination. For example, a record contains both a street address and a P.O. Box; this is common with business data. Select which of the two address lines should be assigned in these cases.

GENERATE_CASS_REPORT

STRING

NA_NO, NA_YES

none

none

NA_NO

Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS report is a text file specified by the United States Postal Service. The report is written to the [nas/bin/admin/reports] folder under the home folder of the name/address server.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LIST_NAME

STRING

none

none

none

empty string

The list name is optional and provides a reference for tracking multiple CASS reports.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Select a name-address parsing type to be performed on the input data

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Select the primary parsing country which best represents the input data. Input addresses having the same country as the primary parsing country will only need to be parsed once. Input addresses having a different country than the primary parsing country may be reparsed by a different parser. For performance reasons, it is best to minimize the percentage of 2-pass parses by selecting the optimal parser.

PROCESSOR_NAME

STRING

none

none

none

empty string

The processor name is the name of the organization submitting the CASS report.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

OUTPUT_PARAMETER_OPERATOR Object

Table 3-97 OUTPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

The name to use when refering to this entity in generated code.

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

OUTPUT_SIGNATURE_OPERATOR Object

Table 3-98 OUTPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_OPERATOR Object

Table 3-99 PIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_GROUP_SIZE

NUMBER

none

1

1000

2

A number specifying the pivot group size for the pivot operation. Pivot group size determines the number of output rows that are produced from each input row.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PLUGGABLE_MAPPING_OPERATOR Object

Table 3-100 PLUGGABLE_MAPPING_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

POSTMAPPING_PROCESS_OPERATOR Object

Table 3-101 POSTMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

POSTMAPPING_PROCESS_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING

none

none

ON_SUCCESS

Indicates under what condition of the mapping the post-mapping process will be run.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PREMAPPING_PROCESS_OPERATOR Object

Table 3-102 PREMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

MAPPING_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS

none

none

ON_SUCCESS

Indicates under what condition of the pre-mapping process the mapping will be run.

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

QUEUE_OPERATOR Object

Table 3-103 QUEUE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_AQ_UOID

STRING

none

none

none

empty string

The UOID of the Advanced Qeue object to which this stage component is bound to.

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.

DB_LOCATION

STRING

none

none

none

empty string

The location used to access this entity during mapping.

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

GENERATE_SUBSCRIBER

BOOLEAN

true, false

none

none

true

This only applies to batch mappings. This specifies whether the subscriber is generated. The name of the subscriber is the owning map. If the queue being sourced is a propagation queue with the same name as the owning map, then set to false.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

IS_REALTIME_SOURCE

BOOLEAN

true, false

none

none

false

IS_STREAMS_QUEUE

BOOLEAN

true, false

none

none

false

PAYLOAD_NAME

STRING

none

none

none

empty string

The name of payload type.

QUEUE_TABLE_NAME

STRING

none

none

none

empty string

The name of the queue table that is used to perist the messages in this Advanced Queue.

REAL_TIME_DATA_FORMAT

STRING

LOGICAL_CHANGE_RECORD, MESSAGE

none

none

MESSAGE

The format for this message, either user-defined or LCR

SOURCE_TABLES

STRING

none

none

none

empty string

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.

TEMPORARY_TABLE_NAME

STRING

none

none

none

empty string

The name of the temporary table that will stage the messages from the Advanced Queue.

UDT

STRING

none

none

none

empty string

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SEQUENCE_OPERATOR Object

Table 3-104 SEQUENCE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SET_OPERATION_OPERATOR Object

Table 3-105 SET_OPERATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SET_OPERATION

STRING

INTERSECT, MINUS, UNION, UNIONALL

none

none

UNION

Specifies the set operation that is to be performed by this operator.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SORTER_OPERATOR Object

Table 3-106 SORTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ORDER_BY_CLAUSE

STRING

none

none

none

empty string

The Order By Clause

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SPLITTER_OPERATOR Object

Table 3-107 SPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

TABLE_FUNCTION_OPERATOR Object

Table 3-108 TABLE_FUNCTION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

TABLE_FUNCTION_IS_TARGET

BOOLEAN

true, false

none

none

false

Description not available.

TABLE_FUNCTION_NAME

STRING

none

none

none

empty string

The name of the Table Function

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

TABLE_OPERATOR Object

Table 3-109 TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

Description not available.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

CONFLICT_RESOLUTION

BOOLEAN

true, false

none

none

true

Detect and resolve any conflicts that may arise during DML using the LCR APIs

CONTROL_CK

STRING

none

none

none

empty string

Set Control Code Template Params for Check Constraint.

CONTROL_DATA_RULES

STRING

none

none

none

empty string

Set Control Code Template Params for Data Rules.

CONTROL_FK

STRING

none

none

none

empty string

Set Control Code Template Params for Foreign Keys.

CONTROL_NN

STRING

none

none

none

empty string

Set Control Code Template Params for Not Null attributes.

CONTROL_PK

STRING

none

none

none

empty string

Set Control Code Template Params for Primary Keys.

CONTROL_UK

STRING

none

none

none

empty string

Set Control Code Template Params for Unique Keys.

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_LOCATION

STRING(30)

none

none

none

empty string

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

ISAPPLYSOURCE

BOOLEAN

true, false

none

none

false

Generate Non Trigger Apply uptime script considering this is a leading source for the map

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_ERROR_TABLE

BOOLEAN

true, false

none

none

false

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_STATIC_TABLE

BOOLEAN

true, false

none

none

false

Check source table operator static

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

IS_USER-DEFINED_DATA

BOOLEAN

true, false

none

none

false

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

JOINRANK

FLOAT

none

none

none

0

Join Rank

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

OPTIMIZE_MERGE

BOOLEAN

true, false

none

none

false

Optimize the execution of expressions by deferring them until really needed

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.

USE_LCR_API

BOOLEAN

true, false

none

none

true

Use LCR APIs if possible to perform the DML

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

ZDT_DOWNTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Downtime Extraction Index Hints

ZDT_DOWNTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

ZDT_UPTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Uptime Extraction Index Hints

ZDT_UPTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

TRANSFORMATION_OPERATOR Object

Table 3-110 TRANSFORMATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

RETURN_TYPE

STRING

none

none

none

empty string

Description not available.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

UNPIVOT_OPERATOR Object

Table 3-111 UNPIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

VIEW_OPERATOR Object

Table 3-112 VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

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_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150

INLINED

BOOLEAN

true, false

none

none

false

If set to true, the view query will be used as an inline subquery in the generated code.

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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

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.

VIEW_QUERY

STRING

none

none

none

empty string

The query text for this view.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

See Also

OMBALTER

OMBCREATE PLUGGABLE_MAPPING

OMBRETRIEVE PLUGGABLE_MAPPING

OMBDROP PLUGGABLE_MAPPING

4 OMBALTER PLUGGABLE_MAPPING_FOLDER to OMBALTER TRANSPORTABLE_MODULE

OMBALTER PLUGGABLE_MAPPING_FOLDER

OMBALTER PROCEDURE

OMBALTER PROCESS_FLOW

OMBALTER PROCESS_FLOW_MODULE

OMBALTER PROCESS_FLOW_PACKAGE

OMBALTER PROFILE_REFERENCE

OMBALTER PROJECT

OMBALTER PSFT_MODULE

OMBALTER QUEUE_PROPAGATION

OMBALTER QUEUE_TABLE

OMBALTER REAL_TIME_MAPPING

OMBALTER REGISTERED_FUNCTION

OMBALTER ROLE

OMBALTER SAP_MODULE

OMBALTER SEQUENCE

OMBALTER SIEBEL_MODULE

OMBALTER SNAPSHOT

OMBALTER TABLE

OMBALTER TABLE_FUNCTION

OMBALTER TIME_DIMENSION

OMBALTER TRANSPORTABLE_MODULE

OMBALTER PLUGGABLE_MAPPING_FOLDER

Purpose

Alter the content of a pluggable map folder.

Prerequisites

1. The current context of scripting must be a project.

2. No concurrent user should be modifying the pluggable map folder.

Syntax

alterPluggableMappingLibraryCommand =  ( OMBALTER (
          PLUGGABLE_MAPPING_FOLDER | PLUGGABLE_MAPPING_LIBRARY )
          "pluggableMapLibraryName" ( ( "renameClause" [
          "alterPropertiesOrIconSetClause" ] ) |
          "alterPropertiesOrIconSetClause" ) )
     pluggableMapLibraryName =  "QUOTED_STRING"
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  ( SET ( ( "setPropertiesClause" [ ( SET
          "setCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) | (
          UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) |
           ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( UNSET
          "unsetCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) | (
          UNSET "unsetReferenceIconSetClause" ) ] ) | ( UNSET
          "unsetControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" )
           | ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
          ) ] ) | ( "setCodeTemplateClause" [ ( SET "setReferenceIconSetClause"
          ) | ( UNSET "unsetReferenceIconSetClause" ) ] ) | (
          "setControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) |
           ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setReferenceIconSetClause" ) ) ) | UNSET ( "unsetCodeTemplateClause"
          | "unsetControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause"
           ) | ( UNSET "unsetReferenceIconSetClause" ) ] |
          "unsetReferenceIconSetClause" )
     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"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     setControlCodeTemplateClause =  ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE
          "QUOTED_STRING" | ( ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE OPTIONS
          "(" "optionValueList" ")" VALUES "(" "optionValueList" ")" )
     unsetCodeTemplateClause =  ( REFERENCE | REF ) CODE_TEMPLATE
     unsetControlCodeTemplateClause =  ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     optionValueList =  "propertyValue" { "," "propertyValue" }
     propertyKey =  "UNQUOTED_STRING" | FILE_FORMAT
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterPluggableMappingLibraryCommand

Alter the content of a pluggable map folder.

pluggableMapLibraryName

Name of the pluggable map folder.

renameClause

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

alterPropertiesOrIconSetClause

Alter the properties, code template or icon set settings of the map.

setPropertiesClause

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

setReferenceIconSetClause

Set icon set for the pluggable map folder.

unsetReferenceIconSetClause

Unset icon set for the pluggable map folder.

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.

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

propertyValue

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

See Also

OMBALTER

OMBALTER PROCEDURE

Purpose

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

Prerequisites

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

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

alterProcedureCommand =  OMBALTER ( PROCEDURE "QUOTED_STRING" (
          "renameClause" [ "alterPropertiesOrIconSetClause" ] [
          "alterFuncProcParameterImplementationSCOClause" ] |
          "alterPropertiesOrIconSetClause" [
          "alterFuncProcParameterImplementationSCOClause" ] |
          "alterFuncProcParameterImplementationSCOClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
     alterFuncProcParameterImplementationSCOClause =  ( ADD (
          "alterFuncProcParameterClause" | "addRelationalDependentClause" |
          "addFuncImplementationClause" ) | MODIFY (
          "modifyFuncProcParameterClause" | "modifyFuncProcImplementationClause"
           ) | DELETE ( "deleteFuncProcParameterClause" |
          "deleteRelationalDependentClause" |
          "deleteFuncProcImplementationClause" ) ) [
          "alterFuncProcParameterImplementationSCOClause" ]
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterFuncProcParameterClause =  PARAMETER "QUOTED_STRING" [ AT POSITION
          "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     addRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
          "QUOTED_STRING"
     addFuncImplementationClause =  FUNCTION_IMPLEMENTATION "QUOTED_STRING" [
          SET "setFuncImplPropertiesClause" ]
     modifyFuncProcParameterClause =  ( PARAMETER "QUOTED_STRING" (
          "renameClause" | "moveToClause" | [ SET "setPropertiesClause" ] ) )
     modifyFuncProcImplementationClause =  ( FUNCTION_IMPLEMENTATION
          "QUOTED_STRING" ( "renameClause" [ SET "setFuncImplPropertiesClause" ]
           | [ SET "setFuncImplPropertiesClause" ] ) )
     deleteFuncProcParameterClause =  ( PARAMETER "QUOTED_STRING" )
     deleteRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
          "QUOTED_STRING"
     deleteFuncProcImplementationClause =  ( FUNCTION_IMPLEMENTATION
          "QUOTED_STRING" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setFuncImplPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES
           "(" "propertyValueList" ")"
     moveToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterProcedureCommand

This command modifies an existing Procedure.

QUOTED_STRING

Name of the existing Procedure in single quotes.

renameClause

Rename a Procedure.

alterPropertiesOrIconSetClause

Used to alter procedure properties or icon set.

alterFuncProcParameterImplementationSCOClause

Used to alter, modify or delete procedure parameter, implementation and dependency.

setPropertiesClause

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

getPropertiesClause

Basic properties for PROCEDURE:

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

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

Name: IMPLEMENTATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Set the code for Procedure which is included global variable declaration and code between BEGIN and END.

Basic properties for PARAMETER:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: 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

Used to set procedure reference icon set.

unsetReferenceIconSetClause

Used to unset procedure reference icon set.

alterFuncProcParameterClause

This clause alters Parameter of a Procedure.

addRelationalDependentClause

This clause adds referential dependencies to other relational objects.

addFuncImplementationClause

Used to add procedure implementation to this procedure.

modifyFuncProcParameterClause

Modify one or more Parameters to this Function/Procedure.

modifyFuncProcImplementationClause

Used to modify procedure implementation.

deleteFuncProcParameterClause

Delete one or more Parameters to this Function/Procedure.

deleteRelationalDependentClause

This clause deletes referential dependencies to other relational objects.

deleteFuncProcImplementationClause

Used to delete a procedure implementation.

propertyNameList

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

propertyValueList

Comma separated list of property values.

setFuncImplPropertiesClause

Used to set procedure implementation properties.

moveToClause

Move a Parameters of this Function/Procedure.

propertyValue

Value of a property.

PROCEDURE Object

Table 4-1 PROCEDURE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER

OMBCREATE PROCEDURE

OMBDROP PROCEDURE

OMBALTER PROCESS_FLOW

Purpose

Alter the Process Flow by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of a Process Flow Package.

Syntax

alterProcessFlowCommand =  OMBALTER PROCESS_FLOW "QUOTED_STRING" ( (
          "renameClause" [ "alterPropertiesOrIconSetClause" ] [
          "alterProcessFlowSCOClauses" ] ) | ( "alterPropertiesOrIconSetClause"
          [ "alterProcessFlowSCOClauses" ] ) | "alterProcessFlowSCOClauses" )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
     alterProcessFlowSCOClauses =  ADD ( "addUserDefinedParameterClause" [
          "alterProcessFlowSCOClauses" ] | "addGenericActivityParameterClause" [
           "alterProcessFlowSCOClauses" ] | "addProcessParameterClause" [
          "alterProcessFlowSCOClauses" ] | "addProcessVariableClause" [
          "alterProcessFlowSCOClauses" ] | "addActivityClause" [
          "alterProcessFlowSCOClauses" ] | "addTransitionClause" [
          "alterProcessFlowSCOClauses" ] ) | MODIFY (
          "modifyGenericActivityParameterClause" [ "alterProcessFlowSCOClauses"
          ] | "modifyUserDefinedActivityParameterClause" [
          "alterProcessFlowSCOClauses" ] | "modifyProcessParameterClause" [
          "alterProcessFlowSCOClauses" ] | "modifyProcessVariableClause" [
          "alterProcessFlowSCOClauses" ] | "modifyActivityClause" [
          "alterProcessFlowSCOClauses" ] | "modifyUserDefinedActivityClause" [
          "alterProcessFlowSCOClauses" ] | "modifyTransitionClause" [
          "alterProcessFlowSCOClauses" ] ) | DELETE (
          "deleteUserDefinedParameterClause" [ "alterProcessFlowSCOClauses" ] |
          "deleteGenericActivityParameterClause" [ "alterProcessFlowSCOClauses"
          ] | "deleteProcessParameterClause" [ "alterProcessFlowSCOClauses" ] |
          "deleteProcessVariableClause" [ "alterProcessFlowSCOClauses" ] |
          "deleteActivityClause" [ "alterProcessFlowSCOClauses" ] |
          "deleteTransitionClause" [ "alterProcessFlowSCOClauses" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     addUserDefinedParameterClause =  ( PARAMETER "QUOTED_STRING" OF
          USER_DEFINED ACTIVITY "QUOTED_STRING" ) [ SET "setPropertiesClause" ]
     addGenericActivityParameterClause =  ( PARAMETER "QUOTED_STRING" OF
          ACTIVITY "QUOTED_STRING" ) [ SET "setPropertiesClause" ]
     addProcessParameterClause =  ( PARAMETER "QUOTED_STRING" ) [ SET
          "setPropertiesClause" ]
     addProcessVariableClause =  ( VARIABLE "QUOTED_STRING" ) [ SET
          "setPropertiesClause" ]
     addActivityClause =  ( "addStandardActivityClause" | "addMapActivityClause"
           | "addTemplateActivityClause" | "addDataAuditorActivityClause" |
          "addFunctionActivityClause" | "addSubProcessActivityClause" |
          "addWebServiceActivityClause" )
     addTransitionClause =  ( TRANSITION "QUOTED_STRING" ( FROM ACTIVITY
          "QUOTED_STRING" ) ( TO "QUOTED_STRING" ) ) [ SET "setPropertiesClause"
           ]
     modifyGenericActivityParameterClause =  PARAMETER "QUOTED_STRING" OF
          ACTIVITY "QUOTED_STRING" ( ( "renameClause" [ SET
          "setPropertiesClause" ] ) | ( SET "setPropertiesClause" ) )
     modifyUserDefinedActivityParameterClause =  PARAMETER "QUOTED_STRING" OF
          USER_DEFINED ACTIVITY "QUOTED_STRING" ( ( "renameClause" [ SET
          "setPropertiesClause" ] ) | ( SET "setPropertiesClause" ) )
     modifyProcessParameterClause =  PARAMETER "QUOTED_STRING" ( "renameClause"
          [ SET "setPropertiesClause" ] | SET "setPropertiesClause" )
     modifyProcessVariableClause =  VARIABLE "QUOTED_STRING" ( "renameClause" [
          SET "setPropertiesClause" ] | SET "setPropertiesClause" )
     modifyActivityClause =  ACTIVITY "QUOTED_STRING" ( ( "renameClause" [
          "alterPropertiesOrIconSetClause" ] [ "modifyActivityParameterClause" ]
           ) | ( "alterPropertiesOrIconSetClause" [
          "modifyActivityParameterClause" ] ) | "modifyActivityParameterClause"
          )
     modifyUserDefinedActivityClause =  ( USER_DEFINED | TRANSFORMATION |
          MAPPING ) ACTIVITY "QUOTED_STRING" ( "renameClause" [
          "alterPropertiesOrIconSetClause" ] [ "modifyUDActivityParameterClause"
           ] | "alterPropertiesOrIconSetClause" [
          "modifyUDActivityParameterClause" ] |
          "modifyUDActivityParameterClause" )
     modifyTransitionClause =  TRANSITION "QUOTED_STRING" ( "renameClause" [ SET
           "setPropertiesClause" ] | SET "setPropertiesClause" )
     deleteUserDefinedParameterClause =  PARAMETER "QUOTED_STRING" OF
          USER_DEFINED ACTIVITY "QUOTED_STRING"
     deleteGenericActivityParameterClause =  PARAMETER "QUOTED_STRING" OF
          ACTIVITY "QUOTED_STRING"
     deleteProcessParameterClause =  PARAMETER "QUOTED_STRING"
     deleteProcessVariableClause =  VARIABLE "QUOTED_STRING"
     deleteActivityClause =  ACTIVITY "QUOTED_STRING"
     deleteTransitionClause =  TRANSITION "QUOTED_STRING"
     propertyNameList =  ( "UNQUOTED_STRING" | BINDING ) { "," (
          "UNQUOTED_STRING" | BINDING ) }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addStandardActivityClause =  ( "UNQUOTED_STRING" | USER_DEFINED ) ACTIVITY
          "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ]
     addMapActivityClause =  ( MAPPING ACTIVITY "QUOTED_STRING" [ SET (
          PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF | REFERENCE )
          "setPropertiesAndReferencesMapClauses" ] [ "setReferenceIconSetClause"
           ] ) ] | ( REF | REFERENCE ) "setPropertiesAndReferencesMapClauses" [
          SET "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
     addTemplateActivityClause =  ( ACTIVITY_TEMPLATE ACTIVITY "QUOTED_STRING" [
           SET ( PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF |
          REFERENCE ) "setPropertiesAndReferencesTemplateClause" ] [
          "setReferenceIconSetClause" ] ) ] | ( REF | REFERENCE )
          "setPropertiesAndReferencesTemplateClause" [ SET
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
     addDataAuditorActivityClause =  ( DATA_AUDITOR ACTIVITY "QUOTED_STRING" [
          SET ( PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF | REFERENCE
           ) "setPropertiesAndReferencesDataAuditorClauses" ] [
          "setReferenceIconSetClause" ] ) ] | ( REF | REFERENCE )
          "setPropertiesAndReferencesDataAuditorClauses" [ SET
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
     addFunctionActivityClause =  ( TRANSFORMATION ACTIVITY "QUOTED_STRING" [
          SET ( PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF | REFERENCE
           ) "setPropertiesAndReferencesFunctionClauses" ] [
          "setReferenceIconSetClause" ] ) ] | ( REF | REFERENCE )
          "setPropertiesAndReferencesFunctionClauses" [ SET
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
     addSubProcessActivityClause =  ( SUBPROCESS ACTIVITY "QUOTED_STRING" SET (
          PROPERTIES "collectPropertiesClause" SET ( REF | REFERENCE )
          "setPropertiesAndReferencesSubProcessClauses" [ SET
          "setReferenceIconSetClause" ] | ( REF | REFERENCE )
          "setPropertiesAndReferencesSubProcessClauses" [ SET
          "setReferenceIconSetClause" ] ) )
     addWebServiceActivityClause =  ( WEB_SERVICE ACTIVITY "QUOTED_STRING" [ SET
           ( PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF | REFERENCE )
          "setPropertiesAndReferencesWebServiceClauses" ] [
          "setReferenceIconSetClause" ] ) ] | ( REF | REFERENCE )
          "setPropertiesAndReferencesWebServiceClauses" [ SET
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
     modifyActivityParameterClause =  MODIFY "modifyActivityParameter" [
          "modifyActivityParameterClause" ]
     modifyUDActivityParameterClause =  ADD ( "addUDActivityParameterClause" [
          "modifyUDActivityParameterClause" ] ) | MODIFY (
          "alterUDActivityParameterClause" [ "modifyUDActivityParameterClause" ]
           ) | DELETE ( "deleteUDActivityParameterClause" [
          "modifyUDActivityParameterClause" ] )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     collectPropertiesClause =  "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setPropertiesAndReferencesMapClauses =  ( MAPPING "QUOTED_STRING" )
     setPropertiesAndReferencesTemplateClause =  ( ACTIVITY_TEMPLATE
          "QUOTED_STRING" )
     setPropertiesAndReferencesDataAuditorClauses =  ( DATA_AUDITOR
          "QUOTED_STRING" )
     setPropertiesAndReferencesFunctionClauses =  ( TRANSFORMATION
          "QUOTED_STRING" )
     setPropertiesAndReferencesSubProcessClauses =  ( PROCESS_FLOW
          "QUOTED_STRING" )
     setPropertiesAndReferencesWebServiceClauses =  ( WEB_SERVICE
          "QUOTED_STRING" )
     modifyActivityParameter =  PARAMETER "QUOTED_STRING" SET
          "setPropertiesClause"
     addUDActivityParameterClause =  PARAMETER "QUOTED_STRING" [ SET
          "setPropertiesClause" ]
     alterUDActivityParameterClause =  PARAMETER "QUOTED_STRING" ( (
          "renameClause" [ SET "setPropertiesClause" ] ) | ( SET
          "setPropertiesClause" ) )
     deleteUDActivityParameterClause =  PARAMETER "QUOTED_STRING"

Parameters

alterProcessFlowCommand

Alter process flow.

renameClause

Rename process flow/ activity, depending on current context.

alterPropertiesOrIconSetClause

Alter existing process flow properties and/or Icon Set.

alterProcessFlowSCOClauses

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

setPropertiesClause

Used to set properties (core, user-defined) for process flow. Note: For MAPPING, TRANSFORMATION and SUBPROCESS

activities the setPropertiesAndReferencesMapClauses,

setPropertiesAndReferencesFunctionClauses and

setPropertiesAndReferencesSubProcessClauses respectively,

are mandatory.

For MAPPING or TRANSFORMATION activities and the REFERENCE property has to be set to a

valid MAP or TRANSFORMATION within the current project.

For SUBPROCESS activities the REFERENCE property has to be set

to a SUBPROCESS within the same PROCESS_FLOW_PACKAGE.

Valid properties are shown below:

setPropertiesClause

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

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

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

Description of the Process Flow Core properties for Transition :

Name: TRANSITION_CONDITION
Type: STRING
Valid Values: '', SUCCESS, ERROR, WARNING
Default: Empty string i.e. Unconditional
Sets the Transition Condition of a Transition

Name: SIMPLE_CONDITION
Type: STRING
Valid Values: '', SUCCESS, ERROR, WARNING
Default: Empty string i.e. Unconditional
Sets the Simple Condition of a Transition

Name: COMPLEX_CONDITION
Type: STRING
Sets the Complex Condition of a Transition

Description of the Process Flow Core properties for Activity Parameter :

Name: DATATYPE
Type: STRING
Valid Values: INTEGER, FLOAT, DATE, STRING, BOOLEAN
Default: STRING
Sets the datatype of a Activity Parameter

Name: DIRECTION
Type: STRING
Valid Values: IN
Default: IN
Sets the direction of a Activity Parameter

Name: ISLITERALVALUE
Type: STRING
Valid Values: TRUE FALSE
Default: TRUE
Whether the value stored is a literal value or an interpreted value, valid for PARAMETERS and VARIABLES.

Name: VALUE
Type: STRING
Valid Values: Examples '123', '123.456', 'Jan-08-2003', 'I am String', 'true'
Default: Empty string
For Mapping activities representing PLSQL maps, the allowed value for the parameters:
OPERATING_MODE:'SET_BASED' 'ROW_BASED' 'ROW_BASED_TARGET_ONLY' 'SET_BASED_FAIL_OVER_TO_ROW_BASED' 'SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY'
AUDIT_LEVEL:'NONE' 'STATISTICS' 'ERROR_DETAILS' 'COMPLETE'
Sets the value of a Activity Parameter

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

Name: BOUND_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The name of the object which a process flow activity represents, for example, a mapping.

Name: DEPLOYED_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: USE_DEFAULT_LOCATION
The locaion to which the process flow is deployed.

Name: EXECUTION_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: NATIVE_EXECUTION
The location which is used to execute the process flow, which may differ from the deployment location.

Name: REMOTE_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: USE_DEFAULT_LOCATION
The File location which is remote from the Working Location, used by FTP to connect to the remote FTP server and set the remote working directory.

Name: USE_RETURN_AS_STATUS
Type: BOOLEAN
Valid Values: true, false
Default: false
When TRUE, the returned result will directly control the outcome of the activity/operator, 1=SUCCESS, 2=WARNINGS, 3=FAILURE.

Name: WORKING_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: USE_DEFAULT_LOCATION
The File location used to initialize the current working directory for an Operating System executable.

setReferenceIconSetClause

Set icon set for the process flow.

unsetReferenceIconSetClause

Unset icon set for the process flow.

addUserDefinedParameterClause

This clause adds the Parametrers for a User Defined Activity of a Process Flow.

addGenericActivityParameterClause

This clause adds a generic activity for a Process Flow.

addProcessParameterClause

This clause adds the Parameters for a Process Flow.

addProcessVariableClause

Add a variable to the process flow.

addActivityClause

This clause adds the Activities for a Process Flow.

addTransitionClause

This clause adds the Transitions for a Process Flow.

modifyGenericActivityParameterClause

Modify the definition of a parameter of generic activity.

modifyUserDefinedActivityParameterClause

Modify the definition of a parameter of a user defined activity.

modifyProcessParameterClause

This clause modifies the Parameters of a Process Flow.

modifyProcessVariableClause

Modify the definition of a variable.

modifyActivityClause

This clause modifies the Activities of a Process Flow.

modifyUserDefinedActivityClause

Alter the properties of the specified user defined activity.

modifyTransitionClause

This clause modifies the Transitions of a Process Flow.

deleteUserDefinedParameterClause

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

deleteGenericActivityParameterClause

Delete a parameter of a generic activity.

deleteProcessParameterClause

This clause deletes the Parameters of a Process Flow.

deleteProcessVariableClause

Delete a variable.

deleteActivityClause

This clause deletes the Activities of a Process Flow.

deleteTransitionClause

This clause deletes the Transitions of a Process Flow.

propertyNameList

A comma delimited set of property names to set.

propertyValueList

A comma delimited set of property values to set.

addStandardActivityClause

This clause adds standard activity types AND, EJB, EMAIL, END_ERROR, END_WARNING, END_SUCCESS, FILE_EXISTS, FORK, FTP, JAVA, OR, ASSIGN, END_LOOP, FOR_LOOP, MANUAL, NOTIFICATION, OMBPLUS, ROUTE, SET_STATUS, SQLPLUS, WAIT, WHILE_LOOP OR USER_DEFINED to a Process Flow.

addMapActivityClause

This clause adds the MAP activity to a Process Flow.

addTemplateActivityClause

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

addDataAuditorActivityClause

This clause adds a DATA_AUDITOR activity to a Process Flow.

addFunctionActivityClause

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

addSubProcessActivityClause

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

addWebServiceActivityClause

This clause adds a web service activity for a Process Flow.

modifyActivityParameterClause

Alter the properties of activity parameters.

modifyUDActivityParameterClause

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

propertyValue

Integer value, float value or quoted string literal.

collectPropertiesClause

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

setPropertiesAndReferencesMapClauses

This clause sets reference to the existing Map.

setPropertiesAndReferencesTemplateClause

This clause sets reference to the existing activity template.

setPropertiesAndReferencesDataAuditorClauses

This clause sets reference to the existing data auditor.

setPropertiesAndReferencesFunctionClauses

This clause sets a reference to existing Function or Procedure.

setPropertiesAndReferencesSubProcessClauses

This clause sets a reference to existing Process Flow.

setPropertiesAndReferencesWebServiceClauses

This clause sets reference to the existing web service.

modifyActivityParameter

Alter the properties of the parameter.

addUDActivityParameterClause

Add more activity parameters to the user defined activity.

alterUDActivityParameterClause

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

deleteUDActivityParameterClause

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

PROCESS_FLOW Object

Table 4-2 PROCESS_FLOW Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

REFERRED_CALENDAR

STRING

none

none

none

empty string

Enter the Schedule to associate with this object.

See Also

OMBALTER

OMBCREATE PROCESS_FLOW

OMBDROP PROCESS_FLOW

OMBALTER PROCESS_FLOW_MODULE

Purpose

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

Prerequisites

Should be in the context of a project.

Syntax

alterProcessFlowModuleCommand =  OMBALTER ( PROCESS_FLOW_MODULE
          "QUOTED_STRING" ( "renameClause" [ "alterPropertiesOrReferenceClause"
          ] | "alterPropertiesOrReferenceClause" ) )
     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

alterProcessFlowModuleCommand

This command modifies an existing process flow module.

renameClause

Rename an existing process flow module.

alterPropertiesOrReferenceClause

Alter existing process flow module's core properties, locations and icon sets.

setPropertiesClause

Set values of properties of a process flow module.

setPropertiesClause

Base properties for PROCESS_FLOW_MODULE:

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

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

setReferenceClause

A general clause for setting references for a process flow module.

unsetReferenceClause

A general clause for unsetting references for a process flow module.

propertyNameList

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

propertyValueList

Comma separated list of property values.

setReferenceLocationClause

Set a location to a supported workflow engine.

setReferenceIconSetClause

Set icon set for the process flow module.

unsetReferenceLocationClause

Unset the location of the process flow module.

unsetReferenceIconSetClause

Unset icon set for the process flow module.

propertyValue

Value of a property.

PROCESS_FLOW_MODULE Object

Table 4-3 PROCESS_FLOW_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

DB_LOCATION

STRING

none

none

none

empty string

This value indicates the location where generated code will be deployed to.

EVAL_LOCATION

STRING

none

none

none

empty string

The location in which the process flow will be evaluated.

See Also

OMBALTER

OMBCREATE PROCESS_FLOW_MODULE

OMBDROP PROCESS_FLOW_MODULE

OMBALTER PROCESS_FLOW_PACKAGE

Purpose

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

Prerequisites

Should be in the context of a Process Flow Module.

Syntax

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

Parameters

alterProcessFlowPackageCommand

Alter process flow package.

renameClause

Rename the process flow package.

alterPropertiesOrIconSetClause

Alter existing process flow package properties and/or Icon Set.

setPropertiesClause

Set the properties of the process flow package.

setPropertiesClause

Basic properties for PROCESS_FLOW_PACKAGE:

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

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

setReferenceIconSetClause

Set icon set for the process flow package.

unsetReferenceIconSetClause

Unset icon set for the process flow package.

propertyNameList

A comma delimited set of property names to set.

propertyValueList

A comma delimited set of property values to set.

propertyValue

Integer value, float value or quoted string literal.

PROCESS_FLOW_PACKAGE Object

Table 4-4 PROCESS_FLOW_PACKAGE Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBALTER

OMBCREATE PROCESS_FLOW_PACKAGE

OMBDROP PROCESS_FLOW_PACKAGE

OMBALTER PROFILE_REFERENCE

Purpose

To alter a profile reference, such as to add or delete a data rule usage, or set properties on a profile attribute.

Prerequisites

Must be done in the context of a Data Profile.

Syntax

alterProfileReferenceCommand =  OMBALTER ( PROFILE_REFERENCE
          "QUOTED_STRING" ( [ SET "setPropertiesClause" ] { ADD
          "addDataRuleUsageClause" | DELETE "deleteDataRuleUsageClause" | MODIFY
           ( "modifyDataRuleUsageClause" | "modifyProfileAttributeClause" ) } )
          )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     addDataRuleUsageClause =  DATA_RULE_USAGE ( [ "QUOTED_STRING" ] [ SET REF
          DATA_RULE "QUOTED_STRING" ] ( DERIVE FROM ( (
          "getProfileAttributeDerivationClause" |
          "getProfileForeignKeyDerivationClause" |
          "getProfileUniqueKeyDerivationClause" |
          "getFunctionalDependencyDerivationClause" |
          "getRowRelationshipDerivationClause" ) [ CREATE IN DATA_RULE_MODULE
          "QUOTED_STRING" ] ) | ( GROUP "QUOTED_STRING" SET REF TABLE
          "QUOTED_STRING" ( ATTRIBUTE "QUOTED_STRING" SET REF COLUMN
          "QUOTED_STRING" )+ )+ [ SET "setPropertiesClause" ] ) )
     deleteDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING"
     modifyDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" (
          "renameClause" [ SET "setPropertiesClause" ] | SET
          "setPropertiesClause" )
     modifyProfileAttributeClause =  PROFILE_ATTRIBUTE "QUOTED_STRING" SET
          "setPropertiesClause"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     getProfileAttributeDerivationClause =  PROFILE_ATTRIBUTE "QUOTED_STRING"
          PROFILE_TYPE "QUOTED_STRING"
     getProfileForeignKeyDerivationClause =  PROFILE_FOREIGN_KEY "QUOTED_STRING"
     getProfileUniqueKeyDerivationClause =  PROFILE_UNIQUE_KEY "QUOTED_STRING"
     getFunctionalDependencyDerivationClause =  FUNCTIONAL_DEPENDENCY
          "QUOTED_STRING"
     getRowRelationshipDerivationClause =  ROW_RELATIONSHIP "QUOTED_STRING"
     renameClause =  RENAME TO "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterProfileReferenceCommand

This clause alters the profile reference.

QUOTED_STRING

This is the name of the source pointed to by the profile reference.

setPropertiesClause

This clause sets properties for the corresponding object.

getPropertiesClause

Configuration properties for PROFILE_REFERENCE 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 always 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

Setting this to true will enable common format discovery for the selected table.

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: 100

Valid Values: 1-100

Default: 100

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

getPropertiesClause

Configuration properties for PROFILE_REFERENCE 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.

getPropertiesClause

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.

Configuration properties for PROFILE_ATTRIBUTE that affect loading:

Name: USE_IN_LOADING

Type: BOOLEAN

Valid Values: true | false

Default: true

This tells the profiler if the data for this column is to be copied from the source schema to the profile workspace schema.

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.

getPropertiesClause

Configuration properties for PROFILE_ATTRIBUTE that affect loading:

Name: USE_IN_FK

Type: BOOLEAN

Valid Values: true | false

Default: true

This tells the profiler if this column is to be part of the determinant in functional dependency discovery.By default, all non-numeric columns set this property to false

Name: USE_IN_LOADING

Type: BOOLEAN

Valid Values: true | false

Default: true

Setting this to true will include this column in profiling.

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

Setting this to true will enable common format discovery for the selected table.

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.

Configuration properties for PROFILE_ATTRIBUTE that affect profiling:

Name: USE_IN_DETERMINANT

Type: BOOLEAN

Valid Values: true | false

Default: true

This tells the profiler if this column is to be part of the determinant in functional dependency discovery.By default, all non-numeric columns set this property to false

Name: CALCULATE_DOMAINS

Type: BOOLEAN

Valid Values: true | false

Default: true

This tells the profiler if domain values are to be discovered for this column.

Name: DOMAIN_MAX_COUNT

Type: NUMBER

Valid Values: 1-any number

Default: true

This tells the profiler the maximum number of distinct values this column can have to be considered as domain attributes.

Name: DOMAIN_MAX_PERCENT

Type: NUMBER

Valid Values: 1-100

Default: true

This tells the profiler the maximum number of distinct values as a percentage this column can have to be considered as domain attributes.

Name: DOMAIN_MIN_COUNT

Type: NUMBER

Valid Values: 1-any number

Default: true

This tells the profiler the minimum number of rows a particular value should have in order to be considered a domain value.

Name: DOMAIN_MIN_PERCENT

Type: NUMBER

Valid Values: 1-100

Default: true

This tells the profiler the minimum number of rows as a percentage a particular value should have in order to be considered a domain value.

addDataRuleUsageClause

Add a data rule usage to the profile table.

QUOTED_STRING

name of data rule usage.

deleteDataRuleUsageClause

Delete a data rule usage.

QUOTED_STRING

name of data rule usage.

modifyDataRuleUsageClause

Rename or modify the properties of a data rule usage.

QUOTED_STRING

name of data rule usage.

modifyProfileAttributeClause

Modify the attribute of a profile reference.

propertyNameList

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

propertyValueList

Comma separated list of property values.

getProfileAttributeDerivationClause

Derive a data rule usage for an attribute from a profile type.

getProfileForeignKeyDerivationClause

Derive a foreign key data rule usage from a profile foreign key.

getProfileUniqueKeyDerivationClause

Derive a unique key data rule usage from a profile unique key.

getFunctionalDependencyDerivationClause

Derive a functional dependency data rule usage from a profile functional dependency.

getRowRelationshipDerivationClause

Derive a row relationship data rule usage for an attribute from a profile row relationship.

renameClause

Renames an object.

propertyValue

Value of a property.

PROFILE_REFERENCE Object

Table 4-5 PROFILE_REFERENCE Object

Property
Type
Choices
Min
Max
Default
Description

ANALYZE_TABLE_ESTIMATE_PERCENT

STRING

none

none

none

empty string

Value represents the sample size as a percentage (0-100) of total rows. When set to a nonzero value, Builder generates a DDL script to analyze the table. The default is 99.

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.

CACHE_MODE

STRING

, CACHE, NOCACHE

none

none

empty string

Indicate how Oracle should store blocks in the buffer cache.

CALCULATE_COMMON_FORMATS

BOOLEAN

true, false

none

none

false

Setting this to true will enable common format discovery for the selected table.

CALCULATE_DATATYPES

BOOLEAN

true, false

none

none

true

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

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 with respect to a foreign key-unique key pair.

CALCULATE_UK

BOOLEAN

true, false

none

none

true

Setting this to true will enable unique key discovery.

CDC_POSITION

NUMBER

none

none

none

0

Table position in change data capture.

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 a materialized view for each column in this table to enhance query performance during drill down.

DATA_RULE_SIGNATURE

STRING

none

none

none

empty string

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

false

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

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.

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string

Use the Tablespace parameter to specify the name of tablespace.

ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string

Use the error table name to specify the name of Error Table.

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, foreign 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.

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.

GENERATED_OBJECTS

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.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

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.

IS_CDC

BOOLEAN

true, false

none

none

false

Enable table for change data capture

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.

MAX_NUM_PATTERNS

NUMBER

none

none

none

10

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

MINEXTENTS

STRING

none

none

none

empty string

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

MONITORING_MODE

STRING

, MONITORING, NOMONITORING

none

none

empty string

Specify MONITORING if you want modification statistics to be collected on this table.

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.

NULL_PERCENT

NUMBER

none

0

100

10

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

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.

NUM_ROWS

NUMBER

none

none

none

0

OVERFLOW

STRING

none

none

none

empty string

Enter a comma separated list of tablespaces for overflow data. For simple-partitoned object, it is used for HASH BY QUANTITY partition overflow tablespaces. The number of tablespaces does not have to equal the number of partitions. If the number of partitions is greater than the number of tablespaces, then Oracle cycles through the names of the 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 simple-partitoned object, it is used for HASH BY QUANTITY partition tablespaces. For composite-partitioned tables, it is used for subpartition template to store a list of tablespaces.

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.

PROFILE_DONE

BOOLEAN

true, false

none

none

false

REDUNDANT_MIN_PERCENT

NUMBER

none

0

100

75

This is the minimum percentage of rows that are redundant.

ROWDEPENDENCIES_MODE

STRING

, NOROWDEPENDENCIES, ROWDEPENDENCIES

none

none

empty string

Specify ROWDEPENDENCIES to use row-level dependency tracking.

ROW_MOVEMENT

STRING

, DISABLE, ENABLE

none

none

empty string

Specify whether Oracle can move a table row.

SAMPLE_RATE

NUMBER

none

0

100

100

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

TABLESPACE

STRING(30)

none

none

none

empty string

UK_MIN_PERCENT

NUMBER

none

0

100

75

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

WHERE_CLAUSE

STRING

none

none

none

empty string

Where clause to be applied on the source when loading data into the profile staging area.

See Also

OMBALTER

OMBALTER PROJECT

Purpose

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

Prerequisites

Should be in the top level context.

Syntax

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

Parameters

alterProjectCommand

Modify an existing project.

QUOTED_STRING

Name of the existing project in quotes.

renameClause

Rename a project.

alterPropertiesOrIconSetClause

Alter existing Project properties and/or Icon Set.

setPropertiesClause

Associate a set of properties with a project.

getPropertiesClause

Basic properties for PROJECT:

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

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

setReferenceIconSetClause

Set icon set for the project.

unsetReferenceIconSetClause

Unset icon set for the project.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

See Also

OMBALTER

OMBCREATE PROJECT

OMBDROP PROJECT

OMBALTER PSFT_MODULE

Purpose

alterPSFTModuleCommandPurposeTag??

Prerequisites

alterPSFTModuleCommandPreTag??

Syntax

alterPSFTModuleCommand =  OMBALTER ( PSFT_MODULE "QUOTED_STRING" (
          "renameClause" [
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule =  (
          "alterJournalCodeTemplateClause" [
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceClauseForDataMetadataModule" )
     alterJournalCodeTemplateClause =  SET "setJournalCodeTemplateClause" |
          UNSET "unsetJournalCodeTemplateClause"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( (
          "alterPropertiesClause" [ ( SET
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | (
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     setJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT "QUOTED_STRING"
          | ( ( REFERENCE | REF ) CDC_CT OPTIONS "(" "propertyValueList" ")"
          VALUES "(" "propertyValueList" ")" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  (
          "unsetReferenceLocationClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "setJournalCodeTemplateClause" [ SET
          "setReferenceMetadataLocationOrIconSetClause" ] |
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "unsetJournalCodeTemplateClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetClause" ] |
          "unsetReferenceMetadataLocationOrIconSetClause" )
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" SET AS DEFAULT
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setReferenceMetadataLocationOrIconSetClause =  (
          "setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
           ] | "setReferenceIconSetClause" )
     unsetReferenceMetadataLocationOrIconSetClause =  (
          "unsetReferenceMetadataLocationClause" [ UNSET
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceMetadataLocationClause =  ( REFERENCE | REF )
          METADATA_LOCATION "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

See Also

OMBALTER

OMBCREATE PSFT_MODULE

OMBDROP PSFT_MODULE

OMBALTER QUEUE_PROPAGATION

Purpose

Alter the Queue Propagation by resetting its properties.

Prerequisites

Should be in the context of an Advanced Queue. The target Queue should exist in any Oracle Module.

Syntax

alterQPCommand =  OMBALTER ( QUEUE_PROPAGATION "QUOTED_STRING" (
          "renameClause" [ "alterQPPropertiesOrIconSetClause" ] |
          "alterQPPropertiesOrIconSetClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterQPPropertiesOrIconSetClause =  SET ( "setQPPropertiesClause" [ SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
     setQPPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterQPCommand

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

renameClause

Renames the Queue Propagation to the given name.

setQPPropertiesClause

Sets properties (core, logical, physical, user-defined) for Queue Propagation. Valid properties are shown below:

getQPPropertiesClause

Basic properties for QUEUE_PROPAGATION:

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

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

Name: TARGET_QUEUE
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Target Queue for the Queue Propagation. This has to be the name of a Queue existing in any Oracle Module.

setReferenceIconSetClause

Set the specified Icon Set.

unsetReferenceIconSetClause

Unset the Icon Set.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

QUEUE_PROPAGATION Object

Table 4-6 QUEUE_PROPAGATION Object

Property
Type
Choices
Min
Max
Default
Description

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.

DURATION

STRING

none

none

none

empty string

The duration of proagation to be done. The default value is null.Applicable only for non-streams queue propagation.

GENERATE_DBLINK

BOOLEAN

true, false

none

none

true

Generate script for Database Link which is used for propagation

GENERATE_QUEUE_PROPAGATION

BOOLEAN

true, false

none

none

true

Generate script for Queue Propagation

GENERATE_REPLICATION_RULE

BOOLEAN

true, false

none

none

false

Generate Ruleset and Rule for Replication purpose in Streams queue propagation

GENERATE_SCHEDULE_PROPAGATION

BOOLEAN

true, false

none

none

true

Generate script for Scheduling propagation. Applicable only for non-streams queue propagation.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

LATENCY

STRING

none

none

none

60

The latency for the queue propagation. By default the value is 60.Applicable only for non-streams queue propagation.

NEXT_TIME

STRING

none

none

none

empty string

Next time when the propagation to be done. The default value is null.Applicable only for non-streams queue propagation.

NOT_PERMITTED_TAG_VALUES

STRING

none

none

none

empty string

List of comma separated Tag values (in Hex numbers) which are not allowed for propagation

PERMITTED_TAG_VALUES

STRING

none

none

none

empty string

List of comma separated Tag values (in Hex numbers) which are allowed for propagation

START_TIME

STRING

none

none

none

SYSDATE

The start time for the propagation to happen. The default value is SYSDATE.Applicable only for non-streams queue propagation.

SUBCRIBER_TRANSFORMATION

STRING

none

none

none

empty string

A Transformation that will be applied before propagation to the target queue. Applicable only for non-streams queue propagation.

SUBSCRIBER_RULE_CONDITION

STRING

none

none

none

empty string

A Rule condition to check whether the message can be propagated to the subscriber. Applicable only for non-streams queue propagation.

See Also

OMBALTER

OMBCREATE QUEUE_PROPAGATION

OMBRETRIEVE QUEUE_PROPAGATION

OMBDROP QUEUE_PROPAGATION

OMBALTER QUEUE_TABLE

Purpose

Alter the Queue Table by resetting its properties.

Prerequisites

Should be in the context of an Oracle Module. The target Queue should exist in any Oracle Module.

Syntax

alterQTCommand =  OMBALTER ( QUEUE_TABLE "QUOTED_STRING" ( "renameClause" [
           SET "setQTPropertiesClause" ] | SET "setQTPropertiesClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     setQTPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterQTCommand

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

renameClause

Renames the Queue Table to the given name.

setQTPropertiesClause

Sets properties (core, logical, physical, user-defined) for Queue Table. Valid properties are shown below:

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.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

QUEUE_TABLE Object

Table 4-7 QUEUE_TABLE Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBALTER

OMBCREATE QUEUE_TABLE

OMBRETRIEVE QUEUE_TABLE

OMBDROP QUEUE_TABLE

OMBALTER REAL_TIME_MAPPING

Purpose

Alter the content of a Real Time mapping.

Prerequisites

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

2. No concurrent user should be modifying the mapping

Syntax

alterRealTimeMappingCommand =  OMBALTER REAL_TIME_MAPPING "mappingName"
          "alterMapDetailClause"
     mappingName =  "QUOTED_STRING"
     alterMapDetailClause =  "renameClause" [ "alterPropertiesOrIconSetClause" ]
           [ "alterOperatorOwnerDescendantsClause"+ ] |
          "alterPropertiesOrIconSetClause" [
          "alterOperatorOwnerDescendantsClause"+ ] |
          "alterOperatorOwnerDescendantsClause"+ |
          "setDefaultExecutionUnitClause"
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  ( SET ( ( "setPropertiesClause" [ ( SET
          "setCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) | (
          UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) |
           ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( UNSET
          "unsetCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) | (
          UNSET "unsetReferenceIconSetClause" ) ] ) | ( UNSET
          "unsetControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" )
           | ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
          ) ] ) | ( "setCodeTemplateClause" [ ( SET "setReferenceIconSetClause"
          ) | ( UNSET "unsetReferenceIconSetClause" ) ] ) | (
          "setControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause" ) |
           ( UNSET "unsetReferenceIconSetClause" ) ] ) | ( SET
          "setReferenceIconSetClause" ) ) ) | UNSET ( "unsetCodeTemplateClause"
          | "unsetControlCodeTemplateClause" [ ( SET "setReferenceIconSetClause"
           ) | ( UNSET "unsetReferenceIconSetClause" ) ] |
          "unsetReferenceIconSetClause" )
     alterOperatorOwnerDescendantsClause =  ADD ( "addOperatorClause" |
          "addGroupClause" | "addAttributeClause" | "addChildClause" |
          "addConnectionClause" | "addExecutionUnitClause" ) | MODIFY (
          "modifyOperatorClause" | "modifyGroupClause" | "modifyAttributeClause"
           | "modifyChildClause" | "modifyExecutionUnitClause" ) | DELETE (
          "operatorBottomUpLocator" | "groupBottomUpLocator" |
          "attributeBottomUpLocator" | "childBottomUpLocator" |
          "deleteConnectionLocator" | "deleteExecutionUnitClause" )
     setDefaultExecutionUnitClause =  SET DEFAULT_EXECUTION_UNIT
     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"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     setControlCodeTemplateClause =  ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE
          "QUOTED_STRING" | ( ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE OPTIONS
          "(" "optionValueList" ")" VALUES "(" "optionValueList" ")" )
     unsetCodeTemplateClause =  ( REFERENCE | REF ) CODE_TEMPLATE
     unsetControlCodeTemplateClause =  ( REFERENCE | REF ) CONTROL_CODE_TEMPLATE
     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" ]
     modifyOperatorClause =  "operatorBottomUpLocator" ( "renameClause" | SET
          "setPropertiesClause" )
     modifyGroupClause =  "groupBottomUpLocator" ( "renameClause" | SET
          "setPropertiesClause" | "setBindingClause" |
          "internallyConnectToClause" )+
     modifyAttributeClause =  "attributeBottomUpLocator" ( "renameClause" |
          "moveToClause" | SET "setPropertiesClause" )
     modifyChildClause =  "childBottomUpLocator" ( "renameClause" | SET
          "setPropertiesClause" )
     modifyExecutionUnitClause =  EXECUTION_UNIT "executionUnitName" ( (
          OPERATORS "operatorNameList" [ ( SET ( REFERENCE | REF ) CODE_TEMPLATE
           "setEUCodeTemplateClause" ) ] [ ( SET ( REFERENCE | REF )
          CONTROL_CODE_TEMPLATE "setEUControlCodeTemplateClause" ) ] ) |
          "addDeleteExecutionUnitOperatorClause"+ [ ( SET ( REFERENCE | REF )
          CODE_TEMPLATE "setEUCodeTemplateClause" ) ] | ( SET ( REFERENCE | REF
          ) CODE_TEMPLATE "setEUCodeTemplateClause" ) | ( SET ( REFERENCE | REF
          ) CONTROL_CODE_TEMPLATE "setEUControlCodeTemplateClause" ) )
     operatorBottomUpLocator =  OPERATOR "operatorName" [
          "pluggableMapBottomUpLocator" ]
     groupBottomUpLocator =  GROUP "groupName" OF "operatorBottomUpLocator"
     attributeBottomUpLocator =  ATTRIBUTE "attributeName" OF
          "groupBottomUpLocator"
     childBottomUpLocator =  "childType" "childName" { OF "childType"
          "childName" } [ OF "mappableBottomUpLocator" ]
     deleteConnectionLocator =  CONNECTION ( FROM "mappableBottomUpLocator" [ TO
           "mappableBottomUpLocator" ] | TO "mappableBottomUpLocator" )
     deleteExecutionUnitClause =  EXECUTION_UNIT "executionUnitName"
     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"
     internallyConnectToClause =  SET REF "groupLocator"
     attributeName =  "QUOTED_STRING"
     childType =  "UNQUOTED_STRING"
     childName =  "QUOTED_STRING"
     childOwnerBottomUpLocator =  { OF "childType" "childName" } [ OF
          "mappableBottomUpLocator" ]
     groupToGroupConnectType =  COPY ALL | BY ( NAME [ IGNORE ( SPECIAL_CHARS
          "QUOTED_STRING" | SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX
          "QUOTED_STRING" | TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX
          "QUOTED_STRING" ) { "," IGNORE ( SPECIAL_CHARS "QUOTED_STRING" |
          SOURCE_PREFIX "QUOTED_STRING" | SOURCE_SUFFIX "QUOTED_STRING" |
          TARGET_PREFIX "QUOTED_STRING" | TARGET_SUFFIX "QUOTED_STRING" ) } ] |
          POSITION )
     attributesBottomUpLocator =  ATTRIBUTES "attributeNameList" OF
          "groupBottomUpLocator"
     executionUnitName =  "QUOTED_STRING"
     operatorNameList =  "(" "operatorName" { "," "operatorName" } ")"
     setEUCodeTemplateClause =  "QUOTED_STRING" | OPTIONS "(" "optionValueList"
          ")" VALUES "(" "optionValueList" ")"
     setEUControlCodeTemplateClause =  "QUOTED_STRING" | OPTIONS "("
          "optionValueList" ")" VALUES "(" "optionValueList" ")"
     moveToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     addDeleteExecutionUnitOperatorClause =  ADD OPERATOR "operatorName" |
          DELETE OPERATOR "operatorName"
     mappableBottomUpLocator =  "operatorBottomUpLocator" |
          "groupBottomUpLocator" | "attributeBottomUpLocator"
     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"
     attributeNameList =  "(" "attributeName" { "," "attributeName" } ")"
     bindableType =  PLUGGABLE_MAPPING | OBJECT_TYPE | "UNQUOTED_STRING"
     bindableName =  "QUOTED_STRING"

Parameters

mappingName

Name of the mapping.

alterMapDetailClause

Alter the detail of the mapping.

renameClause

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

alterPropertiesOrIconSetClause

Alter the properties, code template or icon set settings of the map.

alterOperatorOwnerDescendantsClause

Alter the desired child objects applicable to a mapping or a pluggable mapping.

setDefaultExecutionUnitClause

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

setPropertiesClause

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

addOperatorClause

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

The following is an example for creating 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.

modifyOperatorClause

Modify a mapping operator.

modifyGroupClause

Modify a mapping group.

modifyAttributeClause

Modify a mapping attribute.

modifyChildClause

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

modifyExecutionUnitClause

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

operatorBottomUpLocator

Location of a mapping operator.

groupBottomUpLocator

Location of a mapping group.

attributeBottomUpLocator

Location of a mapping attribute.

childBottomUpLocator

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

deleteConnectionLocator

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

deleteExecutionUnitClause

Delete the specified execution unit.

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.

internallyConnectToClause

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

attributeName

Name of a mapping attribute.

childType

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

childName

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

childOwnerBottomUpLocator

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

groupToGroupConnectType

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

attributesBottomUpLocator

Location of a list of mapping attributes.

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.

moveToClause

Modify the position of the specified attribute within its attribute group.

addDeleteExecutionUnitOperatorClause

Add or delete operator(s) that are contained in the execution unit.

mappableBottomUpLocator

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

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.

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 4-8 MAPPING Object

Property
Type
Choices
Min
Max
Default
Description

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 4-9 OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 4-10 GROUP Object

Property
Type
Choices
Min
Max
Default
Description

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

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 4-11 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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 4-12 AGGREGATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

none

none

none

0

ANYDATA_CAST_OPERATOR Object

Table 4-13 ANYDATA_CAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 4-14 CONSTANT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 4-15 CONSTRUCT_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 4-16 CUBE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 4-17 DATA_GENERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 4-18 DEDUPLICATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 4-19 DIMENSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 4-20 EXPAND_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 4-21 EXPRESSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 4-22 EXTERNAL_TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FILTER_OPERATOR Object

Table 4-23 FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

FILTER_CONDITION

STRING

none

none

none

empty string

The boolean filtering condition that identifies what data is to be processed. Any row with a false condition will be ignored.

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

SUBQUERY_FILTER_OPERATOR Object

Table 4-24 SUBQUERY_FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SUBQUERY_FILTER_CONDITION

STRING

none

none

none

empty string

The Filter Condition for the subquery operator, if blank then the subquery stands alone with no join to the top-level query.

SUBQUERY_INPUT_ROLE

STRING(16)

EXISTS, IN, NOT_EXISTS, NOT_IN

none

none

EXISTS

The role the input stream plays in the subquery filter condition.

SUBQUERY_JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FLAT_FILE_OPERATOR Object

Table 4-25 FLAT_FILE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CONCATENATE_RECORDS

NUMBER

none

none

none

0

Number of Physical Records per Logical Record.

CONTINUATION_CHARACTER

STRING

none

none

none

empty string

Character that indicates the record is continued on the next line.

CONTINUATION_CHARACTER_ON_NEXT_LINE

BOOLEAN

true, false

none

none

FALSE

If there is a continuation character, is it at the start of the line.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The name of the directory in which to open the target data file. The directory must be deployed before the file can be created.

DEBUG_TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

ESCAPE_CHARACTER_FOR_ENCLOSURE

STRING

none

none

none

empty string

Escape character for data containing the enclosure character. This is only applicable with delimited files having enclosure characters.

FIELD_ENCLOSURE_CHARACTERS

STRING

none

none

none

empty string

Characters that wrap fields. Example ' or ".

FIELD_NAMES_IN_THE_FIRST_ROW

BOOLEAN

true, false

none

none

FALSE

Indicates whether file contains a header row.

FIELD_TERMINATION_CHARACTER

STRING

none

none

none

,

Character that separates the fields of a delimited file.

FILE_FORMAT

STRING

DELIMITED, FIXED

none

none

DELIMITED

File Format (Fixed or Delimited).

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LOADING_TYPE

STRING(16)

INSERT, NONE, UPDATE

none

none

INSERT

The loading operation to be performed

NLS_CHARACTERSET

STRING

none

none

none

WE8MSWIN1252

NLS Characterset

OUTPUT_AS_XML

BOOLEAN

true, false

none

none

false

Output data to file in XML format.

RECORDS_TO_SKIP

NUMBER

none

0

none

0

Number of logical records to skip

RECORD_DELIMITER

STRING

none

none

none

empty string

Character that indicates the end of the record.

RECORD_SIZE

NUMBER

none

none

none

0

Size of a fixed length record.

RECORD_TYPE_LENGTH

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the length of the data that identifies the type of record. It is used with the Record Type Position.

RECORD_TYPE_POSITION

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the position of the field that identifies the type of record.

SAMPLED_FILE_NAME

STRING

none

none

none

empty string

The default name of the physical file to be used by sqlloader. If the file was sampled, the default was set from sampled file name.

SOURCE_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The Location of the File Module of this Flat File at the time of reconciliation. Stored as UOID.

TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The location used to access referenced entity.

TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

INPUT_PARAMETER_OPERATOR Object

Table 4-26 INPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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

INPUT_SIGNATURE_OPERATOR Object

Table 4-27 INPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ITERATOR_OPERATOR Object

Table 4-28 ITERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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

JOINER_OPERATOR Object

Table 4-29 JOINER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

JOIN_CONDITION

STRING

none

none

none

empty string

The Join Condition for the join operator

JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

LOOKUP_OPERATOR Object

Table 4-30 LOOKUP_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRCAST_OPERATOR Object

Table 4-31 LCRCAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRSPLITTER_OPERATOR Object

Table 4-32 LCRSPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCHMERGE_OPERATOR Object

Table 4-33 MATCHMERGE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCH_KEYS

STRING

none

none

none

empty string

Ordered list of attributes that control the set of records to be matched at any at any particular time.

MATCH_NEW_RECORDS

BOOLEAN

true, false

none

none

false

MATCH_NEW_RECORD_CONDITION

STRING

none

none

none

empty string

MERGED_PREFIX

STRING

none

none

none

empty string

Set the prefix used for the merged attributes in the cross-reference group.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

MATERIALIZED_VIEW_OPERATOR Object

Table 4-34 MATERIALIZED_VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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).

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.

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

NAME_AND_ADDRESS_OPERATOR Object

Table 4-35 NAME_AND_ADDRESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

ADDRESS_LINE_1

STRING

none

none

none

empty string

Address line 1

ADDRESS_LINE_2

STRING

none

none

none

empty string

Address line 2

ADDRESS_LINE_3

STRING

none

none

none

empty string

Address line 3

ADDRESS_LINE_4

STRING

none

none

none

empty string

Address line 4

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

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

A dual address refers to two address lines for the same destination. For example, a record contains both a street address and a P.O. Box; this is common with business data. Select which of the two address lines should be assigned in these cases.

GENERATE_CASS_REPORT

STRING

NA_NO, NA_YES

none

none

NA_NO

Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS report is a text file specified by the United States Postal Service. The report is written to the [nas/bin/admin/reports] folder under the home folder of the name/address server.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LIST_NAME

STRING

none

none

none

empty string

The list name is optional and provides a reference for tracking multiple CASS reports.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Select a name-address parsing type to be performed on the input data

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Select the primary parsing country which best represents the input data. Input addresses having the same country as the primary parsing country will only need to be parsed once. Input addresses having a different country than the primary parsing country may be reparsed by a different parser. For performance reasons, it is best to minimize the percentage of 2-pass parses by selecting the optimal parser.

PROCESSOR_NAME

STRING

none

none

none

empty string

The processor name is the name of the organization submitting the CASS report.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

OUTPUT_PARAMETER_OPERATOR Object

Table 4-36 OUTPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

The name to use when refering to this entity in generated code.

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

OUTPUT_SIGNATURE_OPERATOR Object

Table 4-37 OUTPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_OPERATOR Object

Table 4-38 PIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_GROUP_SIZE

NUMBER

none

1

1000

2

A number specifying the pivot group size for the pivot operation. Pivot group size determines the number of output rows that are produced from each input row.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PLUGGABLE_MAPPING_OPERATOR Object

Table 4-39 PLUGGABLE_MAPPING_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

POSTMAPPING_PROCESS_OPERATOR Object

Table 4-40 POSTMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

POSTMAPPING_PROCESS_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING

none

none

ON_SUCCESS

Indicates under what condition of the mapping the post-mapping process will be run.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PREMAPPING_PROCESS_OPERATOR Object

Table 4-41 PREMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

MAPPING_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS

none

none

ON_SUCCESS

Indicates under what condition of the pre-mapping process the mapping will be run.

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

QUEUE_OPERATOR Object

Table 4-42 QUEUE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_AQ_UOID

STRING

none

none

none

empty string

The UOID of the Advanced Qeue object to which this stage component is bound to.

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.

DB_LOCATION

STRING

none

none

none

empty string

The location used to access this entity during mapping.

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

GENERATE_SUBSCRIBER

BOOLEAN

true, false

none

none

true

This only applies to batch mappings. This specifies whether the subscriber is generated. The name of the subscriber is the owning map. If the queue being sourced is a propagation queue with the same name as the owning map, then set to false.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

IS_REALTIME_SOURCE

BOOLEAN

true, false

none

none

false

IS_STREAMS_QUEUE

BOOLEAN

true, false

none

none

false

PAYLOAD_NAME

STRING

none

none

none

empty string

The name of payload type.

QUEUE_TABLE_NAME

STRING

none

none

none

empty string

The name of the queue table that is used to perist the messages in this Advanced Queue.

REAL_TIME_DATA_FORMAT

STRING

LOGICAL_CHANGE_RECORD, MESSAGE

none

none

MESSAGE

The format for this message, either user-defined or LCR

SOURCE_TABLES

STRING

none

none

none

empty string

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.

TEMPORARY_TABLE_NAME

STRING

none

none

none

empty string

The name of the temporary table that will stage the messages from the Advanced Queue.

UDT

STRING

none

none

none

empty string

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SEQUENCE_OPERATOR Object

Table 4-43 SEQUENCE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SET_OPERATION_OPERATOR Object

Table 4-44 SET_OPERATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SET_OPERATION

STRING

INTERSECT, MINUS, UNION, UNIONALL

none

none

UNION

Specifies the set operation that is to be performed by this operator.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SORTER_OPERATOR Object

Table 4-45 SORTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ORDER_BY_CLAUSE

STRING

none

none

none

empty string

The Order By Clause

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SPLITTER_OPERATOR Object

Table 4-46 SPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

TABLE_FUNCTION_OPERATOR Object

Table 4-47 TABLE_FUNCTION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

TABLE_FUNCTION_IS_TARGET

BOOLEAN

true, false

none

none

false

Description not available.

TABLE_FUNCTION_NAME

STRING

none

none

none

empty string

The name of the Table Function

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

TABLE_OPERATOR Object

Table 4-48 TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

Description not available.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

CONFLICT_RESOLUTION

BOOLEAN

true, false

none

none

true

Detect and resolve any conflicts that may arise during DML using the LCR APIs

CONTROL_CK

STRING

none

none

none

empty string

Set Control Code Template Params for Check Constraint.

CONTROL_DATA_RULES

STRING

none

none

none

empty string

Set Control Code Template Params for Data Rules.

CONTROL_FK

STRING

none

none

none

empty string

Set Control Code Template Params for Foreign Keys.

CONTROL_NN

STRING

none

none

none

empty string

Set Control Code Template Params for Not Null attributes.

CONTROL_PK

STRING

none

none

none

empty string

Set Control Code Template Params for Primary Keys.

CONTROL_UK

STRING

none

none

none

empty string

Set Control Code Template Params for Unique Keys.

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_LOCATION

STRING(30)

none

none

none

empty string

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

ISAPPLYSOURCE

BOOLEAN

true, false

none

none

false

Generate Non Trigger Apply uptime script considering this is a leading source for the map

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_ERROR_TABLE

BOOLEAN

true, false

none

none

false

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_STATIC_TABLE

BOOLEAN

true, false

none

none

false

Check source table operator static

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

IS_USER-DEFINED_DATA

BOOLEAN

true, false

none

none

false

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

JOINRANK

FLOAT

none

none

none

0

Join Rank

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

OPTIMIZE_MERGE

BOOLEAN

true, false

none

none

false

Optimize the execution of expressions by deferring them until really needed

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.

USE_LCR_API

BOOLEAN

true, false

none

none

true

Use LCR APIs if possible to perform the DML

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

ZDT_DOWNTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Downtime Extraction Index Hints

ZDT_DOWNTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

ZDT_UPTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Uptime Extraction Index Hints

ZDT_UPTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

TRANSFORMATION_OPERATOR Object

Table 4-49 TRANSFORMATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

RETURN_TYPE

STRING

none

none

none

empty string

Description not available.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

UNPIVOT_OPERATOR Object

Table 4-50 UNPIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

VIEW_OPERATOR Object

Table 4-51 VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

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_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150

INLINED

BOOLEAN

true, false

none

none

false

If set to true, the view query will be used as an inline subquery in the generated code.

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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

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.

VIEW_QUERY

STRING

none

none

none

empty string

The query text for this view.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

See Also

OMBALTER

OMBCREATE REAL_TIME_MAPPING

OMBRETRIEVE REAL_TIME_MAPPING

OMBDROP REAL_TIME_MAPPING

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

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE REGISTERED_FUNCTION

OMBRETRIEVE REGISTERED_FUNCTION

OMBALTER ROLE

Purpose

To alter properties of a Warehouse Builder role.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

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

Parameters

alterRoleCommand

This clause alters a Warehouse Builder role.

renameClause

renames a role with a different name.

setPropertiesClause

Used to set properties of a Warehouse Builder role. Valid properties are shown below.

getPropertiesClause

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

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

propertyNameList

A list of valid properties are shown in section of Basic properties for Role.

propertyValueList

A list of valid property value shown in section of Basic properties for Role.

propertyValue

The valid property value shown in section of Basic properties for Role.

See Also

OMBCREATE ROLE

OMBDROP ROLE

OMBALTER SAP_MODULE

Purpose

Alter the SAP module by renaming it, and/or reset its properties.

It is not supported in the current release.

Prerequisites

You must open a project to alter a SAP module.

Syntax

alterSAPModuleCommand =  OMBALTER ( SAP_MODULE "QUOTED_STRING" (
          "renameClause" [
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( (
          "alterPropertiesClause" [ ( SET
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | (
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  (
          "unsetReferenceLocationClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "setJournalCodeTemplateClause" [ SET
          "setReferenceMetadataLocationOrIconSetClause" ] |
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "unsetJournalCodeTemplateClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetClause" ] |
          "unsetReferenceMetadataLocationOrIconSetClause" )
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( 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" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     unsetReferenceMetadataLocationOrIconSetClause =  (
          "unsetReferenceMetadataLocationClause" [ UNSET
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceMetadataLocationClause =  ( REFERENCE | REF )
          METADATA_LOCATION "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

alterSAPModuleCommand

Modify an existing SAP module.

renameClause

Rename a SAP module.

alterPropertiesOrReferenceClauseForDataMetadataModule

Alter existing SAP module's properties and/or locations and/or icon sets.

alterPropertiesClause

Set the properties for the SAP module.

setReferenceClauseForDataMetadataModule

Set data location and/or icon set for the SAP module.

unsetReferenceClauseForDataMetadataModule

Unset data location and/or icon set for the SAP module.

addOrRemoveOrModifyModuleReferenceLocationClause

Add/remove/modify data location for the SAP 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 existing SAP module as the new configuration default.

unsetReferenceLocationClause

Unset a data location to the existing SAP module.

addReferenceLocationClause

Add a data location to the SAP module.

removeReferenceLocationClause

Remove a data location from the SAP module.

modifyReferenceLocationClause

Modify a data location of the SAP module.

propertyValue

Value of a property.

setReferenceMetadataLocationClause

Set metadata location for the SAP module.

setReferenceIconSetClause

Set icon set for the SAP module.

unsetReferenceMetadataLocationClause

Unset metadata location for the SAP module.

unsetReferenceIconSetClause

Unset icon set for the SAP module.

See Also

OMBALTER

OMBCREATE SAP_MODULE

OMBDROP SAP_MODULE

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

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER

OMBCREATE SEQUENCE

OMBDROP SEQUENCE

OMBRETRIEVE SEQUENCE

OMBALTER SIEBEL_MODULE

Purpose

alterSiebelModuleCommandPurposeTag??

Prerequisites

alterSiebelModuleCommandPreTag??

Syntax

alterSiebelModuleCommand =  OMBALTER ( SIEBEL_MODULE "QUOTED_STRING" (
          "renameClause" [
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule =  (
          "alterJournalCodeTemplateClause" [
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceClauseForDataMetadataModule" )
     alterJournalCodeTemplateClause =  SET "setJournalCodeTemplateClause" |
          UNSET "unsetJournalCodeTemplateClause"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( (
          "alterPropertiesClause" [ ( SET
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | (
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     setJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT "QUOTED_STRING"
          | ( ( REFERENCE | REF ) CDC_CT OPTIONS "(" "propertyValueList" ")"
          VALUES "(" "propertyValueList" ")" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  (
          "unsetReferenceLocationClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "setJournalCodeTemplateClause" [ SET
          "setReferenceMetadataLocationOrIconSetClause" ] |
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "unsetJournalCodeTemplateClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetClause" ] |
          "unsetReferenceMetadataLocationOrIconSetClause" )
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" SET AS DEFAULT
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setReferenceMetadataLocationOrIconSetClause =  (
          "setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
           ] | "setReferenceIconSetClause" )
     unsetReferenceMetadataLocationOrIconSetClause =  (
          "unsetReferenceMetadataLocationClause" [ UNSET
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceMetadataLocationClause =  ( REFERENCE | REF )
          METADATA_LOCATION "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

See Also

OMBALTER

OMBCREATE SIEBEL_MODULE

OMBDROP SIEBEL_MODULE

OMBALTER SNAPSHOT

Purpose

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

Prerequisites

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

Syntax

parseAlterCommand =  OMBALTER "alterSnapshotCommand"
     alterSnapshotCommand =  ( SNAPSHOT "QUOTED_STRING" ( SET
          "setPropertiesClause" | ( ( ( ADD | MODIFY ) "objectClause" ) | (
          DELETE "UNQUOTED_STRING" "QUOTED_STRING" ) )+ ) )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     objectClause =  "UNQUOTED_STRING" "QUOTED_STRING" [ CASCADE | NO CASCADE ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseAlterCommand

Root production for OMBALTER SNAPSHOT.

alterSnapshotCommand

To alter already existing snapshot.

QUOTED_STRING

Name of snapshot to be altered.

ADD

Add components to snapshot.

MODIFY

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

DELETE

Remove component from snapshot.

setPropertiesClause

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

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

objectClause

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

UNQUOTED_STRING

Type of the component

QUOTED_STRING

Absolute or relative path name of the component

CASCADE

Cascade option for folder components. By default, any folder is snapshotted along with its contents. The NO CASCADE option allows the user to snapshot only the folder object itself along with its associated properties.

propertyNameList

Property names for SNAPSHOT that can be altered.

propertyValueList

List of property values for SNAPSHOT.

propertyValue

Allowable value types for a snapshot property.

See Also

OMBCREATE SNAPSHOT

OMBDROP SNAPSHOT

OMBRESTORE SNAPSHOT

OMBCOMPARE SNAPSHOT

OMBLIST SNAPSHOT

OMBRETRIEVE SNAPSHOT

OMBALTER TABLE

Purpose

To alter properties and definition of a table.

Prerequisites

In the context of an Oracle Module.

Syntax

alterTableCommand =  OMBALTER ( TABLE "QUOTED_STRING" ( "renameClause" [
          "alterPropertiesOrIconSetClause" ] [ "alterTableSCOClauses" ] |
          "alterPropertiesOrIconSetClause" [ "alterTableSCOClauses" ] |
          "alterTableSCOClauses" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET ( REF |
           REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
          "setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause"
     alterTableSCOClauses =  ADD ( "addColumnClauseForAlter" |
          "addConstraintClause" | "addSCOClause" | "addDataRuleUsageClause" ) [
          "alterTableSCOClauses" ] | MODIFY ( "modifyColumnClause" |
          "modifyConstraintClause" | "modifySCOClause" |
          "modifyDataRuleUsageClause" ) [ "alterTableSCOClauses" ] | DELETE (
          "deleteColumnClause" | "deleteConstraintClause" | "deleteSCOClause" |
          "deleteDataRuleUsageClause" ) [ "alterTableSCOClauses" ]
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ICONSET
     addColumnClauseForAlter =  COLUMN "QUOTED_STRING" [ AT POSITION
          "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     addConstraintClause =  "addUkPkClause" | "addFkClause" |
          "addCheckConstraintClause"
     addSCOClause =  "addIndexClause" | "addIndexPartitionClause" |
          "addIndexPartitionKeyClause" | "addPartitionClause" |
          "addPartitionKeyClause" | "addSubpartitionClause" |
          "addaddMaterializedViewSCOandDependentClauseClause" |
          "addSubPartitionKeyClause" | "addIndexColumnClause" |
          "addAttributeSetClause"
     addDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" SET REF DATA_RULE
           "QUOTED_STRING" ( GROUP "QUOTED_STRING" SET REF ( TABLE | VIEW |
          MATERIALIZED_VIEW | EXTERNAL_TABLE ) "QUOTED_STRING" ( ATTRIBUTE
          "QUOTED_STRING" SET REF COLUMN "QUOTED_STRING" )+ )+ [ SET
          "setPropertiesClause" ]
     modifyColumnClause =  COLUMN "QUOTED_STRING" ( "renameClause" [
          "moveToClause" ] [ SET "setPropertiesClause" ] | "moveToClause" [ SET
          "setPropertiesClause" ] | SET "setPropertiesClause" )
     modifyConstraintClause =  "modifyUkPkClause" | "modifyFkClause" |
          "modifyCheckConstraintClause"
     modifySCOClause =  "modifyIndexClause" | "modifyIndexPartitionClause" |
          "modifyIndexPartitionKeyClause" | "modifyPartitionClause" |
          "modifyPartitionKeyClause" |
          "modifyaddMaterializedViewSCOandDependentClauseClause" |
          "modifySubPartitionClause" | "modifySubPartitionKeyClause" |
          "modifyIndexColumnClause" | "modifyAttributeSetClause"
     modifyDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" (
          "renameClause" [ SET "setPropertiesClause" ] | SET
          "setPropertiesClause" )
     deleteColumnClause =  COLUMN "QUOTED_STRING"
     deleteConstraintClause =  UNIQUE_KEY "QUOTED_STRING" | PRIMARY_KEY
          "QUOTED_STRING" | FOREIGN_KEY "QUOTED_STRING" | CHECK_CONSTRAINT
          "QUOTED_STRING"
     deleteSCOClause =  INDEX "QUOTED_STRING" | PARTITION "QUOTED_STRING" |
          PARTITION_KEY "QUOTED_STRING" | TEMPLATE_SUBPARTITION "QUOTED_STRING"
          | SUBPARTITION_KEY "QUOTED_STRING" | INDEX_COLUMN "QUOTED_STRING" OF
          INDEX "QUOTED_STRING" | INDEX_PARTITION "QUOTED_STRING" OF INDEX
          "QUOTED_STRING" | INDEX_PARTITION_KEY "QUOTED_STRING" OF INDEX
          "QUOTED_STRING" | SUBPARTITION "QUOTED_STRING" OF PARTITION
          "QUOTED_STRING" | ATTRIBUTE_SET "QUOTED_STRING"
     deleteDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addUkPkClause =  ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ SET
          "setUkPkPropertiesAndReferencesColumnsClauses" ]
     addFkClause =  FOREIGN_KEY "QUOTED_STRING" [ SET "setFkSubClauses" ]
     addCheckConstraintClause =  CHECK_CONSTRAINT "QUOTED_STRING" [ SET
          "setPropertiesClause" ]
     addIndexClause =  INDEX "QUOTED_STRING" [ SET
          "setSCOConfigurationPropertiesClauses" ]
     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"
     moveToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     modifyUkPkClause =  ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" (
          "renameClause" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ]
          | SET "setUkPkPropertiesAndReferencesColumnsClauses" )
     modifyFkClause =  FOREIGN_KEY "QUOTED_STRING" ( "renameClause" [ SET
          "setFkSubClauses" ] | SET "setFkSubClauses" )
     modifyCheckConstraintClause =  CHECK_CONSTRAINT "QUOTED_STRING" (
          "renameClause" [ SET "setPropertiesClause" ] | SET
          "setPropertiesClause" )
     modifyIndexClause =  INDEX "QUOTED_STRING" ( "renameSCOConfigurationClause"
           [ SET "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyIndexPartitionClause =  INDEX_PARTITION "QUOTED_STRING" OF INDEX
          "QUOTED_STRING" ( "renameSCOConfigurationClause" [
          "moveToClauseIndexPartition" ] [ SET
          "setSCOConfigurationPropertiesClauses" ] |
          "moveToClauseIndexPartition" [ SET
          "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyIndexPartitionKeyClause =  INDEX_PARTITION_KEY "QUOTED_STRING" OF
          INDEX "QUOTED_STRING" ( SET "setSCOConfigurationPropertiesClauses" )
     modifyPartitionClause =  PARTITION "QUOTED_STRING" (
          "renameSCOConfigurationClause" [ "moveToClausePartition" ] [ SET
          "setSCOConfigurationPropertiesClauses" ] | "moveToClausePartition" [
          SET "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyPartitionKeyClause =  PARTITION_KEY "QUOTED_STRING" (
          "renameSCOConfigurationClause" [ SET
          "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyaddMaterializedViewSCOandDependentClauseClause =
          TEMPLATE_SUBPARTITION "QUOTED_STRING" ( "renameSCOConfigurationClause"
           [ "moveToClauseTemplateSubPartition" ] [ SET
          "setSCOConfigurationPropertiesClauses" ] |
          "moveToClauseTemplateSubPartition" [ SET
          "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifySubPartitionClause =  SUBPARTITION "QUOTED_STRING" OF PARTITION
          "QUOTED_STRING" ( "renameSCOConfigurationClause" [
          "moveToClauseSubPartition" ] [ SET
          "setSCOConfigurationPropertiesClauses" ] | "moveToClauseSubPartition"
          [ SET "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifySubPartitionKeyClause =  SUBPARTITION_KEY "QUOTED_STRING" (
          "renameSCOConfigurationClause" [ SET
          "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyIndexColumnClause =  INDEX_COLUMN "QUOTED_STRING" OF INDEX
          "QUOTED_STRING" ( "renameSCOConfigurationClause" [
          "moveToClauseForIndexColumn" ] [ SET
          "setSCOConfigurationPropertiesClauses" ] |
          "moveToClauseForIndexColumn" [ SET
          "setSCOConfigurationPropertiesClauses" ] | SET
          "setSCOConfigurationPropertiesClauses" )
     modifyAttributeSetClause =  ATTRIBUTE_SET "QUOTED_STRING" ( "renameClause"
          [ SET "setAttributeSetSubClauses" ] | SET "setAttributeSetSubClauses"
          )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     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"
     moveToClauseIndexPartition =  MOVE TO POSITION "INTEGER_LITERAL"
     moveToClausePartition =  MOVE TO POSITION "INTEGER_LITERAL"
     moveToClauseTemplateSubPartition =  MOVE TO POSITION "INTEGER_LITERAL"
     moveToClauseSubPartition =  MOVE TO POSITION "INTEGER_LITERAL"
     moveToClauseForIndexColumn =  MOVE TO POSITION "INTEGER_LITERAL"
     setAttributeSetSubClauses =  "setPropertiesClause" [ SET
          "attributeSetAttributesClause" ] | "attributeSetAttributesClause"
     constraintColumnReferencesClause =  COLUMNS "(" "quotedNameList" ")"
     setFkReferencesClauses =  "constraintColumnReferencesClause" [ SET ( REF |
          REFERENCE ) "constraintUkReferencesClause" ] |
          "constraintUkReferencesClause" [ SET ( REF | REFERENCE )
          "constraintColumnReferencesClause" ]
     attributeSetAttributesClause =  ATTRIBUTES "(" "quotedNameList" ")"
     quotedNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     constraintUkReferencesClause =  ( UNIQUE_KEY | PRIMARY_KEY )
          "QUOTED_STRING" [ OF ( TABLE | VIEW ) "QUOTED_STRING" ]

Parameters

alterTableCommand

This clause alters a table.

QUOTED_STRING

name of the table.

renameClause

renames a table with a different name.

alterTableSCOClauses

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

setPropertiesClause

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

getPropertiesClause

Basic properties for TABLE:

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

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

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.

addColumnClauseForAlter

This clause adds a column at a particular position.

When you alter a table and add columns to it, the position you specify for a new column must be less than or equal to the number of columns added up to that point in the OMBALTER command.

For example, a table TEMP_TAB contains three columns. You use the following

OMBALTER TABLE command to add three more columns:

OMBALTER TABLE 'TEMP_TAB' \

ADD COLUMN 'C4' AT POSITION 4 \

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

ADD COLUMN 'C5' AT POSITION 6 \

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

ADD COLUMN 'C6' AT POSITION 5 \

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

This command does not execute successfully because at the point when you specify the position of the column C5 as 6, the table is contains only 5 columns.

QUOTED_STRING

The column name.

addConstraintClause

Adds primary and unique key, and add check constraints.

addSCOClause

This clause will add SCOs.

addDataRuleUsageClause

Add a data rule usage to the relation.

modifyColumnClause

This clause renames, set properties, and move columns.

modifyConstraintClause

This clause modifies keys and check constraints

modifySCOClause

This clause will modify SCOs.

modifyDataRuleUsageClause

Rename or modify the properties of a data rule usage.

deleteColumnClause

This clause deletes a column.

deleteConstraintClause

This clause deletes a key or check constraint.

deleteSCOClause

This clause deletes a SCO(Second Class Object).

QUOTED_STRING

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

deleteDataRuleUsageClause

Delete a data rule usage.

propertyNameList

The list of properties.

propertyValueList

The list of 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.

addCheckConstraintClause

add a check constraint.

QUOTED_STRING

Name of the CheckConstraint.

addIndexClause

This clause adds an index.

QUOTED_STRING

Name of the index.

addPartitionClause

This clause adds a partition.

QUOTED_STRING

Name of the partition.

addPartitionKeyClause

This clause adds a partition key.

QUOTED_STRING

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

addIndexColumnClause

This clause will add 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.

moveToClause

This clause will move the column to given position.

modifyUkPkClause

This clause modifies a unique or primary key.

modifyFkClause

This clause modifies the foreign key.

modifyCheckConstraintClause

This clause modifies the check constraint.

modifyIndexClause

This clause modifies the Index.

QUOTED_STRING

Name of the index.

modifyPartitionClause

This clause modifies a partition.

QUOTED_STRING

Name of the partition.

modifyPartitionKeyClause

This clause modifies a partition key.

QUOTED_STRING

Name of the partition key.

modifyIndexColumnClause

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

modifyAttributeSetClause

This clause modifies an attribute set.

propertyValue

This clause adds the property values.

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.

setAttributeSetSubClauses

This clause is used to set up an attribute set.

constraintColumnReferencesClause

This clause provides names of all columns.

setFkReferencesClauses

This clause sets foreign key references.

attributeSetAttributesClause

This clause is used to specify attributes belonging to an attribute set.

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.

TABLE Object

Table 4-54 TABLE Object

Property
Type
Choices
Min
Max
Default
Description

ANALYZE_TABLE_ESTIMATE_PERCENT

STRING

none

none

none

empty string

Value represents the sample size as a percentage (0-100) of total rows. When set to a nonzero value, Builder generates a DDL script to analyze the table. The default is 99.

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.

CACHE_MODE

STRING

, CACHE, NOCACHE

none

none

empty string

Indicate how Oracle should store blocks in the buffer cache.

CDC_POSITION

NUMBER

none

none

none

0

Table position in change data capture.

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

false

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

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string

Use the Tablespace parameter to specify the name of tablespace.

ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string

Use the error table name to specify the name of Error Table.

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.

GENERATE_ERROR_TABLE_ONLY

BOOLEAN

true, false

none

none

false

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

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.

IS_CDC

BOOLEAN

true, false

none

none

false

Enable table for change data capture

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.

MONITORING_MODE

STRING

, MONITORING, NOMONITORING

none

none

empty string

Specify MONITORING if you want modification statistics to be collected on this table.

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.

OVERFLOW

STRING

none

none

none

empty string

Enter a comma separated list of tablespaces for overflow data. For simple-partitoned object, it is used for HASH BY QUANTITY partition overflow tablespaces. The number of tablespaces does not have to equal the number of partitions. If the number of partitions is greater than the number of tablespaces, then Oracle cycles through the names of the 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 simple-partitoned object, it is used for HASH BY QUANTITY partition tablespaces. For composite-partitioned tables, it is used for subpartition template to store a list of tablespaces.

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.

ROWDEPENDENCIES_MODE

STRING

, NOROWDEPENDENCIES, ROWDEPENDENCIES

none

none

empty string

Specify ROWDEPENDENCIES to use row-level dependency tracking.

ROW_MOVEMENT

STRING

, DISABLE, ENABLE

none

none

empty string

Specify whether Oracle can move a table row.

TABLESPACE

STRING(30)

none

none

none

empty string

COLUMN Object

Table 4-55 COLUMN Object

Property
Type
Choices
Min
Max
Default
Description

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

PRIMARY_KEY Object

Table 4-56 PRIMARY_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

STREAMS_ADMINISTRATOR_LOCATION

STRING

none

none

none

empty string

The location corresponding to the Streams Administrator

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

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.

UNIQUE_KEY Object

Table 4-57 UNIQUE_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 4-58 FOREIGN_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 4-59 CHECK_CONSTRAINT Object

Property
Type
Choices
Min
Max
Default
Description

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.

PARTITION Object

Table 4-60 PARTITION Object

Property
Type
Choices
Min
Max
Default
Description

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

INDEX Object

Table 4-61 INDEX Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER

OMBCREATE TABLE

OMBDROP TABLE

OMBRETRIEVE TABLE

OMBALTER TABLE_FUNCTION

Purpose

Alter the Table Function by renaming it, and/or reset its properties, and/or resetting its Ordered/Partitioned fields, and/or adding Parameters.

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 in corresponding Package.

Syntax

alterFunctionCommand =  OMBALTER ( FUNCTION "QUOTED_STRING" (
          "renameClause" [ "alterPropertiesOrIconSetClause" ] [
          "alterFuncProcParameterImplementationSCOClause" ] |
          "alterPropertiesOrIconSetClause" [
          "alterFuncProcParameterImplementationSCOClause" ] |
          "alterFuncProcParameterImplementationSCOClause" |
          "alterFunctionCodeTemplateClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" | UNSET "unsetReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) | UNSET "unsetReferenceIconSetClause"
     alterFuncProcParameterImplementationSCOClause =  ( ADD (
          "alterFuncProcParameterClause" | "addRelationalDependentClause" |
          "addFuncImplementationClause" ) | MODIFY (
          "modifyFuncProcParameterClause" | "modifyFuncProcImplementationClause"
           ) | DELETE ( "deleteFuncProcParameterClause" |
          "deleteRelationalDependentClause" |
          "deleteFuncProcImplementationClause" ) ) [
          "alterFuncProcParameterImplementationSCOClause" ]
     alterFunctionCodeTemplateClause =  SET "setFunctionCodeTemplateClause" |
          UNSET "unsetFunctionCodeTemplateClause"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     alterFuncProcParameterClause =  PARAMETER "QUOTED_STRING" [ AT POSITION
          "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     addRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
          "QUOTED_STRING"
     addFuncImplementationClause =  FUNCTION_IMPLEMENTATION "QUOTED_STRING" [
          SET "setFuncImplPropertiesClause" ]
     modifyFuncProcParameterClause =  ( PARAMETER "QUOTED_STRING" (
          "renameClause" | "moveToClause" | [ SET "setPropertiesClause" ] ) )
     modifyFuncProcImplementationClause =  ( FUNCTION_IMPLEMENTATION
          "QUOTED_STRING" ( "renameClause" [ SET "setFuncImplPropertiesClause" ]
           | [ SET "setFuncImplPropertiesClause" ] ) )
     deleteFuncProcParameterClause =  ( PARAMETER "QUOTED_STRING" )
     deleteRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
          "QUOTED_STRING"
     deleteFuncProcImplementationClause =  ( FUNCTION_IMPLEMENTATION
          "QUOTED_STRING" )
     setFunctionCodeTemplateClause =  ( REFERENCE | REF ) CODE_TEMPLATE
          "QUOTED_STRING" FOR PLATFORM "QUOTED_STRING" | ( ( REFERENCE | REF )
          CODE_TEMPLATE FOR PLATFORM "QUOTED_STRING" OPTIONS "("
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")" )
     unsetFunctionCodeTemplateClause =  ( REFERENCE | REF ) CODE_TEMPLATES | (
          REFERENCE | REF ) CODE_TEMPLATE FOR PLATFORM "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setFuncImplPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES
           "(" "propertyValueList" ")"
     moveToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterFunctionCommand

Alters a Table Function

renameClause

Rename a Table Function

alterPropertiesOrIconSetClause

Alter table function properties or icon set.

alterFuncProcParameterImplementationSCOClause

Used to alter, modify or delete table function parameter, implementation or dependency.

setPropertiesClause

Associate a set of properties with a Table Function.

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

Used to set reference icon set to table function.

unsetReferenceIconSetClause

Used to unset reference icon set to table function.

alterFuncProcParameterClause

Alter the parameters of a table function, including adding, dropping parameters, changing their direction, datatype and default values.

addRelationalDependentClause

This clause adds referential dependencies to other relational objects.

addFuncImplementationClause

Used to add implementation to table function.

modifyFuncProcParameterClause

Modify one or more Parameters to this Function/Procedure.

modifyFuncProcImplementationClause

Used to modify table function implementation.

deleteFuncProcParameterClause

Delete one or more Parameters to this Function/Procedure.

deleteRelationalDependentClause

This clause deletes referential dependencies to other relational objects.

deleteFuncProcImplementationClause

Used to delete a table function implementation.

propertyNameList

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

propertyValueList

Comma separated list of property values.

setFuncImplPropertiesClause

Used to set table function implementation properties.

moveToClause

Move a Parameters of this Function/Procedure.

propertyValue

Value of a property.

TABLE_FUNCTION Object

Table 4-62 TABLE_FUNCTION Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER

OMBCREATE TABLE_FUNCTION

OMBDROP TABLE_FUNCTION

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

HIERLOADLEVEL

STRING

none

none

none

empty string

See Also

OMBCREATE TIME_DIMENSION

OMBDROP TIME_DIMENSION

OMBRETRIEVE TIME_DIMENSION

OMBALTER TRANSPORTABLE_MODULE

Purpose

To alter the definision of a transportable module.

Prerequisites

In the context of a project.

Syntax

alterTMCommand =  OMBALTER TRANSPORTABLE_MODULE "QUOTED_STRING" (
          "alterTMClause" { "alterTMClause" } )
     alterTMClause =  "renameClause" | "setPropertiesAndLocationsAndIconSet" |
          "unsetReferenceIconSetClause" | "modifyClause"
     renameClause =  RENAME TO "QUOTED_STRING"
     setPropertiesAndLocationsAndIconSet =  SET ( "setPropertiesClause" |
          "setSourceLocationClause" | "setTargetLocationClause" |
          "setReferenceIconSetClause" )
     unsetReferenceIconSetClause =  UNSET ( REF | REFERENCE ) ICONSET
     modifyClause =  MODIFY ( "modifyTablespaceClause" | "modifyDatafileClause"
          | "modifySchemaClause" )
     setPropertiesClause =  ( PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")" )
     setSourceLocationClause =  SOURCE_LOCATION "QUOTED_STRING"
     setTargetLocationClause =  TARGET_LOCATION "QUOTED_STRING"
     setReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET "QUOTED_STRING"
     modifyTablespaceClause =  TRANSPORTABLE_MODULE_TABLESPACE "QUOTED_STRING"
     modifyDatafileClause =  DATAFILE "QUOTED_STRING"
     modifySchemaClause =  TRANSPORTABLE_MODULE_SCHEMA "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterTMCommand

This command is for altering a transportable module.

QUOTED_STRING

The name of the transportable module to be altered.

alterTMClause

Multiple altering actions can be specified with one OMBALTER TRANSPORTABLE_MODULE command.

renameClause

Change the name of the transportable module

QUOTED_STRING

The new name for the transportable module.

setPropertiesAndLocationsAndIconSet

Set properties for the transportable module, and/or specify source and target locations, and/or specify icon set for the newly create transportable module.

unsetReferenceIconSetClause

Remove the reference to the icon set.

modifyClause

Change contents within a transportable module.

setPropertiesClause

Set properties for the transportable module.

setPropertiesClause

Basic properties for TRANSPORTABLE_MODULE:

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

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

setSourceLocationClause

Specify the source location name.

QUOTED_STRING

The name of an already created transportable module source location.

setTargetLocationClause

Specify the target location name.

QUOTED_STRING

The name of an already created transportable module target location.

setReferenceIconSetClause

Set the icon set for the new transportable module.

QUOTED_STRING

The name of the icon set.

modifyTablespaceClause

Modify a tablespace within a transportable module.

QUOTED_STRING

The tablespace name. Note that the tablespace name is its name in the source database.

modifyDatafileClause

Modify a datafile within a transportable module.

QUOTED_STRING

The name of the datafile. Note that the datafile name is its full path name in the source database. The name must be exactly same with what is in DBA_DATA_FILES view in the source database.

modifySchemaClause

Modify a schema within a transportable module.

QUOTED_STRING

The name of the schema. Note that the schema name is its name in the source database.

propertyNameList

The list of unquoted property names.

propertyValueList

The list of property values.

propertyValue

A property value can be a single-quoted string, an integer, or a floating point number.

TRANSPORTABLE_MODULE Object

Table 4-65 TRANSPORTABLE_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

TARGET_OS_TYPE

STRING

Linux, Unix, Windows

none

none

Unix

The operating system type of the target machine. This is needed for generating shell scripts in correct style required by the OS.

TRANSPORT_TABLESPACE

BOOLEAN

true, false

none

none

true

Specifies whether transportable tablespace (TTS) feature is to be used for deploying tables in the transportable module. If set to true, tablespaces are copied from source to target using the server TTS mechanism. If set to false, tables are individually extracted and deployed using Oracle Data Pump available in Oracle10g or later; but tablespaces are not transported. Since Oracle Data Pump is new in Oracle 10g, setting this parameter to false is only allowed if both source and target databases are with Oracle 10g or a higher versions.

WHAT_TO_DEPLOY

STRING

ALL_OBJECTS, TABLES_ONLY

none

none

ALL_OBJECTS

Specifies whether only tables in the transportable module are deployed or everything in it is deployed.

WORK_DIRECTORY

STRING

none

none

none

empty string

The full path of work directory on target machine, where temporary files, logs and tablespace datafiles may be stored. If left unspecified, OWB's runtime home directory is used as the work directory. It is highly recommended that users specify dedicated directory for transportable module deployment.

TRANSPORTABLE_MODULE_TABLESPACE Object

Table 4-66 TRANSPORTABLE_MODULE_TABLESPACE Object

Property
Type
Choices
Min
Max
Default
Description

DROP_EXISTING_TABLESPACE

BOOLEAN

true, false

none

none

false

If this parameter is set to true, existing tablespace in target is dropped and recreated.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

TARGET_TABLESPACE_NAME

STRING

none

none

none

DEFAULT

Tablespace name in the target database. Target tablespace name must be same with source tablespace name prior to Oracle 10.2.

TRANSPORTABLE_MODULE_DATAFILE Object

Table 4-67 TRANSPORTABLE_MODULE_DATAFILE Object

Property
Type
Choices
Min
Max
Default
Description

DIRECTORY

STRING

none

none

none

empty string

FILENAME

STRING

none

none

none

DEFAULT

The name of the new file on target. Please check to see if there is already a file with same name in the same directory. Transportable tablespace deployement may overwrite any existing files.

REUSE

BOOLEAN

true, false

none

none

false

See Also

OMBALTER

OMBCREATE TRANSPORTABLE_MODULE

OMBRETRIEVE TRANSPORTABLE_MODULE

OMBDROP TRANSPORTABLE_MODULE

5 OMBALTER UNQUOTED_STRING to OMBCREATE ADVANCED_QUEUE

OMBALTER UNQUOTED_STRING

OMBALTER USER

OMBALTER VARYING_ARRAY

OMBALTER VIEW

OMBALTER WEB_SERVICE

OMBALTER WEB_SERVICE_PACKAGE

OMBCAC

OMBCC

OMBCDC

OMBCOMMIT

OMBCOMPARE SNAPSHOT

OMBCOMPILE

OMBCONN

OMBCONN CONTROL_CENTER

OMBCONNECT

OMBCONNECT CONTROL_CENTER

OMBCOPY

OMBCREATE

OMBCREATE ACTIVITY_TEMPLATE

OMBCREATE ACTIVITY_TEMPLATE_FOLDER

OMBCREATE ADVANCED_QUEUE

OMBALTER UNQUOTED_STRING

Purpose

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

Prerequisites

Should be in the context of project.

Syntax

parseAlterCommand =  OMBALTER ( "UNQUOTED_STRING" "QUOTED_STRING" (
          "renameClause" [
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule" |
          "addOrRemoveOrModifyModuleReferenceLocationClause" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule =  (
          "alterJournalCodeTemplateClause" [
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] |
          "alterPropertiesOrReferenceClauseForDataMetadataModule" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  (
          "addReferenceLocationClause" | "removeReferenceLocationClause" |
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" |
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     alterJournalCodeTemplateClause =  SET "setJournalCodeTemplateClause" |
          UNSET "unsetJournalCodeTemplateClause"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( (
          "alterPropertiesClause" [ ( SET
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | (
          "setReferenceClauseForDataMetadataModule" [ UNSET
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET
          "unsetReferenceClauseForDataMetadataModule" [ SET
          "setReferenceClauseForDataMetadataModule" ] ) ) [
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     removeReferenceLocationClause =  REMOVE ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     modifyReferenceLocationClause =  MODIFY ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" SET AS DEFAULT
     setJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT "QUOTED_STRING"
          | ( ( REFERENCE | REF ) CDC_CT OPTIONS "(" "propertyValueList" ")"
          VALUES "(" "propertyValueList" ")" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  (
          "unsetReferenceLocationClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] |
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "setJournalCodeTemplateClause" [ SET
          "setReferenceMetadataLocationOrIconSetClause" ] |
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  (
          "unsetJournalCodeTemplateClause" [ UNSET
          "unsetReferenceMetadataLocationOrIconSetClause" ] |
          "unsetReferenceMetadataLocationOrIconSetClause" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setReferenceMetadataLocationOrIconSetClause =  (
          "setReferenceMetadataLocationClause" [ SET "setReferenceIconSetClause"
           ] | "setReferenceIconSetClause" )
     unsetReferenceMetadataLocationOrIconSetClause =  (
          "unsetReferenceMetadataLocationClause" [ UNSET
          "unsetReferenceIconSetClause" ] | "unsetReferenceIconSetClause" )
     setReferenceMetadataLocationClause =  ( REFERENCE | REF ) METADATA_LOCATION
           "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceMetadataLocationClause =  ( REFERENCE | REF )
          METADATA_LOCATION "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

getPropertiesClause

Basic properties for module:

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

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

See Also

OMBCREATE

OMBALTER USER

Purpose

To alter properties of a Warehouse Builder user.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

alterUserCommand =  OMBALTER ( USER "QUOTED_STRING" ( SET
          "setPropertiesClause" ) )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterUserCommand

This clause alters a Warehouse Builder user.

setPropertiesClause

Used to set properties of a Warehouse Builder user. Valid properties are shown below.

getPropertiesClause

Basic properties for USER:

getPropertiesClause

Name: PROMPT_FOR_COMMIT
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: PROMPT_FOR_JOB_NAME
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: PROMPT_FOR_EXECUTION_PARAMS
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_MONITOR
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_DEPLOYMENT_COMPLETION
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_DEPLOYMENT_DEPENDENCIES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_MONITOR_RESULTS
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_MONITOR_LOGFILE
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: PERSONALITY
Type: STRING
Valid Values: Any valid character string in supported character set.
Default:  Default

Name: SHOW_GUIDED_ASSISTANCE
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: HIDE_WIZARD_WELCOME_PAGES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_DELETE_CONFIRMATION
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: RECYCLE_DELETED_OBJECTS
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: EMPTY_RECYCLE_BIN
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: CLEAR_CLIPBOARD
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_GENERATION_PROJECT
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_GENERATION_MODULE
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_GENERATION_LOCATION
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_GENERATION_ACTION
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_GENERATION_TYPE
Type: BOOLEAN
Valid Values: true, false
Default:  true

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

Name: LOG_FILE_NAME
Type: STRING(1000)
Valid Values: Any valid character string in supported character set.
Default:  log

Name: LOG_FILE_MAX_SIZE
Type: STRING
Valid Values: 1-10000000
Default:  100

Name: LOG_ERROR_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: LOG_WARNING_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: LOG_INFORMATION_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: NAMING_MODE
Type: STRING
Valid Values: PHYSICAL_NAMING_MODE, BUSINESS_NAMING_MODE
Default:  PHYSICAL_NAMING_MODE

Name: PROPAGATE_NAME_CHANGES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: DESIGNREPOS_PWD_PERSIST
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: RUNTIMEREPOS_PWD_SHARE
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: DEFAULT_SEC_POLICY
Type: STRING
Valid Values: MINIMUM_SECURITY, MAXIMUM_SECURITY
Default:  MINIMUM_SECURITY

propertyNameList

A list of valid property shown in seciton of Basic properties for USER.

propertyValueList

A list of valid property values shown in seciton of Basic properties for USER.

propertyValue

The valid property value shown in seciton of Basic properties for USER.

See Also

OMBREGISTER USER

OMBUNREGISTER USER

OMBRETRIEVE USER

OMBALTER VARYING_ARRAY

Purpose

Alter the Varying Array by resetting its properties.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

alterVaryingArrayCommand =  OMBALTER ( VARYING_ARRAY "QUOTED_STRING" (
          "renameClause" [ "alterPropertiesOrIconSetClause" ] |
          "alterPropertiesOrIconSetClause" ) )
     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

alterVaryingArrayCommand

Alters a Varying Array of the given name by either renaming it, or by setting it's properties or a combination of these.

renameClause

renames a table with a different name.

alterPropertiesOrIconSetClause

Alters Varying Array properties or icon set.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Varying Array

getPropertiesClause

Basic properties for VARYING_ARRAY:

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

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

Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Base Element of the Varying Array

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.

VARYING_ARRAY Object

Table 5-1 VARYING_ARRAY Object

Property
Type
Choices
Min
Max
Default
Description

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBALTER

OMBCREATE VARYING_ARRAY

OMBDROP VARYING_ARRAY

OMBALTER VIEW

Purpose

To alter properties and definition of a view.

Prerequisites

In the context of an Oracle Module.

Syntax

alterViewCommand =  OMBALTER ( VIEW "QUOTED_STRING" ( "renameClause" [
          "alterPropertiesOrIconSetClause" ] [ "alterViewSCOandDependentClauses"
           ] | "alterPropertiesOrIconSetClause" [
          "alterViewSCOandDependentClauses" ] |
          "alterViewSCOandDependentClauses" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrIconSetClause =  SET ( "setPropertiesClause" [ SET ( REF |
           REFERENCE ) "setReferenceIconSetClause" | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause" ] | ( REF | REFERENCE )
          "setReferenceIconSetClause" ) | UNSET ( REF | REFERENCE )
          "unsetReferenceIconSetClause"
     alterViewSCOandDependentClauses =  ADD ( "addColumnClauseForAlter" [
          "alterViewSCOandDependentClauses" ] | "addViewConstraintClause" {
          "alterViewConstraintClauses" } | "addDataRuleUsageClause" {
          "alterDataRuleUsageClauses" } | "addRelationalDependentClause" [
          "alterViewSCOandDependentClauses" ] ) | MODIFY ( "modifyColumnClause"
          [ "alterViewSCOandDependentClauses" ] | "modifyViewConstraintClause" {
           "alterViewConstraintClauses" } | "modifyDataRuleUsageClause" {
          "alterDataRuleUsageClauses" } ) | DELETE ( "deleteColumnClause" [
          "alterViewSCOandDependentClauses" ] | "deleteViewConstraintClause" {
          "alterViewConstraintClauses" } | "deleteDataRuleUsageClause" {
          "alterDataRuleUsageClauses" } | "deleteRelationalDependentClause" [
          "alterViewSCOandDependentClauses" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ICONSET
     addColumnClauseForAlter =  COLUMN "QUOTED_STRING" [ AT POSITION
          "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     addViewConstraintClause =  "addUkPkClause" | "addFkClause"
     alterViewConstraintClauses =  ADD "addViewConstraintClause" | MODIFY
          "modifyViewConstraintClause" | DELETE "deleteViewConstraintClause"
     addDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" SET REF DATA_RULE
           "QUOTED_STRING" ( GROUP "QUOTED_STRING" SET REF ( TABLE | VIEW |
          MATERIALIZED_VIEW | EXTERNAL_TABLE ) "QUOTED_STRING" ( ATTRIBUTE
          "QUOTED_STRING" SET REF COLUMN "QUOTED_STRING" )+ )+ [ SET
          "setPropertiesClause" ]
     alterDataRuleUsageClauses =  ADD "addDataRuleUsageClause" | MODIFY
          "modifyDataRuleUsageClause" | DELETE "deleteDataRuleUsageClause"
     addRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW ) "QUOTED_STRING"
     modifyColumnClause =  COLUMN "QUOTED_STRING" ( "renameClause" [
          "moveToClause" ] [ SET "setPropertiesClause" ] | "moveToClause" [ SET
          "setPropertiesClause" ] | SET "setPropertiesClause" )
     modifyViewConstraintClause =  "modifyUkPkClause" | "modifyFkClause"
     modifyDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" (
          "renameClause" [ SET "setPropertiesClause" ] | SET
          "setPropertiesClause" )
     deleteColumnClause =  COLUMN "QUOTED_STRING"
     deleteViewConstraintClause =  UNIQUE_KEY "QUOTED_STRING" | PRIMARY_KEY
          "QUOTED_STRING" | FOREIGN_KEY "QUOTED_STRING"
     deleteDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING"
     deleteRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW ) "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addUkPkClause =  ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ SET
          "setUkPkPropertiesAndReferencesColumnsClauses" ]
     addFkClause =  FOREIGN_KEY "QUOTED_STRING" [ SET "setFkSubClauses" ]
     moveToClause =  MOVE TO POSITION "INTEGER_LITERAL"
     modifyUkPkClause =  ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" (
          "renameClause" [ SET "setUkPkPropertiesAndReferencesColumnsClauses" ]
          | SET "setUkPkPropertiesAndReferencesColumnsClauses" )
     modifyFkClause =  FOREIGN_KEY "QUOTED_STRING" ( "renameClause" [ SET
          "setFkSubClauses" ] | SET "setFkSubClauses" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setUkPkPropertiesAndReferencesColumnsClauses =  "setPropertiesClause" [ SET
           ( REF | REFERENCE ) "constraintColumnReferencesClause" ] | ( REF |
          REFERENCE ) "constraintColumnReferencesClause"
     setFkSubClauses =  "setPropertiesClause" [ SET ( REF | REFERENCE )
          "setFkReferencesClauses" ] | ( REF | REFERENCE )
          "setFkReferencesClauses"
     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

alterViewCommand

This clause alters a view.

QUOTED_STRING

name of the view.

renameClause

renames a table with a different name.

alterViewSCOandDependentClauses

This clause alters the view clause.

setPropertiesClause

Used to set properties (core, logical, physical, user-defined) for views and their columns, 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.

addColumnClauseForAlter

This clause adds a column at a particular position.

When you alter a table and add columns to it, the position you specify for a new column must be less than or equal to the number of columns added up to that point in the OMBALTER command.

For example, a table TEMP_TAB contains three columns. You use the following

OMBALTER TABLE command to add three more columns:

OMBALTER TABLE 'TEMP_TAB' \

ADD COLUMN 'C4' AT POSITION 4 \

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

ADD COLUMN 'C5' AT POSITION 6 \

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

ADD COLUMN 'C6' AT POSITION 5 \

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

This command does not execute successfully because at the point when you specify the position of the column C5 as 6, the table is contains only 5 columns.

QUOTED_STRING

The column name.

addViewConstraintClause

This clause adds the view's configuration clause.

alterViewConstraintClauses

This clause alters the view's constraint clause.

addDataRuleUsageClause

Add a data rule usage to the relation.

alterDataRuleUsageClauses

Add, modify, or delete data rule usages.

addRelationalDependentClause

This clause adds referential dependencies to other relational objects.

modifyColumnClause

This clause renames, set properties, and move columns.

modifyViewConstraintClause

This clause modifies the view's constraint clause.

modifyDataRuleUsageClause

Rename or modify the properties of a data rule usage.

deleteColumnClause

This clause deletes a column.

deleteViewConstraintClause

This clause deletes the view's constraint.

deleteDataRuleUsageClause

Delete a data rule usage.

deleteRelationalDependentClause

This clause deletes referential dependencies to other relational objects.

propertyNameList

The list of properties.

propertyValueList

The list of 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.

moveToClause

This clause will move the column to given position.

modifyUkPkClause

This clause modifies a unique or primary key.

modifyFkClause

This clause modifies the foreign key.

propertyValue

This clause adds the property values.

setUkPkPropertiesAndReferencesColumnsClauses

This clause adds properties and references to columns.

setFkSubClauses

This clause sets references to a foreign key.

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.

VIEW Object

Table 5-2 VIEW Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

false

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

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string

Use the Tablespace parameter to specify the name of tablespace.

ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string

Use the error table name to specify the name of Error Table.

GENERATE_ERROR_TABLE_ONLY

BOOLEAN

true, false

none

none

false

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

COLUMN Object

Table 5-3 COLUMN Object

Property
Type
Choices
Min
Max
Default
Description

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 5-4 UNIQUE_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 5-5 FOREIGN_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER

OMBCREATE VIEW

OMBDROP VIEW

OMBRETRIEVE VIEW

OMBALTER WEB_SERVICE

Purpose

Alter the Web Service by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of a Web Service Package or an Application Server Module, public web service should be in the context of a public Application Service Module.

Syntax

alterWebServiceCommand =  OMBALTER WEB_SERVICE "QUOTED_STRING" (
          "renameClause" | "alterPropertiesClause" | ( SET ( REF | REFERENCE )
          "setReferencedObjectClauses" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesClause =  SET "setPropertiesClause"
     setReferencedObjectClauses =  ( MAPPING | PROCESS_FLOW | TRANSFORMATION |
          DATA_AUDITOR | TABLE | MODULE ) "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

alterWebServiceCommand

Alter the content of the web service.

renameClause

Rename the web service.

alterPropertiesClause

Used to set properties (core, user-defined) for Web service.

setReferencedObjectClauses

Set the reference object for the non-public web service. Valid object types including: MAPPING, PROCESS_FLOW, TRANSFORMATION, DATA_AUDITOR, TABLE (tables for change data capture) and MODULE (native modules for change data capture).

setPropertiesClause

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

getPropertiesClause

Base properties for WEB_SERVICE:
Basic properties for Web Service:

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

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

Name: WSDLURL
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
WSDL url of the public Web Service :

Name: SPEC
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
SPECIFICATION of the Web Service :

propertyNameList

A list of property names.

propertyValueList

A list of property values.

propertyValue

The property value of the object.

WEB_SERVICE Object

Table 5-6 WEB_SERVICE Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

The Web service is deployable or not

See Also

OMBALTER

OMBCREATE WEB_SERVICE

OMBRETRIEVE WEB_SERVICE

OMBDROP WEB_SERVICE

OMBALTER WEB_SERVICE_PACKAGE

Purpose

Alter the Web Service Package by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of a Application Server Module.

Syntax

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

Parameters

alterWebServicePackageCommand

Alter the content of the web service package.

renameClause

Rename the web service package.

alterPropertiesClause

Used to set properties for Web service package.

setPropertiesClause

Used to set properties for Web service package. Valid properties are shown below.

getPropertiesClause

Basic properties for WEB_SERVICE_PACKAGE:

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

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

propertyNameList

A list of property names.

propertyValueList

A list of property values.

propertyValue

The property value of the object.

WEB_SERVICE_PACKAGE Object

Table 5-7 WEB_SERVICE_PACKAGE Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

The Web service package is deployable or not

See Also

OMBALTER

OMBCREATE WEB_SERVICE_PACKAGE

OMBRETRIEVE WEB_SERVICE_PACKAGE

OMBDROP WEB_SERVICE_PACKAGE

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

OMBCC

Purpose

Change Context command allows users to change the current context to the desired location in OWB tree. The target context can be specified either as an absolute path starting from the root ('/') or as a relative path starting from the current context. Also, the path can contain '..', which allows to navigate "up" to the parent context.

Prerequisites

Must be connected to a OWB workspace of the repository.

Syntax

parseChangeContextCommand =  OMBCC "QUOTED_STRING"

Parameters

parseChangeContextCommand

Specify change context command.

QUOTED_STRING

The target context to switch to.

See Also

OMBDCC

OMBCDC

Purpose

To execute Change Data Capture services on a module or a table.

Prerequisites

The module or table must be properly set up for change data capture. In addition, default agent must be configured with password and the module location must be registered.

Syntax

executeCDCCommand =  OMBCDC ( ( ORACLE_MODULE | MODULE | TABLE )
          "QUOTED_STRING" ( START_CDC | DROP_CDC | EXTEND_WINDOW | ( SUBSCRIBE
          "QUOTED_STRING" ) | ( UNSUBSCRIBE "QUOTED_STRING" ) | (
          LOCK_SUBSCRIBER "QUOTED_STRING" ) | ( UNLOCK_SUBSCRIBER
          "QUOTED_STRING" ) | GET_SUBSCRIBERS | PURGE_CDC ) )

Parameters

executeCDCCommand

Executes a change data capture command.

ORACLE_MODULE

Oracle module containing the tables being captured.

MODULE

Module containing the tables that are being captured.

TABLE

Table being captured. This should not be used by consistent cdc.

START_CDC

Start the cdc. This will create the cdc objects.

EXTEND_WINDOW

Extend the data window to allow access to the current changed data.

SUBSCRIBE

Add subscribers to the cdc.

UNSUBSCRIBE

Remove subscribers from the cdc.

LOCK_SUBSCRIBER

Lock the subscriber so that the subscriber has repeated access to consistent data.

UNLOCK_SUBSCRIBER

Unlock the subsciber.

GET_SUBSCRIBERS

Get the currenct subscribers from the cdc. This command does not go through the agent, so the repository must have direct access to the cdc objects for this to work.

PURGE_CDC

Purge the cdc tables.

OMBCOMMIT

Purpose

Perform commit action on the repository.

Prerequisites

Must be connected to a OWB workspace of the repository.

Syntax

parseCommitCommand =  OMBCOMMIT

Parameters

parseCommitCommand

Specify commit command.

See Also

OMBROLLBACK

OMBCOMPARE SNAPSHOT

Purpose

Change management is a key piece of metadata management. This comand provides comparison services of any complex object model in the workspace. This command writes the diff between snapshot/component to XML file.

Prerequisites

Snapshots can be compared from any context and either with another snapshot or the current workspace objects.

Syntax

parseCompareCommand =  OMBCOMPARE "compareSnapshotCommand"
     compareSnapshotCommand =  ( ( SNAPSHOT "QUOTED_STRING" ) WITH
          "getCompareWith" OUTPUT TO "QUOTED_STRING" WRITE ( ALL |
          FOUND_IN_TARGET | FOUND_IN_SOURCE | UPDATED | CHANGED | UNCHANGED ) )
     getCompareWith =  SNAPSHOT "QUOTED_STRING" [ FOR ( "UNQUOTED_STRING"
          "QUOTED_STRING" ) ] | ( CURRENT FOR ( "UNQUOTED_STRING"
          "QUOTED_STRING" ) )

Parameters

parseCompareCommand

Root production of OMBCOMPARE SNAPSHOT.

compareSnapshotCommand

To compare components of snapshots.

QUOTED_STRING

Name of source snapshot which needs to be compared with the target snapshot.

OUTPUT

Specifies output filename where the XML comparison result will written.

WRITE

Specifies filter clause which will make the diff engine only write specified objects of a certain diff state.

getCompareWith

Target of the comparison.

SNAPSHOT

Target snapshot which will be compared with the source snapshot.

FOR

Specifies component which exists in the current workspace.

CURRENT

Indicates current component's definition as the target of compare action.

See Also

OMBCREATE SNAPSHOT

OMBALTER SNAPSHOT

OMBDROP SNAPSHOT

OMBRESTORE SNAPSHOT

OMBLIST SNAPSHOT

OMBRETRIEVE SNAPSHOT

OMBCOMPILE

Purpose

This command compiles an repository object. The results are generated in a file in a user defined directory.

Prerequisites

In the context of a Oracle Module.

Syntax

parseCompileCommand =  OMBCOMPILE ( ( EXPERT | EXPERT_MODULE | CT |
          CT_FOLDER | TABLE | VIEW | SEQUENCE | MATERIALIZED_VIEW | DIMENSION |
          CUBE | DATA_AUDITOR | MAPPING | REAL_TIME_MAPPING |
          TRANSPORTABLE_MODULE | BUSINESS_DEFINITION_MODULE |
          OBIEE_BUSINESS_DEFINITION_MODULE | EXTERNAL_TABLE | OBJECT_TYPE |
          NESTED_TABLE | VARYING_ARRAY | COLLECTION | CONNECTOR |
          ALTERNATIVE_SORT_ORDER | LIST_OF_VALUES | DRILL_TO_DETAIL |
          BUSINESS_AREA | CATALOG_FOLDER | DRILL_PATH | ITEM_FOLDER |
          LOGICAL_TABLE | REGISTERED_FUNCTION | PACKAGE | FUNCTION | PROCEDURE |
           TABLE_FUNCTION | PLSQL_RECORD_TYPE | PLSQL_TABLE_TYPE |
          PLSQL_REF_CURSOR_TYPE | ADVANCED_QUEUE | QUEUE_TABLE |
          QUEUE_PROPAGATION | PROCESS_FLOW_PACKAGE | PROCESS_FLOW_MODULE |
          CALENDAR | CALENDAR_MODULE | FOLDER | WEB_SERVICE |
          APPLICATION_SERVER_MODULE | WEB_SERVICE_PACKAGE ) "QUOTED_STRING" [
          "getOutputValidationResults" ] [ "getOutputGeneratedScripts" ] [
          "getReadableOutputGeneratedScripts" ] )
     getOutputValidationResults =  OUTPUT [ VALIDATION_RESULT ] TO (
          "QUOTED_STRING" | ( FILE "QUOTED_STRING" ) ) WRITE ( ( "(" ( ( SUCCESS
           | WARNING | ERROR ) [ "," ] )+ ")" ) | ALL | SUCCESS | WARNING |
          ERROR )
     getOutputGeneratedScripts =  OUTPUT GENERATION_SCRIPTS TO ( "QUOTED_STRING"
           | ( FILE "QUOTED_STRING" ) )
     getReadableOutputGeneratedScripts =  OUTPUT READABLE GENERATION_SCRIPTS TO
          "QUOTED_STRING"

Parameters

parseCompileCommand

This command compiles a repository object.

QUOTED_STRING

The name of the object.

getOutputValidationResults

This clause outputs the validation results to one or more files in the specified folder.

QUOTED_STRING

A file or directory where validation results are stored.

getOutputGeneratedScripts

This clause outputs the generated scripts for an object to one or more files in specified folder.

QUOTED_STRING

A file or directory where generated scripts are stored.

getReadableOutputGeneratedScripts

This clause outputs all the readable scripts contained in the generated file (such as an EAR file) for an object to one or more files in specified folder.

QUOTED_STRING

A file or directory where generated scripts are stored.

See Also

OMBVALIDATE

OMBCONN

Purpose

To connect to a OWB workspace.

Prerequisites

Must not be connected to another OWB workspace. If connected to another workspace, use OMBDISCONNECT to disconnect first.

Syntax

parseConnectCommand =  ( ( OMBCONNECT | OMBCONN ) "UNQUOTED_STRING" [ USE (
           REPOSITORY | REPOS | WORKSPACE ) "QUOTED_STRING" ] [ USE (
          SINGLE_USER_MODE | MULTIPLE_USER_MODE ) ] )

Parameters

parseConnectCommand

Specify connect command.

UNQUOTED_STRING

Specify the connection string to the database, in the format: username/password@host:port:service name

QUOTED_STRING

Optionally, specify the name of a workspace to work on. If not provided, the default workspace will be used.

SINGLE_USER_MODE

If specified, the user will use the workspace exclusively.

MULTIPLE_USER_MODE

If specified, more than one session can work on the same workspace at the same time. This is the default mode.

See Also

OMBDISCONNECT

OMBCONN CONTROL_CENTER

Purpose

To connect to a Control Center.

This command can either be used when you are already connected to a workspace on the Design Repository or it can be used independently of a workspace on the Design Repository.

With Design Repository connection:

This command will connect you to the Control Center that is associated with the current Active Configuration.

If this is the DEFAULT_CONTROL_CENTER and it does not have a user and password specified, then you will be connected to the Control Center as the currently connected Design Repository User. This is the typical out-of-the-box scenario. If the DEFAULT_CONTROL_CENTER has a user specified then you will be connected as that user. Note in this case you may have to provide a password.

If this is not the DEFAULT_CONTROL_CENTER, then you will either connect as the user specified against the Control Center or you will have to provide a user with this command. Note that in this situation you will probably have to supply a password.

Without Design Repository connection:

This command can be used to connect to a Control Center independently of a workspace on Design Repository. For example, you may want to OMBDEPLOY a deployment specification that had been previously deployed to the file system or OMBSTART a job. In this case you will have to provide the complete connection details.

Prerequisites

With Design Repository connection:

A Design Repository connection, at least a PROJECT context and the Active Configuration's Selected CONTROL_CENTER must be defined.

Without Design Repository connection:

There must not be a Design Repository connection whenever this method is used.

Syntax

parseConnectRuntimeCommand =  ( ( OMBCONNECT | OMBCONN ) CONTROL_CENTER [ (
           USE "QUOTED_STRING" ) | ( "UNQUOTED_STRING" USE ( REPOSITORY | REPOS
          | WORKSPACE ) "QUOTED_STRING" ) ] )

Parameters

parseConnectRuntimeCommand

Specify Control Center connect command.

QUOTED_STRING

Specific Control Center:

OMBCONNECT CONTROL_CENTER USE 'scott/tiger'

OMBCONNECT CONTROL_CENTER

Control Center Only:

OMBCONNECT CONTROL_CENTER RepositoryUserName/RepositoryUserPassword@HostName:PortNumber:OracleServiceName' USE REPOSITORY 'RepositorySchema'

See Also

OMBDISCONNECT CONTROL_CENTER

OMBCONNECT

Purpose

To connect to a OWB workspace.

Prerequisites

Must not be connected to another OWB workspace. If connected to another workspace, use OMBDISCONNECT to disconnect first.

Syntax

parseConnectCommand =  ( ( OMBCONNECT | OMBCONN ) "UNQUOTED_STRING" [ USE (
           REPOSITORY | REPOS | WORKSPACE ) "QUOTED_STRING" ] [ USE (
          SINGLE_USER_MODE | MULTIPLE_USER_MODE ) ] )

Parameters

parseConnectCommand

Specify connect command.

UNQUOTED_STRING

Specify the connection string to the database, in the format: username/password@host:port:service name

QUOTED_STRING

Optionally, specify the name of a workspace to work on. If not provided, the default workspace will be used.

SINGLE_USER_MODE

If specified, the user will use the workspace exclusively.

MULTIPLE_USER_MODE

If specified, more than one session can work on the same workspace at the same time. This is the default mode.

See Also

OMBDISCONNECT

OMBCONNECT CONTROL_CENTER

Purpose

To connect to a Control Center.

This command can either be used when you are already connected to a workspace on the Design Repository or it can be used independently of a workspace on the Design Repository.

With Design Repository connection:

This command will connect you to the Control Center that is associated with the current Active Configuration.

If this is the DEFAULT_CONTROL_CENTER and it does not have a user and password specified, then you will be connected to the Control Center as the currently connected Design Repository User. This is the typical out-of-the-box scenario. If the DEFAULT_CONTROL_CENTER has a user specified then you will be connected as that user. Note in this case you may have to provide a password.

If this is not the DEFAULT_CONTROL_CENTER, then you will either connect as the user specified against the Control Center or you will have to provide a user with this command. Note that in this situation you will probably have to supply a password.

Without Design Repository connection:

This command can be used to connect to a Control Center independently of a workspace on Design Repository. For example, you may want to OMBDEPLOY a deployment specification that had been previously deployed to the file system or OMBSTART a job. In this case you will have to provide the complete connection details.

Prerequisites

With Design Repository connection:

A Design Repository connection, at least a PROJECT context and the Active Configuration's Selected CONTROL_CENTER must be defined.

Without Design Repository connection:

There must not be a Design Repository connection whenever this method is used.

Syntax

parseConnectRuntimeCommand =  ( ( OMBCONNECT | OMBCONN ) CONTROL_CENTER [ (
           USE "QUOTED_STRING" ) | ( "UNQUOTED_STRING" USE ( REPOSITORY | REPOS
          | WORKSPACE ) "QUOTED_STRING" ) ] )

Parameters

parseConnectRuntimeCommand

Specify Control Center connect command.

QUOTED_STRING

Specific Control Center:

OMBCONNECT CONTROL_CENTER USE 'scott/tiger'

OMBCONNECT CONTROL_CENTER

Control Center Only:

OMBCONNECT CONTROL_CENTER RepositoryUserName/RepositoryUserPassword@HostName:PortNumber:OracleServiceName' USE REPOSITORY 'RepositorySchema'

See Also

OMBDISCONNECT CONTROL_CENTER

OMBCOPY

Purpose

Copy one or more objects of the same object type. The replace option allows you to overwrite.

Prerequisites

Use of relative path specifications requires awareness of the current context.

Syntax

parseCopyCommand =  OMBCOPY "copyObjectType" "QUOTED_STRING" { ( OPERATOR |
           GROUP | ATTRIBUTE ) "QUOTED_STRING" } TO "QUOTED_STRING" { ( OPERATOR
           | GROUP | ATTRIBUTE ) "QUOTED_STRING" } [ USE REPLACE_MODE ]
     copyObjectType =  ( "UNQUOTED_STRING" )

Parameters

parseCopyCommand

Specifies the source object type, source path, and target path for the object to copy. Copying objects is subject to the following restrictions: 1. You cannot copy an entire project. 2. When copying objects between projects, you can only copy objects into the current project; you cannot copy objects out to other projects.

QUOTED_STRING

Source and target path specifications can be absolute or relative. To copy multiple objects, include a regular expression as the final step of the source path. If you are copying multiple objects, the final step of the target path must be the folder to which the objects are being copied. If you are only copying one object, you can specify the object's original name or a new name as the final step of the target path.

REPLACE_MODE

Use this option to overwrite existing target objects.

copyObjectType

The type of the object(s) to be copied. Valid types are: PROJECT, ORACLE_MODULE, FLAT_FILE_MODULE, BUSINESS_DEFINITION_MODULE, OBIEE_BUSINESS_DEFINITION_MODULE, BUSINESS_PRESENTATION_MODULE, SAP_MODULE, CMI_MODULE, PROCESS_FLOW_MODULE, PROCESS_FLOW_PACKAGE, PROCESS_FLOW, EXPERT_MODULE, EXPERT, CT, CT_FOLDER, LOCATION, CONTROL_CENTER, CONFIGURATION, FLAT_FILE, ADVANCED_QUEUE, STREAMS_QUEUE, QUEUE_TABLE, QUEUE_PROPAGATION, STREAMS_CAPTURE_PROCESS, OBJECT_TYPE, VARYING_ARRAY, NESTED_TABLE, TABLE, VIEW, MATERIALIZED_VIEW, SEQUENCE, DIMENSION, CUBE, DATA_AUDITOR, DATA_PROFILE, DATA_RULE, DATA_RULE_MODULE, MAPPING, REAL_TIME_MAPPING, PACKAGE, FUNCTION, TABLE_FUNCTION, PROCEDURE, BUSINESS_AREA, COLLECTION, EXTERNAL_TABLE, REGISTERED_FUNCTION, ITEM_FOLDER, DRILL_PATH, LIST_OF_VALUES, DRILL_TO_DETAIL, ALTERNATIVE_SORT_ORDER, PRESENTATION_TEMPLATE and any user defined object types.

See Also

OMBMOVE

OMBCREATE

Purpose

Create a new component.

Prerequisites

Should be in the context that stores the component type.

Syntax

createCommand =  OMBCREATE [ TRANSIENT ] "fco_type" "fco_name" [
          "setPropertiesClause" ] { "setReferenceClause" } { "addSCOClause" }
     setPropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     setReferenceClause =  SET ( REF | REFERENCE ) [ "qualifier" ] "type"
          "quotedNameList" [ { "parentSCOClause" } OF "fco_type" "fco_name" ]
     addSCOClause =  ADD "sco_type" "sco_name" { "parentSCOClause" } [
          "setPropertiesClause" ] { "setReferenceClause" }
     propertyNameList =  "propertyName" { "," "propertyName" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     quotedNameList =  "QUOTED_STRING" | "(" "QUOTED_STRING" { ","
          "QUOTED_STRING" } ")"
     parentSCOClause =  OF "sco_type" "sco_name"
     propertyName =  "UNQUOTED_STRING"
     propertyValue =  "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL"

Parameters

createCommand

Specify metadata for a new component.

TRANSIENT

Keyword used to specify that the object being created will not be persisted in the repository.

fco_type

The type of the component.

fco_name

The physical name of the component in single quotes.

setPropertiesClause

Set object properties.

setReferenceClause

Specify reference objects.

qualifier

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

addSCOClause

Add a new child object to the component.

propertyNameList

A list of property names.

propertyValueList

A list of property values.

quotedNameList

A list of single-quoted physical names.

parentSCOClause

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

propertyName

An unquoted string representing the name of a property.

propertyValue

The value of a property.

See Also

OMBALTER

OMBDROP

OMBCREATE ACTIVITY_TEMPLATE

Purpose

To create an activity template.

Valid Activity Template types are:

ASSIGN

EMAIL

FILE_EXISTS

FTP

MANUAL

NOTIFICATION

SET_STATUS

SQLPLUS

USER_DEFINED

WAIT

Prerequisites

Should be in the context of an Activity Template Folder.

Syntax

createActivityTemplate =  ( OMBCREATE ACTIVITY_TEMPLATE "QUOTED_STRING" [ (
           OF ACTIVITY_TYPE "UNQUOTED_STRING" ) ] { ( SET "setPropertiesClause"
          ) | "setReferenceIconSetClause" } { "addParameterClause" } )
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  SET ( REFERENCE | REF ) ICONSET
          "QUOTED_STRING"
     addParameterClause =  ( ADD PARAMETER "QUOTED_STRING" ) [ SET
          "setPropertiesClause" ]
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createActivityTemplate

Create an activity template.

setPropertiesClause

This clause sets properties for the corresponding object.

getTemplatePropertiesClause

Basic properties for ACTIVITY_TEMPLATE:

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

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

getParameterPropertiesClause

Description of the Activity Template Core properties for Activity Parameter:

Name: DATATYPE
Type: STRING
Valid Values: INTEGER, FLOAT, DATE, STRING, BOOLEAN
Default: STRING
Sets the datatype of a Parameter

Name: DIRECTION
Type: STRING
Valid Values: IN
Default: IN
Sets the direction of a Parameter

Name: DEFAULT_VALUE
Type: STRING
Valid Values: Examples '123', '123.456', 'Jan-08-2003', 'I am String', 'true'
Default: Empty string
Sets the default value of a Parameter

setReferenceIconSetClause

Set icon set for the activity template.

addParameterClause

Add a variable to the activity template.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

propertyKey

A property key for an object.

propertyValue

Value of a property.

PARAMETER Object

Table 5-8 PARAMETER Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBCREATE

OMBALTER ACTIVITY_TEMPLATE

OMBDROP ACTIVITY_TEMPLATE

OMBRETRIEVE ACTIVITY_TEMPLATE

OMBCREATE ACTIVITY_TEMPLATE_FOLDER

Purpose

To create an activity template folder.

Prerequisites

Should be in the context of a Project.

Syntax

createActivityTemplateFolder =  OMBCREATE ACTIVITY_TEMPLATE_FOLDER
          "QUOTED_STRING" { ( SET "setPropertiesClause" ) |
          "setReferenceIconSetClause" }
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  SET ( REFERENCE | REF ) ICONSET
          "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createActivityTemplateFolder

Create an activity template folder.

setPropertiesClause

This clause sets properties for the corresponding object.

getTemplateFolderPropertiesClause

Basic properties for ACTIVITY_TEMPLATE_FOLDER:

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

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

setReferenceIconSetClause

Set icon set for the activity template folder.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

propertyKey

A property key for an object.

propertyValue

Value of a property.

See Also

OMBCREATE

OMBALTER ACTIVITY_TEMPLATE_FOLDER

OMBDROP ACTIVITY_TEMPLATE_FOLDER

OMBRETRIEVE ACTIVITY_TEMPLATE_FOLDER

OMBCREATE ADVANCED_QUEUE

Purpose

To create an Advanced Queue.

Prerequisites

Should be in the context of an Oracle Module. The Queue Table should exist in the same Oracle Module.

Syntax

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

Parameters

createAQCommand

Creates an Advanced Queue with the given name.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Advanced Queue. Valid properties are shown below:

getPropertiesClause

Basic properties for ADVANCED_QUEUE:

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

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

Name: QTABLE
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Queue Table for the Advanced Queue. This has to be the name of a Queue Table(QUEUE_TABLE) existing in the same Oracle Module.

setReferenceIconSetClause

Set the specified Icon Set.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

ADVANCED_QUEUE Object

Table 5-9 ADVANCED_QUEUE Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

DEQUEUE_ENABLED

BOOLEAN

true, false

none

none

true

ENQUEUE_ENABLED

BOOLEAN

true, false

none

none

true

GENERATE_ADVANCED_QUEUE

BOOLEAN

true, false

none

none

true

GENERATE_TEMPORARY_TABLE

BOOLEAN

true, false

none

none

true

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

MAX_RETRIES

NUMBER

none

none

none

5

RETENTION_TIME

NUMBER

none

none

none

0

RETRY_DELAY

NUMBER

none

none

none

0

See Also

OMBCREATE ADVANCED_QUEUE

OMBALTER ADVANCED_QUEUE

OMBDROP ADVANCED_QUEUE

6 OMBCREATE ALTERNATIVE_SORT_ORDER to OMBCREATE CUBE

OMBCREATE ALTERNATIVE_SORT_ORDER

OMBCREATE ANALYZE_ACTION_PLAN

OMBCREATE APPLICATION_SERVER_MODULE

OMBCREATE BUSINESS_AREA

OMBCREATE BUSINESS_DEFINITION_MODULE

OMBCREATE CALENDAR

OMBCREATE CALENDAR_MODULE

OMBCREATE CATALOG_FOLDER

OMBCREATE CDC_CT

OMBCREATE CMI_DEFINITION

OMBCREATE CMI_MODULE

OMBCREATE COLLECTION

OMBCREATE CONFIGURATION

OMBCREATE CONFIGURATION_TEMPLATE

OMBCREATE CONNECTOR

OMBCREATE CONTROL_CENTER

OMBCREATE CONTROL_CT

OMBCREATE CORRECTION_MAPS_ACTION_PLAN

OMBCREATE CORRECTION_SCHEMA_ACTION_PLAN

OMBCREATE CT_FOLDER

OMBCREATE CUBE

OMBCREATE ALTERNATIVE_SORT_ORDER

Purpose

Creates an Alternative Sort Order.

Prerequisites

Should be in the context of a Business Definition Module.

Syntax

createAlternativeSortOrderCommand =  OMBCREATE ALTERNATIVE_SORT_ORDER
          "QUOTED_STRING" [ SET "setPropertiesClauseforLOVandD2D" ] [ SET
          "setReferenceIconSetClause" ] [ "addAlternativeSortOrderDefClause" ] [
           "addAlternativeSortOrderOrdClause" ] {
          "addAlternativeSortOrderReferenceClause" }
     setPropertiesClauseforLOVandD2D =  PROPERTIES "("
          "propertyNameListforLOVandD2D" ")" VALUES "(" "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addAlternativeSortOrderDefClause =  SET ( REF | REFERENCE ) DEFINING ITEM
          "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
     addAlternativeSortOrderOrdClause =  SET ( REF | REFERENCE ) ORDERED ITEM
          "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
     addAlternativeSortOrderReferenceClause =  SET ( REF | REFERENCE ) ITEM
          "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
     propertyNameListforLOVandD2D =  ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
          "," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createAlternativeSortOrderCommand

This command creates an alternative sort order.

QUOTED_STRING

Specify the name of the alternative sort order to be created.

setPropertiesClauseforLOVandD2D

Used to set properties (core, logical, physical, user-defined) for an alternative sort order. Valid properties are shown below:

getPropertiesClauseforLOVandD2D

Basic properties for ALTERNATIVE_SORT_ORDER:

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

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

Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the alternative sort order enables drilling between the item folders containing the items that use the alternative sort order

Name: RETRIEVE_VALUES_GROUP_SIZE
Type: Number
Valid Values: Any valid character string in supported character set.
Default: '100'
The number of rows to be fetched from the database at a time

Name: CACHE_VALUES
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the list of values should be cached in memory

Name: REQUIRE_SEARCH
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether search criteria should be requested

Name: SHOW_IN_NAVIGATOR
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be shown in the item navigator

Name: SORTED_DISTINCT
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be displayed sorted with duplicates hidden

setReferenceIconSetClause

Set specified Icon Set.

addAlternativeSortOrderDefClause

This clause adds a defining item.

addAlternativeSortOrderOrdClause

This clause adds an ordering item.

addAlternativeSortOrderReferenceClause

This adds a reference to an item to an alternative sort order.

propertyNameListforLOVandD2D

This is the list of property names.

propertyValueList

This is the list of property values.

propertyValue

This is a property value.

ALTERNATIVE_SORT_ORDER Object

Table 6-1 ALTERNATIVE_SORT_ORDER Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER ALTERNATIVE_SORT_ORDER

OMBRETRIEVE ALTERNATIVE_SORT_ORDER

OMBCREATE ANALYZE_ACTION_PLAN

Purpose

Create an action plan for executing a profile.

Prerequisites

First make sure that all the sources you want to profile have been imported into the OWB repository.

Syntax

CreateActionPlanCommand =  ( OMBCREATE TRANSIENT ( ( DEPLOYMENT_ACTION_PLAN
           | ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
          CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" { "addActionClause" }
          )
     addActionClause =  ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
     setClause =  ( "propertiesClause" [ SET "setReferenceClause" ] ) |
          "setReferenceClause"
     propertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClause =  ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
          "useClause" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     useClause =  USE DATA_RULE_USAGE "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

CreateActionPlanCommand

Create a profile action plan.

QUOTED_STRING

Action plan name.

addActionClause

Add an action to an action plan.

QUOTED_STRING

Action name.

setClause

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

propertiesClause

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

setReferenceClause

Associate an object with an action.

ObjType

Object type. The only valid value is DATA_PROFILE_TABLE.

propertyNameList

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

propertyValueList

Comma separated list of property values.

useClause

Currently used only in CORRECTION_SCHEMA_ACTION_PLAN.

propertyValue

Value of a property.

See Also

OMBPROFILE

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.

See Also

OMBCREATE

OMBALTER APPLICATION_SERVER_MODULE

OMBDROP APPLICATION_SERVER_MODULE

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

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER BUSINESS_AREA

OMBRETRIEVE BUSINESS_AREA

OMBCREATE BUSINESS_DEFINITION_MODULE

Purpose

To create a business definition module.

Prerequisites

Should be in the context of project.

Syntax

createEULModuleCommand =  OMBCREATE ( BUSINESS_DEFINITION_MODULE
          "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET
          "setReferenceClauseForDataOnlyModule" ] |
          "setReferenceClauseForDataOnlyModule" ) ] [
          "addModuleReferenceLocationClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataOnlyModule =  ( "setReferenceLocationClause" [ SET
           "setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
     addModuleReferenceLocationClause =  "addReferenceLocationClause" {
          "addReferenceLocationClause" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createEULModuleCommand

This command creates a business definition module.

QUOTED_STRING

Specify the name of a business definition module to be created.

setPropertiesClause

Associate a set of properties with a business definition module.

getPropertiesClause

Basic properties for 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 business definition module

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

setReferenceClauseForDataOnlyModule

Set location and/or icon set for the new business definition module.

addModuleReferenceLocationClause

Add data locations to the new business definition module.

propertyNameList

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

propertyValueList

Comma-separated list of property values.

setReferenceLocationClause

Set a data location for a business definition module as the new configuration default.

setReferenceIconSetClause

Set icon set for the new business definition module.

addReferenceLocationClause

Add a data location to the new business definition module.

propertyValue

Value for a specified property.

BUSINESS_DEFINITION_MODULE Object

Table 6-3 BUSINESS_DEFINITION_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

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

OBJECT_MATCHING

STRING

BY_IDENTIFIER, BY_NAME

none

none

BY_IDENTIFIER

Whether import should match up objects by identifier or by name

See Also

OMBCREATE

OMBALTER BUSINESS_DEFINITION_MODULE

OMBDROP BUSINESS_DEFINITION_MODULE

OMBCREATE CALENDAR

Purpose

To create a calendar.

Prerequisites

Should be in the context of a Calendar Folder.

Syntax

createCalendarCommand =  ( OMBCREATE CALENDAR "QUOTED_STRING" [ SET ( (
          "setPropertiesClause" [ SET "setReferenceIconSetClause" ] ) |
          "setReferenceIconSetClause" ) ] ( ADD SCHEDULE ) [ SET
          "setPropertiesClause" ] )
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createCalendarCommand

Create a new calendar.

setPropertiesClause

Describe the keys of properties for the calendar.

setPropertiesClause

Basic properties for CALENDAR:

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

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

Each calendar contains a single schedule with the name 'LOCALWINDOW'
which has the following properties which define the various aspects
of the schedule
Basic properties for SCHEDULE:

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

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

setPropertiesClause

Basic properties for the owned SCHEDULE OBJECT :

Name: START_TIME
Type: STRING(4000)
Valid Values: Start time in the format specified by property DATE_FORMAT. The value NULL can also be passed if a schedule that takes on a start time of ASAP ie. upon deployment.
Default: Empty string
Start time for the schedule

Name: END_TIME
Type: STRING(4000)
Valid Values: End time in the format specified by property DATE_FORMAT. The value NULL can also be passed if a schedule that repeats forever is to be created..
Default: Empty string
End time for the schedule

Name: TIMEZONE
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Time zone which times refer to.

Name: REPEAT_EXPRESSION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
iCal format of a repeat expression. If no REPEAT_EXPRESSION is supplied, the scheduled activity is only performed once. The REPEAT_EXPRESSION includes the following:
FREQ
This specifies the type of recurrence. It must be specified. The possible predefined frequency values are YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, and SECONDLY. Alternatively, specifies an existing schedule to use as a user-defined frequency.
INTERVAL
This specifies a positive integer representing how often the recurrence repeats. The default is 1, which means every second for secondly, every day for daily, and so on. The maximum value is 999.
BYMONTH
This specifies which month or months you want the job to execute in. You can use numbers such as 1 for January and 3 for March, as well as three-letter abbreviations such as FEB for February and JUL for July.
BYWEEKNO
This specifies the week of the year as a number. byweekno is only valid for YEARLY.
BYYEARDAY
This specifies the day of the year as a number. Valid values are 1 to 366. An example is 69, which is March 10 (31 for January, 28 for February, and 10 for March). 69 evaluates to March 10 for non-leap years and March 9 in leap years. -2 will always evaluate to December 30th independent of whether it is a leap year.
BYMONTHDAY
This specifies the day of the month as a number. Valid values are 1 to 31. An example is 10, which means the 10th day of the selected month. You can use the minus sign (-) to count backward from the last day, so, for example, BYMONTHDAY=-1 means the last day of the month and BYMONTHDAY=-2 means the next to last day of the month.
BYDAY
This specifies the day of the week from Monday to Sunday in the form MON, TUE, and so on. Using numbers, you can specify the 26th Friday of the year, if using a YEARLY frequency, or the 4th THU of the month, using a MONTHLY frequency. Using the minus sign, you can say the second to last Friday of the month. For example, -1 FRI is the last Friday of the month.
BYHOUR
This specifies the hour on which the job is to run. Valid values are 0 to 23. As an example, 10 means 10 a.m.
BYMINUTE
This specifies the minute on which the job is to run. Valid values are 0 to 59. As an example, 45 means 45 minutes past the chosen hour.
BYSECOND
This specifies the second on which the job is to run. Valid values are 0 to 59. As an example, 30 means 30 seconds past the chosen minute.

BYSETPOS (10gR2 only)
This selects one or more items by position in the list of timestamps that result after the whole calendaring expression is evaluated. It is useful for requirements such as running a job on the last workday of the month. Rather than attempting to express this with the other BY clauses, you can code the calendaring expression to evaluate to a list of every workday of the month, and then add the BYSETPOS clause to select only the last item of that list.

All of the above properties can be used in the SET PROPERTIES clause as well.

setPropertiesClause

The following properties are supported for the GET PROPERTIES clause only
Name: DATE_FORMAT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N//A
Region specific time format string, eg MMM/dd/yy:HH:mm:ss.
Name: AVAILABLE_TIMEZONES
Type: STRING ARRAY
Valid Values: Any valid character string in supported character set.
Default: N//A
List of available time zone ids that can be used to set the TIMEZONE property. This property is for information purposes only.
Name: PREVIEW_DATES
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Preview of dates that this schedule includes. This property is only valid for OMBRETRIEVE.

setReferenceIconSetClause

Set specified Icon Set.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

propertyKey

A property key for an object.

propertyValue

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

CALENDAR Object

Table 6-4 CALENDAR Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBCREATE

OMBALTER CALENDAR

OMBDROP CALENDAR

OMBRETRIEVE CALENDAR

OMBCREATE CALENDAR_MODULE

Purpose

To create an calendar module.

Prerequisites

Should be in the context of a Calendar Folder.

Syntax

createModuleCommand =  OMBCREATE CALENDAR_MODULE "QUOTED_STRING" [
          "alterModulePropertiesOrIconSetClause" ]
     alterModulePropertiesOrIconSetClause =  ( SET ( ( "setPropertiesClause" [ (
           ( SET ( "setReferenceLocationClause" [ ( SET
          "setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
          ) ] ) ) | ( UNSET "unsetReferenceLocationClause" [ ( SET
          "setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
          ) ] ) ) | ( ( SET "setReferenceIconSetClause" ) | ( UNSET
          "unsetReferenceIconSetClause" ) ) ] ) | ( "setReferenceLocationClause"
           [ ( SET "setReferenceIconSetClause" ) | ( UNSET
          "unsetReferenceIconSetClause" ) ] ) | "setReferenceIconSetClause" ) )
          | ( UNSET ( "unsetReferenceLocationClause" [ ( SET
          "setReferenceIconSetClause" ) | ( UNSET "unsetReferenceIconSetClause"
          ) ] ) | "unsetReferenceIconSetClause" )
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createModuleCommand

Create a new Calendar Module.

alterModulePropertiesOrIconSetClause

Alter a property of the module or the icon set.

setPropertiesClause

Describe the keys of properties for object.

setPropertiesClause

Basic properties for CALENDAR_MODULE:

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

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

setReferenceLocationClause

Set the referenced location.

setReferenceIconSetClause

Set specified Icon Set.

unsetReferenceIconSetClause

Unset specified Icon Set.

unsetReferenceLocationClause

Unset the referenced location.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

propertyKey

A property key for an object.

propertyValue

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

CALENDAR_MODULE Object

Table 6-5 CALENDAR_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

DB_LOCATION

STRING

none

none

none

empty string

The location to which the schedule will be deployed.

EVAL_LOCATION

STRING

none

none

none

empty string

The location in which the scheduled object will be evaluated.

See Also

OMBCREATE

OMBALTER CALENDAR_MODULE

OMBDROP CALENDAR_MODULE

OMBRETRIEVE CALENDAR_MODULE

OMBCREATE CATALOG_FOLDER

Purpose

Creates a catalog folder to group business related items.

Prerequisites

Should be in the context of an OBIEE Business Definition Module.

Syntax

createCatalogFolderCommand =  ( OMBCREATE CATALOG_FOLDER "QUOTED_STRING" [
          SET "setPropertiesClause" ] [ SET "setReferenceIconSetClause" ] { SET
          ( REF | REFERENCE ) LOGICAL_TABLES "(" "setLogicalTableNameList" ")" |
           SET ( REF | REFERENCE ) DRILL_PATHS "(" "setDrillPathNameList" ")" }
          )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setLogicalTableNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     setDrillPathNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createCatalogFolderCommand

This command creates a catalog folder.

QUOTED_STRING

Specify the name of the catalog folder to be created.

setPropertiesClause

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

getPropertiesClause

Basic properties for CATALOG_FOLDER:

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

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

setReferenceIconSetClause

Set specified Icon Set.

setLogicalTableNameList

Used to set logical table references for this catalog folder.

setDrillPathNameList

Used to set logical table references for this catalog folder.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

propertyValue

This is a property value.

CATALOG_FOLDER Object

Table 6-6 CATALOG_FOLDER Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER CATALOG_FOLDER

OMBRETRIEVE CATALOG_FOLDER

OMBCREATE CDC_CT

Purpose

To create a CDC Code Template.

Prerequisites

In the context of an CT module.

Syntax

createJCTCommand =  OMBCREATE CDC_CT "QUOTED_STRING" {
          "kmCreateOptionsOptionsClause" }
     kmCreateOptionsOptionsClause =  SET "setReferenceIconSetClause" | SET
          "setPropertiesClause" | ADD ( "addParameterClause" |
          "addVariableClause" | "addCTTaskClause" | "addNestedCTTaskClause" |
          "addTransitionClause" )
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     addParameterClause =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
           [ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
     addVariableClause =  VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
     addCTTaskClause =  "TASK_TYPE" TASK "QUOTED_STRING" {
          "kmTaskAddOptionsOptionsClause" }
     addNestedCTTaskClause =  NESTED_CT TASK "QUOTED_STRING" SET [
          "collectPropertiesClause" SET ] ( REF | REFERENCE ) CT "QUOTED_STRING"
           [ SET "setReferenceIconSetClause" ]
     addTransitionClause =  TRANSITION "QUOTED_STRING" FROM TASK "QUOTED_STRING"
           TO "QUOTED_STRING" [ SET "setPropertiesClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     parameterBindingClause =  UNBIND | BIND TO ( "parameterLocator" |
          "variableLocator" )
     kmTaskAddOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET
          "unsetReferenceIconSetClause" | SET "setPropertiesClause"
     collectPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     parameterLocator =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
     variableLocator =  VARIABLE "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

createJCTCommand

Creates a CDC CT. The following code template will be created by default:

{0}

setReferenceIconSetClause

Set icon set for the expert module.

setPropertiesClause

This clause sets properties for the corresponding object.

setPropertiesClause

Basic properties for Code Template:

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

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

Basic properties for TASK:

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

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

addParameterClause

Add a parameter to the expert or one of it's tasks.

addVariableClause

Add a variable to the expert.

addTransitionClause

Add a transition to the expert.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

parameterBindingClause

Bind or unbind two parameters. Note that this is setting the binding attribute of the parameter object and is not necessarily the same as the direction of data flow. The parameter to be set should be the one whose binding attribute is modified via the Object Inspector in the expert editor.

collectPropertiesClause

This clause sets properties for the corresponding object.

propertyValue

Value of a property.

parameterLocator

Specify a parameter, either one of the expert or of a task.

variableLocator

Specify a variable in the expert.

CDC_CT Object

Table 6-7 CDC_CT Object

Property
Type
Choices
Min
Max
Default
Description

CONSISTENT_SET

BOOLEAN

true, false

none

none

false

Is the change data capture operator on a consistent set of tables?

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

PLATFORM

STRING

none

none

none

GENERIC

SOURCE_PLATFORM

STRING

none

none

none

GENERIC

See Also

OMBCREATE

OMBALTER CT

OMBRETRIEVE CT

OMBDROP CT

OMBCREATE CMI_DEFINITION

Purpose

To create an CMI definition.

Prerequisites

Should be in the root context.

Syntax

createMIVDefinitionCommand =  OMBCREATE ( CMI_DEFINITION "QUOTED_STRING"
          USING DEFINITION_FILE "QUOTED_STRING" ) [ SET "setPropertiesClause" ]
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createMIVDefinitionCommand

This command creates a CMI definition.

QUOTED_STRING

Name of the CMI definition to be created.

setPropertiesClause

Associate a set of properties with a CMI definition.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

See Also

OMBCREATE

OMBDROP CMI_DEFINITION

OMBCREATE CMI_MODULE

Purpose

To create an CMI module.

Prerequisites

Should be in the context of project.

Syntax

createMIVModuleCommand =  OMBCREATE ( CMI_MODULE "QUOTED_STRING" USING
          CMI_DEFINITION "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET
          "setReferenceClauseForDataMetadataModule" ] |
          "setReferenceClauseForDataMetadataModule" ) ] [
          "addModuleReferenceLocationClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "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

createMIVModuleCommand

This command creates a CMI module

setPropertiesClause

Associate a set of properties with a CMI module. For example, you can use this clause to set the platform for a module. For example:

OMBCREATE CMI_MODULE 'PPLSOFT' SET PROPERTIES (TYPE) VALUES ('DB2UDB')

getPropertiesClause

Basic properties for CMI_MODULE:

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

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

setReferenceClauseForDataMetadataModule

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

addModuleReferenceLocationClause

Add datae locations to the CMI module.

propertyNameList

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

propertyValueList

Comma separated list of property values.

setReferenceLocationClause

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

addReferenceLocationClause

Add a data location to the CMI module.

propertyValue

Value of a property.

setReferenceMetadataLocationOrIconSetClause

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

setReferenceMetadataLocationClause

Set metadata location for the CMI module.

setReferenceIconSetClause

Set icon set for the CMI module.

CMI_MODULE Object

Table 6-8 CMI_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE

OMBALTER CMI_MODULE

OMBDROP CMI_MODULE

OMBCREATE COLLECTION

Purpose

This is an arbitrary grouping mechanism in OWB. Any first class object can be added to the collection.

Prerequisites

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

Syntax

createCollectionCommand =  OMBCREATE ( COLLECTION "QUOTED_STRING" [ SET
          "setPropertiesClause" [ SET "setReferenceIconSetClause" ] | SET
          "setReferenceIconSetClause" ] ( { "addReferenceClause" } ) )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addReferenceClause =  ADD REFERENCE TO "componentRefClause"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     componentRefClause =  ( "UNQUOTED_STRING" "QUOTED_STRING" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createCollectionCommand

Create a collection of objects.

setPropertiesClause

Set values for a number of properties when creating the collection.

propertiesClause

Basic properties for COLLECTION:

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

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

setReferenceIconSetClause

Set icon set for the collection.

addReferenceClause

Add a reference to the collection.

propertyNameList

Comma separated list of property names to retrieve values. Property names are unquoted.

propertyValueList

Comma separated list of property values.

componentRefClause

Specify the type of the object to reference.

propertyValue

Value of property.

See Also

OMBCREATE

OMBALTER COLLECTION

OMBDROP COLLECTION

OMBCREATE CONFIGURATION

Purpose

To create a Configuration for supporting of objects multi-configuration.

Prerequisites

Should be in the context of project.

Syntax

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

Parameters

createConfigurationCommand

This command creates an Configuration.

setPropertiesClause

Associate a set of properties with a Configuration.

getPropertiesClause

Basic properties for CONFIGURATION:

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

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

setReferenceIconSetClause

Associate an Icon Set with a Configuration.

setReferenceConfigTemplateClause

Associate a Configuration Template with a Configuration.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

See Also

OMBCREATE

OMBALTER CONFIGURATION

OMBDROP CONFIGURATION

OMBCREATE CONFIGURATION_TEMPLATE

Purpose

Create a configuration template that can be associated with a configuration.

Prerequisites

None.

Syntax

createConfigurationTemplateCommand =  OMBCREATE ( CONFIGURATION_TEMPLATE
          "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" ] [ SET "setTemplateValuesClause" ] |
          "setReferenceIconSetClause" [ SET "setTemplateValuesClause" ] |
          "setTemplateValuesClause" ) ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setTemplateValuesClause =  ( TEMPLATE_VALUES "(" "propertyNameList" ")" TO
          "(" "propertyValueList" ")" FOR "getType" )+ ON PLATFORM
          "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     getType =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createConfigurationTemplateCommand

Create a configuration template.

setPropertiesClause

Associate a set of properties with a configuration template.

getPropertiesClause

Basic properties for CONFIGURATION_TEMPLATE:

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

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

setReferenceIconSetClause

Associate an Icon Set with this configuration template.

setTemplateValuesClause

Specifies the configuration properties that will be overriden in this template for objects of a certain type on a certain platform.
The following is a list of configuration properties and their seeded default values:

Platform ObjectType {UI category}
  {UI name} ScriptingName {Default value}

DB2UDB DB2UDB_MODULE {GENERATION_TARGET_DIRECTORIES}
  {8i.DB2UDB.1.CTLDIRECTORY} LOADER_DIRECTORY {ctl\}
  {8i.DB2UDB.1.CTLEXTENSION} LOADER_EXTENSION {.ctl}
  {8i.DB2UDB.1.CTLRUNPRM} LOADER_RUN_PARAMETER_FILE {_run.ini}

DB2UDB FUNCTION {Identification}
  {Deployable} DEPLOYABLE {true}

DB2UDB FUNCTION {Options}
  {Deterministic} DETERMINISTIC_STATE {}
  {Language} LANGUAGE_SQL {}
  {SPECIFIC} SPECIFIC {}
  {Call On Null Input} CALLED_ON_NULL_INPUT {}
  {External Action} EXTERNAL_ACTION {}
  {Inherit Isolation Level} INHERIT_ISOLATION_LEVEL {}
  {Inherit Special Registers} INHERIT_SPECIAL_REGISTERS {}
  {Parameter Ccsid} PARAMETER_CCSID {}
  {SQL Data} SQL_DATA {}
  {Static Dispatch} STATIC_DISPATCH {}

DB2UDB FUNCTION {}
  {Generation Comments} GENERATION_COMMENTS {}

DB2UDB TABLE {Change Data Capture}
  {Enable} IS_CDC {false}
  {Table Position} CDC_POSITION {0}

GENERIC ALTERNATIVE_SORT_ORDER {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC BUSINESS_AREA {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC BUSINESS_DEFINITION_MODULE {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC BUSINESS_DEFINITION_MODULE {Discoverer Import Options}
  {Object Matching} OBJECT_MATCHING {BY_IDENTIFIER}

GENERIC CATALOG_FOLDER {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC DRILL_TO_DETAIL {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC EJB {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC FOR_LOOP {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC JAVA {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC LIST_OF_VALUES {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC OBIEEDRILL_PATH {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC OBIEEQUERY_OBJECT_SIMPLE {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC OBIEE_BUSINESS_DEFINITION_MODULE {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC OBISEDRILL_PATH {Identification}
  {Deployable} DEPLOYABLE {true}

GENERIC OBISEQUERY_OBJECT_SIMPLE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Optimizer Hint} OPTIMIZER_HINT {}

GENERIC OMBPLUS {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC PROCESS_ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC PROCESS_FLOW {}
  {Generation Comments} GENERATION_COMMENTS {}
  {Referred Calendar} REFERRED_CALENDAR {}

GENERIC PROCESS_FLOW_PACKAGE {IDENTIFICATION}
  {OWF.PACKAGES.DEPLOYABLE} DEPLOYABLE {true}

GENERIC PROCESS_FLOW_PACKAGE {}
  {Generation Comments} GENERATION_COMMENTS {}

GENERIC REGISTERED_FUNCTION {Identification}
  {Deployable} DEPLOYABLE {true}
  {Package} PACKAGE {}

GENERIC REGISTERED_FUNCTION {Options}
  {AUTHID} AUTHID {}
  {Deterministic} IS_DETERMINISTIC {}
  {Parallel Enable} IS_PARALLEL_ENABLE {}
  {Pragma Autonomous Transaction} PRAGMA_AUTONOMOUS_TRANSACTION {}

GENERIC REGISTERED_FUNCTION {}
  {Generation Comments} GENERATION_COMMENTS {}

GENERIC SEQUENCE {}
  {Generation Comments} GENERATION_COMMENTS {}

GENERIC TABLE {Change Data Capture}
  {Enable} IS_CDC {false}

GENERIC VIEW {}
  {Generation Comments} GENERATION_COMMENTS {}

GENERIC WEBSERVICE {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC AND ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC ASSIGN ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC DATA_AUDITOR ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC EMAIL ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC END ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC END_ERROR ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC END_LOOP ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC END_SUCCESS ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC END_WARNING ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC EVENT_LISTENER ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC FILE_EXISTS ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC FORK ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC FTP ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC MANUAL ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC MAPPING ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC NOTIFICATION ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC OR ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC PREDICT ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC ROUTE ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC SET_STATUS ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC SQLPLUS ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC START ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC SUBPROCESS ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC TRANSFORMATION ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC USER_DEFINED ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC WAIT ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

GENERIC WHILE_LOOP ACTIVITY {Execution Settings}
  {Use Return as Status} USE_RETURN_AS_STATUS {false}

J2EE WEB_SERVICE {IDENTIFICATION}
  {Deployable} DEPLOYABLE {true}

J2EE WEB_SERVICE_PACKAGE {IDENTIFICATION}
  {Deployable} DEPLOYABLE {true}

ORACLE BATCH_MAPPING {CODE_GENERATION_OPTIONS}
  {MAP.AUTHID} AUTHID {None}
  {Analyze table statements} ANALYZE_TABLE_STATEMENTS {false}
  {ANSI SQL Syntax } ANSI_SQL_SYNTAX {true}
  {Bulk processing code} BULK_PROCESSING_CODE {true}
  {Commit Control} COMMIT_CONTROL {AUTO_COMMIT}
  {Enable Parallel DML} ENABLE_PARALLEL_DML {false}
  {Error Trigger} ERROR_TRIGGER {}
  {Generation Mode} GENERATION_MODE {ALL_MODES}
  {Optimized code} OPTIMIZED_CODE {true}
  {Use Target Load Ordering} TARGET_LOAD_ORDERING {true}

ORACLE BATCH_MAPPING {TDF}
  {Backports} BACKPORT_TRANSFORMS {}
  {Extends} EXTENDED_TRANSFORMS {}
  {Fixes} FIXED_TRANSFORMS {}
  {Handler} HANDLER_TRANSFORM {}
  {Release} TRANSFORM_RELEASE {}
  {Replaces} REPLACED_TRANSFORMS {}
  {ADXML Comments} ADXML_COMMENTS {}
  {Associated Partial Backport } ASSOCIATED_PARTIAL_BACKPORT_TRANSFORMS {}
  {Customer Notes} CUSTOMER_NOTES {}
  {Deploy Condition} DEPLOY_CONDITION {}
  {Dev Version} DEV_VERSION {}
  {Developer Notes} DEVELOPER_NOTES {}
  {Handler Of} HANDLER_OF_TRANSFORMS {}
  {Must Run After} MUST_RUN_AFTER_TRANSFORMS {}
  {Partial Backports} PARTIAL_BACKPORT_TRANSFORMS {}

ORACLE BATCH_MAPPING {PL/SQL mapping debugger properties for stage}
  {Debug runtime connection.} DEBUG_RUNTIME_CONNECTION {}

ORACLE BATCH_MAPPING {Runtime parameters}
  {Audit} AUDIT {true}
  {ABAP Report Name} ABAP_REPORT_NAME {}
  {Analyze table sample percentage} ANALYZE_TABLE_SAMPLE_PERCENTAGE {5}
  {Background Job} BACKGROUND {false}
  {Bulk size} BULK_SIZE {1000}
  {Commit frequency} COMMIT_FREQUENCY {1000}
  {Data File Name} DATA_FILE_NAME {}
  {Default audit level} DEFAULT_AUDIT_LEVEL {ERROR_DETAILS}
  {Default Operating Mode} DEFAULT_OPERATING_MODE {SET_BASED_FAIL_OVER_TO_ROW_BASED}
  {Default purge group} DEFAULT_PURGE_GROUP {WB}
  {File Delimiter for Staging File} FILE_DELIMITER_FOR_STAGING_FILE {~}
  {Include FTP} SAP_FTP {true}
  {Maximum number of errors} MAXIMUM_NUMBER_OF_ERRORS {50}
  {Nested Loop} NESTED_LOOP {TRUE_DEFAULT}
  {Primary Foreign Key for Join} PRIMARY_FOREIGN_KEY_FOR_JOIN {DEFAULT}
  {SAP System Version} SAP_SYSTEM_VERSION {SAP_R3_4X}
  {Sql Join Collapsing} SQL_JOIN_COLLAPSING {TRUE_DEFAULT}
  {Staging File Directory} STAGING_FILE_DIRECTORY {C:\temp\}
  {Use Select Single} USE_SELECT_SINGLE {TRUE_DEFAULT}

ORACLE BATCH_MAPPING {SQL Loader Settings}
  {Multithreading} MULTITHREADING {USE_DEFAULT}
  {Resumable} RESUMABLE {false}
  {Bind Size} BIND_SIZE {50000}
  {Byte Order Mark} BYTE_ORDER_MARK {NOT_APPLICABLE}
  {Column Array Rows} COLUMNARRAYROWS {0}
  {Continue Load} CONTINUE_LOAD {false}
  {Control File Name} CONTROL_FILE_NAME {}
  {Database File Name} DATABASE_FILE_NAME {}
  {Delimited File Record Termination} DELIMITED_FILE_RECORD_TERMINATION {}
  {Direct Mode} DIRECT_MODE {false}
  {Endian (Byte Order)} BYTE_ORDER {DEFAULT_TO_PLATFORM}
  {Errors Allowed} ERRORS_ALLOWED {50}
  {Load Last Field As Pieced} LOAD_LAST_FIELD_AS_PIECED {false}
  {Log File Name} LOG_FILE_NAME {}
  {Nls Characterset} NLS_CHARACTERSET {}
  {Operation Recoverable} OPERATION_RECOVERABLE {true}
  {Perform Parallel Load} PERFORM_PARALLEL_LOAD {false}
  {Preserve Blanks} PRESERVE_BLANKS {false}
  {Read Buffers} READ_BUFFERS {0}
  {Read Size} READ_SIZE {65536}
  {Records to Load} RECORDS_TO_LOAD {0}
  {Records to Skip} RECORDS_TO_SKIP {0}
  {Resumable Name} RESUMABLE_NAME {}
  {Resumeable Timeout} RESUMABLE_TIMEOUT {7200}
  {Rows per Commit} ROWS_PER_COMMIT {200}
  {Skip Index Maintenance} SKIP_INDEX_MAINTENANCE {false}
  {Skip Unusable Indexes} SKIP_UNUSABLE_INDEXES {USE_DATABASE_CONFIG}
  {Stream size} STREAM_SIZE {0}
  {Supress discards} SUPRESS_DISCARDS {false}
  {Supress Errors} SUPRESS_ERRORS {false}
  {Supress Feedback} SUPRESS_FEEDBACK {false}
  {Supress Header} SUPRESS_HEADER {false}
  {Supress partitions} SUPRESS_PARTITIONS {false}

ORACLE BATCH_MAPPING {SQL*Plus Settings}
  {ARRAYSIZE} ARRAYSIZE {15}
  {COPYCOMMIT} COPYCOMMIT {0}
  {LONG} LONG_SIZE {2000000}
  {LOG File Directory} LOG_FILE_DIRECTORY {}
  {LOG File Name} LOG_FILE_NAME_SQLPLUS {}
  {SQL File Directory} SQL_FILE_DIRECTORY {}
  {SQL File Name} SQL_FILE_NAME {}

ORACLE BATCH_MAPPING {}
  {Deployable} DEPLOYABLE {true}
  {Language} GENERATION_LANGUAGE {UNDEFINED}
  {Generation Comments} GENERATION_COMMENTS {}
  {Referred Calendar} REFERRED_CALENDAR {}

ORACLE CUBE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Visible} VISIBLE {true}
  {Deployment Options} DEPLOYMENT_OPTIONS {DEPLOY_DATA_OBJECTS_ONLY}
  {Materialized View Index Tablespace} MATERIALIZED_VIEW_INDEX_TABLESPACE {USERS}
  {Materialized View Tablespace} MATERIALIZED_VIEW_TABLESPACE {USERS}

ORACLE CUBE {Summary Management}
  {Cost Based Aggregation} COSTBASEDPERCENTAGE {0}
  {Enable MV Refresh} ENABLE_MV_REFRESH {false}
  {Enable Query Rewrite} QUERY_REWRITE {DISABLE}
  {MV Constraints} MVCONSTRAINTS {TRUSTED}
  {Refresh Mode} REFRESH {FORCE}
  {Refresh Next Date} NEXTDATE {}
  {Refresh On} REFRESH_ON {DEMAND}
  {Refresh Start Date} STARTWITH {}

ORACLE CUBE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE DATA_AUDITOR {Code generation options}
  {Analyze table statements} ANALYZE_TABLE_STATEMENTS {true}
  {ANSI SQL Syntax } ANSI_SQL_SYNTAX {true}
  {Bulk processing code} BULK_PROCESSING_CODE {true}
  {Commit Control} COMMIT_CONTROL {AUTO_COMMIT}
  {Enable Parallel DML} ENABLE_PARALLEL_DML {true}
  {Error Trigger} ERROR_TRIGGER {}
  {Generation Mode} GENERATION_MODE {SET_BASED}
  {Optimized code} OPTIMIZED_CODE {true}
  {Use Target Load Ordering} TARGET_LOAD_ORDERING {true}

ORACLE DATA_AUDITOR {PL/SQL mapping debugger properties for stage}
  {Debug runtime connection.} DEBUG_RUNTIME_CONNECTION {}

ORACLE DATA_AUDITOR {Runtime parameters}
  {Analyze table sample percentage} ANALYZE_TABLE_SAMPLE_PERCENTAGE {90}
  {Bulk size} BULK_SIZE {50}
  {Commit frequency} COMMIT_FREQUENCY {1000}
  {Default audit level} DEFAULT_AUDIT_LEVEL {STATISTICS}
  {Default Operating Mode} DEFAULT_OPERATING_MODE {SET_BASED}
  {Default purge group} DEFAULT_PURGE_GROUP {WB}
  {Maximum number of errors} MAXIMUM_NUMBER_OF_ERRORS {50}

ORACLE DATA_AUDITOR {}
  {Deployable} DEPLOYABLE {true}
  {Language} GENERATION_LANGUAGE {UNDEFINED}
  {Generation Comments} GENERATION_COMMENTS {}
  {Referred Calendar} REFERRED_CALENDAR {}
  {Threshold Mode} THRESHOLD_MODE {PERCENTAGE}

ORACLE DATA_PROFILE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Application Short Name} APPLICATION_SHORT_NAME {WB}
  {Main Application Short Name} MAIN_APPLICATION_SHORT_NAME {ora}
  {Top Directory} TOP_DIRECTORY {..\..\codegen\}

ORACLE DATA_PROFILE {Deployment System Type}
  {PL/SQL Generation Mode} PLSQL_GENERATION_MODE {Default}

ORACLE DATA_PROFILE {Generation Preferences}
  {End of Line} END_OF_LINE {\r\n}

ORACLE DATA_PROFILE {Generation Target Directories}
  {8i.ORACLE8.1.SQLPLUSDIRECTORY} SQLPLUS_DIRECTORY {sqlplus\}
  {8i.ORACLE8.1.SQLPLUSEXTENSION} SQLPLUS_EXTENSION {.sql}
  {8i.ORACLE8.1.SQLPLUSRUNPRM} SQLPLUS_RUN_PARAMETER_FILE {_run.ini}
  {8i.ORACLE8.1.ZDTTDFEXTENSION} ZDT_EXTENSION {.tdf}
  {ABAP Extension} ABAP_EXTENSION {.abap}
  {ABAP Run Parameter File} ABAP_RUN_PARAMETER_FILE {_run.ini}
  {ABAP Spool Directory} ABAP_SPOOL_DIRECTORY {abap\log\}
  {DDL Directory} DDL_DIRECTORY {ddl\}
  {DDL Extension} DDL_EXTENSION {.ddl}
  {DDL Spool Directory} DDL_SPOOL_DIRECTORY {ddl\log\}
  {LIB Directory} LIB_DIRECTORY {lib\}
  {LIB Extension} LIB_EXTENSION {.lib}
  {LIB Spool Directory} LIB_SPOOL_DIRECTORY {lib\log\}
  {LOADER Directory} LOADER_DIRECTORY {ctl\}
  {LOADER Extension} LOADER_EXTENSION {.ctl}
  {LOADER Run Parameter File} LOADER_RUN_PARAMETER_FILE {_run.ini}
  {PL/SQL Directory} PLSQL_DIRECTORY {pls\}
  {PL/SQL Extension} PLSQL_EXTENSION {.pls}
  {PL/SQL Run Parameter File} PLSQL_RUN_PARAMETER_FILE {_run.ini}
  {PL/SQL Spool Directory} PLSQL_SPOOL_DIRECTORY {pls\log\}
  {Staging File Directory} ABAP_DIRECTORY {/tmp}
  {TCL Directory} TCL_DIRECTORY {tcl\}

ORACLE DATA_PROFILE {Run Time Directories}
  {Archive Directory} ARCHIVE_DIRECTORY {archive\}
  {Input Directory} INPUT_DIRECTORY {input\}
  {Invalid Directory} INVALID_DIRECTORY {invalid\}
  {Log Directory} LOG_DIRECTORY {log\}
  {Receive Directory} RECEIVE_DIRECTORY {receive\}
  {Sort Directory} SORT_DIRECTORY {sort\}
  {Work Directory} WORK_DIRECTORY {work\}

ORACLE DATA_PROFILE {Tablespace Defaults}
  {Default Index Tablespace} DEFAULT_INDEX_TABLESPACE {}
  {Default Object Tablespace} DEFAULT_OBJECT_TABLESPACE {}

ORACLE DIMENSION {Identification}
  {Deployable} DEPLOYABLE {true}
  {Visible} VISIBLE {true}
  {Deployment Options} DEPLOYMENT_OPTIONS {DEPLOY_DATA_OBJECTS_ONLY}
  {View Name} VIEW_NAME {}

ORACLE DIMENSION {Summary Management}
  {Enable MV Refresh} ENABLE_MV_REFRESH {false}
  {MV Constraints} MVCONSTRAINTS {TRUSTED}
  {Refresh Mode} REFRESH {FORCE}
  {Refresh Next Date} NEXTDATE {}
  {Refresh On} REFRESH_ON {DEMAND}
  {Refresh Start Date} STARTWITH {}

ORACLE DIMENSION {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE EXTERNAL_TABLE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Error Table Only} GENERATE_ERROR_TABLE_ONLY {false}

ORACLE EXTERNAL_TABLE {Parallel}
  {Parallel Access Drivers} PARALLEL_ACCESS_DRIVERS {1}
  {Parallel Access Mode} PARALLEL_ACCESS_MODE {false}

ORACLE EXTERNAL_TABLE {Reject}
  {Number Of Rejects Allowed} NUMBER_OF_REJECTS_ALLOWED {0}
  {Rejects Are Unlimited} REJECTS_ARE_UNLIMITED {true}

ORACLE EXTERNAL_TABLE {Access Specification}
  {Bad File Name} BAD_FILE_NAME {}
  {Discard File Name} DISCARD_FILE_NAME {}
  {Log File Name} LOG_FILE_NAME {}

ORACLE EXTERNAL_TABLE {Data Characteristics}
  {Endian} ENDIAN {PLATFORM}
  {String Sizes In} STRING_SIZES_IN {BYTES}

ORACLE EXTERNAL_TABLE {Error Table}
  {Error Table Name} ERROR_TABLE_NAME {}
  {Error Tablespace} ERROR_TABLESPACE {}

ORACLE EXTERNAL_TABLE {Field Editing}
  {Trim} TRIM {NONE}
  {Load Nulls When Missing Values} LOAD_NULLS_WHEN_MISSING_VALUES {false}

ORACLE EXTERNAL_TABLE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE FUNCTION {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE FUNCTION {Options}
  {AUTHID} AUTHID {}
  {Deterministic} IS_DETERMINISTIC {}
  {Parallel Enable} IS_PARALLEL_ENABLE {}
  {Pragma Autonomous Transaction} PRAGMA_AUTONOMOUS_TRANSACTION {}

ORACLE FUNCTION {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE MATERIALIZED_VIEW {Identification}
  {Deployable} DEPLOYABLE {true}
  {Error Table Only} GENERATE_ERROR_TABLE_ONLY {false}

ORACLE MATERIALIZED_VIEW {Parallel}
  {9i.MATERIALIZEDVIEWS.PARALLELDEGREE} PARALLEL_DEGREE {}
  {Parallel Access Mode} PARALLEL_ACCESS_MODE {}

ORACLE MATERIALIZED_VIEW {Default Index Options}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXBUFFERPOOL} DEFAULTINDEXBUFFERPOOL {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXFREELISTGROUPS} DEFAULTINDEXFREELISTGROUPS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXFREELISTS} DEFAULTINDEXFREELISTS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXINITIAL} DEFAULTINDEXINITIAL {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXINITRANS} DEFAULTINDEXINITRANS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXMAXEXTENTS} DEFAULTINDEXMAXEXTENTS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXMAXTRANS} DEFAULTINDEXMAXTRANS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXMINEXTENTS} DEFAULTINDEXMINEXTENTS {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXNEXT} DEFAULTINDEXNEXT {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXPCTINCREASE} DEFAULTINDEXPCTINCREASE {}
  {9i.MATERIALIZEDVIEWS.DEFAULTINDEXSTOREIN} DEFAULT_INDEX_TABLESPACE {}
  {Using Index Mode} USING_INDEX_MODE {}

ORACLE MATERIALIZED_VIEW {Error Table}
  {9i.MATERIALIZEDVIEWS.SHADOWTABLE.TABLENAME} ERROR_TABLE_NAME {}
  {9i.MATERIALIZEDVIEWS.SHADOWTABLE.TABLESPACE} ERROR_TABLESPACE {}

ORACLE MATERIALIZED_VIEW {Hash Partition Parameters}
  {Hash Partition Tablespace List} HASH_PARTITION_TABLESPACE_LIST {}

ORACLE MATERIALIZED_VIEW {Materialized View Parameters}
  {9i.MATERIALIZEDVIEWS.FORUPDATE} FOR_UPDATE {}
  {9i.MATERIALIZEDVIEWS.NEXTDATE} NEXTDATE {}
  {Build} BUILD {}
  {Constraints} CONSTRAINTS {}
  {On} REFRESH_ON {}
  {Refresh} REFRESH {}
  {Rollback} ROLLBACK {DEFAULT LOCAL}
  {Rollbacksegmentlocal} ROLLBACKSEGMENTLOCAL {}
  {Rollbacksegmentmaster} ROLLBACKSEGMENTMASTER {}
  {Startwith} STARTWITH {}
  {With} WITH_KEY {}
  {9i.MATERIALIZEDVIEWS.QUERY REWRITE} QUERY_REWRITE {}
  {Base Tables} BASE_TABLES {}
  {Reduced Precision} REDUCED_PRECISION {}

ORACLE MATERIALIZED_VIEW {Performance Parameters}
  {Buffer Cache } CACHE_MODE {}
  {Data Segment Compression} DATA_SEGMENT_COMPRESSION {}
  {Logging Mode} LOGGING_MODE {}

ORACLE MATERIALIZED_VIEW {Physical Attributes}
  {9i.MATERIALIZEDVIEWS.INITRANS} INITRANS {}
  {9i.MATERIALIZEDVIEWS.MAXTRANS} MAXTRANS {}
  {9i.MATERIALIZEDVIEWS.PCTFREE} PCTFREE {}
  {9i.MATERIALIZEDVIEWS.PCTUSED} PCTUSED {}

ORACLE MATERIALIZED_VIEW {Storage Space}
  {9i.MATERIALIZEDVIEWS.BUFFERPOOL} BUFFER_POOL {}
  {9i.MATERIALIZEDVIEWS.FREELISTGROUPS} FREELISTGROUPS {}
  {9i.MATERIALIZEDVIEWS.FREELISTS} FREELISTS {}
  {9i.MATERIALIZEDVIEWS.INITIAL} INITIAL {}
  {9i.MATERIALIZEDVIEWS.MAXEXTENTS} MAXEXTENTS {}
  {9i.MATERIALIZEDVIEWS.MINEXTENTS} MINEXTENTS {}
  {9i.MATERIALIZEDVIEWS.PCTINCREASE} PCTINCREASE {}
  {Next} NEXT {}
  {Tablespace} TABLESPACE {}

ORACLE MATERIALIZED_VIEW {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE NESTED_TABLE {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE NESTED_TABLE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE OBJECT_TYPE {IDENTIFICATION}
  {Deployable} DEPLOYABLE {true}

ORACLE OBJECT_TYPE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE ORACLE_MODULE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Application Short Name} APPLICATION_SHORT_NAME {WB}
  {Main Application Short Name} MAIN_APPLICATION_SHORT_NAME {ora}
  {Top Directory} TOP_DIRECTORY {..\..\codegen\}

ORACLE ORACLE_MODULE {Deployment System Type}
  {PL/SQL Generation Mode} PLSQL_GENERATION_MODE {Default}

ORACLE ORACLE_MODULE {Generation Preferences}
  {End of Line} END_OF_LINE {\r\n}

ORACLE ORACLE_MODULE {Generation Target Directories}
  {8i.ORACLE8.1.SQLPLUSDIRECTORY} SQLPLUS_DIRECTORY {sqlplus\}
  {8i.ORACLE8.1.SQLPLUSEXTENSION} SQLPLUS_EXTENSION {.sql}
  {8i.ORACLE8.1.SQLPLUSRUNPRM} SQLPLUS_RUN_PARAMETER_FILE {_run.ini}
  {8i.ORACLE8.1.ZDTTDFEXTENSION} ZDT_EXTENSION {.tdf}
  {ABAP Extension} ABAP_EXTENSION {.abap}
  {ABAP Run Parameter File} ABAP_RUN_PARAMETER_FILE {_run.ini}
  {ABAP Spool Directory} ABAP_SPOOL_DIRECTORY {abap\log\}
  {DDL Directory} DDL_DIRECTORY {ddl\}
  {DDL Extension} DDL_EXTENSION {.ddl}
  {DDL Spool Directory} DDL_SPOOL_DIRECTORY {ddl\log\}
  {LIB Directory} LIB_DIRECTORY {lib\}
  {LIB Extension} LIB_EXTENSION {.lib}
  {LIB Spool Directory} LIB_SPOOL_DIRECTORY {lib\log\}
  {LOADER Directory} LOADER_DIRECTORY {ctl\}
  {LOADER Extension} LOADER_EXTENSION {.ctl}
  {LOADER Run Parameter File} LOADER_RUN_PARAMETER_FILE {_run.ini}
  {PL/SQL Directory} PLSQL_DIRECTORY {pls\}
  {PL/SQL Extension} PLSQL_EXTENSION {.pls}
  {PL/SQL Run Parameter File} PLSQL_RUN_PARAMETER_FILE {_run.ini}
  {PL/SQL Spool Directory} PLSQL_SPOOL_DIRECTORY {pls\log\}
  {Staging File Directory} ABAP_DIRECTORY {abap\}
  {TCL Directory} TCL_DIRECTORY {tcl\}

ORACLE ORACLE_MODULE {Run Time Directories}
  {Archive Directory} ARCHIVE_DIRECTORY {archive\}
  {Input Directory} INPUT_DIRECTORY {input\}
  {Invalid Directory} INVALID_DIRECTORY {invalid\}
  {Log Directory} LOG_DIRECTORY {log\}
  {Receive Directory} RECEIVE_DIRECTORY {receive\}
  {Sort Directory} SORT_DIRECTORY {sort\}
  {Work Directory} WORK_DIRECTORY {work\}

ORACLE ORACLE_MODULE {Tablespace Defaults}
  {Default Index Tablespace} DEFAULT_INDEX_TABLESPACE {}
  {Default Object Tablespace} DEFAULT_OBJECT_TABLESPACE {}

ORACLE PACKAGE {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE PACKAGE {Options}
  {AUTHID} AUTHID {}

ORACLE PACKAGE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE PLSQL_RECORD_TYPE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE PROCEDURE {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE PROCEDURE {Options}
  {AUTHID} AUTHID {}
  {Deterministic} IS_DETERMINISTIC {}
  {Parallel Enable} IS_PARALLEL_ENABLE {}
  {Pragma Autonomous Transaction} PRAGMA_AUTONOMOUS_TRANSACTION {}

ORACLE PROCEDURE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE QUEUE_PROPAGATION {Generation Options}
  {Generate Database Link} GENERATE_DBLINK {true}
  {Generate Queue Propagation} GENERATE_QUEUE_PROPAGATION {true}
  {Generate Ruleset and Rule for Replication } GENERATE_REPLICATION_RULE {false}
  {Generate Schedule Propagation} GENERATE_SCHEDULE_PROPAGATION {true}

ORACLE QUEUE_PROPAGATION {Replication Option (Only for Streams queues)}
  {Not Permitted Tag Values} NOT_PERMITTED_TAG_VALUES {}
  {Permitted Tag Values} PERMITTED_TAG_VALUES {}

ORACLE QUEUE_PROPAGATION {Scheduling Options}
  {Duration} DURATION {}
  {Latency} LATENCY {60}
  {Next Time} NEXT_TIME {}
  {Start Time} START_TIME {SYSDATE}

ORACLE QUEUE_PROPAGATION {}
  {Deployable} DEPLOYABLE {true}
  {Transformation} SUBCRIBER_TRANSFORMATION {}
  {Generation Comments} GENERATION_COMMENTS {}
  {Rule Condition} SUBSCRIBER_RULE_CONDITION {}

ORACLE QUEUE_TABLE {Generation Options}
  {Generate Queue Table} GENERATE_QUEUE_TABLE {true}

ORACLE QUEUE_TABLE {Storage Space}
  {Tablespace} TABLESPACE {}

ORACLE QUEUE_TABLE {}
  {Deployable} DEPLOYABLE {true}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE SEQUENCE {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE SEQUENCE {Sequence Parameters}
  {Increment By} INCREMENT_BY {1}
  {Start With} START_WITH {1}

ORACLE SEQUENCE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE TABLE {Identification}
  {Deployable} DEPLOYABLE {true}
  {Error Table Only} GENERATE_ERROR_TABLE_ONLY {false}

ORACLE TABLE {Parallel}
  {Parallel Access Mode} PARALLEL_ACCESS_MODE {}
  {Parallel Degree} PARALLEL_DEGREE {}

ORACLE TABLE {Change Data Capture}
  {Enable} IS_CDC {false}
  {Table Position} CDC_POSITION {0}

ORACLE TABLE {Error Table}
  {Tablespace} ERROR_TABLESPACE {}
  {Error Table Name } ERROR_TABLE_NAME {}

ORACLE TABLE {Partition Parameters}
  {Overflow Tablespace List} OVERFLOW {}
  {Partition Tablespace List} PARTITION_TABLESPACE_LIST {}

ORACLE TABLE {Performance Parameters}
  {Buffer Cache} CACHE_MODE {}
  {Data Segment Compression} DATA_SEGMENT_COMPRESSION {}
  {Estimate Percent To Analyze Table} ANALYZE_TABLE_ESTIMATE_PERCENT {}
  {Logging Mode} LOGGING_MODE {}
  {Row Movement} ROW_MOVEMENT {}
  {Row-level Dependency} ROWDEPENDENCIES_MODE {}
  {Statistics Collection} MONITORING_MODE {}

ORACLE TABLE {Physical Attributes}
  {INITRANS} INITRANS {}
  {MAXTRANS} MAXTRANS {}
  {PCTFREE} PCTFREE {}
  {PCTUSED} PCTUSED {}

ORACLE TABLE {Storage Space}
  {BUFFER_POOL} BUFFER_POOL {}
  {FREELISTS} FREELISTS {}
  {INITIAL} INITIAL {}
  {MAXEXTENTS} MAXEXTENTS {}
  {MINEXTENTS} MINEXTENTS {}
  {NEXT} NEXT {}
  {PCTINCREASE} PCTINCREASE {}
  {Tablespace} TABLESPACE {}
  {FREELIST GROUPS} FREELISTGROUPS {}

ORACLE TABLE {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE TABLE_FUNCTION {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE TABLE_FUNCTION {Options}
  {AUTHID} AUTHID {}
  {Deterministic} IS_DETERMINISTIC {}
  {Parallel Enable} IS_PARALLEL_ENABLE {}
  {Pragma Autonomous Transaction} PRAGMA_AUTONOMOUS_TRANSACTION {}

ORACLE TABLE_FUNCTION {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE TYPED_QUEUE {Generation Options}
  {9i.ADVANCEDQUEUES.GENERATEAQ} GENERATE_ADVANCED_QUEUE {true}
  {9i.ADVANCEDQUEUES.GENERATETEMPTABLE} GENERATE_TEMPORARY_TABLE {true}

ORACLE TYPED_QUEUE {}
  {9i.ADVANCEDQUEUES.DEFAULT.DEPLOYABLE} DEPLOYABLE {true}
  {9i.ADVANCEDQUEUES.DEFAULT.MAXRETRIES} MAX_RETRIES {5}
  {9i.ADVANCEDQUEUES.DEFAULT.RETENTIONTIME} RETENTION_TIME {0}
  {9i.ADVANCEDQUEUES.DEFAULT.RETRYDELAY} RETRY_DELAY {0}
  {Dequeue Enabled} DEQUEUE_ENABLED {true}
  {Enqueue Enabled} ENQUEUE_ENABLED {true}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE VARYING_ARRAY {Identification}
  {Deployable} DEPLOYABLE {true}

ORACLE VARYING_ARRAY {}
  {Generation Comments} GENERATION_COMMENTS {}

ORACLE VIEW {Identification}
  {Deployable} DEPLOYABLE {true}
  {Error Table Only} GENERATE_ERROR_TABLE_ONLY {false}

ORACLE VIEW {Error Table}
  {Tablespace} ERROR_TABLESPACE {}
  {Error Table Name } ERROR_TABLE_NAME {}

ORACLE VIEW {}
  {Generation Comments} GENERATION_COMMENTS {}

SQLSERVER FUNCTION {Identification}
  {Deployable} DEPLOYABLE {true}

SQLSERVER FUNCTION {Options}
  {Encryption} ENCRYPTION {}
  {Execute As} EXECUTE_AS {}
  {Schema Binding} SCHEMABINDING {}
  {With Null Input} WITH_NULL_INPUT {}

SQLSERVER FUNCTION {}
  {Generation Comments} GENERATION_COMMENTS {}

SQLSERVER SQLSERVER_MODULE {GENERATION_TARGET_DIRECTORIES}
  {8i.SQLSERVER.1.CTLDIRECTORY} LOADER_DIRECTORY {ctl\}
  {8i.SQLSERVER.1.CTLEXTENSION} LOADER_EXTENSION {.ctl}
  {8i.SQLSERVER.1.CTLRUNPRM} LOADER_RUN_PARAMETER_FILE {_run.ini}

SQLSERVER TABLE {Change Data Capture}
  {Enable} IS_CDC {false}
  {Table Position} CDC_POSITION {0}

propertyNameList

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

propertyValueList

Comma separated list of property values. Property values are quoted.

getType

The object type that contains the property. (See setTemplateValuesClause for possible values.)

propertyValue

The new value for the property.

See Also

OMBCREATE

OMBALTER CONFIGURATION_TEMPLATE

OMBDROP CONFIGURATION_TEMPLATE

OMBCREATE CONNECTOR

Purpose

To create a connector.

Prerequisites

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

Syntax

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

Parameters

createConnectorCommand

Create a new connector. Connector name is specified as parent location name and a connector name separated by a slash as follows: 'LOCATION_NAME/NEW_CONNECTOR_NAME'.

setPropertiesClause

Set specified properties of the connector.

setReferenceToLocationClause

Set the name of the location which the connector references.

setReferenceIconSetClause

Set specified Icon Set.

propertyNameList

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

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.

propertyValueList

The values for the named properties.

propertyValue

A property value.

CONNECTOR Object

Table 6-9 CONNECTOR Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBCREATE

OMBALTER CONNECTOR

OMBDROP CONNECTOR

OMBCREATE CONTROL_CENTER

Purpose

To create a control center.

Prerequisites

Can be in any context.

Syntax

createControlCenterCommand =  OMBCREATE ( CONTROL_CENTER "QUOTED_STRING" (
          "createControlCenterSetPropertiesClause" [ SET
          "setReferenceIconSetClause" ] { "addReferenceLocationClause" } ) )
     createControlCenterSetPropertiesClause =  SET PROPERTIES "("
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addReferenceLocationClause =  ADD ( REF | REFERENCE ) LOCATION
          "QUOTED_STRING" [ SET "setPropertiesClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createControlCenterCommand

Create a new control center.

createControlCenterSetPropertiesClause

Set the specified properties of the control center.

setReferenceIconSetClause

Set the specified icon set.

addReferenceLocationClause

Add a referenced location and set the specified properties of that referenced location.

propertyNameList

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

propertyNameList

Properties for CONTROL_CENTER:

Name: HOST
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The host machine the control center is installed on.

Name: PORT
Type: NUMBER
Valid Values: 1 - 65535
Default: 1521
The port number of the database in which the control center is installed.

Name: SERVICE_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The service name of the database in which the control center is installed.

Name: USER
Synonym: USER_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The name of the database user you wish to connect to the control center as.

Name: PASSWORD
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The password.

Name: WORKSPACE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The name of the workspace to which to connect.

All of the preceding properties (except of PASSWORD) are mandatory for OMBCREATE CONTROL_CENTER.

Basic properties for CONTROL_CENTER:

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

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

Properties for a referenced location of the control center:

Name: IS_SOURCE
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, then a referenced location is a source location.

Name: IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, then a referenced location is a target location.

Name: CONNECTION_TYPE
Type: STRING
Valid Values: 'HOST_PORT_SERVICE', 'SQL_NET_CONNECTION'
Default: 'HOST_PORT_SERVICE'
The control center connection details format.

propertyValueList

The values for the named properties.

setPropertiesClause

Set the specified properties of the control center.

propertyValue

A property value.

CONTROL_CENTER Object

Table 6-10 CONTROL_CENTER Object

Property
Type
Choices
Min
Max
Default
Description

CONNECTION_TYPE

STRING

HOST:PORT:SERVICE, SQL*NET Connection

none

none

HOST:PORT:SERVICE

Type of J2EE connection to use

DISPLAY_TYPE

STRING

none

none

none

CMPLocation_RuntimeRepository

Type of the location

HOST

STRING

none

none

none

empty string

Host of the location

NET_SERVICE_NAME

STRING(2000)

none

none

none

empty string

Net Service Name of the location

PASSWORD

STRING(30)

none

none

none

empty string

PLATFORM_NAME

STRING

none

none

none

empty string

Platform for the location.

PORT

NUMBER

none

none

none

1521

SCHEMA

STRING

none

none

none

empty string

Workspace owner.name to use for deployment

SERVICE_NAME

STRING

none

none

none

empty string

Service name of the web service activity

USER

STRING

none

none

none

empty string

VERSION

STRING

none

none

none

0

Version of the location

See Also

OMBCREATE

OMBALTER CONTROL_CENTER

OMBDROP CONTROL_CENTER

OMBCREATE CONTROL_CT

Purpose

To create a Control Code Template.

Prerequisites

In the context of an CT module.

Syntax

createCCTCommand =  OMBCREATE CONTROL_CT "QUOTED_STRING" {
          "kmCreateOptionsOptionsClause" }
     kmCreateOptionsOptionsClause =  SET "setReferenceIconSetClause" | SET
          "setPropertiesClause" | ADD ( "addParameterClause" |
          "addVariableClause" | "addCTTaskClause" | "addNestedCTTaskClause" |
          "addTransitionClause" )
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     addParameterClause =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
           [ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
     addVariableClause =  VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
     addCTTaskClause =  "TASK_TYPE" TASK "QUOTED_STRING" {
          "kmTaskAddOptionsOptionsClause" }
     addNestedCTTaskClause =  NESTED_CT TASK "QUOTED_STRING" SET [
          "collectPropertiesClause" SET ] ( REF | REFERENCE ) CT "QUOTED_STRING"
           [ SET "setReferenceIconSetClause" ]
     addTransitionClause =  TRANSITION "QUOTED_STRING" FROM TASK "QUOTED_STRING"
           TO "QUOTED_STRING" [ SET "setPropertiesClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     parameterBindingClause =  UNBIND | BIND TO ( "parameterLocator" |
          "variableLocator" )
     kmTaskAddOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET
          "unsetReferenceIconSetClause" | SET "setPropertiesClause"
     collectPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     parameterLocator =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
     variableLocator =  VARIABLE "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

createCCTCommand

Creates an Integration CT. The following code template will be created by default:

{0}

setReferenceIconSetClause

Set icon set for the expert module.

setPropertiesClause

This clause sets properties for the corresponding object.

setPropertiesClause

Basic properties for Code Template:

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

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

Basic properties for TASK:

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

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

addParameterClause

Add a parameter to the expert or one of it's tasks.

addVariableClause

Add a variable to the expert.

addTransitionClause

Add a transition to the expert.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

parameterBindingClause

Bind or unbind two parameters. Note that this is setting the binding attribute of the parameter object and is not necessarily the same as the direction of data flow. The parameter to be set should be the one whose binding attribute is modified via the Object Inspector in the expert editor.

collectPropertiesClause

This clause sets properties for the corresponding object.

propertyValue

Value of a property.

parameterLocator

Specify a parameter, either one of the expert or of a task.

variableLocator

Specify a variable in the expert.

CONTROL_CT Object

Table 6-11 CONTROL_CT Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

PLATFORM

STRING

none

none

none

GENERIC

SOURCE_PLATFORM

STRING

none

none

none

GENERIC

See Also

OMBCREATE

OMBALTER CT

OMBRETRIEVE CT

OMBDROP CT

OMBCREATE CORRECTION_MAPS_ACTION_PLAN

Purpose

Create an action plan for creating correction maps.

Prerequisites

In the context of a data profile after creating a correction schema using a CORRECTION_SCHEMA_ACTION_PLAN.

Syntax

CreateActionPlanCommand =  ( OMBCREATE TRANSIENT ( ( DEPLOYMENT_ACTION_PLAN
           | ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
          CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" { "addActionClause" }
          )
     addActionClause =  ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
     setClause =  ( "propertiesClause" [ SET "setReferenceClause" ] ) |
          "setReferenceClause"
     propertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClause =  ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
          "useClause" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     useClause =  USE DATA_RULE_USAGE "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

CreateActionPlanCommand

Create a correction schema action plan.

CreateActionPlanCommand

Name: DATA_RULE_USAGE_NAME

Type: String

Valid Values: Any data rule usage name associated with the profile table

Name: ERROR_HANDLING_STRATEGY

Type: String

One of IGNORE REPORT CLEANSE

This property determines the action to take when the rule fails. If the action is cleanse, then a CORRECTION_STRATEGY

is used to determine the specific cleansing action.

Name: CORRECTION_STRATEGY

Type: String

One of DISCARD DOMAINSOUNDEX DOMAINSIMILARITY DISCARD MIN MAX FD_MAPLET FIX_REMOTE UK_MATCHMERGE

This property determines the correction action to take when the rule fails.

Not all correction strategies are supported with all data rule types.

All rule type have DISCARD, CUSTOM, and &lt;function name&gt; as strategies. The specific strategies for each rule types are:

Data Rule Type Correction Strategy

DOMAIN_LIST_RULE DOMAINSOUNDEX

DOMAINSIMILARITY

DOMAIN_RANGE_RULE MIN

MAX

FUNCTIONAL_DEPENDENCY_RULE FD_MAPLET

REFERENCE_RULE FIX_REMOTE

IDENTITY_RULE UK_MATCHMERGE

The CUSTOM rule type will generate an empty function in the schema. The generated map will call the function to correct the error.

The &lt;function name&gt; strategy allows the user to call an existing function to correct the error. The format of the strategy is:

'|SOURCE_MOD/CF_1(IN VARCHAR2, IN VARCHAR2, IN VARCHAR2)|SOURCE_MOD/CF_1(IN VARCHAR2, IN VARCHAR2, IN VARCHAR2)'

where a function signature delimited by | is entered for each attribute of the rule. A normal rule with a single input parameter will have only one function.

Name: CORRECTION_ORDER

Type: NUMBER

Valid Values: 1-any number

Optional: This sets the relative order of the data corrections.

addActionClause

Add an action to an action plan.

QUOTED_STRING

Action name.

setClause

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

propertiesClause

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

setReferenceClause

Associate an object with an action.

ObjType

Object type. The only valid value is DATA_PROFILE_TABLE.

propertyNameList

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

propertyValueList

Comma separated list of property values.

useClause

Currently used only in CORRECTION_SCHEMA_ACTION_PLAN.

propertyValue

Value of a property.

See Also

OMBPROFILE

OMBCREATE CORRECTION_SCHEMA_ACTION_PLAN

Purpose

Create an action plan for creating a correction schema, identifying the tables that will be mapped to that schema.

Prerequisites

In the context of a data profile. First do OMBCREATE DATA_RULE, and OMBALTER TABLE 'T' ADD DATA_RULE_USAGE, on the profile tables that will be mapped.

Syntax

CreateActionPlanCommand =  ( OMBCREATE TRANSIENT ( ( DEPLOYMENT_ACTION_PLAN
           | ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
          CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" { "addActionClause" }
          )
     addActionClause =  ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
     setClause =  ( "propertiesClause" [ SET "setReferenceClause" ] ) |
          "setReferenceClause"
     propertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClause =  ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
          "useClause" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     useClause =  USE DATA_RULE_USAGE "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

CreateActionPlanCommand

Create a correcton schmema action plan.

QUOTED_STRING

Action plan name.

addActionClause

Add an action to an action plan.

QUOTED_STRING

Action name.

setClause

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

propertiesClause

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

setReferenceClause

Associate an object with an action.

ObjType

Object type. The only valid value is DATA_PROFILE_TABLE.

propertyNameList

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

propertyValueList

Comma separated list of property values.

useClause

Use data rule in construction of correction schema.

QUOTED_STRING

Name of data rule usage.

propertyValue

Value of a property.

See Also

OMBPROFILE

OMBCREATE CT_FOLDER

Purpose

To create an CT (Code Template) folder.

Prerequisites

In the context of a project.

Syntax

createCTModuleCommand =  OMBCREATE CT_FOLDER "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

createCTModuleCommand

Create a CT (Code Template) folder.

setPropertiesClause

Set properties for the CT folder.

getPropertiesClause

Basic properties for CT_FOLDER:

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

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

setReferenceIconSetClause

Set icon set for the CT folder.

propertyNameList

The list of properties to set.

propertyValueList

The list of property values to set.

propertyValue

The value of the property.

See Also

OMBCREATE

OMBALTER CT_FOLDER

OMBDROP CT_FOLDER

OMBCREATE CUBE

Purpose

This command creates a Cube.

Prerequisites

Should be in Oracle Module context.

Syntax

createCubeCommand =  OMBCREATE CUBE "cubeName" [ SET ( (
          "setPropertiesClause" [ SET "setReferenceIconSetClause" ] ) |
          "setReferenceIconSetClause" ) ] [ "setCubeAggFunctionClause" ] { ADD (
           "addMeasureClause" | "addDimensionUseClause" |
          "addCompositeDimensionClause" ) } [ "cubeImplementationClause" ]
     cubeName =  "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setCubeAggFunctionClause =  SET AGGREGATE_FUNCTION TO "aggFunctionName"
     addMeasureClause =  MEASURE "measureName" [ SET "setPropertiesClause" ] [
          "setAggFunctionClause" ] [ "setPreComputedLevelsClause" ] [
          "setCalcExprClause" ]
     addDimensionUseClause =  DIMENSION_USE "dimensionUseName" [ SET
          "setPropertiesClause" ] [ "setDimensionUseReferenceClause" ] [ AT
          POSITION "INTEGER_LITERAL" ]
     addCompositeDimensionClause =  COMPOSITE_DIMENSION "compositeDimensionName"
           [ SET "setPropertiesClause" ] [
          "setCompositeDimensionReferenceClause" ]
     cubeImplementationClause =  IMPLEMENTED BY ( ( "cubeBindingClause" {
          "measureBindingClause" | "dimensionUseBindingClause" } ) |
          "cubeAutoBindingClause" )
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     aggFunctionName =  "QUOTED_STRING"
     measureName =  "QUOTED_STRING"
     setAggFunctionClause =  SET AGGREGATE_FUNCTIONS "aggFunctionList" FOR
          DIMENSIONS "dimensionList"
     setPreComputedLevelsClause =  SET PRECOMPUTE_LEVELS "preComputedLevelList"
     setCalcExprClause =  SET CALCULATED_EXPRESSION "(" "calcExpr" ")"
     dimensionUseName =  "QUOTED_STRING"
     setDimensionUseReferenceClause =  [ USE ROLE "roleName" ] SET ( REF |
          REFERENCE ) [ LEVEL "levelName" OF ] DIMENSION "dimensionName"
     compositeDimensionName =  "QUOTED_STRING"
     setCompositeDimensionReferenceClause =  SET ( REF | REFERENCE ) DIMENSIONS
          "(" "dimensionName" { "," "dimensionName" } ")"
     cubeBindingClause =  ( TABLE "tableName" | VIEW "viewName" )
     measureBindingClause =  "measureLocator" BOUND TO COLUMN "columnName"
     dimensionUseBindingClause =  "dimensionUseLocator" BOUND TO COLUMN
          "columnName"
     cubeAutoBindingClause =  SYSTEM
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     aggFunctionList =  "(" "aggFunction" { "," "aggFunction" } ")"
     dimensionList =  "(" "dimension" { "," "dimension" } ")"
     preComputedLevelList =  "(" "preComputedLevel" { "," "preComputedLevel" }
          ")"
     calcExpr =  "QUOTED_STRING"
     roleName =  "QUOTED_STRING"
     levelName =  "QUOTED_STRING"
     dimensionName =  "QUOTED_STRING"
     tableName =  "QUOTED_STRING"
     viewName =  "QUOTED_STRING"
     measureLocator =  MEASURE "measureName"
     columnName =  "QUOTED_STRING"
     dimensionUseLocator =  DIMENSION_USE "dimensionUseName"
     aggFunction =  "QUOTED_STRING"
     dimension =  "QUOTED_STRING"
     preComputedLevel =  "QUOTED_STRING"

Parameters

createCubeCommand

This command creates a cube.

cubeName

The name of the cube.

setPropertiesClause

Sets the properties of the cube.

setPropertiesClause

Basic properties for CUBE, MEASURE and  DIMENSION_USE:

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

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

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: 'true', 'false'
Default: 'true'
The dimension is visible to OLAP end user

Name: UNIQUE_KEY_CONSTRAINT
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
set the Unique Key constraint on the Business Key

Name: STORAGE
Type: STRING
Valid Values: 'RELATIONAL', 'MOLAP'
Default: 'RELATIONAL'
The storage of a cube can be relational or molap

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

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

Name: USE_GLOBAL_INDEX
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Sets the flag to say whether to generate a composite for measure partition combination

Name: BITMAP_INDEX
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Sets the flag to say whether to generate a bitmap for a cube

Name: SUMMARY_REFRESH_METHOD
Type: STRING
Valid Values: 'On Demand', 'On Commit'
Default: 'On Commit'
Sets the Solve flag for Relational Cube whether to solve the cube 'On Demand' or 'On Commit'

Name: SPARSITY_ULTRA_COMPRESS
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Sets the flag to say whether its a compressed cube. Only valid for Molap cube.

setPropertiesClause

Name: LOAD_POLICY_FOR_NULL_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_DIMENSION_RECORD'
Default: 'NO_MAINTENANCE'
Data policy for loading cube where OWB mapping code relies on
database constraints to detect the orphans (null parent references).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_DIMENSION_RECORD', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

Name: LOAD_POLICY_FOR_INVALID_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_DIMENSION_RECORD'
Default: 'NO_MAINTENANCE'
Data policy for loading cube where OWB mapping code relies on
database constraints to detect the orphans (could contain a value that is not actually found in the parent).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_DIMENSION_RECORD', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

setReferenceIconSetClause

References to ICONSET.

setCubeAggFunctionClause

This clauses sets the AGGREGATE_FUNCTION.

addMeasureClause

This clause add a measure.

addDimensionUseClause

This clause adds a dimension use clause.

addCompositeDimensionClause

This clause creates a COMPOSITE_DIMENSION.

cubeImplementationClause

This clause creates the IMPLEMENTED object, Table or View.

propertyKeyList

This clause sets a list of properties.

propertyValueList

Part of the property list values.

aggFunctionName

Name of aggregation function name.

measureName

Name of a measure.

setAggFunctionClause

The is clause sets AGGREGATE_FUNCTIONS FOR DIMENSIONS.

setPreComputedLevelsClause

This clause sets the PRECOMPUTE_LEVELS.

setCalcExprClause

This clause sets CALCULATED_EXPRESSION

dimensionUseName

Dimension Use's name.

setDimensionUseReferenceClause

This clause sets ROLE, LEVEL, DIMENSION

compositeDimensionName

Name of the composite dimension.

setCompositeDimensionReferenceClause

This clause sets a reference to a composite dimension.

cubeBindingClause

This clause binds a cube to a TABLE or VIEW.

measureBindingClause

This clause bind a measure to a COLUMN.

dimensionUseBindingClause

This clause binds a dimension use to a COLUMN.

cubeAutoBindingClause

Auto binding using SYSTEM.

propertyKey

The property key name.

propertyValue

The property value in QUOTED_STRING, INTEGER_LITERAL, or FLOATING_POINT_LITERAL.

aggFunctionList

Aggregation function list.

dimensionList

Dimension List.

preComputedLevelList

Precompute Level list.

calcExpr

Name of the Calculated Express in QUOTED_STRING.

roleName

Name of the role in QUOTED_STRING.

levelName

Name of level name in QUOTED_STRING.

dimensionName

Name of dimension name in QUOTED_STRING.

tableName

Name of in table name in QUOTED_STRING.

viewName

Name of view name in QUOTED_STRING.

measureLocator

This clause finds the MEASURE.

columnName

Name of a column in QUOTED_STRING.

dimensionUseLocator

This clause finds the DIMENSION_USE.

aggFunction

Name of aggregated function QUOTED_STRING

dimension

Name of dimension QUOTED_STRING

preComputedLevel

Name of pre-computed level in QUOTED_STRING

CUBE Object

Table 6-12 CUBE Object

Property
Type
Choices
Min
Max
Default
Description

COSTBASEDPERCENTAGE

NUMBER

none

none

none

0

Cost Based Aggregation

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_AGGREGATION, DEPLOY_ALL, DEPLOY_DATA_OBJECTS_ONLY, DEPLOY_TO_CATALOG_ONLY

none

none

DEPLOY_DATA_OBJECTS_ONLY

Warehouse Builder generates a set of scripts for cube, they are DDL Scripts for Relational Cube or Scripts for OLAP API-II or Scripts for AW.

ENABLE_MV_REFRESH

BOOLEAN

true, false

none

none

false

Enable MV Refresh

ERROR_TABLE_COLUMN_NAMES

STRING

none

none

none

empty string

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

MATERIALIZED_VIEW_INDEX_TABLESPACE

STRING

none

none

none

USERS

Tablespace for materialized view indexes.

MATERIALIZED_VIEW_TABLESPACE

STRING

none

none

none

USERS

Tablespace for materialized view.

MVCONSTRAINTS

STRING

, ENFORCED, TRUSTED

none

none

TRUSTED

MV Constraints

NEXTDATE

STRING

none

none

none

empty string

Refresh Next Date

QUERY_REWRITE

STRING

, DISABLE, ENABLE

none

none

DISABLE

Enable Query Rewrite

REFRESH

STRING

, COMPLETE, FAST, FORCE

none

none

FORCE

Refresh Mode

REFRESH_ON

STRING

, COMMIT, DEMAND, ONDATE

none

none

DEMAND

Refresh On

STARTWITH

STRING

none

none

none

empty string

Refresh Start Date

VISIBLE

BOOLEAN

true, false

none

none

true

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

See Also

OMBCREATE

OMBALTER CUBE

OMBRETRIEVE CUBE

OMBDROP CUBE

7 OMBCREATE DATA_AUDITOR to OMBCREATE INTEGRATION_CT

OMBCREATE DATA_AUDITOR

OMBCREATE DATA_PROFILE

OMBCREATE DATA_RULE

OMBCREATE DATA_RULE_MODULE

OMBCREATE DEPLOYMENT

OMBCREATE DEPLOYMENT_ACTION_PLAN

OMBCREATE DIMENSION

OMBCREATE DRILL_PATH

OMBCREATE DRILL_TO_DETAIL

OMBCREATE EXPERT

OMBCREATE EXPERT_MODULE

OMBCREATE EXTERNAL_TABLE

OMBCREATE FLAT_FILE

OMBCREATE FLAT_FILE_MODULE

OMBCREATE FOLDER

OMBCREATE FUNCTION

OMBCREATE FUNCTION_CT

OMBCREATE GATEWAY_MODULE

OMBCREATE ICONSET

OMBCREATE IMPORT_ACTION_PLAN

OMBCREATE INTEGRATION_CT

OMBCREATE DATA_AUDITOR

Purpose

Create a data auditor in an Oracle Module.

Prerequisites

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

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

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

Syntax

createDataAuditorCommand =  OMBCREATE DATA_AUDITOR "dataAuditorName" [ SET
          ( ( "setPropertiesClause" [ SET "setReferenceIconSetClause" ] ) |
          "setReferenceIconSetClause" ) ] { ADD "addOperatorClause" }
     dataAuditorName =  "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addOperatorClause =  "operatorType" OPERATOR "operatorName" [ SET
          "setPropertiesClause" ] [ BOUND TO "setBindingClause" ]
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     operatorType =  "UNQUOTED_STRING"
     operatorName =  "QUOTED_STRING"
     setBindingClause =  "bindableLocator"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     bindableLocator =  "bindableType" "bindableName"
     bindableType =  "UNQUOTED_STRING"
     bindableName =  "QUOTED_STRING"

Parameters

createDataAuditorCommand

Create a data auditor in an Oracle Module.

dataAuditorName

Name of data auditor.

setPropertiesClause

Set the properties of the data auditor.

setReferenceIconSetClause

Set icon set for the data auditor.

addOperatorClause

Adds an operator to a data auditor.OMBCREATE DATA_AUDITOR 'MAP1'

SET PROPERTIES (business_name, description)

VALUES ('My map', 'Audit table foo')

ADD TABLE OPERATOR 'CUST_SRC'

BOUND TO TABLE '../SRC_MODULE/CUST_SRC'

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

operatorType

Type of a mapping operator. The following operator types are available: CUBE, DIMENSION, MATERIALIZED_VIEW, TABLE, VIEW.

operatorName

Name of an operator.

setBindingClause

Set the binding during the creation of a operator.

propertyKey

A property key for an object.

propertyKey

Basic properties for DATA_AUDITOR:

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

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

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

#

propertyValue

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

bindableLocator

Location of the object to be bound to an operator.

bindableType

Type of object bound to an operator.

bindableName

Name of the object bound to operator.

DATA_AUDITOR Object

Table 7-1 DATA_AUDITOR Object

Property
Type
Choices
Min
Max
Default
Description

ANALYZE_TABLE_SAMPLE_PERCENTAGE

NUMBER

none

none

none

90

The default percentage of rows to be sampled when the target tables are analyzed for statistics to improve performance during insertion.

ANALYZE_TABLE_STATEMENTS

BOOLEAN

true, false

none

none

true

Generate statistics collection statement if this is true.

ANSI_SQL_SYNTAX

BOOLEAN

true, false

none

none

true

A switch between ANSI and Oracle SQL Syntax.

BULK_PROCESSING_CODE

BOOLEAN

true, false

none

none

true

Generate bulk processing code if this is true.

BULK_SIZE

NUMBER

none

none

none

50

COMMIT_CONTROL

STRING

AUTO_COMMIT, AUTO_CORR_COMMIT, MANUAL_COMMIT

none

none

AUTO_COMMIT

Options for how commit is performed

COMMIT_FREQUENCY

NUMBER

none

none

none

1000

DEBUG_RUNTIME_CONNECTION

STRING

none

none

none

empty string

Runtime schema connection info for debug.

DEFAULT_AUDIT_LEVEL

STRING

COMPLETE, ERROR_DETAILS, NONE, STATISTICS

none

none

STATISTICS

The default audit level when the step is executed.

DEFAULT_OPERATING_MODE

STRING

ROW_BASED, ROW_BASED_TARGET_ONLY, SET_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY

none

none

SET_BASED

The default operating mode.

DEFAULT_PURGE_GROUP

STRING

none

none

none

WB

The default purge group to be used when the step is executed.

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

ENABLE_PARALLEL_DML

BOOLEAN

true, false

none

none

false

Determine if PDML is enabled at runtime.

ERROR_TRIGGER

STRING

none

none

none

empty string

Error trigger procedure name.

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

PLSQL, UNDEFINED

none

none

UNDEFINED

The language used when generating code for the mapping.

GENERATION_MODE

STRING

ALL_MODES, ROW_BASED, ROW_BASED_TARGET_ONLY, SET_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY

none

none

SET_BASED

The operating modes for which code should be generated.

MAXIMUM_NUMBER_OF_ERRORS

NUMBER

none

none

none

50

The default maximum number of errors encountered before aborting the step execution.

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.

OPTIMIZED_CODE

BOOLEAN

true, false

none

none

true

Attempt to generate optimized code if this is true.

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.

TARGET_LOAD_ORDERING

BOOLEAN

true, false

none

none

true

Generate target load ordering code.

THRESHOLD_MODE

STRING

PERCENTAGE, SIX_SIGMA

none

none

PERCENTAGE

Use six sigma or percentage for failure thresholds.

OPERATOR Object

Table 7-2 OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBCREATE DATA_AUDITOR

OMBALTER DATA_AUDITOR

OMBRETRIEVE DATA_AUDITOR

OMBDROP DATA_AUDITOR

OMBCREATE DATA_PROFILE

Purpose

To create a Data Profile.

Prerequisites

Should be in the context of project.

Syntax

createDataProfileCommand =  OMBCREATE ( DATA_PROFILE "QUOTED_STRING" [ SET
          ( "setPropertiesClause" [ SET "setReferenceClause" ] |
          "setReferenceClause" ) ] { ADD ( TABLE | VIEW | EXTERNAL_TABLE |
          MATERIALIZED_VIEW | DIMENSION | CUBE | FLAT_FILE ) "QUOTED_STRING" [
          USING ATTRIBUTE_SET "QUOTED_STRING" ] [ LIMIT_COLUMNS ] } )
     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

createDataProfileCommand

This command creates a Data Profile

QUOTED_STRING

Name of the Data Profile to be created.

LIMIT_COLUMNS

Limit the number of columns profiled to the maximum number allowed by data profiling.

setPropertiesClause

Associate a set of properties with a 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

The location where the profile will be deployed.

propertyNameList

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

propertyValueList

Comma separated list of property values.

setReferenceLocationClause

Set a location to a Data Profile.

setReferenceIconSetClause

Set icon set for the profile.

propertyValue

Value of a property.

See Also

OMBCREATE

OMBALTER DATA_PROFILE

OMBDROP DATA_PROFILE

OMBCREATE DATA_RULE

Purpose

Create a DataRule rule in an dataRule rule Module.

Prerequisites

1. The current context of scripting must be an DataRule Rule Module.

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

3. The rule name must not conflict with existing rule names.

Syntax

createDataRuleCommand =  OMBCREATE ( DATA_RULE "QUOTED_STRING" [ SET (
          "setInitialPropertiesClause" [ SET "setReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) ] [ ADD "addDomainValueClause" ] )
     setInitialPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES
          "(" "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addDomainValueClause =  ( DOMAIN_VALUE "QUOTED_STRING" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createDataRuleCommand

Create a data rule.

QUOTED_STRING

Data rule name.

setInitialPropertiesClause

Set properties associated with the created data rule. The property RULE_TYPE must be set.

setReferenceIconSetClause

Set icon set for the data rule.

addDomainValueClause

Add a domain value.

QUOTED_STRING

Domain value.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

See Also

OMBCREATE

OMBALTER DATA_RULE

OMBDROP DATA_RULE

OMBCREATE DATA_RULE_MODULE

Purpose

To create a data rule module.

Prerequisites

Should be in the context of project.

Syntax

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

Parameters

createDataRuleModuleCommand

Create data rule module.

QUOTED_STRING

Data rule module name.

setPropertiesClause

Set the properties of the data rule module.

setPropertiesClause

Basic properties for DATA_RULE_MODULE:

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

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

setReferenceIconSetClause

Set icon set for the data rule module.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

See Also

OMBCREATE

OMBALTER DATA_RULE_MODULE

OMBCREATE DEPLOYMENT

Purpose

To create a Deployment.

Prerequisites

Should be in the context of CONFIGURATION.

Syntax

createDeploymentCommand =  OMBCREATE ( DEPLOYMENT "QUOTED_STRING" [ SET
          "setPropertiesClause" ] [ "setReferenceControlCenterClause" ] [
          "setReferenceRemoteAgentClause" ] [ "setAsActiveClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceControlCenterClause =  SET ( REFERENCE | REF ) CONTROL_CENTER
          "QUOTED_STRING"
     setReferenceRemoteAgentClause =  SET ( REFERENCE | REF ) AGENT
          "QUOTED_STRING"
     setAsActiveClause =  SET AS ACTIVE
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createDeploymentCommand

This command creates a Deployment.

setPropertiesClause

Associate a set of properties with a Deployment.

setPropertiesClause

Basic properties for DEPLOYMENT:

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

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

setReferenceControlCenterClause

Sets the Control Center the Deployment.

setReferenceRemoteAgentClause

Sets the Remote Agent for the Deployment.

setAsActiveClause

Sets this Deployment as Active.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

See Also

OMBCREATE

OMBALTER DEPLOYMENT

OMBDROP DEPLOYMENT

OMBCREATE DEPLOYMENT_ACTION_PLAN

Purpose

Create a deployment action plan.

Prerequisites

There must be a current working project.

Syntax

CreateActionPlanCommand =  ( OMBCREATE TRANSIENT ( ( DEPLOYMENT_ACTION_PLAN
           | ANALYZE_ACTION_PLAN | CORRECTION_SCHEMA_ACTION_PLAN |
          CORRECTION_MAPS_ACTION_PLAN ) ) "QUOTED_STRING" { "addActionClause" }
          )
     addActionClause =  ADD ACTION "QUOTED_STRING" [ SET "setClause" ]
     setClause =  ( "propertiesClause" [ SET "setReferenceClause" ] ) |
          "setReferenceClause"
     propertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClause =  ( REF | REFERENCE ) "ObjType" "QUOTED_STRING" {
          "useClause" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     useClause =  USE DATA_RULE_USAGE "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

CreateActionPlanCommand

Create a deployment action plan.

QUOTED_STRING

Name of the action plan in a single-quoted string. It is case-insensitive. Must be unique within a project.

addActionClause

Add an action to an action plan.

QUOTED_STRING

Name of the action in a single-quoted string. It is case-insensitive. Must be unquie within an action plan.

setClause

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

propertiesClause

Associate a set of properties with an action.

PROPERTIES

OPERATION, which specifies the type of action to be taken. DEPLOYMENT_LOCATION, which sets the target location for a Code Template.

setReferenceClause

Associate an object with an action.

ObjType

Object type. Valid values are ADVANCED_QUEUE, CUBE, DIMENSION, EXTERNAL_TABLE, CONNECTOR, FUNCTION, MAPPING, MATERIALIZED_VIEW, PROCEDURE, PROCESS_FLOW_PACKAGE, SCHEDULABLE, SEQUENCE, TABLE, and VIEW.

QUOTED_STRING

Absolute or relative path name of an object (e.g. '/MY_PROJECT/MODULE_X/TABLE_Y'). Global objects (for example public transforms), require a relative path.

propertyNameList

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

propertyValueList

Comma separated list of property values.

useClause

Currently used only in CORRECTION_SCHEMA_ACTION_PLAN.

propertyValue

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

OMBCREATE DIMENSION

Purpose

This command creates a dimension.

Prerequisites

Should be in Oracle Module context.

Syntax

createDimensionCommand =  OMBCREATE DIMENSION "dimensionName" [
          "setPropertiesClause" ] [ "setReferenceIconSetClause" ] [
          "setDimensionKeySequenceClause" ] [ ADD
          "addSurrogateKeyDimensionAttributeClause" ] [ ADD
          "addParentKeyDimensionAttributeClause" ] { ADD (
          "addDimensionAttributeClause" | "addDimensionRoleClause" |
          "addLevelClause" | "addLevelAttributeClause" | "addHierarchyClause" |
          "addSkipLevelsClause" ) } [ "createDimensionBindingClause" ]
     dimensionName =  "QUOTED_STRING"
     setPropertiesClause =  SET PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  SET ( REFERENCE | REF ) ICONSET
          "QUOTED_STRING"
     setDimensionKeySequenceClause =  SET ( REF | REFERENCE ) SEQUENCE
          "sequenceName"
     addSurrogateKeyDimensionAttributeClause =  DIMENSION_ATTRIBUTE
          "dimensionAttributeName" SET AS SURROGATE_KEY [ "setPropertiesClause"
          ]
     addParentKeyDimensionAttributeClause =  DIMENSION_ATTRIBUTE
          "dimensionAttributeName" SET AS PARENT_KEY [ "setPropertiesClause" ]
     addDimensionAttributeClause =  DIMENSION_ATTRIBUTE "dimensionAttributeName"
           [ SET AS BUSINESS_KEY ] [ "setPropertiesClause" ]
     addDimensionRoleClause =  DIMENSION_ROLE "roleName" [ "setPropertiesClause"
           ]
     addLevelClause =  LEVEL "levelName" [ "setPropertiesClause" ]
     addLevelAttributeClause =  LEVEL_ATTRIBUTE "levelAttributeName" OF
          "levelLocator" [ "setPropertiesClause" ]
          "setLevelAttributeReferenceClause"
     addHierarchyClause =  HIERARCHY "hierarchyName" [ "setPropertiesClause" ] [
           "hierarchyLevelReferenceClause" ]
     addSkipLevelsClause =  SKIP_LEVELS FROM "levelLocator" TO "levelLocator" IN
           "hierarchyLocator"
     createDimensionBindingClause =  IMPLEMENTED BY ( SYSTEM ( STAR  | SNOWFLAKE
            ) | STAR ( ( DIMENSION_KEY BOUND TO COLUMN "columnName" (
          "levelBindingClause" { "levelAttributeBindingClause" } )+ {
          "setBindRelationshipClause" } [ "setSkipBindRelationshipClause" ] ) )
          | SNOWFLAKE ( ( ( "levelBindingClause" { "levelAttributeBindingClause"
           } )+ { "setBindRelationshipClause" } [
          "setSkipBindRelationshipClause" ] ) ) )
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     sequenceName =  "QUOTED_STRING"
     dimensionAttributeName =  "QUOTED_STRING"
     roleName =  "QUOTED_STRING"
     levelName =  "QUOTED_STRING"
     levelAttributeName =  "QUOTED_STRING"
     levelLocator =  LEVEL "levelName"
     setLevelAttributeReferenceClause =  SET ( REF | REFERENCE ) (
          "dimensionAttributeLocator" [ TYPE_THREE_SCD_PREVIOUS
          "levelAttributeLocator" ] )
     hierarchyName =  "QUOTED_STRING"
     hierarchyLevelReferenceClause =  SET ( REF | REFERENCE ) LEVELS "("
          "levelName" { "," "levelName" } ")"
     hierarchyLocator =  HIERARCHY "hierarchyName"
     columnName =  "QUOTED_STRING"
     levelBindingClause =  "levelLocator" BOUND TO ( TABLE "tableName" | VIEW
          "viewName" )
     levelAttributeBindingClause =  LEVEL_ATTRIBUTE "levelAttributeName" OF
          LEVEL "levelName" BOUND TO COLUMN "columnName"
     setBindRelationshipClause =  LEVEL_RELATIONSHIP OF "levelLocator" IN
          "hierarchyLocator" BOUND TO COLUMN "columnName"
     setSkipBindRelationshipClause =  SKIP_LEVEL_RELATIONSHIP OF "levelLocator"
          IN "hierarchyLocator" BOUND TO COLUMN "columnName"
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     dimensionAttributeLocator =  DIMENSION_ATTRIBUTE "dimensionAttributeName"
     levelAttributeLocator =  LEVEL_ATTRIBUTE "levelAttributeName"
     tableName =  "QUOTED_STRING"
     viewName =  "QUOTED_STRING"

Parameters

createDimensionCommand

This clause alter the properties of a dimension.

dimensionName

The name of the dimension in QUOTED_STRING.

setPropertiesClause

This clause sets the PROPERTIES.

setPropertiesClause

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

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

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

Name: SCD_TYPE
Type: INTEGER
Valid Values: 1, 2, 3
Default: 1
Slowly changing policy to be applied on the dimension. Give Integer values 1, 2, 3
for Slowly changing type one, two and three

Name: LOAD_POLICY_FOR_NULL_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_PARENT'
Default: 'NO_MAINTENANCE'
Data policy for loading dimension where OWB mapping code relies on
database constraints to detect the orphans (null parent references).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_PARENT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

Name: LOAD_POLICY_FOR_INVALID_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_PARENT'
Default: 'NO_MAINTENANCE'
Data policy for loading dimension where OWB mapping code relies on
database constraints to detect the orphans (could contain a value that is not actually found in the parent).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_PARENT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

Name: REMOVE_POLICY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT'
Default: 'NO_MAINTENANCE'
Data policy for remove dimension data where OWB relies on database
constraints to detect removal of parent records who still have child records.
'NO_MAINTENANCE', does not actively enforce the parentage integrity rule that requires
every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', data policy for loading dimension where OWB mapping code will actively
reject the removal of parent records who still have child records.
#'CASCADE', data policy for removing dimension data where OWB mapping code will
#actively detect the removal of parent records who still have child records,
#and remove all of the descendents.

setPropertiesClause

Name: TYPE
Type: STRING
Valid Values: 'NONE', 'TIME'
Default: 'NONE'
'NONE'  it does not recognize it as any specific type of dimension.
'TIME' dimension is a time dimension

Name: OLAP_TYPE
Type: STRING
Valid Values: NONE, TIME
Default: NONE
Dimension type for OLAP, get regular dimension 'NONE' and for OLAP Time Dimension 'TIME'

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The dimension is visible to OLAP end user

Name: UNIQUE_KEY_CONSTRAINT
Type: STRING
Valid Values: true, false
Default: false
set the Unique Key constraint on the Business Key

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

Name: AW_NAME
Type: STRING(32)
Valid Values: 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

Name: USE_BUSINESS_KEYS
Type: STRING
Valid Values: true, false
Default: false
Set the flag for Analytical Workspace dimension to use Business Keys as data source

setPropertiesClause

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
Description of the Dimension_Attribute

Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH TIME ZONE, TIMESTAMP WITH LOCAL TIME ZONE, VARCHAR, VARCHAR2
Default: NUMBER
Sets the datatype of a Dimension_Attribute

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

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

Name: PRECISION
Type: NUMBER
Valid Values: 0 - 39
Default: 1
The precision of a number.

setPropertiesClause

Name: DESCRIPTOR
Type: STRING
Valid Values: NONE, SHORT_DESCRIPTION, LONG_DESCRIPTION, END_DATE, TIME_SPAN, PRIOR_PERIOD, YEAR_AGO_PERIOD
Default: NONE
The following properties are set on dimension attribute so that it is recognized by OLAP service
'NONE' it is not specially recognized type by OLAP service
'SHORT_DESCRIPTION' sets as a short description
'LONG_DESCRIPTION' sets as a long description
'END_DATE' sets as a last date of a period.
'TIME_SPAN' sets as a number of days in a period.
'PRIOR_PERIOD' sets as the prior period number.
'YEAR_AGO_PERIOD' sets as the time period a year before this period

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The dimension attribute is visible to OLAP end user

setPropertiesClause

Name: TYPE
Type: STRING
Valid Values: NONE, START_DATE, END_DATE, TIME_SPAN
Default: NONE
'NONE'  dimension attribute so OWB does not recognize it as any specific type.
'START_DATE' dimension attribute of time dimension as the start date of a period
'END_DATE' dimension attribute of time dimension as the end date of a period
'TIME_SPAN' dimension attribute of time dimension as the time span

Name: AW_ATTRIBUTE_NAME
Type: STRING(32)
Valid Values: Any valid character string in supported character set.
Default: Empty string
set the AW object name implementing the dimension attribute

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

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

Name: TYPE
Type: STRING
Valid Values: NONE, DAY, FISCAL_WEEK, FISCAL_MONTH, FISCAL_QUARTER, FISCAL_YEAR, CALENDAR_WEEK, CALENDAR_MONTH, CALENDAR_QUARTER, CALENDAR_YEAR
Default: NONE
For regular relational dimension level (non-time dimension level) use 'NONE'. For relational time dimension use other values.

Name: OLAP_TYPE
Type: STRING
Valid Values: NONE,DAY,MONTH,QUARTER,YEAR,TOTAL
Default: NONE
Level has an olap-type for OLAP-based levels; use 'NONE' for regular levels, and other values for OLAP Time Dimension

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The level is visible to OLAP end user

Basic properties for Level_Attribute :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string

setPropertiesClause

Business name of the Level_Attribute

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

Name: DEFAULT_VALUE
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
This is used to construct the default parent policy for loading data into dimesion.

Name: OLAP_TYPE
Type: STRING
Valid Values: NONE, SHORT_DESCRIPTION, END_DATE, TIME_SPAN, PRIOR_PERIOD, YEAR_AGO_PERIOD
Default: NONE
The following properties are set on level attribute so that it is recognized by OLAP service
'NONE' it is not specially recognized type by OLAP service
'SHORT_DESCRIPTION' sets as a short description
'END_DATE' sets as a last date of a period.
'TIME_SPAN' sets as a number of days in a period.
'PRIOR_PERIOD' sets as the prior period number.
'YEAR_AGO_PERIOD' sets as the time period a year before this period

setPropertiesClause

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The level attribute is visible to OLAP end user

Name: TYPE
Type: STRING
Valid Values: NONE, START_DATE, END_DATE, TIME_SPAN
Default: 'NONE'
'NONE'  level attribute so OWB does not recognize it as any specific type.
'START_DATE' level attribute of time dimension as the start date of a period
'END_DATE' level attribute of time dimension as the end date of a period
'TIME_SPAN' level attribute of time dimension as the time span

Name: TYPE_TWO_SCD_EFFECTIVE_DATE
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Effective Date for Slowly changing type 2

Name: TYPE_TWO_SCD_EXPIRATION_DATE
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Expiration Date for Slowly changing type 2

Name: TYPE_TWO_SCD_TRIGGER
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Trigger for saving history for Slowly changing type 2

Name: TYPE_THREE_SCD_EFFECTIVE_DATE
Type: STRING
Valid Values: true, false
Default: false
The level attribute is defined as Effective Date for Slowly changing type 3

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

setPropertiesClause

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

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The hierarchy is visible to OLAP end user

Name: TYPE
Type: STRING
Valid Values: NONE, FISCAL, CALENDAR_YEAR, CALENDAR_WEEK
Default: NONE
'NONE'  hierarchy so OWB does not recognize it as any specific type.
'FISCAL' fiscal hierarchy for time dimension
'CALENDAR_YEAR' calendar year hierarchy time dimension
'CALENDAR_WEEK' calendar week hierarchy time dimension

Name: DEFAULT_DISPLAY
Type: STRING
Valid Values: true, false
Default: false
The hierarchy is set as Default display hierarchy

Name: VALUE_BASED
Type: STRING
Valid Values: true, false
Default: false
Sets the flag to define a Value Based Hierarchy for AW only

setReferenceIconSetClause

This clause sets the reference to an ICONSET.

setDimensionKeySequenceClause

This clause sets the dimension key SEQUENCE.

addSurrogateKeyDimensionAttributeClause

This clause adds DIMENSION_ATTRIBUTE as a SURROGATE_KEY.

addParentKeyDimensionAttributeClause

This clause adds a DIMENSION_ATTRIBUTE as a PARENT_KEY.

addDimensionAttributeClause

This clause adds DIMENSION_ATTRIBUTE as a BUSINESS_KEY.

addDimensionRoleClause

This clause adds a DIMENSION_ROLE.

addLevelClause

This clause adds a LEVEL.

addLevelAttributeClause

This clause adds a LEVEL_ATTRIBUTE.

addHierarchyClause

This clause adds a HIERARCHY.

addSkipLevelsClause

This clause adds SKIP_LEVELS.

createDimensionBindingClause

This clause creates dimension binding clauses.

propertyKeyList

The property list clause.

propertyValueList

The property value list clause.

sequenceName

The sequence name in QUOTED_STRING.

dimensionAttributeName

The dimension attribute name in QUOTED_STRING.

roleName

The name of the role in QUOTED_STRING.

levelName

The name of the level in a QUOTED_STRING

levelAttributeName

The name of the level attribute in a QUOTED_STRING

levelLocator

This clause finds a LEVEL

setLevelAttributeReferenceClause

This clause sets level attribute reference clause.

hierarchyName

The name of the hierarchy in QUOTED_STRING.

hierarchyLevelReferenceClause

This is hierarchy level reference clause.

hierarchyLocator

This clause finds a HIERARCHY

columnName

The name of the column in QUOTED_STRING

levelBindingClause

This clause binds a level to a table or view.

levelAttributeBindingClause

This clause binds a LEVEL_ATTRIBUTE to a column.

setBindRelationshipClause

This clause binds LEVEL_RELATIONSHIP to a COLUMN.

setSkipBindRelationshipClause

This clause binds SKIP_LEVEL_RELATIONSHIP to a COLUMN.

propertyKey

The property key.

propertyValue

The property key value: QUOTED_STRING, INTEGER_LITERAL, FLOATING_POINT_LITERAL

dimensionAttributeLocator

This clause finds a DIMENSION_ATTRIBUTE.

levelAttributeLocator

This clause locates a LEVEL_ATTRIBUTE.

tableName

The table name in QUOTED_STRING.

viewName

The view name in QUOTED_STRING.

DIMENSION Object

Table 7-3 DIMENSION Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE

OMBALTER DIMENSION

OMBRETRIEVE DIMENSION

OMBDROP DIMENSION

OMBCREATE DRILL_PATH

Purpose

Creates a Drill path to enable drilling to detail.

Prerequisites

Should be in the context of a Business Definition Module.

Syntax

createDrillPathCommand =  OMBCREATE DRILL_PATH "QUOTED_STRING" [ SET
          "setPropertiesClause" ] [ SET "setReferenceIconSetClause" ] {
          "DrillLevelClause" } { "DrillLevelLinkClause" }
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     DrillLevelClause =  ADD [ ROOT ] DRILL_LEVEL "QUOTED_STRING" [ DEFAULT_ROOT
           ] [ SET "setPropertiesClause" ] { "setDrillItemClause" } {
          "addDrillLevelKey" }
     DrillLevelLinkClause =  ADD DRILL_LEVEL_LINK PARENT DRILL_LEVEL
          "QUOTED_STRING" CHILD DRILL_LEVEL "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setDrillItemClause =  SET ( REF | REFERENCE ) ITEM "QUOTED_STRING" OF ( (
          ITEM_FOLDER "QUOTED_STRING" "itemJoinUsages" ) | ( LOGICAL_TABLE
          "QUOTED_STRING" ) )
     addDrillLevelKey =  ADD DRILL_LEVEL_KEY "QUOTED_STRING" [ SET
          "setPropertiesClause" ] { "setDrillItemKeyClause" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     itemJoinUsages =  { USING JOIN "QUOTED_STRING" OF ITEM_FOLDER
          "QUOTED_STRING" }
     setDrillItemKeyClause =  SET ( REF | REFERENCE ) ITEM "QUOTED_STRING" OF
          LOGICAL_TABLE "QUOTED_STRING"

Parameters

createDrillPathCommand

This command creates a drill path.

QUOTED_STRING

Specify the name of the drill path to be created.

setPropertiesClause

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

getPropertiesClause

Basic properties for DRILL_PATH:

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

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

Name: TIMEDIMENSION
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the drill path represents a time dimension. Oracle Business Intelligence Modules (OBIEE) only

Basic properties for DRILL_LEVEL:

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

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

Name: DEFAULT_ROOT_LEVEL
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level is a default root. Oracle Business Intelligence Modules (OBIEE) only

Name: GRAND_TOTAL_LEVEL
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level is a grand total level. Oracle Business Intelligence Modules (OBIEE) only

Name: SUPPORTS_ROLLUP
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the level supports rollup to a higher level of aggregation. Oracle Business Intelligence Modules (OBIEE) only

Basic properties for DRILL_LEVEL_KEY (Oracle Business Intelligence (OBIEE):

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

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

Name: PRIMARYKEY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level key is the primary key for the drill level. Oracle Business Intelligence Modules (OBIEE) only

Name: CHRONOLOGICALKEY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level key is the chronological key for a time dimension. Oracle Business Intelligence Modules (OBIEE) only

Name: USE_FOR_DRILLDOWN
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the level key is used for drill down. Oracle Business Intelligence Modules (OBIEE) only

setReferenceIconSetClause

Set specified Icon Set.

DrillLevelClause

This clause adds a drill level to a drill path.

DRILL_LEVEL

A level in a drill path.

DrillLevelLinkClause

This clause adds a link bewteen a parent and child level.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

setDrillItemClause

This clause adds a reference to an item for the level.

addDrillLevelKey

This clause adds a level key to the level.

propertyValue

This is a property value.

itemJoinUsages

The specific joins to be used.

setDrillItemKeyClause

Associates an item with a drill level key.

DRILL_PATH Object

Table 7-4 DRILL_PATH Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER DRILL_PATH

OMBRETRIEVE DRILL_PATH

OMBCREATE DRILL_TO_DETAIL

Purpose

Creates a Drill to detail to allow drilling between items.

Prerequisites

Should be in the context of a Business Definition Module.

Syntax

createDrillToDetailCommand =  OMBCREATE DRILL_TO_DETAIL "QUOTED_STRING" [
          SET "setPropertiesClause" ] [ SET "setReferenceIconSetClause" ] {
          "addDrillToDetailReferenceClause" }
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addDrillToDetailReferenceClause =  SET ( REF | REFERENCE ) ITEM
          "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createDrillToDetailCommand

This command creates a drill to detail.

QUOTED_STRING

Specify the name of the drill to detail to be created.

setPropertiesClause

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

getPropertiesClause

Basic properties for DRILL_TO_DETAIL:

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

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

setReferenceIconSetClause

Set specified Icon Set.

addDrillToDetailReferenceClause

This adds a reference to an item to a drill to detail.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

propertyValue

This is a property value.

DRILL_TO_DETAIL Object

Table 7-5 DRILL_TO_DETAIL Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER DRILL_TO_DETAIL

OMBRETRIEVE DRILL_TO_DETAIL

OMBCREATE EXPERT

Purpose

To create an expert.

Prerequisites

In the context of an expert module.

Syntax

createExpertCommand =  OMBCREATE EXPERT "QUOTED_STRING" [ SET (
          "setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) ] { "addExpertDetailClauses" }
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addExpertDetailClauses =  ADD ( "addParameterClause" | "addVariableClause"
          | "addNestedExpertClause" | "addTaskClause" | "addTransitionClause" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addParameterClause =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
           [ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
     addVariableClause =  VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
     addNestedExpertClause =  NESTED_EXPERT TASK "QUOTED_STRING" SET [
          "collectPropertiesClause" SET ] ( REF | REFERENCE ) EXPERT
          "QUOTED_STRING" [ SET "setReferenceIconSetClause" ]
     addTaskClause =  "TASK_TYPE" TASK "QUOTED_STRING" [ SET (
          "setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) ]
     addTransitionClause =  TRANSITION "QUOTED_STRING" FROM TASK "QUOTED_STRING"
           TO "QUOTED_STRING" [ SET "setPropertiesClause" ]
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     parameterBindingClause =  UNBIND | BIND TO ( "parameterLocator" |
          "variableLocator" )
     collectPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     parameterLocator =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
     variableLocator =  VARIABLE "QUOTED_STRING"

Parameters

createExpertCommand

Creates an expert.  The following expert parameters will be created by default:

1) EXP_LAUNCH_CONTEXT, type: STRING, direction: IN
The console context in which this expert is being launched.
2) EXP_LAUNCH_CONTEXT_TYPE, type: STRING, direction: IN
The type of the console context in which this expert is being launched.
3) EXP_OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) EXP_TYPE_TO_CREATE, type: STRING, direction: IN
The object type selected to be created when this expert is launched.

setPropertiesClause

This clause sets properties for the corresponding object.

getPropertiesClause

Basic properties for EXPERT:

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

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

Basic properties for TASK:

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

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the task.  This is equivalent to the Goal of task in the expert editor.

Name: INSTRUCTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The instruction for the task

Name: PREPROCESSING
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The pre-processing script for the task

Name: MAIN
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The main script for the task

Name: POSTPROCESSING
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The post-processing script for the task

Basic propeties for START TASK:

Name: PROC_DECL
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The procedure declaration for the expert.

Basic properties for TRANSITION:

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

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

Name: TRANSITION_CONDITION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Condition of the transition

Name: TRANSITION_ORDER
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: N/A
Order of the transition

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: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the parameter

Name: DIRECTION
Type: STRING
Valid Values: IN, OUT, INOUT
Default: IN
Direction of the parameter.
Direction of custom expert parameter can only be IN or OUT.
For some tasks, direction of custom parameter can be IN, OUT or INOUT.

Name: VALUE
Type: Same as datatype of the parameter
Valid Values: Any valid character string in supported character set.
Default: N/A
The static value of the parameter

Basic properties for VARIABLE:

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

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

Name: DATATYPE
Type: STRING
Valid Values: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the variable

Name: VALUE
Type: Same as datatype of the variable
Valid Values: Any valid character string in supported character set.
Default: N/A
The static value of the variable

setReferenceIconSetClause

Set icon set for the expert module.

addExpertDetailClauses

Add child objects for the expert.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

addParameterClause

Add a parameter to the expert or one of it's tasks.

addVariableClause

Add a variable to the expert.

addNestedExpertClause

Add a nested expert to the expert. The nested expert is added by reference.

addTaskClause

Add a task to the expert.  Valid task types include: ADVANCED_QUEUE, ALTERNATIVE_SORT_ORDER, ANALYZE_IMPACT, ANALYZE_LINEAGE, BUSINESS_AREA, CATALOG_FOLDER, CHANGE_MANAGER, COMMIT, CONTROLCENTERJOBS, CUBE, CUSTOM_DIALOG, DATA_AUDITOR, DATA_PROFILE, DATA_RULE, DATA_VIEWER, DEPLOY, DERIVATION, DIMENSION, DIMENSION_DRILL_PATH, DRILL_PATH, DRILL_TO_DETAIL, END, EXTERNAL_TABLE, FLAT_FILE, FUNCTION, GENERATION, ITEM_FOLDER, JACL, JAVA, JDBC, JYTHON, LIST_OF_VALUES, LOGICAL_TABLE, MAPPING, MATERIALIZED_VIEW, NESTED_EXPERT, NESTED_KM, OBJECT_SELECTOR, OMB, OS, PLUGGABLE_MAPPING, PRESENTATION_TEMPLATE, PROCEDURE, PROCESS_FLOW, REGISTERED_FUNCTION, RUNTIME_API, SELECT_SOURCE, SELECT_TARGET, SEQUENCE, SOURCE_IMPORT, START, STARTJOB, TABLE, VALIDATION, VIEW, WEB_SERVICE.

Definition of each task is as follow:

Task type  : ADVANCED_QUEUE
Group      : MML
Description: A task to create or alter an advanced queue.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : ALTERNATIVE_SORT_ORDER
Group      : MML
Description: A task to create or alter an alternative sort order.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : ANALYZE_IMPACT
Group      : Service
Description: A task to analyze impact of an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object for analyzing impact.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object whose impact will be analyzed.

Task type  : ANALYZE_LINEAGE
Group      : Service
Description: A task to analyze lineage of an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object for analyzing lineage.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object whose lineage will be analyzed.

Task type  : BUSINESS_AREA
Group      : MML
Description: A task to create or alter a business area.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : CATALOG_FOLDER
Group      : MML
Description: A task to create or alter a catalog folder.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : CHANGE_MANAGER
Group      : Service
Description: A task to invoke the change manager.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : COMMIT
Group      : Service
Description: A task to perform commit in the design repository.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : CONTROLCENTERJOBS
Group      : Service
Description: A task to launch the Control Center Job Monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) CONTROL_CENTER_NAME, type: STRING, direction: IN
The Control Center to use.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : CUBE
Group      : MML
Description: A task to create or alter a cube.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : CUSTOM_DIALOG
Group      : UI
Description: A task to show a custom dialog for user interaction.
Built-in parameters:
1) GUI_RETURN_VALUE, type: ARRAY, direction: OUT
The return value of type ARRAY that stores the name and return value pair for each UI component.
2) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
3) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : DATA_AUDITOR
Group      : MML
Description: A task to create or alter a data auditor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DATA_PROFILE
Group      : MML
Description: A task to create or alter a data profile.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DATA_RULE
Group      : MML
Description: A task to create or alter a data rule.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DATA_VIEWER
Group      : Service
Description: A task to launch the data viewer.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of the OWB FCO, such as TABLE.
4) OBJECT_NAME, type: STRING, direction: IN
The name of the OWB FCO.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : DEPLOY
Group      : Service
Description: A task to launch the Control Center deployment monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) ACTION_PLAN_NAME, type: STRING, direction: IN
The deployment action plan to use.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : DERIVATION
Group      : Service
Description: A task to run derivation service.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to derive.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be derived.

Task type  : DIMENSION
Group      : MML
Description: A task to create or alter a dimension.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DIMENSION_DRILL_PATH
Group      : MML
Description: A task to create or alter a dimension drill path.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DRILL_PATH
Group      : MML
Description: A task to create or alter a drill path.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : DRILL_TO_DETAIL
Group      : MML
Description: A task to create or alter a drill to detail.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : END
Group      : FlowControl
Description: A task that marks the end of the flow.
Built-in parameters:

Task type  : EXTERNAL_TABLE
Group      : MML
Description: A task to create or alter an external table.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : FLAT_FILE
Group      : MML
Description: A task to create or alter a file.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : FUNCTION
Group      : MML
Description: A task to create or alter a function.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : GENERATION
Group      : Service
Description: A task to invoke the generation dialog.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to generate.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be generated.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : ITEM_FOLDER
Group      : MML
Description: A task to create or alter an item folder.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : JACL
Group      : Runtime
Description: A task to execute Jacl code.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : JAVA
Group      : Integration
Description: A task to execute a Java program.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) CLASS_URL, type: STRING, direction: IN
The URL specification of the Jar file.  An example for a local jar file xyz.jar can be specified as file:/xyz.jar
4) CLASS_NAME, type: STRING, direction: IN
The class to load.  This includes the package as well in dotted notation.  For example, oracle.owb.Test
5) METHOD_NAME, type: STRING, direction: IN
The static method to execute.
6) ARGUMENT_LIST, type: STRING, direction: IN
The argument list to be passed into the static method.

Task type  : JDBC
Group      : Runtime
Description: A task to connect to a database and execute SQL DDL and DML statements.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : JYTHON
Group      : Runtime
Description: A task to execute Jython code.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : LIST_OF_VALUES
Group      : MML
Description: A task to create or alter a list of values.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : LOGICAL_TABLE
Group      : MML
Description: A task to create or alter an item folder.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : MAPPING
Group      : MML
Description: A task to create or alter a mapping.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : MATERIALIZED_VIEW
Group      : MML
Description: A task to create or alter a materialized view.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : NESTED_EXPERT
Group      : FlowControl
Description: A task that references another expert.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : NESTED_KM
Group      : FlowControl
Description: A task that references another knowledge module.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : OBJECT_SELECTOR
Group      : UI
Description: A task that shows a dialog for user to select an object.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) OBJECT_TYPE, type: STRING, direction: IN
The type of object for selection.

Task type  : OMB
Group      : Integration
Description: A task to launch a generic OMB script.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : OS
Group      : Runtime
Description: A task to execute an OS call.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : PLUGGABLE_MAPPING
Group      : MML
Description: A task to create or alter a pluggable mapping.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : PRESENTATION_TEMPLATE
Group      : MML
Description: A task to create or alter a presentation template.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : PROCEDURE
Group      : MML
Description: A task to create or alter a procedure.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : PROCESS_FLOW
Group      : MML
Description: A task to create or alter a process flow.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : REGISTERED_FUNCTION
Group      : MML
Description: A task to create or alter a registered function.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : RUNTIME_API
Group      : Runtime
Description: A task to execute a runtime API call.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.

Task type  : SELECT_SOURCE
Group      : UI
Description: A task that allows users to pick a metadata source.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) MODULE_NAME, type: STRING, direction: OUT
The name of the module.
5) LOCATION_NAME, type: STRING, direction: OUT
The name of the location for this connection.
6) OBJECT_TYPE, type: STRING, direction: OUT
The type of object selected as the source.
7) SOURCE_TYPE, type: STRING, direction: INOUT
The type of the source, e.g. file or database.

Task type  : SELECT_TARGET
Group      : UI
Description: A task that allows users to pick a target.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) MODULE_NAME, type: STRING, direction: OUT
The name of the module.
5) LOCATION_NAME, type: STRING, direction: OUT
The name of the location for this connection.
6) OBJECT_TYPE, type: STRING, direction: OUT
The type of object selected as the target.
7) SOURCE_TYPE, type: STRING, direction: INOUT
The type of the source, e.g. file or database.

Task type  : SEQUENCE
Group      : MML
Description: A task to create or alter a sequence.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : SOURCE_IMPORT
Group      : Service
Description: A task to invoke the import wizard.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
4) OBJECT_TYPE, type: STRING, direction: IN
The type of object to import.
5) IMPORT_MODE, type: STRING, direction: IN
The mode for import.  Select FULL_MODE for importing multiple objects, or MINIMAL_MODE for single import.

Task type  : START
Group      : FlowControl
Description: A task that marks the beginning of the flow.
Built-in parameters:

Task type  : STARTJOB
Group      : Service
Description: A task to launch the start job monitor.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to be started.
4) OBJECT_PATH, type: STRING, direction: IN
The context path of the object to be started.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : TABLE
Group      : MML
Description: A task to create or alter a table.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : VALIDATION
Group      : Service
Description: A task to invoke the validation dialog.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OBJECT_TYPE, type: STRING, direction: IN
The type of object to validate.
4) OBJECT_PATH, type: STRING, direction: IN
The path to the object to be validated.
5) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.

Task type  : VIEW
Group      : MML
Description: A task to create or alter a view.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

Task type  : WEB_SERVICE
Group      : MML
Description: A task to create or alter a web service.
Built-in parameters:
1) EXIT_CODE, type: NUMBER, direction: OUT
The exit code represents the exit status on the execution of a task. An exit code of 0 means the task executed successfully, 1 for error, and -1 for cancel.
2) RETURN_VALUE, type: STRING, direction: OUT
The return value from the execution of a task.
3) OPERATION, type: STRING, direction: IN
The operation to be performed.  It is either CREATE or EDIT.
4) PARENT_CONTEXT, type: STRING, direction: IN
The parent context for executing this task.
5) OBJECT_TO_EDIT, type: STRING, direction: IN
The OWB object to be edited for this OWB object task, when the OPERATION is specified as EDIT.

addTransitionClause

Add a transition to the expert.

propertyValue

Value of a property.

parameterBindingClause

Bind or unbind two parameters. Note that this is setting the binding attribute of the parameter object and is not necessarily the same as the direction of data flow. The parameter to be set should be the one whose binding attribute is modified via the Object Inspector in the expert editor.

collectPropertiesClause

This clause sets properties for the corresponding object.

parameterLocator

Specify a parameter, either one of the expert or of a task.

variableLocator

Specify a variable in the expert.

EXPERT Object

Table 7-6 EXPERT Object

Property
Type
Choices
Min
Max
Default
Description

CLOSE_ASSISTANT_ON_COMPLETION

BOOLEAN

true, false

none

none

true

Sets whether the task assistant should be automatically closed after the expert has been run.

CLOSE_WINDOWS_ON_EXECUTION

BOOLEAN

true, false

none

none

true

Close all open windows when this expert is run.

FINISH_DIALOG_ON_COMPLETION

BOOLEAN

true, false

none

none

true

Shows the finish dialog upon completion of expert.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

LOGGING

BOOLEAN

true, false

none

none

false

MENU_ITEM_DISPLAY_STRING

STRING

none

none

none

empty string

The display string when this expert is added as a menu item.

ONLY_RUN_FROM_MENU

BOOLEAN

true, false

none

none

false

Only allow this expert to be run when it is attached to a menu item.

REVERT_TO_SAVED_ON_ERROR

BOOLEAN

true, false

none

none

false

Revert to saved metadata if error occurs when the expert is run.

RUN_STANDALONE

BOOLEAN

true, false

none

none

true

Sets whether the expert should be run as a standalone in expert assistant mode or not.

SAVE_ALL_BEFORE_START

BOOLEAN

true, false

none

none

false

Save all metadata before running the expert.

SHOW_BUSY_DIALOG

BOOLEAN

true, false

none

none

true

Sets whether busy dialog should be shown when OMB or Java tasks are executed in non-standalone mode.

SHOW_LOG_WINDOW

BOOLEAN

true, false

none

none

false

Sets whether the log window should be shown when running the expert.

SHOW_PROGRESS_GRAPH

BOOLEAN

true, false

none

none

true

Sets whether the progress graph dialog should be shown when running the expert.

SHOW_TASK_ASSISTANT

BOOLEAN

true, false

none

none

true

Sets whether the task assistant should be shown when running the expert.

See Also

OMBCREATE

OMBALTER EXPERT

OMBRETRIEVE EXPERT

OMBDROP EXPERT

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.

See Also

OMBCREATE

OMBALTER EXPERT_MODULE

OMBDROP EXPERT_MODULE

OMBCREATE EXTERNAL_TABLE

Purpose

To create an external table.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

createExternalTableCommand =  OMBCREATE ( EXTERNAL_TABLE "QUOTED_STRING" [
          SET "setPropertiesAndReferencesClauses" ] [
          "addExternalTableSCOClauses" ] )
     setPropertiesAndReferencesClauses =  "setPropertiesClause" [ SET ( REF |
          REFERENCE ) "setReferencesToRecordAndLocationClauses" ] | ( REF |
          REFERENCE ) "setReferencesToRecordAndLocationClauses"
     addExternalTableSCOClauses =  ADD ( "addExternalTableColumnClause" [
          "addExternalTableSCOClauses" ] | "addExternalTableDatafileClause" {
          ADD "addExternalTableDatafileClause" } )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferencesToRecordAndLocationClauses =
          "setReferencesToRecordFileModuleClause" [
          "setReferencesToLocationClause" ] [ SET ( REF | REFERENCE )
          "setReferenceIconSetClause" ] | "setReferencesToFileAndModuleClause" [
           "setReferencesToLocationClause" ] [ SET ( REF | REFERENCE )
          "setReferenceIconSetClause" ] | "setReferencesToLocationClause" [ SET
          ( REF | REFERENCE ) "setReferenceIconSetClause" ] |
          "setReferenceIconSetClause"
     addExternalTableColumnClause =  COLUMN "QUOTED_STRING" [ SET
          "setPropertiesAndReferencesToFieldClauses" ]
     addExternalTableDatafileClause =  DATA_FILE "QUOTED_STRING" [ SET
          "setPropertiesClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferencesToRecordFileModuleClause =  RECORD "QUOTED_STRING" OF
          FLAT_FILE "QUOTED_STRING"
     setReferencesToLocationClause =  DEFAULT_LOCATION "QUOTED_STRING"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     setReferencesToFileAndModuleClause =  FLAT_FILE "QUOTED_STRING"
     setPropertiesAndReferencesToFieldClauses =  "setPropertiesClause" [ SET (
          REF | REFERENCE ) "setReferencesToFieldClause" ] | ( REF | REFERENCE )
           "setReferencesToFieldClause"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setReferencesToFieldClause =  FIELD "QUOTED_STRING"

Parameters

createExternalTableCommand

Create a new external table.

QUOTED_STRING

The name of the new external table.

setPropertiesAndReferencesClauses

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

addExternalTableSCOClauses

Add columns and/or data files to the external table.

setPropertiesClause

Set specified properties of the external table.

setReferencesToRecordAndLocationClauses

Set the referenced record and/or default location.

addExternalTableColumnClause

Add an external table column.

addExternalTableDatafileClause

Add a data file to the external table.

propertyNameList

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

propertyNameList

propertyNameList

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: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2
Default: NUMBER
The datatype of a column

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

Name: PRECISION
Type: NUMBER
Valid Values: 0 - 38
Default: 1
The precision of a number. Use 0 to specify floating-point numbers.

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

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

propertyValueList

The values for the named properties.

setReferencesToRecordFileModuleClause

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

setReferencesToLocationClause

The name of the external table's default location.

setReferenceIconSetClause

Set specified Icon Set.

setReferencesToFileAndModuleClause

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

setPropertiesAndReferencesToFieldClauses

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

propertyValue

A property value.

setReferencesToFieldClause

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

EXTERNAL_TABLE Object

Table 7-7 EXTERNAL_TABLE Object

Property
Type
Choices
Min
Max
Default
Description

BAD_FILE_LOCATION

STRING

none

none

none

USE_DEFAULT_LOCATION

BAD_FILE_NAME

STRING

none

none

none

empty string

CONFIGURATION_DEFAULT_LOCATION

STRING

none

none

none

empty string

Customized location default within each configuration of an external table. If not defined, overall default location of an external table is used.

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Description not available.

DISCARD_FILE_LOCATION

STRING

none

none

none

USE_DEFAULT_LOCATION

DISCARD_FILE_NAME

STRING

none

none

none

empty string

ENDIAN

STRING

BIG, LITTLE, PLATFORM

none

none

PLATFORM

Description not available.

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string

Description not available.

ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string

Description not available.

GENERATE_ERROR_TABLE_ONLY

BOOLEAN

true, false

none

none

false

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

LOAD_NULLS_WHEN_MISSING_VALUES

BOOLEAN

true, false

none

none

false

Description not available.

LOG_FILE_LOCATION

STRING

none

none

none

USE_DEFAULT_LOCATION

LOG_FILE_NAME

STRING

none

none

none

empty string

The name of the file that will store the log messages

NLS_CHARACTERSET

STRING

none

none

none

empty string

NLS Characterset of the file. When the Access Parameters property is specified for the External Table, this configuration parameter is ignored.

NUMBER_OF_REJECTS_ALLOWED

NUMBER

none

0

2147483647

0

Description not available.

PARALLEL_ACCESS_DRIVERS

NUMBER

none

1

63999

1

Description not available.

PARALLEL_ACCESS_MODE

BOOLEAN

true, false

none

none

false

Description not available.

REJECTS_ARE_UNLIMITED

BOOLEAN

true, false

none

none

true

Description not available.

STRING_SIZES_IN

STRING

BYTES, CHARACTERS

none

none

BYTES

Description not available.

TRIM

STRING

BOTH, LEFT, NONE, RIGHT, SQL*LOADER

none

none

NONE

EXTERNAL_TABLE_COLUMN Object

Table 7-8 EXTERNAL_TABLE_COLUMN Object

Property
Type
Choices
Min
Max
Default
Description

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

DATA_FILE Object

Table 7-9 DATA_FILE Object

Property
Type
Choices
Min
Max
Default
Description

DATA_FILE_LOCATION

STRING

none

none

none

USE_DEFAULT_LOCATION

DATA_FILE_NAME

STRING

none

none

none

empty string

SOURCE_DATA_FILE_DIRECTORY

STRING

none

none

none

empty string

SOURCE_DATA_FILE_NAME

STRING

none

none

none

empty string

See Also

OMBCREATE

OMBALTER EXTERNAL_TABLE

OMBDROP EXTERNAL_TABLE

OMBRETRIEVE EXTERNAL_TABLE

OMBCREATE FLAT_FILE

Purpose

To create a flat file.

Prerequisites

Should be in the context of a flat file module.

Syntax

createFlatFileCommand =  OMBCREATE ( FLAT_FILE "QUOTED_STRING" [ SET (
          "setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) ] ( "importCopybookClause" | {
          "addRecordClause" } ) )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     importCopybookClause =  IMPORT ( COPYBOOK "QUOTED_STRING" { EXCLUDE
          "excludeGroupsClause" | EXCLUDE "excludeRedefinesClause" |
          STORAGE_BOUNDARY "storageBoundaryClause" | ON_ERROR "onErrorClause" |
          MESSAGE_LEVEL "messageLevelClause" } )
     addRecordClause =  ADD ( RECORD "QUOTED_STRING" [ SET "setPropertiesClause"
           ] { "addFieldClause" } )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     excludeGroupsClause =  GROUPS
     excludeRedefinesClause =  REDEFINES
     storageBoundaryClause =  "INTEGER_LITERAL"
     onErrorClause =  ( CHECK | LOAD_VALID | CANCEL )
     messageLevelClause =  ( NONE | ERROR | WARNING | INFO )
     addFieldClause =  ADD FIELD "QUOTED_STRING" [ SET "setPropertiesClause" ]
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createFlatFileCommand

Create a new flat file object.

QUOTED_STRING

The name of the new flat file.

setPropertiesClause

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

setReferenceIconSetClause

Set specified Icon Set.

importCopybookClause

Import a COBOL copybook.

QUOTED_STRING

The file containing the copybook.

addRecordClause

Add a record to the flat file.

QUOTED_STRING

The name of the new record.

propertyNameList

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

propertyNameList

Properties for FLAT_FILE:

Name: DATA_FILE_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default ''
The name of the "sampled" file.  Also the default data file value used in SQL*Loader maps and External Tables.

Name: IS_DELIMITED
Type: BOOLEAN
Valid Values: true, false, 1, 0
Default: true
True indicates that this flat file is delimited.  False indicates that its fields are defined by fixed lengths

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

Name: RECORD_DELIMITER
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The character(s) which denote the end of a physical record in a data file.  A hex value may be entered by entering embedded single quotes twice as:   'x''0f''' (all are single quotes).  The outside single quote indicates a quoted string and the inside single quotes  single-quote  x  single-quote single-quote   0F  single-quote single-quote single-quote.  (Please note that this is not the FIELD_DELIMITER.

Name: RECORD_LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0 (Records are delimited by default)
The length (in characters) of the records in the data file.

Name: RECORD_TYPE_COLUMN_NUMBER
Type: NUMBER
Valid Values: 0+
Default: 0
The column which contains the record type values for a delimited, multi-record type file.

Name: RECORD_TYPE_START_POSITION
Type: NUMBER
Valid Values: 0+
Default: 0
The starting position of the field (relative to 0) which contains the record type values for a fixed-length, multi-record type file.

Name: RECORD_TYPE_END_POSITION
Type: NUMBER
Valid Values: 0+
Default: 0
The ending position of the field (relative to 0) which contains the record type values for a fixed-length, multi-record type file.

propertyNameList

Name: NUMBER_OF_RECORDS_TO_SKIP
Type: NUMBER
Valid Values: 0 - 1000
Default: 0
The default number of records to skip when loading this file.

Name: FIELD_DELIMITER
Type: STRING
Valid Values: Any single character
Default: ',' (Comma)
The character to divide the fields in a delimited file.

Name: FIELD_LEFT_ENCLOSURE
Type: STRING
Valid Values: Any single character
Default: None
A character to enclose fields which may contain the field delimiter.

Name: FIELD_RIGHT_ENCLOSURE
Type: STRING
Valid Values: Any single character
Default: None
A character to enclose fields which may contain the field delimiter.

Name: NUMBER_OF_PHYSICAL_RECORDS_PER_LOGICAL
Type: Number
Valid Values: 0+
Default: 0
Set this value if you wish to concatenate a fixed number of physical records to form a single logical record.

Name: CONTINUE_IF_ENDS_WITH
Type: STRING
Valid Values: Any single character
Default: None
Set this value if you wish to concatenate a variable number of physical records to form a single logical record, determined by records ending with this character.

Name: CONTINUE_IF_STARTS_WITH
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: None
Set this value if you wish to concatenate a variable number of physical records to form a single logical record, determined by records beginning with this character.

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

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

Properties for RECORD:

Name: RECORD_TYPE_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: None
This is a mandatory property for each record of a multi-record type file.  It is the string which will identify this record type in the data file.

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

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

Properties for FIELD:

Name: DATATYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE, FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARRAW, VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
This is the SQL*Loader data type for the field.

Name: MAXIMUM_LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0
This is the maximum length of the field.

Name: LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0
Depreciated.  This is the length of the field in a fixed length file.  This is the max length of the field in a delimited file.

Name: PRECISION
Type: NUMBER
Valid Values: Depends on data type
Default: 0
Precision of the field.

Name SCALE
Type: NUMBER
Valid Values: Depends on data type
Default: 0
Scale of the field

Name: START_POSITION
Type: NUMBER
Valid Values: 1+
Default: 1
The starting position of a field for a fixed length file.

Name: END_POSITION
Type: NUMBER
Valid Values: 1+
Default: 1
The ending position of a field for a fixed length file.

propertyNameList

Name: SQL_DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: DEFAULT.  This will derive the SQL_DATATYPE from the value of DATATYPE.
The data type which the field will be treated as in mapping and for External Tables.

Name: SQL_LENGTH
Type: NUMBER
Valid Values: 1 - 4000
Default: 0

Name: SQL_PRECISION
Type: NUMBER
Valid Values: 1 - 38
Default: 1

Name: SQL_SCALE
Type: NUMBER
Valid Values: -84 - 127
Default: 0

Name: MASK
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: None
This is the mask used to define the format of DATE fields in the data file.

Name: NULL_IF
Type: STRING
Valid Values: Either = or != followed by either 'BLANKS', a single quoted string, or a hexadecimal string
Default: None
If this condition is true for a field, the value loaded will be NULL.

Name: DEFAULT_IF
Type: STRING
Valid Values: Either = or != followed by either 'BLANKS', a single quoted string, or a hexadecimal string
Default: None
If this condition is true for a field, the value loaded will be either NULL or 0, dependent on data type.

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

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

propertyValueList

The values for the named properties.

excludeGroupsClause

Indicates that fields should not be created for group items.

excludeRedefinesClause

Indicates that fields should not be created for redefined items or items subordinate to redefined items.

storageBoundaryClause

Specifies the storage boundary for the data in the file.

onErrorClause

Specifies how the processing should continue if an error is encountered.

messageLevelClause

Specifies the types of messages to be shown.

addFieldClause

Add a field to the record.

QUOTED_STRING

The name of the new field.

propertyValue

A property value.

See Also

OMBCREATE

OMBALTER FLAT_FILE

OMBDROP FLAT_FILE

OMBCREATE FLAT_FILE_MODULE

Purpose

To create a flat file module.

Prerequisites

Should be in the context of project.

Syntax

createFlatFileModuleCommand =  OMBCREATE ( FLAT_FILE_MODULE "QUOTED_STRING"
           [ SET ( "setPropertiesClause" [ SET
          "setReferenceClauseForDataMetadataModule" ] |
          "setReferenceClauseForDataMetadataModule" ) ] [
          "addModuleReferenceLocationClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "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

createFlatFileModuleCommand

Create a new flat file module.

QUOTED_STRING

The name for the new flat file module.

setPropertiesClause

Set specified properties of the new flat file module.

setReferenceClauseForDataMetadataModule

Set location and/or icon set for the new flat file module.

addModuleReferenceLocationClause

Add data locations to the new flat file module.

propertyNameList

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

propertyNameList

Basic properties for FLAT_FILE_MODULE:

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

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

propertyValueList

The values for the named properties.

setReferenceLocationClause

Set a data location to the new flat file module.

setReferenceMetadataLocationOrIconSetOrJCTClause

Set metadata location and/or icon set and/or journal code template for the new flat file module.

addReferenceLocationClause

Add a data location to the new flat file module as the new configuration default.

propertyValue

A property value.

setReferenceMetadataLocationOrIconSetClause

Set metadata location and/or icon set for the new flat file module.

setReferenceMetadataLocationClause

Set metadata location for the new flat file module.

setReferenceIconSetClause

Set icon set for the new flat file module.

See Also

OMBCREATE

OMBALTER FLAT_FILE_MODULE

OMBDROP FLAT_FILE_MODULE

OMBCREATE FOLDER

Purpose

To create a folder.

Prerequisites

Should be in the context of a module (Oracle, Non-Oracle, Aplications, Process Flow types) or a folder.

Syntax

createUserFolderCommand =  OMBCREATE ( FOLDER "QUOTED_STRING" [ SET
          "setPropertiesClause" [ SET "setReferenceIconSetClause" ] | SET
          "setReferenceIconSetClause" ] ( { "addContainedObjClause" } ) )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addContainedObjClause =  ADD CONTAINED_OBJECT "containedObjTypeClause"
          "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     containedObjTypeClause =  ( TABLE | VIEW | PACKAGE | DIMENSION |
          MATERIALIZED_VIEW | SEQUENCE | CUBE | DATA_AUDITOR | ADVANCED_QUEUE |
          QUEUE_TABLE | EXTERNAL_TABLE | VARYING_ARRAY | OBJECT_TYPE |
          NESTED_TABLE | MAPPING | PLUGGABLE_MAPPING | PROCESS_FLOW_PACKAGE |
          FUNCTION | TABLE_FUNCTION | PROCEDURE )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createUserFolderCommand

This command creates a folder

QUOTED_STRING

Name of the folder to be created.

setPropertiesClause

Associate a set of properties with a folder.

propertiesClause

Basic properties for FOLDER:

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

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

setReferenceIconSetClause

Set icon set for the folder module.

addContainedObjClause

This command adds a module object to the folder as a contained object.

propertyNameList

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

propertyValueList

Comma separated list of property values.

containedObjTypeClause

The type of the contained object to be added. Valid object types are: TABLE | VIEW | PACKAGE | DIMENSION | MATERIALIZED_VIEW | SEQUENCE | CUBE | ADVANCED_QUEUE | STREAMS_QUEUE | QUEUE_TABLE | EXTERNAL_TABLE | VARYING_ARRAY | OBJECT_TYPE | NESTED_TABLE | MAPPING | PROCESS_FLOW_PACKAGE | FUNCTION | PROCEDURE.

propertyValue

Value of a property.

See Also

OMBCREATE

OMBALTER FOLDER

OMBDROP FOLDER

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

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE

OMBALTER FUNCTION

OMBDROP FUNCTION

OMBCREATE FUNCTION_CT

Purpose

To create an FCT (Function Code Template).

Prerequisites

In the context of an CT module.

Syntax

createFCTCommand =  OMBCREATE FUNCTION_CT "QUOTED_STRING" {
          "kmCreateOptionsOptionsClause" }
     kmCreateOptionsOptionsClause =  SET "setReferenceIconSetClause" | SET
          "setPropertiesClause" | ADD ( "addParameterClause" |
          "addVariableClause" | "addCTTaskClause" | "addNestedCTTaskClause" |
          "addTransitionClause" )
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     addParameterClause =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
           [ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
     addVariableClause =  VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
     addCTTaskClause =  "TASK_TYPE" TASK "QUOTED_STRING" {
          "kmTaskAddOptionsOptionsClause" }
     addNestedCTTaskClause =  NESTED_CT TASK "QUOTED_STRING" SET [
          "collectPropertiesClause" SET ] ( REF | REFERENCE ) CT "QUOTED_STRING"
           [ SET "setReferenceIconSetClause" ]
     addTransitionClause =  TRANSITION "QUOTED_STRING" FROM TASK "QUOTED_STRING"
           TO "QUOTED_STRING" [ SET "setPropertiesClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     parameterBindingClause =  UNBIND | BIND TO ( "parameterLocator" |
          "variableLocator" )
     kmTaskAddOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET
          "unsetReferenceIconSetClause" | SET "setPropertiesClause"
     collectPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     parameterLocator =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
     variableLocator =  VARIABLE "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

createFCTCommand

Creates a Function CT. The following code template parameters will be created by default:

{0}

setReferenceIconSetClause

Set icon set for the expert module.

setPropertiesClause

This clause sets properties for the corresponding object.

setPropertiesClause

Basic properties for Code Template:

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

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

Basic properties for TASK:

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

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

addParameterClause

Add a parameter to the expert or one of it's tasks.

addVariableClause

Add a variable to the expert.

addTransitionClause

Add a transition to the expert.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

parameterBindingClause

Bind or unbind two parameters. Note that this is setting the binding attribute of the parameter object and is not necessarily the same as the direction of data flow. The parameter to be set should be the one whose binding attribute is modified via the Object Inspector in the expert editor.

collectPropertiesClause

This clause sets properties for the corresponding object.

propertyValue

Value of a property.

parameterLocator

Specify a parameter, either one of the expert or of a task.

variableLocator

Specify a variable in the expert.

FUNCTION_CT Object

Table 7-11 FUNCTION_CT Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

PLATFORM

STRING

none

none

none

GENERIC

SOURCE_PLATFORM

STRING

none

none

none

GENERIC

See Also

OMBCREATE

OMBALTER CT

OMBRETRIEVE CT

OMBDROP CT

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

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE

OMBALTER GATEWAY_MODULE

OMBDROP GATEWAY_MODULE

OMBCREATE ICONSET

Purpose

To create an icon set.

Prerequisites

In any context.

Syntax

createIconSetCommand =  OMBCREATE ( ICONSET "QUOTED_STRING" [ SET
          "setPropertiesClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createIconSetCommand

This command creates an iconset.

QUOTED_STRING

Specify the name of the iconset to be created.

setPropertiesClause

This clause sets a list properties to the specified values.

getPropertiesClause

Basic properties for ICONSET:

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

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

Name: BELONGS_TO_GROUP
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Name of the Group to which the iconset belongs

Name: CANVAS_ICON
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
URL of the canvas icon (36x36)

Name: PALETTE_ICON
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
URL of the palette icon (18x18)

Name: TREE_ICON
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
URL of the tree icon (16x16)

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

A property value.

ICONSET Object

Table 7-13 ICONSET Object

Property
Type
Choices
Min
Max
Default
Description

BELONGS_TO_GROUP

STRING

Applications, Data Source, Generic, Processes, Tasks

none

none

empty string

Group assignment for this icon..

See Also

OMBCREATE ICONSET

OMBALTER ICONSET

OMBDROP ICONSET

OMBCREATE IMPORT_ACTION_PLAN

Purpose

To create a transient import action plan.

Prerequisites

In the context of a project.

Syntax

createImportActionPlanCommand =  ( OMBCREATE TRANSIENT IMPORT_ACTION_PLAN
          "QUOTED_STRING" { "addActionClause" } )
     addActionClause =  ADD ACTION "QUOTED_STRING" ( "setPropertiesClause" [
          "setRefSourceAndTargetClause" ] | "setRefSourceAndTargetClause" )
     setPropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     setRefSourceAndTargetClause =  SET ( REF | REFERENCE ) "sourcesClause" SET
          ( REF | REFERENCE ) "targetClause"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     sourcesClause =  SOURCE "ObjType" "QUOTED_STRING" [ SET ( REF | REFERENCE )
           "sourcesClause" ]
     targetClause =  TARGET "ObjType" "QUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createImportActionPlanCommand

This command is for creating a transient import action plan, which is composed of a set of import actions. Each import action includes specification of source objects from which metadata will be extracted and one target object, into which the metadata will be added.

QUOTED_STRING

The name of the import action plan to be created.

addActionClause

For adding an action to the import action plan.

QUOTED_STRING

The name of the action to be added.

setPropertiesClause

For setting any properties for the import action. For the current release, there are no predefined property for import actions.

setRefSourceAndTargetClause

For specifying source and target objects for the import action. The source objects are to be imported into target.

sourcesClause

For specifying source objects in an import action. Valid object types are as follows.

TABLE

VIEW

SEQUENCE

MATERIALIZED_VIEW

EXTERNAL_TABLE

ADVANCED_QUEUE

QUEUE_TABLE

OBJECT_TYPE

VARRAY

NESTED_TABLE

DIMENSION

CUBE

FUNCTION

PROCEDURE

PACKAGE

QUOTED_STRING

The name of the source object. Note that the name of the source object must be qualified with schema name, such as 'SCOTT.EMP'.

For importing into a transportable module, the object specification requires an optional tablespace name qualifier, such as 'USERS.SCOTT.EMP' or 'DEFAULT.SCOTT.EMP'. The tablespace name is required because schemas are listed under tablespaces in the transportable module tree in OWB designer console. If 'DEFAULT' is specified as tablespace name, then the default tablespace name of the schema is used. If the tablespace name is ommitted, then the following rule is used to deduce the appropriate tablespace name.

First, if the object is a database segment (i.e., table and materialized view), then use the tablespace name of the tablespace where the segment resides.

Second if the object is not a database segment, then the default tablespace name for the schema is used, i.e., it is equivalent to specifying 'DEFAULT' as tablespace name.

targetClause

For specifying the target object in an import action. There can only be one target object in an import action.

QUOTED_STRING

The name of the target object.

See Also

OMBIMPORT

OMBCREATE INTEGRATION_CT

Purpose

To create an Integration Code Template.

Prerequisites

In the context of an CT module.

Syntax

createICTCommand =  OMBCREATE INTEGRATION_CT "QUOTED_STRING" {
          "kmCreateOptionsOptionsClause" }
     kmCreateOptionsOptionsClause =  SET "setReferenceIconSetClause" | SET
          "setPropertiesClause" | ADD ( "addParameterClause" |
          "addVariableClause" | "addCTTaskClause" | "addNestedCTTaskClause" |
          "addTransitionClause" )
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     addParameterClause =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
           [ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
     addVariableClause =  VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
     addCTTaskClause =  "TASK_TYPE" TASK "QUOTED_STRING" {
          "kmTaskAddOptionsOptionsClause" }
     addNestedCTTaskClause =  NESTED_CT TASK "QUOTED_STRING" SET [
          "collectPropertiesClause" SET ] ( REF | REFERENCE ) CT "QUOTED_STRING"
           [ SET "setReferenceIconSetClause" ]
     addTransitionClause =  TRANSITION "QUOTED_STRING" FROM TASK "QUOTED_STRING"
           TO "QUOTED_STRING" [ SET "setPropertiesClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     parameterBindingClause =  UNBIND | BIND TO ( "parameterLocator" |
          "variableLocator" )
     kmTaskAddOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET
          "unsetReferenceIconSetClause" | SET "setPropertiesClause"
     collectPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     parameterLocator =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
     variableLocator =  VARIABLE "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

createICTCommand

Creates an Integration CT. The following code template will be created by default:

{0}

setReferenceIconSetClause

Set icon set for the expert module.

setPropertiesClause

This clause sets properties for the corresponding object.

setPropertiesClause

Basic properties for Code Template:

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

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

Basic properties for TASK:

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

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

addParameterClause

Add a parameter to the expert or one of it's tasks.

addVariableClause

Add a variable to the expert.

addTransitionClause

Add a transition to the expert.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

parameterBindingClause

Bind or unbind two parameters. Note that this is setting the binding attribute of the parameter object and is not necessarily the same as the direction of data flow. The parameter to be set should be the one whose binding attribute is modified via the Object Inspector in the expert editor.

collectPropertiesClause

This clause sets properties for the corresponding object.

propertyValue

Value of a property.

parameterLocator

Specify a parameter, either one of the expert or of a task.

variableLocator

Specify a variable in the expert.

INTEGRATION_CT Object

Table 7-14 INTEGRATION_CT Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

MULTI_CONNECTIONS

BOOLEAN

true, false

none

none

false

Does Code Template support multiple connections?

PLATFORM

STRING

none

none

none

GENERIC

SOURCE_PLATFORM

STRING

none

none

none

GENERIC

See Also

OMBCREATE

OMBALTER CT

OMBRETRIEVE CT

OMBDROP CT

8 OMBCREATE ITEM_FOLDER to OMBCREATE PLSQL_REF_CURSOR_TYPE

OMBCREATE ITEM_FOLDER

OMBCREATE J2EE_USER

OMBCREATE LIST_OF_VALUES

OMBCREATE LOAD_CT

OMBCREATE LOCATION

OMBCREATE LOGICAL_TABLE

OMBCREATE MAPPING

OMBCREATE MAPPING_MODULE

OMBCREATE MATERIALIZED_VIEW

OMBCREATE MDL_ACTION_PLAN

OMBCREATE MODULE

OMBCREATE NESTED_TABLE

OMBCREATE OBIEE_BUSINESS_DEFINITION_MODULE

OMBCREATE OBJECT_TYPE

OMBCREATE ORACLE_EBS_MODULE

OMBCREATE ORACLE_MODULE

OMBCREATE ORACLE_TARGET_CT

OMBCREATE PACKAGE

OMBCREATE PLATFORM

OMBCREATE PLSQL_RECORD_TYPE

OMBCREATE PLSQL_REF_CURSOR_TYPE

OMBCREATE ITEM_FOLDER

Purpose

Creates an item folder that can be used in a business view.

Prerequisites

Should be in the context of a Business Definition Module.

Syntax

createItemFolderCommand =  ( OMBCREATE ITEM_FOLDER "QUOTED_STRING" [ SET
          "setpropertiesClauseDelayed" ] [ SET "setReferenceIconSetClause" ] {
          "addItemFolderSCOClauses" } )
     setpropertiesClauseDelayed =  PROPERTIES "(" "propertyNameListVector" ")"
          VALUES "(" "propertyValueListVector" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addItemFolderSCOClauses =  ADD ( "addItemClause" | "addConditionClause" |
          "addJoinClause" )
     propertyNameListVector =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueListVector =  "propertyValue" { "," "propertyValue" }
     addItemClause =  ITEM "QUOTED_STRING" [ SET "setPropertiesClause" ] [ SET (
           REF | REFERENCE ) ( "ItemItemReferencesClause" |
          "ItemListOfValuesReferencesClause" |
          "ItemDrillToDetailReferencesClause" |
          "ItemAlternativeSortOrderReferencesClause" |
          "ItemColumnReferencesClause" ) ]
     addConditionClause =  CONDITION "QUOTED_STRING" [ SET
          "setPropertiesClauseforCondition" ]
     addJoinClause =  JOIN "QUOTED_STRING" [ SET "setPropertiesClause" ] [ SET (
           REF | REFERENCE ) "JoinForeignKeyReferencesClause" ] {
          "joinComponentClause" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     ItemItemReferencesClause =  ITEM "QUOTED_STRING" OF ( ( ITEM_FOLDER
          "QUOTED_STRING" "itemJoinUsages" ) | ( LOGICAL_TABLE "QUOTED_STRING" )
           )
     ItemListOfValuesReferencesClause =  LIST_OF_VALUES "QUOTED_STRING"
     ItemDrillToDetailReferencesClause =  DRILL_TO_DETAIL "QUOTED_STRING"
     ItemAlternativeSortOrderReferencesClause =  ALTERNATIVE_SORT_ORDER
          "QUOTED_STRING"
     ItemColumnReferencesClause =  COLUMN "QUOTED_STRING" OF ( TABLE | (
          EXTERNAL_TABLE | ( VIEW | MATERIALIZED_VIEW ) ) ) "QUOTED_STRING" [
          USING FOREIGN_KEY "QUOTED_STRING" OF ( TABLE | ( VIEW |
          MATERIALIZED_VIEW ) ) "QUOTED_STRING" ]
     setPropertiesClauseforCondition =  PROPERTIES "("
          "propertyNameListforCondition" ")" VALUES "(" "propertyValueList" ")"
     JoinForeignKeyReferencesClause =  FOREIGN_KEY "QUOTED_STRING" OF ( TABLE |
          ( VIEW | MATERIALIZED_VIEW ) ) "QUOTED_STRING"
     joinComponentClause =  ADD JOIN_COMPONENT "QUOTED_STRING" [ SET
          "setPropertiesClause" ] { SET ( REF | REFERENCE )
          "setJoinComponentClauseDetails" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     itemJoinUsages =  { USING JOIN "QUOTED_STRING" OF ITEM_FOLDER
          "QUOTED_STRING" }
     propertyNameListforCondition =  ( "UNQUOTED_STRING" | CONDITION ) { "," (
          "UNQUOTED_STRING" | CONDITION ) }
     setJoinComponentClauseDetails =  LOCAL ITEM "QUOTED_STRING" | REMOTE ITEM
          "QUOTED_STRING" OF ( ( ITEM_FOLDER "QUOTED_STRING" ) | ( LOGICAL_TABLE
           "QUOTED_STRING" ) )

Parameters

createItemFolderCommand

This command creates an item folder.

QUOTED_STRING

Specify the name of the item folder to be created.

setpropertiesClauseDelayed

This clause sets the properties.

setReferenceIconSetClause

Set specified Icon Set.

addItemFolderSCOClauses

This clause adds items to an item folder.

propertyNameListVector

This clause holds the names of the properties.

propertyValueListVector

This clause holds the values of the properties.

addItemClause

This clause adds an item to an item folder.

ITEM

A field within the item folder.

QUOTED_STRING

The name of the item to be added.

addConditionClause

This clause adds a condition to an item folder.

CONDITION

A condition within the item folder.

QUOTED_STRING

The name of the condition to be added.

addJoinClause

This clause adds a foreign key relationship to another item folder.

JOIN

A foreign key relationship with another item folder.

QUOTED_STRING

The name of the join to be added.

propertyValue

This is a property value.

setPropertiesClause

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

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

ItemItemReferencesClause

This clause is used to reference another item.

QUOTED_STRING

name of the referenced item.

ItemListOfValuesReferencesClause

This clause is used to reference a list of values.

QUOTED_STRING

name of the list of values.

ItemDrillToDetailReferencesClause

This clause is used to reference a drill to detail.

QUOTED_STRING

name of the drill to detail.

ItemAlternativeSortOrderReferencesClause

This clause is used to reference an alternative sort order.

QUOTED_STRING

name of the alternative sort order.

ItemColumnReferencesClause

This clause is used to reference a column.

QUOTED_STRING

name of the referenced column.

setPropertiesClauseforCondition

Sets the properties of a condition.

JoinForeignKeyReferencesClause

The foreign key reference.

joinComponentClause

The join components.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

itemJoinUsages

The specific joins to be used.

propertyNameListforCondition

Names of the condition properties.

setJoinComponentClauseDetails

The structure of the join component.

ITEM_FOLDER Object

Table 8-1 ITEM_FOLDER Object

Property
Type
Choices
Min
Max
Default
Description

DB_LOCATION

STRING

none

none

none

empty string

Location for the referenced database object

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

EXTERNAL_TABLE_NAME

STRING

none

none

none

empty string

The physical name for the corresponding table or view.

OBJECT_TYPE

STRING

none

none

none

empty string

OPTIMIZER_HINT

STRING

none

none

none

empty string

Optimizer Hint to be added when this Item Folder is used in a query

VISIBLE

BOOLEAN

true, false

none

none

false

Whether this object is visible for use in query definitions.

See Also

OMBALTER ITEM_FOLDER

OMBRETRIEVE ITEM_FOLDER

OMBCREATE J2EE_USER

Purpose

To create a J2EE user that will be added to the runtime.

Prerequisites

J2EE runtime must be up and running.

Syntax

parseCreateJ2eeUserCommand =  OMBCREATE J2EE_USER "QUOTED_STRING"
          IDENTIFIED BY "QUOTED_STRING" "J2eePropertiesClause"
     J2eePropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")" VALUES
          "(" "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseCreateJ2eeUserCommand

This clause creates a J2EE runtime user.

J2eePropertiesClause

Properties for making J2EE connection to create or drop J2EE users.

propertyNameList

Connection property names : USER, PASSWORD, HOST, PORT, JSR88TYPE, ROOT, INSTANCE, PROTOCOL

propertyValueList

List of connection property value for the property name. See the example for detail.

propertyValue

The value for the connection property. See example for detail.

See Also

OMBDROP J2EE_USER

OMBCREATE LIST_OF_VALUES

Purpose

Creates a List of Values.

Prerequisites

Should be in the context of a Business Definition Module.

Syntax

createListOfValuesCommand =  OMBCREATE LIST_OF_VALUES "QUOTED_STRING" [ SET
           "setPropertiesClauseforLOVandD2D" ] [ SET "setReferenceIconSetClause"
           ] [ "addListOfValuesClause" ] { "addListOfValuesReferenceClause" }
     setPropertiesClauseforLOVandD2D =  PROPERTIES "("
          "propertyNameListforLOVandD2D" ")" VALUES "(" "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addListOfValuesClause =  SET ( REF | REFERENCE ) DEFINING ITEM
          "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
     addListOfValuesReferenceClause =  SET ( REF | REFERENCE ) ITEM
          "QUOTED_STRING" OF ITEM_FOLDER "QUOTED_STRING"
     propertyNameListforLOVandD2D =  ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
          "," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createListOfValuesCommand

This command creates a list of values.

QUOTED_STRING

Specify the name of the list of values to be created.

setPropertiesClauseforLOVandD2D

Used to set properties (core, logical, physical, user-defined) for a list of values. Valid properties are shown below:

getPropertiesClauseforLOVandD2D

Basic properties for LIST_OF_VALUES:

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

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

Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the list of values enables drilling between the item folders containing the items that use the list of values

Name: RETRIEVE_VALUES_GROUP_SIZE
Type: Number
Valid Values: Any valid character string in supported character set.
Default: '100'
The number of rows to be fetched from the database at a time

Name: CACHE_VALUES
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the list of values should be cached in memory

Name: REQUIRE_SEARCH
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether search criteria should be requested

Name: SHOW_IN_NAVIGATOR
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be shown in the item navigator

Name: SORTED_DISTINCT
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be displayed sorted with duplicates hidden

setReferenceIconSetClause

Set specified Icon Set.

addListOfValuesClause

This clause modifies a list of values.

addListOfValuesReferenceClause

This adds a reference to an item to a list of values.

propertyNameListforLOVandD2D

This is the list of property names.

propertyValueList

This is the list of property values.

propertyValue

This is a property value.

LIST_OF_VALUES Object

Table 8-2 LIST_OF_VALUES Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER LIST_OF_VALUES

OMBRETRIEVE LIST_OF_VALUES

OMBCREATE LOAD_CT

Purpose

To create an LCT (Load Code Template).

Prerequisites

In the context of an CT module.

Syntax

createLCTCommand =  OMBCREATE LOAD_CT "QUOTED_STRING" {
          "kmCreateOptionsOptionsClause" }
     kmCreateOptionsOptionsClause =  SET "setReferenceIconSetClause" | SET
          "setPropertiesClause" | ADD ( "addParameterClause" |
          "addVariableClause" | "addCTTaskClause" | "addNestedCTTaskClause" |
          "addTransitionClause" )
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     addParameterClause =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
           [ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
     addVariableClause =  VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
     addCTTaskClause =  "TASK_TYPE" TASK "QUOTED_STRING" {
          "kmTaskAddOptionsOptionsClause" }
     addNestedCTTaskClause =  NESTED_CT TASK "QUOTED_STRING" SET [
          "collectPropertiesClause" SET ] ( REF | REFERENCE ) CT "QUOTED_STRING"
           [ SET "setReferenceIconSetClause" ]
     addTransitionClause =  TRANSITION "QUOTED_STRING" FROM TASK "QUOTED_STRING"
           TO "QUOTED_STRING" [ SET "setPropertiesClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     parameterBindingClause =  UNBIND | BIND TO ( "parameterLocator" |
          "variableLocator" )
     kmTaskAddOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET
          "unsetReferenceIconSetClause" | SET "setPropertiesClause"
     collectPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     parameterLocator =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
     variableLocator =  VARIABLE "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

createLCTCommand

Creates a Load CT. The following code template will be created by default:

{0}

setReferenceIconSetClause

Set icon set for the expert module.

setPropertiesClause

This clause sets properties for the corresponding object.

setPropertiesClause

Basic properties for Code Template:

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

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

Basic properties for TASK:

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

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

addParameterClause

Add a parameter to the expert or one of it's tasks.

addVariableClause

Add a variable to the expert.

addTransitionClause

Add a transition to the expert.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

parameterBindingClause

Bind or unbind two parameters. Note that this is setting the binding attribute of the parameter object and is not necessarily the same as the direction of data flow. The parameter to be set should be the one whose binding attribute is modified via the Object Inspector in the expert editor.

collectPropertiesClause

This clause sets properties for the corresponding object.

propertyValue

Value of a property.

parameterLocator

Specify a parameter, either one of the expert or of a task.

variableLocator

Specify a variable in the expert.

LOAD_CT Object

Table 8-3 LOAD_CT Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

MULTI_CONNECTIONS

BOOLEAN

true, false

none

none

true

Does Code Template support multiple connections?

PLATFORM

STRING

none

none

none

empty string

SOURCE_PLATFORM

STRING

none

none

none

UNDEFINED

See Also

OMBCREATE

OMBALTER CT

OMBRETRIEVE CT

OMBDROP CT

OMBCREATE LOCATION

Purpose

To create a location.

Prerequisites

Can be in any context.

Syntax

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

Parameters

createLocationCommand

Create a new location.

createLocationSetPropertiesClause

Set specified properties of the new location.

setReferenceIconSetClause

Set the Icon Set for the new location.

propertyNameList

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

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

Name: INTEGRATION_TYPE
Type: STRING
Valid Values: 'DIRECT','INDIRECT'
Default: 'DIRECT'
The integration type for Discoverer.

Name: IS_TEST_ON_REGISTER
Type: BOOLEAN
Valid Values: 'TRUE','FALSE'N/A
Default: 'TRUE'
Execute location test when registering this Generic location.

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

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

Name: PASSWORD
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The password.

Name: PORT
Type: NUMBER
Valid Values: 1 - 65535
Default: 1521
The port number of a database listener.

Name: PORT_TYPE
Type: STRING
Valid Values: 'RMI','OPMN','RMIS'
Default: 'RMI'
OC4J Port Type for J2EE Runtime Locations.

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

Name: ROOT_PATH
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The file system directory.

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

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

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

Name: TRANSFER_TYPE
Type: STRING
Valid Values: 'ASCII','IMAGE'
Default: 'IMAGE'
The transfer type to be used for FTP transport (TRANSPORT_TYPE=FTP).

Name: TRANSPORT_TYPE
Type: STRING
Valid Values: 'FILE','FTP','HTTP','HTTPS'
Default: 'FILE'
The transport type used for Discoverer, OBIEE and SAP type locations.

Name: URI
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The connection string.

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

Name: WEB_PORT
Type: STRING
Valid Values:
Default: '8888'
OC4J Web Port 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.

propertyValueList

The values for the named properties.

propertyValue

A property value.

LOCATION Object

Table 8-4 LOCATION Object

Property
Type
Choices
Min
Max
Default
Description

PLATFORM_NAME

STRING

none

none

none

empty string

Platform for the location.

VERSION

STRING

none

none

none

0

Version of the location

See Also

OMBCREATE

OMBALTER LOCATION

OMBDROP LOCATION

OMBCREATE LOGICAL_TABLE

Purpose

Creates a logical table that can be used in a business view.

Prerequisites

Should be in the context of an OBIEE Business Definition Module.

Syntax

createLogicalTableCommand =  ( OMBCREATE LOGICAL_TABLE "QUOTED_STRING" [
          SET "setpropertiesClauseDelayed" ] [ SET "setReferenceIconSetClause" ]
           { "addLogicalTableSCOClauses" } )
     setpropertiesClauseDelayed =  PROPERTIES "(" "propertyNameListVector" ")"
          VALUES "(" "propertyValueListVector" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addLogicalTableSCOClauses =  ADD ( "addItemClause" | "addJoinClause" )
     propertyNameListVector =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueListVector =  "propertyValue" { "," "propertyValue" }
     addItemClause =  ITEM "QUOTED_STRING" [ SET "setPropertiesClause" ] [ SET (
           REF | REFERENCE ) ( "ItemItemReferencesClause" |
          "ItemListOfValuesReferencesClause" |
          "ItemDrillToDetailReferencesClause" |
          "ItemAlternativeSortOrderReferencesClause" |
          "ItemColumnReferencesClause" ) ]
     addJoinClause =  JOIN "QUOTED_STRING" [ SET "setPropertiesClause" ] [ SET (
           REF | REFERENCE ) "JoinForeignKeyReferencesClause" ] {
          "joinComponentClause" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     ItemItemReferencesClause =  ITEM "QUOTED_STRING" OF ( ( ITEM_FOLDER
          "QUOTED_STRING" "itemJoinUsages" ) | ( LOGICAL_TABLE "QUOTED_STRING" )
           )
     ItemListOfValuesReferencesClause =  LIST_OF_VALUES "QUOTED_STRING"
     ItemDrillToDetailReferencesClause =  DRILL_TO_DETAIL "QUOTED_STRING"
     ItemAlternativeSortOrderReferencesClause =  ALTERNATIVE_SORT_ORDER
          "QUOTED_STRING"
     ItemColumnReferencesClause =  COLUMN "QUOTED_STRING" OF ( TABLE | (
          EXTERNAL_TABLE | ( VIEW | MATERIALIZED_VIEW ) ) ) "QUOTED_STRING" [
          USING FOREIGN_KEY "QUOTED_STRING" OF ( TABLE | ( VIEW |
          MATERIALIZED_VIEW ) ) "QUOTED_STRING" ]
     JoinForeignKeyReferencesClause =  FOREIGN_KEY "QUOTED_STRING" OF ( TABLE |
          ( VIEW | MATERIALIZED_VIEW ) ) "QUOTED_STRING"
     joinComponentClause =  ADD JOIN_COMPONENT "QUOTED_STRING" [ SET
          "setPropertiesClause" ] { SET ( REF | REFERENCE )
          "setJoinComponentClauseDetails" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     itemJoinUsages =  { USING JOIN "QUOTED_STRING" OF ITEM_FOLDER
          "QUOTED_STRING" }
     setJoinComponentClauseDetails =  LOCAL ITEM "QUOTED_STRING" | REMOTE ITEM
          "QUOTED_STRING" OF ( ( ITEM_FOLDER "QUOTED_STRING" ) | ( LOGICAL_TABLE
           "QUOTED_STRING" ) )

Parameters

createLogicalTableCommand

This command creates a logical table.

QUOTED_STRING

Specify the name of the logical table to be created.

setpropertiesClauseDelayed

This clause sets the properties.

setReferenceIconSetClause

Set specified Icon Set.

addLogicalTableSCOClauses

This clause adds items to a logical table.

propertyNameListVector

This clause holds the names of the properties.

propertyValueListVector

This clause holds the values of the properties.

addItemClause

This clause adds an item to a logical table.

ITEM

A field within the logical table.

QUOTED_STRING

The name of the item to be added.

addJoinClause

This clause adds a foreign key relationship to another logical table.

JOIN

A foreign key relationship with another logical table.

QUOTED_STRING

The name of the join to be added.

propertyValue

This is a property value.

setPropertiesClause

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

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

ItemItemReferencesClause

This clause is used to reference another item.

QUOTED_STRING

name of the referenced item.

ItemListOfValuesReferencesClause

This clause is used to reference a list of values.

QUOTED_STRING

name of the list of values.

ItemDrillToDetailReferencesClause

This clause is used to reference a drill to detail.

QUOTED_STRING

name of the drill to detail.

ItemAlternativeSortOrderReferencesClause

This clause is used to reference an alternative sort order.

QUOTED_STRING

name of the alternative sort order.

ItemColumnReferencesClause

This clause is used to reference a column.

QUOTED_STRING

name of the referenced column.

JoinForeignKeyReferencesClause

The foreign key reference.

joinComponentClause

The join components.

propertyNameList

This is the list of property names.

propertyValueList

This is the list of property values.

itemJoinUsages

The specific joins to be used.

setJoinComponentClauseDetails

The structure of the join component.

LOGICAL_TABLE Object

Table 8-5 LOGICAL_TABLE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER LOGICAL_TABLE

OMBRETRIEVE LOGICAL_TABLE

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

none

none

none

0

ANYDATA_CAST_OPERATOR Object

Table 8-11 ANYDATA_CAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FILTER_OPERATOR Object

Table 8-21 FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

FILTER_CONDITION

STRING

none

none

none

empty string

The boolean filtering condition that identifies what data is to be processed. Any row with a false condition will be ignored.

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

SUBQUERY_FILTER_OPERATOR Object

Table 8-22 SUBQUERY_FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SUBQUERY_FILTER_CONDITION

STRING

none

none

none

empty string

The Filter Condition for the subquery operator, if blank then the subquery stands alone with no join to the top-level query.

SUBQUERY_INPUT_ROLE

STRING(16)

EXISTS, IN, NOT_EXISTS, NOT_IN

none

none

EXISTS

The role the input stream plays in the subquery filter condition.

SUBQUERY_JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FLAT_FILE_OPERATOR Object

Table 8-23 FLAT_FILE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CONCATENATE_RECORDS

NUMBER

none

none

none

0

Number of Physical Records per Logical Record.

CONTINUATION_CHARACTER

STRING

none

none

none

empty string

Character that indicates the record is continued on the next line.

CONTINUATION_CHARACTER_ON_NEXT_LINE

BOOLEAN

true, false

none

none

FALSE

If there is a continuation character, is it at the start of the line.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The name of the directory in which to open the target data file. The directory must be deployed before the file can be created.

DEBUG_TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

ESCAPE_CHARACTER_FOR_ENCLOSURE

STRING

none

none

none

empty string

Escape character for data containing the enclosure character. This is only applicable with delimited files having enclosure characters.

FIELD_ENCLOSURE_CHARACTERS

STRING

none

none

none

empty string

Characters that wrap fields. Example ' or ".

FIELD_NAMES_IN_THE_FIRST_ROW

BOOLEAN

true, false

none

none

FALSE

Indicates whether file contains a header row.

FIELD_TERMINATION_CHARACTER

STRING

none

none

none

,

Character that separates the fields of a delimited file.

FILE_FORMAT

STRING

DELIMITED, FIXED

none

none

DELIMITED

File Format (Fixed or Delimited).

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LOADING_TYPE

STRING(16)

INSERT, NONE, UPDATE

none

none

INSERT

The loading operation to be performed

NLS_CHARACTERSET

STRING

none

none

none

WE8MSWIN1252

NLS Characterset

OUTPUT_AS_XML

BOOLEAN

true, false

none

none

false

Output data to file in XML format.

RECORDS_TO_SKIP

NUMBER

none

0

none

0

Number of logical records to skip

RECORD_DELIMITER

STRING

none

none

none

empty string

Character that indicates the end of the record.

RECORD_SIZE

NUMBER

none

none

none

0

Size of a fixed length record.

RECORD_TYPE_LENGTH

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the length of the data that identifies the type of record. It is used with the Record Type Position.

RECORD_TYPE_POSITION

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the position of the field that identifies the type of record.

SAMPLED_FILE_NAME

STRING

none

none

none

empty string

The default name of the physical file to be used by sqlloader. If the file was sampled, the default was set from sampled file name.

SOURCE_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The Location of the File Module of this Flat File at the time of reconciliation. Stored as UOID.

TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The location used to access referenced entity.

TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

INPUT_PARAMETER_OPERATOR Object

Table 8-24 INPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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

INPUT_SIGNATURE_OPERATOR Object

Table 8-25 INPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ITERATOR_OPERATOR Object

Table 8-26 ITERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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

JOINER_OPERATOR Object

Table 8-27 JOINER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

JOIN_CONDITION

STRING

none

none

none

empty string

The Join Condition for the join operator

JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

LOOKUP_OPERATOR Object

Table 8-28 LOOKUP_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRCAST_OPERATOR Object

Table 8-29 LCRCAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRSPLITTER_OPERATOR Object

Table 8-30 LCRSPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCHMERGE_OPERATOR Object

Table 8-31 MATCHMERGE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCH_KEYS

STRING

none

none

none

empty string

Ordered list of attributes that control the set of records to be matched at any at any particular time.

MATCH_NEW_RECORDS

BOOLEAN

true, false

none

none

false

MATCH_NEW_RECORD_CONDITION

STRING

none

none

none

empty string

MERGED_PREFIX

STRING

none

none

none

empty string

Set the prefix used for the merged attributes in the cross-reference group.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

MATERIALIZED_VIEW_OPERATOR Object

Table 8-32 MATERIALIZED_VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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).

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.

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

NAME_AND_ADDRESS_OPERATOR Object

Table 8-33 NAME_AND_ADDRESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

ADDRESS_LINE_1

STRING

none

none

none

empty string

Address line 1

ADDRESS_LINE_2

STRING

none

none

none

empty string

Address line 2

ADDRESS_LINE_3

STRING

none

none

none

empty string

Address line 3

ADDRESS_LINE_4

STRING

none

none

none

empty string

Address line 4

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

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

A dual address refers to two address lines for the same destination. For example, a record contains both a street address and a P.O. Box; this is common with business data. Select which of the two address lines should be assigned in these cases.

GENERATE_CASS_REPORT

STRING

NA_NO, NA_YES

none

none

NA_NO

Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS report is a text file specified by the United States Postal Service. The report is written to the [nas/bin/admin/reports] folder under the home folder of the name/address server.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LIST_NAME

STRING

none

none

none

empty string

The list name is optional and provides a reference for tracking multiple CASS reports.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Select a name-address parsing type to be performed on the input data

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Select the primary parsing country which best represents the input data. Input addresses having the same country as the primary parsing country will only need to be parsed once. Input addresses having a different country than the primary parsing country may be reparsed by a different parser. For performance reasons, it is best to minimize the percentage of 2-pass parses by selecting the optimal parser.

PROCESSOR_NAME

STRING

none

none

none

empty string

The processor name is the name of the organization submitting the CASS report.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

OUTPUT_PARAMETER_OPERATOR Object

Table 8-34 OUTPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

The name to use when refering to this entity in generated code.

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

OUTPUT_SIGNATURE_OPERATOR Object

Table 8-35 OUTPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_OPERATOR Object

Table 8-36 PIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_GROUP_SIZE

NUMBER

none

1

1000

2

A number specifying the pivot group size for the pivot operation. Pivot group size determines the number of output rows that are produced from each input row.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PLUGGABLE_MAPPING_OPERATOR Object

Table 8-37 PLUGGABLE_MAPPING_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

POSTMAPPING_PROCESS_OPERATOR Object

Table 8-38 POSTMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

POSTMAPPING_PROCESS_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING

none

none

ON_SUCCESS

Indicates under what condition of the mapping the post-mapping process will be run.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PREMAPPING_PROCESS_OPERATOR Object

Table 8-39 PREMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

MAPPING_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS

none

none

ON_SUCCESS

Indicates under what condition of the pre-mapping process the mapping will be run.

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

QUEUE_OPERATOR Object

Table 8-40 QUEUE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_AQ_UOID

STRING

none

none

none

empty string

The UOID of the Advanced Qeue object to which this stage component is bound to.

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.

DB_LOCATION

STRING

none

none

none

empty string

The location used to access this entity during mapping.

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

GENERATE_SUBSCRIBER

BOOLEAN

true, false

none

none

true

This only applies to batch mappings. This specifies whether the subscriber is generated. The name of the subscriber is the owning map. If the queue being sourced is a propagation queue with the same name as the owning map, then set to false.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

IS_REALTIME_SOURCE

BOOLEAN

true, false

none

none

false

IS_STREAMS_QUEUE

BOOLEAN

true, false

none

none

false

PAYLOAD_NAME

STRING

none

none

none

empty string

The name of payload type.

QUEUE_TABLE_NAME

STRING

none

none

none

empty string

The name of the queue table that is used to perist the messages in this Advanced Queue.

REAL_TIME_DATA_FORMAT

STRING

LOGICAL_CHANGE_RECORD, MESSAGE

none

none

MESSAGE

The format for this message, either user-defined or LCR

SOURCE_TABLES

STRING

none

none

none

empty string

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.

TEMPORARY_TABLE_NAME

STRING

none

none

none

empty string

The name of the temporary table that will stage the messages from the Advanced Queue.

UDT

STRING

none

none

none

empty string

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SEQUENCE_OPERATOR Object

Table 8-41 SEQUENCE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SET_OPERATION_OPERATOR Object

Table 8-42 SET_OPERATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SET_OPERATION

STRING

INTERSECT, MINUS, UNION, UNIONALL

none

none

UNION

Specifies the set operation that is to be performed by this operator.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SORTER_OPERATOR Object

Table 8-43 SORTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ORDER_BY_CLAUSE

STRING

none

none

none

empty string

The Order By Clause

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SPLITTER_OPERATOR Object

Table 8-44 SPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

TABLE_FUNCTION_OPERATOR Object

Table 8-45 TABLE_FUNCTION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

TABLE_FUNCTION_IS_TARGET

BOOLEAN

true, false

none

none

false

Description not available.

TABLE_FUNCTION_NAME

STRING

none

none

none

empty string

The name of the Table Function

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

TABLE_OPERATOR Object

Table 8-46 TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

Description not available.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

CONFLICT_RESOLUTION

BOOLEAN

true, false

none

none

true

Detect and resolve any conflicts that may arise during DML using the LCR APIs

CONTROL_CK

STRING

none

none

none

empty string

Set Control Code Template Params for Check Constraint.

CONTROL_DATA_RULES

STRING

none

none

none

empty string

Set Control Code Template Params for Data Rules.

CONTROL_FK

STRING

none

none

none

empty string

Set Control Code Template Params for Foreign Keys.

CONTROL_NN

STRING

none

none

none

empty string

Set Control Code Template Params for Not Null attributes.

CONTROL_PK

STRING

none

none

none

empty string

Set Control Code Template Params for Primary Keys.

CONTROL_UK

STRING

none

none

none

empty string

Set Control Code Template Params for Unique Keys.

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_LOCATION

STRING(30)

none

none

none

empty string

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

ISAPPLYSOURCE

BOOLEAN

true, false

none

none

false

Generate Non Trigger Apply uptime script considering this is a leading source for the map

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_ERROR_TABLE

BOOLEAN

true, false

none

none

false

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_STATIC_TABLE

BOOLEAN

true, false

none

none

false

Check source table operator static

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

IS_USER-DEFINED_DATA

BOOLEAN

true, false

none

none

false

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

JOINRANK

FLOAT

none

none

none

0

Join Rank

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

OPTIMIZE_MERGE

BOOLEAN

true, false

none

none

false

Optimize the execution of expressions by deferring them until really needed

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.

USE_LCR_API

BOOLEAN

true, false

none

none

true

Use LCR APIs if possible to perform the DML

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

ZDT_DOWNTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Downtime Extraction Index Hints

ZDT_DOWNTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

ZDT_UPTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Uptime Extraction Index Hints

ZDT_UPTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

TRANSFORMATION_OPERATOR Object

Table 8-47 TRANSFORMATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

RETURN_TYPE

STRING

none

none

none

empty string

Description not available.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

UNPIVOT_OPERATOR Object

Table 8-48 UNPIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

VIEW_OPERATOR Object

Table 8-49 VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

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_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150

INLINED

BOOLEAN

true, false

none

none

false

If set to true, the view query will be used as an inline subquery in the generated code.

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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

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.

VIEW_QUERY

STRING

none

none

none

empty string

The query text for this view.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

See Also

OMBCREATE

OMBALTER MAPPING

OMBRETRIEVE MAPPING

OMBDROP MAPPING

OMBCREATE MAPPING_MODULE

Purpose

To create a mapping module.

Prerequisites

Should be in the context of project.

Syntax

createMapModuleCommand =  OMBCREATE ( MAPPING_MODULE "QUOTED_STRING" [ SET
          ( "setPropertiesClause" [ SET
          "setReferenceClauseForDataMetadataModule" ] |
          "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

createMapModuleCommand

Create a new mapping module.

setPropertiesClause

Set values of properties of a mapping module.

getPropertiesClause

Basic properties for MAPPING_MODULE:

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

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

setReferenceClauseForDataMetadataModule

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

addModuleReferenceLocationClause

Add agent locations to the mapping module.

propertyNameList

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

propertyValueList

Comma-separated list of property values.

setReferenceLocationClause

Set a data location to a supported agent as the new configuration default.

setReferenceMetadataLocationOrIconSetOrJCTClause

Set metadata location and/or icon set and/or journal code template for the new mapping module.

addReferenceLocationClause

Add a data location to the mapping module.

propertyValue

Value of a property.

setReferenceMetadataLocationOrIconSetClause

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

setReferenceMetadataLocationClause

Set metadata location for the mapping module.

setReferenceIconSetClause

Set icon set for the mapping module.

MAPPING_MODULE Object

Table 8-50 MAPPING_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

ABAP_DIRECTORY

STRING

none

none

none

abap\

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

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.

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

none

empty string

END_OF_LINE

STRING

none

none

none

\r\n

End of Line

INPUT_DIRECTORY

STRING

none

none

none

input\

Input Directory

INVALID_DIRECTORY

STRING

none

none

none

invalid\

Directory for SQL*Loader errors and rejected records

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

PLSQL_DIRECTORY

STRING

none

none

none

pls\

Location where PL/SQL scripts are stored.

PLSQL_EXTENSION

STRING

none

none

none

.pls

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

SORT_DIRECTORY

STRING

none

none

none

sort\

Sort Directory

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

WORK_DIRECTORY

STRING

none

none

none

work\

Work Directory

See Also

OMBCREATE

OMBALTER MAPPING_MODULE

OMBDROP MAPPING_MODULE

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBCREATE

OMBALTER MATERIALIZED_VIEW

OMBDROP MATERIALIZED_VIEW

OMBRETRIEVE MATERIALIZED_VIEW

OMBCREATE MDL_ACTION_PLAN

Purpose

Create a metadataloader action plan.

Prerequisites

Connection must be established to the repository.

Syntax

createMDLActionPlanCommand =  ( OMBCREATE TRANSIENT MDL_ACTION_PLAN
          "QUOTED_STRING" { "addActionClause" } )
     addActionClause =  ADD ACTION "QUOTED_STRING" "setReferenceClause"
     setReferenceClause =  SET ( REF | REFERENCE ) ( "referenceValueClause" )
     referenceValueClause =  "objectTypeValue" "QUOTED_STRING" [ SET ( REF |
          REFERENCE ) "referenceValueClause" ]
     objectTypeValue =  ( PROJECT | ORACLE_MODULE | TABLE | VIEW | SEQUENCE |
          MATERIALIZED_VIEW | FUNCTION | PROCEDURE | PACKAGE | DIMENSION | CUBE
          | ADVANCED_QUEUE | MAPPING | REAL_TIME_MAPPING | PROCESS_FLOW_MODULE |
           PROCESS_FLOW_PACKAGE | PROCESS_FLOW | APPLICATION_SERVER_MODULE |
          WEB_SERVICE_PACKAGE | WEB_SERVICE | SAP_MODULE | CMI_MODULE |
          GATEWAY_MODULE | EXTERNAL_TABLE | FLAT_FILE_MODULE | FLAT_FILE |
          BUSINESS_DEFINITION_MODULE | OBIEE_BUSINESS_DEFINITION_MODULE |
          ITEM_FOLDER | LOGICAL_TABLE | LIST_OF_VALUES | DRILL_TO_DETAIL |
          ALTERNATIVE_SORT_ORDER | DRILL_PATH | BUSINESS_AREA | CATALOG_FOLDER |
           LOCATION | CONNECTOR | CONTROL_CENTER | CONFIGURATION | COLLECTION |
          SNAPSHOT | ROLE | USER | ICONSET | TRANSFORMATION_MODULE |
          CALENDAR_MODULE | CALENDAR_FOLDER | CALENDAR | EXPERT_MODULE | EXPERT
          | CT_FOLDER | CT | DATA_RULE_MODULE | DATA_RULE | DATA_AUDITOR |
          QUEUE_TABLE | QUEUE_PROPAGATION | OBJECT_TYPE | NESTED_TABLE |
          VARYING_ARRAY | DEPLOYMENT | DATA_PROFILE | PROFILE_REFERENCE |
          PLSQL_TABLE_TYPE | PLSQL_RECORD_TYPE | PLSQL_REF_CURSOR_TYPE |
          PLUGGABLE_MAPPING | PLUGGABLE_MAPPING_FOLDER |
          PLUGGABLE_MAPPING_LIBRARY | CMI_DEFINITION | ACTIVITY_TEMPLATE |
          ACTIVITY_TEMPLATE_FOLDER | TRANSPORTABLE_MODULE | MODULE )

Parameters

createMDLActionPlanCommand

Create a metadata loader action plan.

QUOTED_STRING

Name of the action plan in a single-quoted string. It is case-insensitive.

addActionClause

Add an action to an action plan.

QUOTED_STRING

Name of the action in a single-quoted string. It is case-insensitive. Must be unquie within an action plan.

setReferenceClause

Specify the object type and the absolute path name of an object.

referenceValueClause

Specify a first-class object type and the absolute pathname of an object.

QUOTED_STRING

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

objectTypeValue

The first-class object type that is allowed to be specified in the referenceValueClause.

See Also

OMBALTER MDL_ACTION_PLAN

OMBDROP MDL_ACTION_PLAN

OMBRETRIEVE MDL_ACTION_PLAN

OMUEXPORT MDL_FILE

OMBCREATE MODULE

Purpose

createModuleCommandPurposeTag??

Prerequisites

createModuleCommandPreTag??

Syntax

createModuleCommand =  OMBCREATE ( MODULE "QUOTED_STRING"
          "createModuleSetPropertiesClause" [ SET
          "setReferenceClauseForDataMetadataModule" ] [
          "addModuleReferenceLocationClause" ] )
     createModuleSetPropertiesClause =  SET 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

setReferenceClauseForDataMetadataModule

Set location and/or icon set for the module.

addModuleReferenceLocationClause

Add data locations to the 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 module as the new configuration default.

addReferenceLocationClause

Add a data location to the module.

propertyValue

Value of a property.

setReferenceMetadataLocationOrIconSetClause

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

setReferenceMetadataLocationClause

Set metadata location for the module.

setReferenceIconSetClause

Set icon set for the module.

See Also

OMBCREATE

OMBALTER MODULE

OMBCREATE NESTED_TABLE

Purpose

To create an Nested Table (or NestedTable)

Prerequisites

Should be in the context of an Oracle Module

Syntax

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

Parameters

createNestedTableCommand

Creates a Nested Table with the given name.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Nested Table . Valid properties are shown below:

getPropertiesClause

Basic properties for NESTED_TABLE:

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

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

Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Base Element of the Nested Table

setReferenceIconSetClause

Sets reference icon set.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

NESTED_TABLE Object

Table 8-58 NESTED_TABLE Object

Property
Type
Choices
Min
Max
Default
Description

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBCREATE

OMBALTER NESTED_TABLE

OMBDROP NESTED_TABLE

OMBCREATE OBIEE_BUSINESS_DEFINITION_MODULE

Purpose

To create an Oracle BI business definition module.

Prerequisites

Should be in the context of project.

Syntax

createOBIEEModuleCommand =  OMBCREATE ( OBIEE_BUSINESS_DEFINITION_MODULE
          "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET
          "setReferenceClauseForDataOnlyModule" ] |
          "setReferenceClauseForDataOnlyModule" ) ] [
          "addModuleReferenceLocationClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataOnlyModule =  ( "setReferenceLocationClause" [ SET
           "setReferenceIconSetClause" ] | "setReferenceIconSetClause" )
     addModuleReferenceLocationClause =  "addReferenceLocationClause" {
          "addReferenceLocationClause" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addReferenceLocationClause =  ADD ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" [ SET AS DEFAULT ]
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createOBIEEModuleCommand

This command creates an Oracle BI business definition module.

QUOTED_STRING

Specify the name of an Oracle BI business definition module to be created.

setPropertiesClause

Associate a set of properties with an 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

setReferenceClauseForDataOnlyModule

Set data location and/or icon set for the new Oracle BI business definition module.

addModuleReferenceLocationClause

Add data locations to the new Oracle BI business definition module.

propertyNameList

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

propertyValueList

Comma-separated list of property values.

setReferenceLocationClause

Set a data location for an Oracle BI business definition module as the new configuration default.

setReferenceIconSetClause

Set icon set for the new Oracle BI business definition module.

addReferenceLocationClause

Add a data location to the new Oracle BI business definition module.

propertyValue

Value for a specified property.

OBIEE_BUSINESS_DEFINITION_MODULE Object

Table 8-59 OBIEE_BUSINESS_DEFINITION_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBCREATE

OMBALTER OBIEE_BUSINESS_DEFINITION_MODULE

OMBDROP OBIEE_BUSINESS_DEFINITION_MODULE

OMBCREATE OBJECT_TYPE

Purpose

To create an Object Type.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

createObjectTypeCommand =  OMBCREATE ( OBJECT_TYPE "QUOTED_STRING" [ SET (
          "setPropertiesClause" [ SET ( REF | REFERENCE )
          "setReferenceIconSetClause" ] | ( REF | REFERENCE )
          "setReferenceIconSetClause" ) ] [ "addObjectAttributesClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     addObjectAttributesClause =  "addAttributeClause"+
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addAttributeClause =  ADD OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING" [ AT
          POSITION "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createObjectTypeCommand

Creates an Object Type with the given name.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Object Type or its Attributes. Valid properties are shown below:

getPropertiesClause

Basic properties for OBJECT_TYPE:

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

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

Basic properties for OBJECT_TYPE_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, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Attribute

setReferenceIconSetClause

Sets reference icon set.

addObjectAttributesClause

Adds one or more Attributes in this Object Type.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

addAttributeClause

Adds an Attribute with the given name and properties.

propertyValue

This clause adds the property values.

OBJECT_TYPE Object

Table 8-60 OBJECT_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

OBJECT_TYPE_ATTRIBUTE Object

Table 8-61 OBJECT_TYPE_ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBCREATE

OMBALTER OBJECT_TYPE

OMBDROP OBJECT_TYPE

OMBCREATE ORACLE_EBS_MODULE

Purpose

createOracleEBSModuleCommandPurposeTag??

Prerequisites

createOracleEBSModuleCommandPreTag??

Syntax

createOracleEBSModuleCommand =  OMBCREATE ( ORACLE_EBS_MODULE
          "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET
          "setReferenceClauseForDataMetadataModule" ] |
          "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

getPropertiesClause

corePropertiesForOracleEBSModuleTag??

See Also

OMBCREATE

OMBALTER ORACLE_EBS_MODULE

OMBDROP ORACLE_EBS_MODULE

OMBCREATE ORACLE_MODULE

Purpose

To create an Oracle module.

Prerequisites

Should be in the context of project.

Syntax

createOracleModuleCommand =  OMBCREATE ( ORACLE_MODULE "QUOTED_STRING" [
          SET ( "setPropertiesClause" [ SET
          "setReferenceClauseForDataMetadataModule" ] |
          "setReferenceClauseForDataMetadataModule" ) ] [
          "addModuleReferenceLocationClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "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

createOracleModuleCommand

This command creates an Oracle module

QUOTED_STRING

Name of the Oracle module to be created.

setPropertiesClause

Associate a set of properties with an Oracle module.

getPropertiesClause

Basic properties for ORACLE_MODULE:

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

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

setReferenceClauseForDataMetadataModule

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

addModuleReferenceLocationClause

Add data locations to the Oracle module.

propertyNameList

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

propertyValueList

Comma separated list of property values.

setReferenceLocationClause

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

addReferenceLocationClause

Add a data location to the Oracle module.

propertyValue

Value of a property.

setReferenceMetadataLocationOrIconSetClause

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

setReferenceMetadataLocationClause

Set metadata location for the Oracle module.

setReferenceIconSetClause

Set icon set for the Oracle module.

ORACLE_MODULE Object

Table 8-62 ORACLE_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

ABAP_DIRECTORY

STRING

none

none

none

abap\

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

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.

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

none

empty string

END_OF_LINE

STRING

none

none

none

\r\n

End of Line

INPUT_DIRECTORY

STRING

none

none

none

input\

Input Directory

INVALID_DIRECTORY

STRING

none

none

none

invalid\

Directory for SQL*Loader errors and rejected records

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

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

SORT_DIRECTORY

STRING

none

none

none

sort\

Sort Directory

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

WORK_DIRECTORY

STRING

none

none

none

work\

Work Directory

See Also

OMBCREATE

OMBALTER ORACLE_MODULE

OMBDROP ORACLE_MODULE

Note:

To create modules in non-Oracle platforms such as DB2 and SQL Server, use the command OMBCREATE UNQUOTED_STRING.

OMBCREATE ORACLE_TARGET_CT

Purpose

To create an Oracle Target Code Template.

Prerequisites

In the context of an CT module.

Syntax

createTCTCommand =  OMBCREATE ORACLE_TARGET_CT "QUOTED_STRING" {
          "kmCreateOptionsOptionsClause" }
     kmCreateOptionsOptionsClause =  SET "setReferenceIconSetClause" | SET
          "setPropertiesClause" | ADD ( "addParameterClause" |
          "addVariableClause" | "addCTTaskClause" | "addNestedCTTaskClause" |
          "addTransitionClause" )
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     addParameterClause =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
           [ SET "setPropertiesClause" ] [ "parameterBindingClause" ]
     addVariableClause =  VARIABLE "QUOTED_STRING" [ SET "setPropertiesClause" ]
     addCTTaskClause =  "TASK_TYPE" TASK "QUOTED_STRING" {
          "kmTaskAddOptionsOptionsClause" }
     addNestedCTTaskClause =  NESTED_CT TASK "QUOTED_STRING" SET [
          "collectPropertiesClause" SET ] ( REF | REFERENCE ) CT "QUOTED_STRING"
           [ SET "setReferenceIconSetClause" ]
     addTransitionClause =  TRANSITION "QUOTED_STRING" FROM TASK "QUOTED_STRING"
           TO "QUOTED_STRING" [ SET "setPropertiesClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     parameterBindingClause =  UNBIND | BIND TO ( "parameterLocator" |
          "variableLocator" )
     kmTaskAddOptionsOptionsClause =  SET "setReferenceIconSetClause" | UNSET
          "unsetReferenceIconSetClause" | SET "setPropertiesClause"
     collectPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     parameterLocator =  PARAMETER "QUOTED_STRING" [ OF TASK "QUOTED_STRING" ]
     variableLocator =  VARIABLE "QUOTED_STRING"
     unsetReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET

Parameters

createTCTCommand

Creates a Oracle Target CT. The following code template will be created by default:

{0}

setReferenceIconSetClause

Set icon set for the expert module.

setPropertiesClause

This clause sets properties for the corresponding object.

setPropertiesClause

Basic properties for Code Template:

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

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

Basic properties for TASK:

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

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

addParameterClause

Add a parameter to the expert or one of it's tasks.

addVariableClause

Add a variable to the expert.

addTransitionClause

Add a transition to the expert.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

parameterBindingClause

Bind or unbind two parameters. Note that this is setting the binding attribute of the parameter object and is not necessarily the same as the direction of data flow. The parameter to be set should be the one whose binding attribute is modified via the Object Inspector in the expert editor.

collectPropertiesClause

This clause sets properties for the corresponding object.

propertyValue

Value of a property.

parameterLocator

Specify a parameter, either one of the expert or of a task.

variableLocator

Specify a variable in the expert.

ORACLE_TARGET_CT Object

Table 8-63 ORACLE_TARGET_CT Object

Property
Type
Choices
Min
Max
Default
Description

EXECUTION_TYPE

STRING

PLSQL_BATCH, PLSQL_TRICKLE

none

none

PLSQL_BATCH

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBCREATE

OMBALTER CT

OMBRETRIEVE CT

OMBDROP CT

OMBCREATE PACKAGE

Purpose

To create a Package.

Prerequisites

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

A Transformation Module may be WB_CUSTOM_TRANS for Public Transformations.

WB_CUSTOM_TRANS may by modified by an administrator.

WB_CUSTOM_TRANS is not dependent on any project.

Syntax

createPackageCommand =  OMBCREATE ( PACKAGE "QUOTED_STRING" ( [ SET (
          "setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) ] ) { ADD "addRelationalDependentClause"
           } )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
          "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createPackageCommand

This command creates a Package

QUOTED_STRING

Name of the Package to be created.

setPropertiesClause

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

setPropertiesClause

Basic properties for PACKAGE:

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

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

setReferenceIconSetClause

Set reference icon set to this

addRelationalDependentClause

This clause adds referential dependencies to other relational objects.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

PACKAGE Object

Table 8-64 PACKAGE Object

Property
Type
Choices
Min
Max
Default
Description

AUTHID

STRING

, Current_User, Definer

none

none

empty string

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

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBCREATE

OMBALTER PACKAGE

OMBDROP PACKAGE

OMBCREATE PLATFORM

Purpose

Defines a new platform enabling a flexible mechanism to easily integrate disparate systems. The extensible platform capabilities plus code templates make for an extensible framework to extend the integration capabilities of the product.

The platform definition constitutes a number of properties (including how to connect, naming lengths and restrictions), platform data types (including the syntax for creation etc.) and their mapping to and from the generic type set. You can query the generic type set by performing the following;

OMBRETRIEVE PLATFORM 'GENERIC' GET PLATFORM_TYPES

These are the types you will map to and from the platform definition. You can also specify a custom import definition as an alternative to using the metadata available from the driver.

Prerequisites

Should be in the context of a project, before creating a platform.

Syntax

createPlatformCommand =  OMBCREATE ( PLATFORM "QUOTED_STRING" [ SET
          "setPropertiesClause" ] ( { "addPlatformTypeClause" } ) ( {
          "addFromPlatformTypeMapClause" } ) ( { "addToPlatformTypeMapClause" }
          ) [ SET "setMIVForPlatformClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     addPlatformTypeClause =  ADD ( PLATFORM_TYPE "QUOTED_STRING" [ SET
          "setPropertiesClause" ] )
     addFromPlatformTypeMapClause =  ADD ( FROM_PLATFORM_TYPEMAP "QUOTED_STRING"
           [ SET "setPropertiesClause" ] )
     addToPlatformTypeMapClause =  ADD ( TO_PLATFORM_TYPEMAP "QUOTED_STRING" [
          SET "setPropertiesClause" ] )
     setMIVForPlatformClause =  ( ( REF | REFERENCE ) CMI_DEFINITION
          "QUOTED_STRING" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createPlatformCommand

Create a platform definition in the repository.

setPropertiesClause

Set the characteristics of the platform, this includes the driver class for connecting to the system and default connection string.

platformTypeProperties

Basic properties for PLATFORM:

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

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

platformTypeProperties

Properties for PLATFORM:
Name: COL_ALIAS_WORD
Type: STRING
Column alias word.

Name: DATE_FCT
Type: STRING
The function allowing the date and time to be returned - for example in Oracle this would by SYSDATE and DB2 UDB would be CURRENT TIMESTAMP

Name: DATE_MASK
Type: STRING
The syntax to be used to describe the Date datatype in DDL, for example in Oracle may be DATE in DB2 UDB TIMESTAMP.

Name: DDLNULL
Type: STRING
The word used to describe a column that can contain empty (null) values. For example in Oracle NULL is used.

Name: DEFAULT_MAX_NAME_LEN
Type: INTEGER
The default max length name of a relational access item (ie. a table).

Name: DEFAULT_NAME_LEN_SEMANTICS
Type: STRING
The name length semantics to be used (CHARACTER or BYTE).

Name: DELETE_IN_OVERRIDE
Type: BOOLEAN
Delete in override property

Name: DRIVER_CLASS
Type: STRING
The driver class name, all locations created for this platform will be created using this driver class.

Name: ENCLOSURE_CHAR
Type: STRING
The character used to delimit names ie. single quote, double quote etc.

Name: ESCAPE_CHAR
Type: STRING
Escape character.

Name: ILLEGAL_CHARS
Type: STRING
The list of illegal characters that can be in a name.

Name: ILLEGAL_LEADING_CHARS
Type: STRING
The list of illegal characters that a name can start with.

Name: LOCAL_OBJECT_MASK
Type: STRING
This determines how an object is named when you are connected to the location the object is based on. For Oracle this should be
%SCHEMA.%OBJECT The list of tags available for the mask include;
%CATALOG to represent the physical catalog name
%SCHEMA to represent the schema name
%OBJECT to represent the object name

Name: NUMERIC_MASK
Type: STRING
The syntax to be used to describe the Numerical datatype in DDL, the tags %L (data length) and %P (precision) can be used.

Name: REMOTE_OBJECT_MASK
Type: STRING
This determines how an object is named when you are not connected to the location the object is based on. For Oracle this should be
%SCHEMA.%OBJECT The list of tags available for the mask include;
%CATALOG to represent the physical catalog name
%SCHEMA to represent the schema name
%OBJECT to represent the object name
%DSERVER to represent the data server

Name: RESERVED_WORDS
Type: STRING
The list of reserved words which cannot be used for names of objects.

Name: SEEDED
Type: BOOLEAN
A flag to indicate if the platform was seeded.

Name: SPECIAL_MAX_NAME_LEN
Type: STRING
Name length for secondary objects such as column, index (the value has the following format INDEX=18:COLUMN=30:PACKAGE=18)

Name: SPECIAL_NAME_LEN_SEMANTICS
Type: STRING
SpecialNameLenSemantics

Name: TAB_ALIAS_WORD
Type: STRING
The element designed to separate a table name from its alias in a SQL FROM clause. This element may be left incomplete.

Name: URI_TEMPLATE
Type: STRING
A sample template URI for accessing the platform.

Name: VARCHAR_MASK
Type: STRING
The syntax to be used to describe the String datatype in DDL, the tags %L (data length) and %P (precision) can be used.

platformTypeProperties

Properties for PLATFORM_TYPE:
Name: IS_DEFAULT
Type: BOOLEAN
Is this the default datatype for the platform.

Name: P1
Type: STRING
Parameter from the following list (leave blank if not applicable);
size: for length
precision: for numbers
scale: for numbers

Name: P1DEFAULT
Type: STRING
Default value for P1; leave blank if not applicable

Name: P1MAX
Type: STRING
Maximum value for P1; leave blank if not applicable

Name: P1MIN
Type: STRING
Minimum value for P1; leave blank if not applicable

Name: P1TYPE
Type: STRING
Parameter type from the following supported list (Leave blank if not applicable): range

Name: SEEDED
Type: BOOLEAN
Seeded indicator for the platform types which are pre-seeded.

Name: SYNTAX
Type: STRING
DDL Syntax for columns of this data type, can use %size %precision %scale. For example CHAR(%size) is the syntax for defining a data type of CHAR which has a particular length

addPlatformTypeClause

Add a type to the platform definition.

addFromPlatformTypeMapClause

Add a mapping from this type to a generic type.

addToPlatformTypeMapClause

Add a mapping from a generic type to thid platform type.

setMIVForPlatformClause

Set the CMI Definition for this platform. This optional class lets custom metadata import objects be defined to override the use of the JDBC metadata import for example.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

See Also

OMBCREATE

OMBALTER PLATFORM

OMBDROP PLATFORM

OMBCREATE PLSQL_RECORD_TYPE

Purpose

To create a PLSQL Record Type.

Prerequisites

Should be in the context of a Package.

Syntax

createPlSqlRecordTypeCommand =  OMBCREATE ( PLSQL_RECORD_TYPE
          "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET ( REF | REFERENCE
          ) "setReferenceIconSetClause" ] | ( REF | REFERENCE )
          "setReferenceIconSetClause" ) ] [ "addPlSqlRecordAttributesClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     addPlSqlRecordAttributesClause =  "addRecordTypeAttributeClause"+
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addRecordTypeAttributeClause =  ADD ATTRIBUTE "QUOTED_STRING" [ AT POSITION
           "INTEGER_LITERAL" ] [ SET "setPropertiesClause" ]
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createPlSqlRecordTypeCommand

Creates an PLSQL Record Type with the given name.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for PLSQL Record Type or its Attributes. Valid properties are shown below:

getPropertiesClause

Basic properties for PLSQL_RECORD_TYPE:

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

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

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, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Attribute

setReferenceIconSetClause

Sets reference icon set to this PLSQL Record Type.

addPlSqlRecordAttributesClause

Adds one or more Attributes in this PLSQL Record Type.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

addRecordTypeAttributeClause

Adds an attribute to this PLSQL Record Type

propertyValue

This clause adds the property values.

PLSQL_RECORD_TYPE Object

Table 8-65 PLSQL_RECORD_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

ATTRIBUTE Object

Table 8-66 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE

OMBALTER PLSQL_RECORD_TYPE

OMBDROP PLSQL_RECORD_TYPE

OMBCREATE PLSQL_REF_CURSOR_TYPE

Purpose

To create a PLSQL Ref-Cursor Type.

Prerequisites

Should be in the context of a Package.

Syntax

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

Parameters

createPlSqlRefCursorTypeCommand

Creates a PL/SQL Ref-Cursor Type with the given name.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Ref-Cursor Type Valid properties are shown below:

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.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

PLSQL_REF_CURSOR_TYPE Object

Table 8-67 PLSQL_REF_CURSOR_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

PLSQL_REF_CURSOR_TYPE Object

Table 8-68 PLSQL_REF_CURSOR_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBCREATE

OMBALTER PLSQL_REF_CURSOR_TYPE

OMBDROP PLSQL_REF_CURSOR_TYPE

9 OMBCREATE PLSQL_TABLE_TYPE to OMBCREATE TIME_DIMENSION

OMBCREATE PLSQL_TABLE_TYPE

OMBCREATE PLUGGABLE_MAPPING

OMBCREATE PLUGGABLE_MAPPING_FOLDER

OMBCREATE PROCEDURE

OMBCREATE PROCESS_FLOW

OMBCREATE PROCESS_FLOW_MODULE

OMBCREATE PROCESS_FLOW_PACKAGE

OMBCREATE PROJECT

OMBCREATE PSFT_MODULE

OMBCREATE QUEUE_PROPAGATION

OMBCREATE QUEUE_TABLE

OMBCREATE REAL_TIME_MAPPING

OMBCREATE REGISTERED_FUNCTION

OMBCREATE ROLE

OMBCREATE SAP_MODULE

OMBCREATE SEQUENCE

OMBCREATE SIEBEL_MODULE

OMBCREATE SNAPSHOT

OMBCREATE TABLE

OMBCREATE TABLE_FUNCTION

OMBCREATE TIME_DIMENSION

OMBCREATE PLSQL_TABLE_TYPE

Purpose

To create a PLSQL Table Type.

Prerequisites

Should be in the context of a Package.

Syntax

createPlSqlTableTypeCommand =  OMBCREATE ( PLSQL_TABLE_TYPE "QUOTED_STRING"
           SET "setPropertiesClause" )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createPlSqlTableTypeCommand

Creates a PL/SQL Table Type with the given name.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Table Type Valid properties are shown below:

getPropertiesClause

Basic properties for PLSQL_TABLE_TYPE:

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

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

Name: RETURN_TYPE
Type: STRING(20)
Valid Values: NUMBER, VARCHAR2, VARCHAR, DATE, FLOAT
Default: Empty string
Return type of the Table Type. This can be a scalar type or a PLSQL Record Type.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

PLSQL_TABLE_TYPE Object

Table 9-1 PLSQL_TABLE_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

PLSQL_TABLE_TYPE Object

Table 9-2 PLSQL_TABLE_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBCREATE

OMBALTER PLSQL_TABLE_TYPE

OMBDROP PLSQL_TABLE_TYPE

OMBCREATE PLUGGABLE_MAPPING

Purpose

Create a pluggable mapping in a project or a pluggable map folder.

Prerequisites

1. The current context of scripting must be a project or pluggable map folder.

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

3. The pluggable mapping name must not conflict with existing pluggable mapping names and the pluggable mappings names that concurrent user tries to use.

Syntax

createPluggableMappingCommand =  OMBCREATE PLUGGABLE_MAPPING
          "pluggableMapName" [ "createOperatorOwnerDetailClause" ]
     pluggableMapName =  "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" )
     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

createPluggableMappingCommand

Create a pluggable mapping in a project or a pluggable map folder.

pluggableMapName

Name of the pluggable map.

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 pluggable 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.

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.

PLUGGABLE_MAPPING Object

Table 9-3 PLUGGABLE_MAPPING Object

Property
Type
Choices
Min
Max
Default
Description

DIAGRAM_LAYOUT

STRING

none

none

none

empty string

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 9-4 OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-5 GROUP Object

Property
Type
Choices
Min
Max
Default
Description

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

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 9-6 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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 9-7 AGGREGATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

none

none

none

0

ANYDATA_CAST_OPERATOR Object

Table 9-8 ANYDATA_CAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-9 CONSTANT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-10 CONSTRUCT_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-11 CUBE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-12 DATA_GENERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-13 DEDUPLICATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-14 DIMENSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-15 EXPAND_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-16 EXPRESSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-17 EXTERNAL_TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FILTER_OPERATOR Object

Table 9-18 FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

FILTER_CONDITION

STRING

none

none

none

empty string

The boolean filtering condition that identifies what data is to be processed. Any row with a false condition will be ignored.

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

SUBQUERY_FILTER_OPERATOR Object

Table 9-19 SUBQUERY_FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SUBQUERY_FILTER_CONDITION

STRING

none

none

none

empty string

The Filter Condition for the subquery operator, if blank then the subquery stands alone with no join to the top-level query.

SUBQUERY_INPUT_ROLE

STRING(16)

EXISTS, IN, NOT_EXISTS, NOT_IN

none

none

EXISTS

The role the input stream plays in the subquery filter condition.

SUBQUERY_JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FLAT_FILE_OPERATOR Object

Table 9-20 FLAT_FILE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CONCATENATE_RECORDS

NUMBER

none

none

none

0

Number of Physical Records per Logical Record.

CONTINUATION_CHARACTER

STRING

none

none

none

empty string

Character that indicates the record is continued on the next line.

CONTINUATION_CHARACTER_ON_NEXT_LINE

BOOLEAN

true, false

none

none

FALSE

If there is a continuation character, is it at the start of the line.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The name of the directory in which to open the target data file. The directory must be deployed before the file can be created.

DEBUG_TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

ESCAPE_CHARACTER_FOR_ENCLOSURE

STRING

none

none

none

empty string

Escape character for data containing the enclosure character. This is only applicable with delimited files having enclosure characters.

FIELD_ENCLOSURE_CHARACTERS

STRING

none

none

none

empty string

Characters that wrap fields. Example ' or ".

FIELD_NAMES_IN_THE_FIRST_ROW

BOOLEAN

true, false

none

none

FALSE

Indicates whether file contains a header row.

FIELD_TERMINATION_CHARACTER

STRING

none

none

none

,

Character that separates the fields of a delimited file.

FILE_FORMAT

STRING

DELIMITED, FIXED

none

none

DELIMITED

File Format (Fixed or Delimited).

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LOADING_TYPE

STRING(16)

INSERT, NONE, UPDATE

none

none

INSERT

The loading operation to be performed

NLS_CHARACTERSET

STRING

none

none

none

WE8MSWIN1252

NLS Characterset

OUTPUT_AS_XML

BOOLEAN

true, false

none

none

false

Output data to file in XML format.

RECORDS_TO_SKIP

NUMBER

none

0

none

0

Number of logical records to skip

RECORD_DELIMITER

STRING

none

none

none

empty string

Character that indicates the end of the record.

RECORD_SIZE

NUMBER

none

none

none

0

Size of a fixed length record.

RECORD_TYPE_LENGTH

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the length of the data that identifies the type of record. It is used with the Record Type Position.

RECORD_TYPE_POSITION

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the position of the field that identifies the type of record.

SAMPLED_FILE_NAME

STRING

none

none

none

empty string

The default name of the physical file to be used by sqlloader. If the file was sampled, the default was set from sampled file name.

SOURCE_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The Location of the File Module of this Flat File at the time of reconciliation. Stored as UOID.

TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The location used to access referenced entity.

TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

INPUT_PARAMETER_OPERATOR Object

Table 9-21 INPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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

INPUT_SIGNATURE_OPERATOR Object

Table 9-22 INPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ITERATOR_OPERATOR Object

Table 9-23 ITERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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

JOINER_OPERATOR Object

Table 9-24 JOINER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

JOIN_CONDITION

STRING

none

none

none

empty string

The Join Condition for the join operator

JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

LOOKUP_OPERATOR Object

Table 9-25 LOOKUP_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRCAST_OPERATOR Object

Table 9-26 LCRCAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRSPLITTER_OPERATOR Object

Table 9-27 LCRSPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCHMERGE_OPERATOR Object

Table 9-28 MATCHMERGE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCH_KEYS

STRING

none

none

none

empty string

Ordered list of attributes that control the set of records to be matched at any at any particular time.

MATCH_NEW_RECORDS

BOOLEAN

true, false

none

none

false

MATCH_NEW_RECORD_CONDITION

STRING

none

none

none

empty string

MERGED_PREFIX

STRING

none

none

none

empty string

Set the prefix used for the merged attributes in the cross-reference group.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

MATERIALIZED_VIEW_OPERATOR Object

Table 9-29 MATERIALIZED_VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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).

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.

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

NAME_AND_ADDRESS_OPERATOR Object

Table 9-30 NAME_AND_ADDRESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

ADDRESS_LINE_1

STRING

none

none

none

empty string

Address line 1

ADDRESS_LINE_2

STRING

none

none

none

empty string

Address line 2

ADDRESS_LINE_3

STRING

none

none

none

empty string

Address line 3

ADDRESS_LINE_4

STRING

none

none

none

empty string

Address line 4

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

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

A dual address refers to two address lines for the same destination. For example, a record contains both a street address and a P.O. Box; this is common with business data. Select which of the two address lines should be assigned in these cases.

GENERATE_CASS_REPORT

STRING

NA_NO, NA_YES

none

none

NA_NO

Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS report is a text file specified by the United States Postal Service. The report is written to the [nas/bin/admin/reports] folder under the home folder of the name/address server.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LIST_NAME

STRING

none

none

none

empty string

The list name is optional and provides a reference for tracking multiple CASS reports.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Select a name-address parsing type to be performed on the input data

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Select the primary parsing country which best represents the input data. Input addresses having the same country as the primary parsing country will only need to be parsed once. Input addresses having a different country than the primary parsing country may be reparsed by a different parser. For performance reasons, it is best to minimize the percentage of 2-pass parses by selecting the optimal parser.

PROCESSOR_NAME

STRING

none

none

none

empty string

The processor name is the name of the organization submitting the CASS report.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

OUTPUT_PARAMETER_OPERATOR Object

Table 9-31 OUTPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

The name to use when refering to this entity in generated code.

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

OUTPUT_SIGNATURE_OPERATOR Object

Table 9-32 OUTPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_OPERATOR Object

Table 9-33 PIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_GROUP_SIZE

NUMBER

none

1

1000

2

A number specifying the pivot group size for the pivot operation. Pivot group size determines the number of output rows that are produced from each input row.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PLUGGABLE_MAPPING_OPERATOR Object

Table 9-34 PLUGGABLE_MAPPING_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

POSTMAPPING_PROCESS_OPERATOR Object

Table 9-35 POSTMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

POSTMAPPING_PROCESS_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING

none

none

ON_SUCCESS

Indicates under what condition of the mapping the post-mapping process will be run.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PREMAPPING_PROCESS_OPERATOR Object

Table 9-36 PREMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

MAPPING_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS

none

none

ON_SUCCESS

Indicates under what condition of the pre-mapping process the mapping will be run.

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

QUEUE_OPERATOR Object

Table 9-37 QUEUE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_AQ_UOID

STRING

none

none

none

empty string

The UOID of the Advanced Qeue object to which this stage component is bound to.

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.

DB_LOCATION

STRING

none

none

none

empty string

The location used to access this entity during mapping.

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

GENERATE_SUBSCRIBER

BOOLEAN

true, false

none

none

true

This only applies to batch mappings. This specifies whether the subscriber is generated. The name of the subscriber is the owning map. If the queue being sourced is a propagation queue with the same name as the owning map, then set to false.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

IS_REALTIME_SOURCE

BOOLEAN

true, false

none

none

false

IS_STREAMS_QUEUE

BOOLEAN

true, false

none

none

false

PAYLOAD_NAME

STRING

none

none

none

empty string

The name of payload type.

QUEUE_TABLE_NAME

STRING

none

none

none

empty string

The name of the queue table that is used to perist the messages in this Advanced Queue.

REAL_TIME_DATA_FORMAT

STRING

LOGICAL_CHANGE_RECORD, MESSAGE

none

none

MESSAGE

The format for this message, either user-defined or LCR

SOURCE_TABLES

STRING

none

none

none

empty string

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.

TEMPORARY_TABLE_NAME

STRING

none

none

none

empty string

The name of the temporary table that will stage the messages from the Advanced Queue.

UDT

STRING

none

none

none

empty string

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SEQUENCE_OPERATOR Object

Table 9-38 SEQUENCE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SET_OPERATION_OPERATOR Object

Table 9-39 SET_OPERATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SET_OPERATION

STRING

INTERSECT, MINUS, UNION, UNIONALL

none

none

UNION

Specifies the set operation that is to be performed by this operator.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SORTER_OPERATOR Object

Table 9-40 SORTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ORDER_BY_CLAUSE

STRING

none

none

none

empty string

The Order By Clause

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SPLITTER_OPERATOR Object

Table 9-41 SPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

TABLE_FUNCTION_OPERATOR Object

Table 9-42 TABLE_FUNCTION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

TABLE_FUNCTION_IS_TARGET

BOOLEAN

true, false

none

none

false

Description not available.

TABLE_FUNCTION_NAME

STRING

none

none

none

empty string

The name of the Table Function

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

TABLE_OPERATOR Object

Table 9-43 TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

Description not available.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

CONFLICT_RESOLUTION

BOOLEAN

true, false

none

none

true

Detect and resolve any conflicts that may arise during DML using the LCR APIs

CONTROL_CK

STRING

none

none

none

empty string

Set Control Code Template Params for Check Constraint.

CONTROL_DATA_RULES

STRING

none

none

none

empty string

Set Control Code Template Params for Data Rules.

CONTROL_FK

STRING

none

none

none

empty string

Set Control Code Template Params for Foreign Keys.

CONTROL_NN

STRING

none

none

none

empty string

Set Control Code Template Params for Not Null attributes.

CONTROL_PK

STRING

none

none

none

empty string

Set Control Code Template Params for Primary Keys.

CONTROL_UK

STRING

none

none

none

empty string

Set Control Code Template Params for Unique Keys.

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_LOCATION

STRING(30)

none

none

none

empty string

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

ISAPPLYSOURCE

BOOLEAN

true, false

none

none

false

Generate Non Trigger Apply uptime script considering this is a leading source for the map

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_ERROR_TABLE

BOOLEAN

true, false

none

none

false

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_STATIC_TABLE

BOOLEAN

true, false

none

none

false

Check source table operator static

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

IS_USER-DEFINED_DATA

BOOLEAN

true, false

none

none

false

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

JOINRANK

FLOAT

none

none

none

0

Join Rank

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

OPTIMIZE_MERGE

BOOLEAN

true, false

none

none

false

Optimize the execution of expressions by deferring them until really needed

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.

USE_LCR_API

BOOLEAN

true, false

none

none

true

Use LCR APIs if possible to perform the DML

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

ZDT_DOWNTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Downtime Extraction Index Hints

ZDT_DOWNTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

ZDT_UPTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Uptime Extraction Index Hints

ZDT_UPTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

TRANSFORMATION_OPERATOR Object

Table 9-44 TRANSFORMATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

RETURN_TYPE

STRING

none

none

none

empty string

Description not available.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

UNPIVOT_OPERATOR Object

Table 9-45 UNPIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

VIEW_OPERATOR Object

Table 9-46 VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

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_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150

INLINED

BOOLEAN

true, false

none

none

false

If set to true, the view query will be used as an inline subquery in the generated code.

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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

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.

VIEW_QUERY

STRING

none

none

none

empty string

The query text for this view.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

See Also

OMBCREATE

OMBALTER PLUGGABLE_MAPPING

OMBRETRIEVE PLUGGABLE_MAPPING

OMBDROP PLUGGABLE_MAPPING

OMBCREATE PLUGGABLE_MAPPING_FOLDER

Purpose

Create a pluggable map folder in a project.

Prerequisites

1. The current context of scripting must be a project.

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

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

Syntax

createPluggableMappingLibraryCommand =  ( OMBCREATE (
          PLUGGABLE_MAPPING_FOLDER | PLUGGABLE_MAPPING_LIBRARY )
          "pluggableMapLibraryName" [ SET ( ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" ] ) | "setReferenceIconSetClause" ) ] )
     pluggableMapLibraryName =  "QUOTED_STRING"
     setPropertiesClause =  PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     propertyKey =  "UNQUOTED_STRING" | FILE_FORMAT
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createPluggableMappingLibraryCommand

Create a pluggable map folder in a project.

pluggableMapLibraryName

Name of the pluggable map folder.

setPropertiesClause

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

setReferenceIconSetClause

Set icon set for the pluggable map folder.

propertyKeyList

The list of property keys.

propertyValueList

A list of property values.

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

propertyValue

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

See Also

OMBCREATE

OMBCREATE PROCEDURE

Purpose

To create a Procedure.

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

createProcedureCommand =  OMBCREATE ( PROCEDURE "QUOTED_STRING" ( [ SET (
          "setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) ] ) { ADD ( "addFuncProcParameterClause"
           | "addRelationalDependentClause" ) } )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addFuncProcParameterClause =  PARAMETER "QUOTED_STRING" [ SET
          "setPropertiesClause" ]
     addRelationalDependentClause =  ( REFERENCE | REF ) ( TABLE | VIEW |
          MATERIALIZED_VIEW | SEQUENCE | FUNCTION | PROCEDURE | PACKAGE )
          "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createProcedureCommand

This command creates a Procedure

QUOTED_STRING

Name of the Procedure to be created.

setPropertiesClause

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

getPropertiesClause

Basic properties for PROCEDURE:

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

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

Name: IMPLEMENTATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Set the code for Procedure which is included global variable declaration and code between BEGIN and END.

Basic properties for PARAMETER:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: 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 to this procedure.

addFuncProcParameterClause

Adds one or more Parameters to this Procedure.

addRelationalDependentClause

This clause adds referential dependencies to other relational objects.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

PROCEDURE Object

Table 9-47 PROCEDURE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE

OMBALTER PROCEDURE

OMBDROP PROCEDURE

OMBCREATE PROCESS_FLOW

Purpose

To create a Process Flow.

Prerequisites

Should be in the context of a Process Flow Package.

Syntax

createProcessFlowCommand =  OMBCREATE ( PROCESS_FLOW "QUOTED_STRING" [ SET
          ( "setPropertiesClause" [ SET "setReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) ] ( { ADD "addProcessParameterClause" }
          { ADD "addProcessVariableClause" } { ADD "addActivityClause" } { ADD
          "addTransitionClause" } { ADD "addUserDefinedParameterClause" } ) )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addProcessParameterClause =  ( PARAMETER "QUOTED_STRING" ) [ SET
          "setPropertiesClause" ]
     addProcessVariableClause =  ( VARIABLE "QUOTED_STRING" ) [ SET
          "setPropertiesClause" ]
     addActivityClause =  ( "addStandardActivityClause" | "addMapActivityClause"
           | "addTemplateActivityClause" | "addDataAuditorActivityClause" |
          "addFunctionActivityClause" | "addSubProcessActivityClause" |
          "addWebServiceActivityClause" )
     addTransitionClause =  ( TRANSITION "QUOTED_STRING" ( FROM ACTIVITY
          "QUOTED_STRING" ) ( TO "QUOTED_STRING" ) ) [ SET "setPropertiesClause"
           ]
     addUserDefinedParameterClause =  ( PARAMETER "QUOTED_STRING" OF
          USER_DEFINED ACTIVITY "QUOTED_STRING" ) [ SET "setPropertiesClause" ]
     propertyNameList =  ( "UNQUOTED_STRING" | BINDING ) { "," (
          "UNQUOTED_STRING" | BINDING ) }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addStandardActivityClause =  ( "UNQUOTED_STRING" | USER_DEFINED ) ACTIVITY
          "QUOTED_STRING" [ SET ( "setPropertiesClause" [ SET
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ]
     addMapActivityClause =  ( MAPPING ACTIVITY "QUOTED_STRING" [ SET (
          PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF | REFERENCE )
          "setPropertiesAndReferencesMapClauses" ] [ "setReferenceIconSetClause"
           ] ) ] | ( REF | REFERENCE ) "setPropertiesAndReferencesMapClauses" [
          SET "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
     addTemplateActivityClause =  ( ACTIVITY_TEMPLATE ACTIVITY "QUOTED_STRING" [
           SET ( PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF |
          REFERENCE ) "setPropertiesAndReferencesTemplateClause" ] [
          "setReferenceIconSetClause" ] ) ] | ( REF | REFERENCE )
          "setPropertiesAndReferencesTemplateClause" [ SET
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
     addDataAuditorActivityClause =  ( DATA_AUDITOR ACTIVITY "QUOTED_STRING" [
          SET ( PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF | REFERENCE
           ) "setPropertiesAndReferencesDataAuditorClauses" ] [
          "setReferenceIconSetClause" ] ) ] | ( REF | REFERENCE )
          "setPropertiesAndReferencesDataAuditorClauses" [ SET
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
     addFunctionActivityClause =  ( TRANSFORMATION ACTIVITY "QUOTED_STRING" [
          SET ( PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF | REFERENCE
           ) "setPropertiesAndReferencesFunctionClauses" ] [
          "setReferenceIconSetClause" ] ) ] | ( REF | REFERENCE )
          "setPropertiesAndReferencesFunctionClauses" [ SET
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
     addSubProcessActivityClause =  ( SUBPROCESS ACTIVITY "QUOTED_STRING" SET (
          PROPERTIES "collectPropertiesClause" SET ( REF | REFERENCE )
          "setPropertiesAndReferencesSubProcessClauses" [ SET
          "setReferenceIconSetClause" ] | ( REF | REFERENCE )
          "setPropertiesAndReferencesSubProcessClauses" [ SET
          "setReferenceIconSetClause" ] ) )
     addWebServiceActivityClause =  ( WEB_SERVICE ACTIVITY "QUOTED_STRING" [ SET
           ( PROPERTIES "collectPropertiesClause" [ SET ( [ ( REF | REFERENCE )
          "setPropertiesAndReferencesWebServiceClauses" ] [
          "setReferenceIconSetClause" ] ) ] | ( REF | REFERENCE )
          "setPropertiesAndReferencesWebServiceClauses" [ SET
          "setReferenceIconSetClause" ] | "setReferenceIconSetClause" ) ] )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     collectPropertiesClause =  "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setPropertiesAndReferencesMapClauses =  ( MAPPING "QUOTED_STRING" )
     setPropertiesAndReferencesTemplateClause =  ( ACTIVITY_TEMPLATE
          "QUOTED_STRING" )
     setPropertiesAndReferencesDataAuditorClauses =  ( DATA_AUDITOR
          "QUOTED_STRING" )
     setPropertiesAndReferencesFunctionClauses =  ( TRANSFORMATION
          "QUOTED_STRING" )
     setPropertiesAndReferencesSubProcessClauses =  ( PROCESS_FLOW
          "QUOTED_STRING" )
     setPropertiesAndReferencesWebServiceClauses =  ( WEB_SERVICE
          "QUOTED_STRING" )

Parameters

createProcessFlowCommand

Create a new process flow using quoted name.

setPropertiesClause

Used to set properties (core, user-defined) for process flow. Note: For MAPPING, TRANSFORMATION and SUBPROCESS

activities the setPropertiesAndReferencesMapClauses,

setPropertiesAndReferencesFunctionClauses and

setPropertiesAndReferencesSubProcessClauses respectively,

are mandatory.

For MAPPING or TRANSFORMATION activities and the REFERENCE property has to be set to a

valid MAP or TRANSFORMATION within the current project.

For SUBPROCESS activities the REFERENCE property has to be set

to a SUBPROCESS within the same PROCESS_FLOW_PACKAGE.

Valid properties are shown below:

setPropertiesClause

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

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

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

Description of the Process Flow Core properties for Transition :

Name: TRANSITION_CONDITION
Type: STRING
Valid Values: '', SUCCESS, ERROR, WARNING
Default: Empty string i.e. Unconditional
Sets the Transition Condition of a Transition

Name: SIMPLE_CONDITION
Type: STRING
Valid Values: '', SUCCESS, ERROR, WARNING
Default: Empty string i.e. Unconditional
Sets the Simple Condition of a Transition

Name: COMPLEX_CONDITION
Type: STRING
Sets the Complex Condition of a Transition

Description of the Process Flow Core properties for Activity Parameter :

Name: DATATYPE
Type: STRING
Valid Values: INTEGER, FLOAT, DATE, STRING, BOOLEAN
Default: STRING
Sets the datatype of a Activity Parameter

Name: DIRECTION
Type: STRING
Valid Values: IN
Default: IN
Sets the direction of a Activity Parameter

Name: ISLITERALVALUE
Type: STRING
Valid Values: TRUE FALSE
Default: TRUE
Whether the value stored is a literal value or an interpreted value, valid for PARAMETERS and VARIABLES.

Name: VALUE
Type: STRING
Valid Values: Examples '123', '123.456', 'Jan-08-2003', 'I am String', 'true'
Default: Empty string
For Mapping activities representing PLSQL maps, the allowed value for the parameters:
OPERATING_MODE:'SET_BASED' 'ROW_BASED' 'ROW_BASED_TARGET_ONLY' 'SET_BASED_FAIL_OVER_TO_ROW_BASED' 'SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY'
AUDIT_LEVEL:'NONE' 'STATISTICS' 'ERROR_DETAILS' 'COMPLETE'
Sets the value of a Activity Parameter

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

Name: BOUND_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The name of the object which a process flow activity represents, for example, a mapping.

Name: DEPLOYED_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: USE_DEFAULT_LOCATION
The locaion to which the process flow is deployed.

Name: EXECUTION_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: NATIVE_EXECUTION
The location which is used to execute the process flow, which may differ from the deployment location.

Name: REMOTE_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: USE_DEFAULT_LOCATION
The File location which is remote from the Working Location, used by FTP to connect to the remote FTP server and set the remote working directory.

Name: USE_RETURN_AS_STATUS
Type: BOOLEAN
Valid Values: true, false
Default: false
When TRUE, the returned result will directly control the outcome of the activity/operator, 1=SUCCESS, 2=WARNINGS, 3=FAILURE.

Name: WORKING_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: USE_DEFAULT_LOCATION
The File location used to initialize the current working directory for an Operating System executable.

setReferenceIconSetClause

Set icon set for the process flow.

addProcessParameterClause

This clause adds the Parameters for a Process Flow.

addProcessVariableClause

Add a variable to the process flow.

addActivityClause

This clause adds the Activities for a Process Flow.

addTransitionClause

This clause adds the Transitions for a Process Flow.

addUserDefinedParameterClause

This clause adds the Parametrers for a User Defined Activity of a Process Flow.

propertyNameList

A comma delimited set of property names to set.

propertyValueList

A comma delimited set of property values to set.

addStandardActivityClause

This clause adds standard activity types AND, EJB, EMAIL, END_ERROR, END_WARNING, END_SUCCESS, FILE_EXISTS, FORK, FTP, JAVA, OR, ASSIGN, END_LOOP, FOR_LOOP, MANUAL, NOTIFICATION, OMBPLUS, ROUTE, SET_STATUS, SQLPLUS, WAIT, WHILE_LOOP OR USER_DEFINED to a Process Flow.

addMapActivityClause

This clause adds the MAP activity to a Process Flow.

addTemplateActivityClause

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

addDataAuditorActivityClause

This clause adds a DATA_AUDITOR activity to a Process Flow.

addFunctionActivityClause

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

addSubProcessActivityClause

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

addWebServiceActivityClause

This clause adds a web service activity for a Process Flow.

propertyValue

Integer value, float value or quoted string literal.

collectPropertiesClause

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

setPropertiesAndReferencesMapClauses

This clause sets reference to the existing Map.

setPropertiesAndReferencesTemplateClause

This clause sets reference to the existing activity template.

setPropertiesAndReferencesDataAuditorClauses

This clause sets reference to the existing data auditor.

setPropertiesAndReferencesFunctionClauses

This clause sets a reference to existing Function or Procedure.

setPropertiesAndReferencesSubProcessClauses

This clause sets a reference to existing Process Flow.

setPropertiesAndReferencesWebServiceClauses

This clause sets reference to the existing web service.

PROCESS_FLOW Object

Table 9-48 PROCESS_FLOW Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

REFERRED_CALENDAR

STRING

none

none

none

empty string

Enter the Schedule to associate with this object.

See Also

OMBCREATE

OMBALTER PROCESS_FLOW

OMBDROP PROCESS_FLOW

OMBCREATE PROCESS_FLOW_MODULE

Purpose

To create a Process Flow Module.

Prerequisites

Should be in the context of a project.

Syntax

createProcessFlowModuleCommand =  OMBCREATE ( PROCESS_FLOW_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

createProcessFlowModuleCommand

Create a new process flow module.

setPropertiesClause

Used to set properties (core, user-defined) for process flow module.

setPropertiesClause

Base properties for PROCESS_FLOW_MODULE:

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

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

setReferenceClause

A general clause for setting references for a process flow module.

propertyNameList

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

propertyValueList

Comma-separated list of property values.

setReferenceLocationClause

Set a location to a supported workflow engine.

setReferenceIconSetClause

Set icon set for the process flow module.

propertyValue

Value of a property.

PROCESS_FLOW_MODULE Object

Table 9-49 PROCESS_FLOW_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

DB_LOCATION

STRING

none

none

none

empty string

This value indicates the location where generated code will be deployed to.

EVAL_LOCATION

STRING

none

none

none

empty string

The location in which the process flow will be evaluated.

See Also

OMBCREATE

OMBALTER PROCESS_FLOW_MODULE

OMBDROP PROCESS_FLOW_MODULE

OMBCREATE PROCESS_FLOW_PACKAGE

Purpose

To create a Process Flow Package.

Prerequisites

Should be in the context of a Process Flow Module.

Syntax

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

Parameters

createProcessFlowPackageCommand

Create a new process flow package.

setPropertiesClause

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

setPropertiesClause

Basic properties for PROCESS_FLOW_PACKAGE:

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

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

setReferenceIconSetClause

Set icon set for the process flow package.

propertyNameList

A comma delimited set of property names to set.

propertyValueList

A comma delimited set of property values to set.

propertyValue

Integer value, float value or quoted string literal.

PROCESS_FLOW_PACKAGE Object

Table 9-50 PROCESS_FLOW_PACKAGE Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBCREATE

OMBALTER PROCESS_FLOW_PACKAGE

OMBDROP PROCESS_FLOW_PACKAGE

OMBCREATE PROJECT

Purpose

To create a project.

Prerequisites

Should be in the top level context.

Syntax

createProjectCommand =  OMBCREATE PROJECT "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

createProjectCommand

Create a project.

setPropertiesClause

Associate a set of properties with a project.

getPropertiesClause

Basic properties for PROJECT:

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

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

setReferenceIconSetClause

Set icon set for the project.

propertyNameList

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

propertyValueList

Comma separated list of property values.

propertyValue

Value of a property.

See Also

OMBCREATE

OMBALTER PROJECT

OMBDROP PROJECT

OMBCREATE PSFT_MODULE

Purpose

createPSFTModuleCommandPurposeTag??

Prerequisites

createPSFTModuleCommandPreTag??

Syntax

createPSFTModuleCommand =  OMBCREATE ( PSFT_MODULE "QUOTED_STRING" [ SET (
          "setPropertiesClause" [ SET "setReferenceClauseForDataMetadataModule"
          ] | "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

getPropertiesClause

corePropertiesForPSFTModuleTag??

See Also

OMBCREATE

OMBALTER PSFT_MODULE

OMBDROP PSFT_MODULE

OMBCREATE QUEUE_PROPAGATION

Purpose

To create a Queue Propagation.

Prerequisites

Should be in the context of an Advanced Queue or Streams Queue. The Target Queue can exist in any Oracle Module.

Syntax

createQPCommand =  OMBCREATE ( QUEUE_PROPAGATION "QUOTED_STRING" [ SET (
          "setQPPropertiesClause" [ SET "setReferenceIconSetClause" ] |
          "setReferenceIconSetClause" ) ] )
     setQPPropertiesClause =  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

createQPCommand

Creates a Queue Propagation with the given name.

setQPPropertiesClause

Sets properties (core, logical, physical, user-defined) for Queue Propagation. Valid properties are shown below:

getQPPropertiesClause

Basic properties for QUEUE_PROPAGATION:

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

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

Name: TARGET_QUEUE
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Target Queue for the Queue Propagation. This has to be the name of a Queue existing in any Oracle Module.

setReferenceIconSetClause

Set the specified Icon Set.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

QUEUE_PROPAGATION Object

Table 9-51 QUEUE_PROPAGATION Object

Property
Type
Choices
Min
Max
Default
Description

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.

DURATION

STRING

none

none

none

empty string

The duration of proagation to be done. The default value is null.Applicable only for non-streams queue propagation.

GENERATE_DBLINK

BOOLEAN

true, false

none

none

true

Generate script for Database Link which is used for propagation

GENERATE_QUEUE_PROPAGATION

BOOLEAN

true, false

none

none

true

Generate script for Queue Propagation

GENERATE_REPLICATION_RULE

BOOLEAN

true, false

none

none

false

Generate Ruleset and Rule for Replication purpose in Streams queue propagation

GENERATE_SCHEDULE_PROPAGATION

BOOLEAN

true, false

none

none

true

Generate script for Scheduling propagation. Applicable only for non-streams queue propagation.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

LATENCY

STRING

none

none

none

60

The latency for the queue propagation. By default the value is 60.Applicable only for non-streams queue propagation.

NEXT_TIME

STRING

none

none

none

empty string

Next time when the propagation to be done. The default value is null.Applicable only for non-streams queue propagation.

NOT_PERMITTED_TAG_VALUES

STRING

none

none

none

empty string

List of comma separated Tag values (in Hex numbers) which are not allowed for propagation

PERMITTED_TAG_VALUES

STRING

none

none

none

empty string

List of comma separated Tag values (in Hex numbers) which are allowed for propagation

START_TIME

STRING

none

none

none

SYSDATE

The start time for the propagation to happen. The default value is SYSDATE.Applicable only for non-streams queue propagation.

SUBCRIBER_TRANSFORMATION

STRING

none

none

none

empty string

A Transformation that will be applied before propagation to the target queue. Applicable only for non-streams queue propagation.

SUBSCRIBER_RULE_CONDITION

STRING

none

none

none

empty string

A Rule condition to check whether the message can be propagated to the subscriber. Applicable only for non-streams queue propagation.

See Also

OMBCREATE QUEUE_PROPAGATION

OMBALTER QUEUE_PROPAGATION

OMBDROP QUEUE_PROPAGATION

OMBCREATE QUEUE_TABLE

Purpose

To create a Queue Table.

Prerequisites

Should be in the context of an Oracle Module. The Object Type can exist in any Oracle Module.

Syntax

createQTCommand =  OMBCREATE ( QUEUE_TABLE "QUOTED_STRING" [ SET
          "setQTPropertiesClause" ] )
     setQTPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createQTCommand

Creates a Queue Table with the given name.

setQTPropertiesClause

Sets properties (core, logical, physical, user-defined) for Queue Table. Valid properties are shown below:

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.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

QUEUE_TABLE Object

Table 9-52 QUEUE_TABLE Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBCREATE QUEUE_TABLE

OMBALTER QUEUE_TABLE

OMBDROP QUEUE_TABLE

OMBCREATE REAL_TIME_MAPPING

Purpose

Create a Real Time mapping in an Oracle Module.

Prerequisites

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

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

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

Syntax

createRealTimeMappingCommand =  OMBCREATE REAL_TIME_MAPPING "mappingName" [
           "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

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.

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 9-53 MAPPING Object

Property
Type
Choices
Min
Max
Default
Description

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 9-54 OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-55 GROUP Object

Property
Type
Choices
Min
Max
Default
Description

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

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 9-56 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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 9-57 AGGREGATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

none

none

none

0

ANYDATA_CAST_OPERATOR Object

Table 9-58 ANYDATA_CAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-59 CONSTANT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-60 CONSTRUCT_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-61 CUBE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-62 DATA_GENERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-63 DEDUPLICATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-64 DIMENSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-65 EXPAND_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-66 EXPRESSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 9-67 EXTERNAL_TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FILTER_OPERATOR Object

Table 9-68 FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

FILTER_CONDITION

STRING

none

none

none

empty string

The boolean filtering condition that identifies what data is to be processed. Any row with a false condition will be ignored.

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

SUBQUERY_FILTER_OPERATOR Object

Table 9-69 SUBQUERY_FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SUBQUERY_FILTER_CONDITION

STRING

none

none

none

empty string

The Filter Condition for the subquery operator, if blank then the subquery stands alone with no join to the top-level query.

SUBQUERY_INPUT_ROLE

STRING(16)

EXISTS, IN, NOT_EXISTS, NOT_IN

none

none

EXISTS

The role the input stream plays in the subquery filter condition.

SUBQUERY_JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FLAT_FILE_OPERATOR Object

Table 9-70 FLAT_FILE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CONCATENATE_RECORDS

NUMBER

none

none

none

0

Number of Physical Records per Logical Record.

CONTINUATION_CHARACTER

STRING

none

none

none

empty string

Character that indicates the record is continued on the next line.

CONTINUATION_CHARACTER_ON_NEXT_LINE

BOOLEAN

true, false

none

none

FALSE

If there is a continuation character, is it at the start of the line.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The name of the directory in which to open the target data file. The directory must be deployed before the file can be created.

DEBUG_TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

ESCAPE_CHARACTER_FOR_ENCLOSURE

STRING

none

none

none

empty string

Escape character for data containing the enclosure character. This is only applicable with delimited files having enclosure characters.

FIELD_ENCLOSURE_CHARACTERS

STRING

none

none

none

empty string

Characters that wrap fields. Example ' or ".

FIELD_NAMES_IN_THE_FIRST_ROW

BOOLEAN

true, false

none

none

FALSE

Indicates whether file contains a header row.

FIELD_TERMINATION_CHARACTER

STRING

none

none

none

,

Character that separates the fields of a delimited file.

FILE_FORMAT

STRING

DELIMITED, FIXED

none

none

DELIMITED

File Format (Fixed or Delimited).

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LOADING_TYPE

STRING(16)

INSERT, NONE, UPDATE

none

none

INSERT

The loading operation to be performed

NLS_CHARACTERSET

STRING

none

none

none

WE8MSWIN1252

NLS Characterset

OUTPUT_AS_XML

BOOLEAN

true, false

none

none

false

Output data to file in XML format.

RECORDS_TO_SKIP

NUMBER

none

0

none

0

Number of logical records to skip

RECORD_DELIMITER

STRING

none

none

none

empty string

Character that indicates the end of the record.

RECORD_SIZE

NUMBER

none

none

none

0

Size of a fixed length record.

RECORD_TYPE_LENGTH

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the length of the data that identifies the type of record. It is used with the Record Type Position.

RECORD_TYPE_POSITION

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the position of the field that identifies the type of record.

SAMPLED_FILE_NAME

STRING

none

none

none

empty string

The default name of the physical file to be used by sqlloader. If the file was sampled, the default was set from sampled file name.

SOURCE_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The Location of the File Module of this Flat File at the time of reconciliation. Stored as UOID.

TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The location used to access referenced entity.

TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

INPUT_PARAMETER_OPERATOR Object

Table 9-71 INPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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

INPUT_SIGNATURE_OPERATOR Object

Table 9-72 INPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ITERATOR_OPERATOR Object

Table 9-73 ITERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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

JOINER_OPERATOR Object

Table 9-74 JOINER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

JOIN_CONDITION

STRING

none

none

none

empty string

The Join Condition for the join operator

JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

LOOKUP_OPERATOR Object

Table 9-75 LOOKUP_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRCAST_OPERATOR Object

Table 9-76 LCRCAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRSPLITTER_OPERATOR Object

Table 9-77 LCRSPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCHMERGE_OPERATOR Object

Table 9-78 MATCHMERGE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCH_KEYS

STRING

none

none

none

empty string

Ordered list of attributes that control the set of records to be matched at any at any particular time.

MATCH_NEW_RECORDS

BOOLEAN

true, false

none

none

false

MATCH_NEW_RECORD_CONDITION

STRING

none

none

none

empty string

MERGED_PREFIX

STRING

none

none

none

empty string

Set the prefix used for the merged attributes in the cross-reference group.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

MATERIALIZED_VIEW_OPERATOR Object

Table 9-79 MATERIALIZED_VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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).

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.

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

NAME_AND_ADDRESS_OPERATOR Object

Table 9-80 NAME_AND_ADDRESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

ADDRESS_LINE_1

STRING

none

none

none

empty string

Address line 1

ADDRESS_LINE_2

STRING

none

none

none

empty string

Address line 2

ADDRESS_LINE_3

STRING

none

none

none

empty string

Address line 3

ADDRESS_LINE_4

STRING

none

none

none

empty string

Address line 4

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

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

A dual address refers to two address lines for the same destination. For example, a record contains both a street address and a P.O. Box; this is common with business data. Select which of the two address lines should be assigned in these cases.

GENERATE_CASS_REPORT

STRING

NA_NO, NA_YES

none

none

NA_NO

Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS report is a text file specified by the United States Postal Service. The report is written to the [nas/bin/admin/reports] folder under the home folder of the name/address server.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LIST_NAME

STRING

none

none

none

empty string

The list name is optional and provides a reference for tracking multiple CASS reports.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Select a name-address parsing type to be performed on the input data

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Select the primary parsing country which best represents the input data. Input addresses having the same country as the primary parsing country will only need to be parsed once. Input addresses having a different country than the primary parsing country may be reparsed by a different parser. For performance reasons, it is best to minimize the percentage of 2-pass parses by selecting the optimal parser.

PROCESSOR_NAME

STRING

none

none

none

empty string

The processor name is the name of the organization submitting the CASS report.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

OUTPUT_PARAMETER_OPERATOR Object

Table 9-81 OUTPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

The name to use when refering to this entity in generated code.

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

OUTPUT_SIGNATURE_OPERATOR Object

Table 9-82 OUTPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_OPERATOR Object

Table 9-83 PIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_GROUP_SIZE

NUMBER

none

1

1000

2

A number specifying the pivot group size for the pivot operation. Pivot group size determines the number of output rows that are produced from each input row.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PLUGGABLE_MAPPING_OPERATOR Object

Table 9-84 PLUGGABLE_MAPPING_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

POSTMAPPING_PROCESS_OPERATOR Object

Table 9-85 POSTMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

POSTMAPPING_PROCESS_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING

none

none

ON_SUCCESS

Indicates under what condition of the mapping the post-mapping process will be run.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PREMAPPING_PROCESS_OPERATOR Object

Table 9-86 PREMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

MAPPING_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS

none

none

ON_SUCCESS

Indicates under what condition of the pre-mapping process the mapping will be run.

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

QUEUE_OPERATOR Object

Table 9-87 QUEUE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_AQ_UOID

STRING

none

none

none

empty string

The UOID of the Advanced Qeue object to which this stage component is bound to.

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.

DB_LOCATION

STRING

none

none

none

empty string

The location used to access this entity during mapping.

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

GENERATE_SUBSCRIBER

BOOLEAN

true, false

none

none

true

This only applies to batch mappings. This specifies whether the subscriber is generated. The name of the subscriber is the owning map. If the queue being sourced is a propagation queue with the same name as the owning map, then set to false.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

IS_REALTIME_SOURCE

BOOLEAN

true, false

none

none

false

IS_STREAMS_QUEUE

BOOLEAN

true, false

none

none

false

PAYLOAD_NAME

STRING

none

none

none

empty string

The name of payload type.

QUEUE_TABLE_NAME

STRING

none

none

none

empty string

The name of the queue table that is used to perist the messages in this Advanced Queue.

REAL_TIME_DATA_FORMAT

STRING

LOGICAL_CHANGE_RECORD, MESSAGE

none

none

MESSAGE

The format for this message, either user-defined or LCR

SOURCE_TABLES

STRING

none

none

none

empty string

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.

TEMPORARY_TABLE_NAME

STRING

none

none

none

empty string

The name of the temporary table that will stage the messages from the Advanced Queue.

UDT

STRING

none

none

none

empty string

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SEQUENCE_OPERATOR Object

Table 9-88 SEQUENCE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SET_OPERATION_OPERATOR Object

Table 9-89 SET_OPERATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SET_OPERATION

STRING

INTERSECT, MINUS, UNION, UNIONALL

none

none

UNION

Specifies the set operation that is to be performed by this operator.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SORTER_OPERATOR Object

Table 9-90 SORTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ORDER_BY_CLAUSE

STRING

none

none

none

empty string

The Order By Clause

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SPLITTER_OPERATOR Object

Table 9-91 SPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

TABLE_FUNCTION_OPERATOR Object

Table 9-92 TABLE_FUNCTION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

TABLE_FUNCTION_IS_TARGET

BOOLEAN

true, false

none

none

false

Description not available.

TABLE_FUNCTION_NAME

STRING

none

none

none

empty string

The name of the Table Function

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

TABLE_OPERATOR Object

Table 9-93 TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

Description not available.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

CONFLICT_RESOLUTION

BOOLEAN

true, false

none

none

true

Detect and resolve any conflicts that may arise during DML using the LCR APIs

CONTROL_CK

STRING

none

none

none

empty string

Set Control Code Template Params for Check Constraint.

CONTROL_DATA_RULES

STRING

none

none

none

empty string

Set Control Code Template Params for Data Rules.

CONTROL_FK

STRING

none

none

none

empty string

Set Control Code Template Params for Foreign Keys.

CONTROL_NN

STRING

none

none

none

empty string

Set Control Code Template Params for Not Null attributes.

CONTROL_PK

STRING

none

none

none

empty string

Set Control Code Template Params for Primary Keys.

CONTROL_UK

STRING

none

none

none

empty string

Set Control Code Template Params for Unique Keys.

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_LOCATION

STRING(30)

none

none

none

empty string

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

ISAPPLYSOURCE

BOOLEAN

true, false

none

none

false

Generate Non Trigger Apply uptime script considering this is a leading source for the map

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_ERROR_TABLE

BOOLEAN

true, false

none

none

false

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_STATIC_TABLE

BOOLEAN

true, false

none

none

false

Check source table operator static

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

IS_USER-DEFINED_DATA

BOOLEAN

true, false

none

none

false

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

JOINRANK

FLOAT

none

none

none

0

Join Rank

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

OPTIMIZE_MERGE

BOOLEAN

true, false

none

none

false

Optimize the execution of expressions by deferring them until really needed

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.

USE_LCR_API

BOOLEAN

true, false

none

none

true

Use LCR APIs if possible to perform the DML

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

ZDT_DOWNTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Downtime Extraction Index Hints

ZDT_DOWNTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

ZDT_UPTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Uptime Extraction Index Hints

ZDT_UPTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

TRANSFORMATION_OPERATOR Object

Table 9-94 TRANSFORMATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

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

RETURN_TYPE

STRING

none

none

none

empty string

Description not available.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

UNPIVOT_OPERATOR Object

Table 9-95 UNPIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

VIEW_OPERATOR Object

Table 9-96 VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

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_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150

INLINED

BOOLEAN

true, false

none

none

false

If set to true, the view query will be used as an inline subquery in the generated code.

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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

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.

VIEW_QUERY

STRING

none

none

none

empty string

The query text for this view.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

See Also

OMBCREATE

OMBALTER REAL_TIME_MAPPING

OMBRETRIEVE REAL_TIME_MAPPING

OMBDROP REAL_TIME_MAPPING

OMBCREATE REGISTERED_FUNCTION

Purpose

Creates a function that can be used in a query.

Prerequisites

Should be in the context of a Business Definition Module.

Syntax

createRegisteredFunctionCommand =  OMBCREATE REGISTERED_FUNCTION
          "QUOTED_STRING" [ SET "setPropertiesClauseforRegFunforCreate" ] [ SET
          "setReferenceIconSetClause" ] { "addFunArgClauses" }
     setPropertiesClauseforRegFunforCreate =  PROPERTIES "("
          "propertyNameListforRegFun" ")" VALUES "(" "propertyValueList" ")"
     setReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET "QUOTED_STRING"
     addFunArgClauses =  ADD PARAMETER "QUOTED_STRING" [ SET
          "setPropertiesClause" ]
     propertyNameListforRegFun =  ( "UNQUOTED_STRING" | ( PACKAGE | SIGNATURE )
          ) { "," ( "UNQUOTED_STRING" | ( PACKAGE | SIGNATURE ) ) }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

createRegisteredFunctionCommand

This command creates a registered function.

QUOTED_STRING

Specify the name of the function to be created.

setPropertiesClauseforRegFunforCreate

This clause sets the properties of the object.

setReferenceIconSetClause

Set specified Icon Set.

addFunArgClauses

This clause is for adding parameters to a function.

propertyNameListforRegFun

This is the list of property names.

propertyValueList

This is the list of property values.

setPropertiesClause

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

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

propertyValue

This is a property value.

propertyNameList

This is the list of property names.

REGISTERED_FUNCTION Object

Table 9-97 REGISTERED_FUNCTION Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER REGISTERED_FUNCTION

OMBRETRIEVE REGISTERED_FUNCTION

OMBCREATE ROLE

Purpose

To create a Warehouse Builder role.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseCreateRoleCommand =  OMBCREATE ( ROLE "QUOTED_STRING" [ SET
          "setPropertiesClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseCreateRoleCommand

This clause creates a Warehouse Builder role.

setPropertiesClause

Used to set properties of a Warehouse Builder role. Valid properties are shown below.

getPropertiesClause

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

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

propertyNameList

A list of valid properties are shown in section of Basic properties for Role.

propertyValueList

A list of valid property value shown in section of Basic properties for Role.

propertyValue

The valid property value shown in section of Basic properties for Role.

See Also

OMBALTER ROLE

OMBDROP ROLE

OMBRETRIEVE ROLE

OMBCREATE SAP_MODULE

Purpose

To create a SAP module.

It is not supported in the current release.

Prerequisites

You must open a project to create a SAP module.

Syntax

createSAPModuleCommand =  OMBCREATE ( SAP_MODULE "QUOTED_STRING" [ SET (
          "setPropertiesClause" [ SET "setReferenceClauseForDataMetadataModule"
          ] | "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

createSAPModuleCommand

Create a SAP module

setPropertiesClause

Associate a set of properties 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

setReferenceClauseForDataMetadataModule

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

addModuleReferenceLocationClause

Add data locations to the SAP 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 SAP module as the new configuration default.

addReferenceLocationClause

Add a data location to the SAP module.

propertyValue

Value of a property.

setReferenceMetadataLocationClause

Set metadata location for the SAP module.

setReferenceIconSetClause

Set icon set for the SAP module.

See Also

OMBCREATE

OMBALTER SAP_MODULE

OMBDROP SAP_MODULE

OMBCREATE SEQUENCE

Purpose

To create a sequence.

Prerequisites

In the context of an Oracle Module.

Syntax

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

Parameters

createSequenceCommand

This command creates a sequence.

setPropertiesClause

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

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 9-98 SEQUENCE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE

OMBALTER SEQUENCE

OMBDROP SEQUENCE

OMBRETRIEVE SEQUENCE

OMBCREATE SIEBEL_MODULE

Purpose

createSiebelModuleCommandPurposeTag??

Prerequisites

createSiebelModuleCommandPreTag??

Syntax

createSiebelModuleCommand =  OMBCREATE ( SIEBEL_MODULE "QUOTED_STRING" [
          SET ( "setPropertiesClause" [ SET
          "setReferenceClauseForDataMetadataModule" ] |
          "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

getPropertiesClause

corePropertiesForSiebelModuleTag??

See Also

OMBCREATE

OMBALTER SIEBEL_MODULE

OMBDROP SIEBEL_MODULE

OMBCREATE SNAPSHOT

Purpose

To create a snapshot of a component.

Prerequisites

Component on which snapshot is to be created should already exist. This command can be executed for any component regardless of current context.

Syntax

parseCreateCommand =  OMBCREATE "createSnapshotCommand"
     createSnapshotCommand =  ( SNAPSHOT "QUOTED_STRING" [ WITH DEPENDEE_DEPTH (
           MAX | "INTEGER_LITERAL" ) ] [ SET "setPropertiesClause" ]
          "addSnapshotFCOClauses" )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     addSnapshotFCOClauses =  ( ADD "objectClause" )+
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     objectClause =  "UNQUOTED_STRING" "QUOTED_STRING" [ CASCADE | NO CASCADE ]
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseCreateCommand

Root production for OMBCREATE SNAPSHOT.

createSnapshotCommand

Clause for creating snapshots.

QUOTED_STRING

Name of the snapshot to be created.

DEPENDEE_DEPTH

Use this optional clause to include in the snapshot all dependees for each component in the command.

setPropertiesClause

Optional clause to set the properties of a snapshot. This includes the description and the type of the snapshot.

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

VALUES

Values for the corresponding properties. Default values of properties for DESCRIPTION is null and valid values for TYPE are FULL or SIGNATURE

addSnapshotFCOClauses

Components to be added to the snapshot

propertyNameList

Property names for SNAPSHOT.

propertyValueList

List of property values for SNAPSHOT.

objectClause

Component to be added to the snapshot

UNQUOTED_STRING

Type of the component to be added to the snapshot

QUOTED_STRING

Absolute or relative path name of the component to be added to the snapshot

CASCADE

Cascade option for folder components. By default, any folder is snapshotted along with its contents. The NO CASCADE option allows the user to snapshot only the folder object itself along with its associated properties.

propertyValue

Allowable value types for a snapshot property.

See Also

OMBALTER SNAPSHOT

OMBDROP SNAPSHOT

OMBRESTORE SNAPSHOT

OMBCOMPARE SNAPSHOT

OMBLIST SNAPSHOT

OMBRETRIEVE SNAPSHOT

OMBCREATE TABLE

Purpose

To create a table.

Prerequisites

In the context of an Oracle Module.

Syntax

createTableCommand =  OMBCREATE ( TABLE "QUOTED_STRING" [ SET (
          "setPropertiesClause" [ SET ( REF | REFERENCE )
          "setReferenceIconSetClause" ] | ( REF | REFERENCE )
          "setReferenceIconSetClause" ) ] [ "addTableSCOClauses" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     addTableSCOClauses =  ADD ( "addColumnClause" | "addConstraintClause" |
          "addSCOClause" ) [ "addTableSCOClauses" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addColumnClause =  COLUMN "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ]
           [ SET "setPropertiesClause" ]
     addConstraintClause =  "addUkPkClause" | "addFkClause" |
          "addCheckConstraintClause"
     addSCOClause =  "addIndexClause" | "addIndexPartitionClause" |
          "addIndexPartitionKeyClause" | "addPartitionClause" |
          "addPartitionKeyClause" | "addSubpartitionClause" |
          "addaddMaterializedViewSCOandDependentClauseClause" |
          "addSubPartitionKeyClause" | "addIndexColumnClause" |
          "addAttributeSetClause"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     addUkPkClause =  ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" [ SET
          "setUkPkPropertiesAndReferencesColumnsClauses" ]
     addFkClause =  FOREIGN_KEY "QUOTED_STRING" [ SET "setFkSubClauses" ]
     addCheckConstraintClause =  CHECK_CONSTRAINT "QUOTED_STRING" [ SET
          "setPropertiesClause" ]
     addIndexClause =  INDEX "QUOTED_STRING" [ SET
          "setSCOConfigurationPropertiesClauses" ]
     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

createTableCommand

This command creates a table.

QUOTED_STRING

Specify the name of the table to be created.

setPropertiesClause

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

getPropertiesClause

Basic properties for TABLE:

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

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

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.

addTableSCOClauses

This clause adds the secon class objects.

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

addConstraintClause

Adds primary and unique key, and add check constraints.

addSCOClause

This clause will add SCOs.

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.

addCheckConstraintClause

add a check constraint.

QUOTED_STRING

Name of the CheckConstraint.

addIndexClause

This clause adds an index.

QUOTED_STRING

Name of the index.

addPartitionClause

This clause adds a partition.

QUOTED_STRING

Name of the partition.

addPartitionKeyClause

This clause adds a partition key.

QUOTED_STRING

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

addIndexColumnClause

This clause will add 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.

TABLE Object

Table 9-99 TABLE Object

Property
Type
Choices
Min
Max
Default
Description

ANALYZE_TABLE_ESTIMATE_PERCENT

STRING

none

none

none

empty string

Value represents the sample size as a percentage (0-100) of total rows. When set to a nonzero value, Builder generates a DDL script to analyze the table. The default is 99.

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.

CACHE_MODE

STRING

, CACHE, NOCACHE

none

none

empty string

Indicate how Oracle should store blocks in the buffer cache.

CDC_POSITION

NUMBER

none

none

none

0

Table position in change data capture.

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

false

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

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string

Use the Tablespace parameter to specify the name of tablespace.

ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string

Use the error table name to specify the name of Error Table.

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.

GENERATE_ERROR_TABLE_ONLY

BOOLEAN

true, false

none

none

false

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

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.

IS_CDC

BOOLEAN

true, false

none

none

false

Enable table for change data capture

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.

MONITORING_MODE

STRING

, MONITORING, NOMONITORING

none

none

empty string

Specify MONITORING if you want modification statistics to be collected on this table.

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.

OVERFLOW

STRING

none

none

none

empty string

Enter a comma separated list of tablespaces for overflow data. For simple-partitoned object, it is used for HASH BY QUANTITY partition overflow tablespaces. The number of tablespaces does not have to equal the number of partitions. If the number of partitions is greater than the number of tablespaces, then Oracle cycles through the names of the 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 simple-partitoned object, it is used for HASH BY QUANTITY partition tablespaces. For composite-partitioned tables, it is used for subpartition template to store a list of tablespaces.

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.

ROWDEPENDENCIES_MODE

STRING

, NOROWDEPENDENCIES, ROWDEPENDENCIES

none

none

empty string

Specify ROWDEPENDENCIES to use row-level dependency tracking.

ROW_MOVEMENT

STRING

, DISABLE, ENABLE

none

none

empty string

Specify whether Oracle can move a table row.

TABLESPACE

STRING(30)

none

none

none

empty string

COLUMN Object

Table 9-100 COLUMN Object

Property
Type
Choices
Min
Max
Default
Description

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

PRIMARY_KEY Object

Table 9-101 PRIMARY_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

STREAMS_ADMINISTRATOR_LOCATION

STRING

none

none

none

empty string

The location corresponding to the Streams Administrator

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

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.

UNIQUE_KEY Object

Table 9-102 UNIQUE_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 9-103 FOREIGN_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 9-104 CHECK_CONSTRAINT Object

Property
Type
Choices
Min
Max
Default
Description

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.

PARTITION Object

Table 9-105 PARTITION Object

Property
Type
Choices
Min
Max
Default
Description

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

INDEX Object

Table 9-106 INDEX Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE

OMBALTER TABLE

OMBDROP TABLE

OMBRETRIEVE TABLE

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

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE

OMBALTER TABLE_FUNCTION

OMBDROP TABLE_FUNCTION

OMBCREATE TIME_DIMENSION

Purpose

This command creates a time dimension.

Prerequisites

Should be in Oracle Module context.

Syntax

createTimeDimensionCommand =  OMBCREATE TIME_DIMENSION "TimeDimensionName"
          ( ( "setFiscalPropertyClause" "addFiscalCalendarHierarchyClause"+ |
          "addCalendarHierarchyClause"+ [ "setFiscalPropertyClause"
          "addFiscalCalendarHierarchyClause"+ ] ) | ( "setPropertiesClause" (
          "setFiscalPropertyClause" "addFiscalCalendarHierarchyClause"+ | (
          "addCalendarHierarchyClause"+ [ "setFiscalPropertyClause"
          "addFiscalCalendarHierarchyClause"+ ] ) ) ) ) {
          "addDimensionRoleClause" } [ "implementationClause" [
          "addSequenceClause" ] ] "populationClause"
     TimeDimensionName =  "QUOTED_STRING"
     setFiscalPropertyClause =  "setFiscalPropertiesClause"
     addFiscalCalendarHierarchyClause =  ADD FISCAL_CALENDAR HIERARCHY
          "hierarchyName" [ "setPropertiesClause" ] SET ( REF | REFERENCE )
          "fiscalCalendarLevelList"
     addCalendarHierarchyClause =  ADD ( ( NORMAL_CALENDAR HIERARCHY
          "hierarchyName" [ "setPropertiesClause" ] SET ( REF | REFERENCE )
          "normalCalendarLevelList" ) | ( WEEK_CALENDAR HIERARCHY
          "hierarchyName" [ "setPropertiesClause" ] SET ( REF | REFERENCE )
          "weekCalendarLevelList" ) )
     setPropertiesClause =  SET PROPERTIES "propertyKeyList" VALUES
          "propertyValueList"
     addDimensionRoleClause =  ADD DIMENSION_ROLE "roleName" [
          "setPropertiesClause" ]
     implementationClause =  IMPLEMENTED BY ( STAR | SNOWFLAKE ) [ USING
          COMPOSITE_UNIQUE_KEY ]
     addSequenceClause =  ( ( ADD ( REF | REFERENCE ) SEQUENCE "QUOTED_STRING" )
           | ( SET ( REF | REFERENCE ) SEQUENCE "QUOTED_STRING" ) )
     populationClause =  POPULATE DATA FROM "calendarYear" FOR "yearCount" YEARS
     setFiscalPropertiesClause =  SET FISCAL_CALENDAR PROPERTIES
          "propertyKeyList" VALUES "propertyValueList"
     hierarchyName =  "QUOTED_STRING"
     fiscalCalendarLevelList =  "(" ( "fiscalCalendarLevelType" LEVEL [
          "levelName" ] [ "setPropertiesClause" ] ) { ","
          "fiscalCalendarLevelType" LEVEL [ "levelName" ] [
          "setPropertiesClause" ] } ")"
     normalCalendarLevelList =  "(" ( "normalCalendarLevelType" LEVEL [
          "levelName" ] [ "setPropertiesClause" ] ) { ","
          "normalCalendarLevelType" LEVEL [ "levelName" ] [
          "setPropertiesClause" ] } ")"
     weekCalendarLevelList =  "(" ( "weekCalendarLevelType" LEVEL [ "levelName"
          ] [ "setPropertiesClause" ] ) { "," "weekCalendarLevelType" LEVEL [
          "levelName" ] [ "setPropertiesClause" ] } ")"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     propertyValueList =  "(" "propertyValue" { "," "propertyValue" } ")"
     roleName =  "QUOTED_STRING"
     calendarYear =  "INTEGER_LITERAL"
     yearCount =  "INTEGER_LITERAL"
     fiscalCalendarLevelType =  ( DAY | FISCAL_WEEK | FISCAL_MONTH |
          FISCAL_QUARTER | FISCAL_YEAR )
     levelName =  "QUOTED_STRING"
     normalCalendarLevelType =  ( DAY | CALENDAR_MONTH | CALENDAR_QUARTER |
          CALENDAR_YEAR )
     weekCalendarLevelType =  ( DAY | CALENDAR_WEEK )
     propertyKey =  "UNQUOTED_STRING"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createTimeDimensionCommand

This clause creates a time dimension.

TimeDimensionName

The name of the time dimension.

setFiscalPropertyClause

set the fiscal properties.

addFiscalCalendarHierarchyClause

This clause adds an fiscal hierarchy to the time dimension.

addCalendarHierarchyClause

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

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

addDimensionRoleClause

This clause adds a dimension role.

implementationClause

Time Dimension is implemented as STAR or as SNOWFLAKE.

addSequenceClause

Either create a new sequence and use it in the time dimension using ADD REF SEQUENCE ... statement, otherwise use SET REF SEQUENCE ... statement use to an existing sequence.

populationClause

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

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'

hierarchyName

The name of a hierarchy.

fiscalCalendarLevelList

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

normalCalendarLevelList

This clause defines Levels used in Normal Calendar.

weekCalendarLevelList

This clause defines a week Calendar.

propertyKeyList

A list of time dimension properties.

propertyValueList

A list of time dimension property values.

roleName

A role name.

calendarYear

The Calendar year given by INTEGER_LITERAL.

yearCount

The year could is given by INTEGER_LITERAL.

fiscalCalendarLevelType

The types of Fiscal Calendar: DAY, FISCAL_WEEK, FISCAL_MONTH, FISCAL_QUARTER, FISCAL_YEAR

levelName

User defined Level name.

normalCalendarLevelType

The types of Normal Calendar Year: DAY, CALENDAR_MONTH, CALENDAR_QUARTER, CALENDAR_YEAR

weekCalendarLevelType

Type of Week Calendar: DAY, CALENDAR_WEEK

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.

DIMENSION Object

Table 9-108 DIMENSION Object

Property
Type
Choices
Min
Max
Default
Description

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 9-109 HIERARCHY Object

Property
Type
Choices
Min
Max
Default
Description

HIERLOADLEVEL

STRING

none

none

none

empty string

See Also

OMBALTER TIME_DIMENSION

OMBDROP TIME_DIMENSION

OMBRETRIEVE TIME_DIMENSION

10 OMBCREATE TRANSPORTABLE_MODULE to OMBDESCRIBE MODEL

OMBCREATE TRANSPORTABLE_MODULE

OMBCREATE UNQUOTED_STRING

OMBCREATE VARYING_ARRAY

OMBCREATE VIEW

OMBCREATE WEB_SERVICE

OMBCREATE WEB_SERVICE_PACKAGE

OMBDAC

OMBDCC

OMBDEBUG MAPPING

OMBDEFINE ASSOCIATION_DEFINITION

OMBDEFINE CLASS_DEFINITION

OMBDEFINE COMPONENT_DEFINITION

OMBDEFINE DOMAIN_DEFINITION

OMBDEFINE FOLDER_DEFINITION

OMBDEINSTALL OWB_REPOSITORY

OMBDEINSTALL WORKSPACE

OMBDEPLOY

OMBDERIVE

OMBDESCRIBE ASSOCIATION_DEFINITION

OMBDESCRIBE CLASS_DEFINITION

OMBDESCRIBE MODEL

OMBCREATE TRANSPORTABLE_MODULE

Purpose

To create a transportable module.

Prerequisites

In the context of a project.

Syntax

createTMCommand =  ( OMBCREATE TRANSPORTABLE_MODULE "QUOTED_STRING" {
          "setPropertiesAndLocationsAndIconSet" } )
     setPropertiesAndLocationsAndIconSet =  SET ( "setPropertiesClause" |
          "setSourceLocationClause" | "setTargetLocationClause" |
          "setReferenceIconSetClause" )
     setPropertiesClause =  ( PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")" )
     setSourceLocationClause =  SOURCE_LOCATION "QUOTED_STRING"
     setTargetLocationClause =  TARGET_LOCATION "QUOTED_STRING"
     setReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createTMCommand

This command is for creating a transportable module.

QUOTED_STRING

The name of the transportable module to be created.

setPropertiesAndLocationsAndIconSet

Set properties for the transportable module, and/or specify source and target locations, and/or specify icon set for the newly create transportable module.

setPropertiesClause

Set properties for the transportable module.

setPropertiesClause

Basic properties for TRANSPORTABLE_MODULE:

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

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

setSourceLocationClause

Specify the source location name.

QUOTED_STRING

The name of an already created transportable module source location.

setTargetLocationClause

Specify the target location name.

QUOTED_STRING

The name of an already created transportable module target location.

setReferenceIconSetClause

Set the icon set for the new transportable module.

QUOTED_STRING

The name of the icon set.

propertyNameList

The list of unquoted property names.

propertyValueList

The list of property values.

propertyValue

A property value can be a single-quoted string, an integer, or a floating point number.

TRANSPORTABLE_MODULE Object

Table 10-1 TRANSPORTABLE_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

TARGET_OS_TYPE

STRING

Linux, Unix, Windows

none

none

Unix

The operating system type of the target machine. This is needed for generating shell scripts in correct style required by the OS.

TRANSPORT_TABLESPACE

BOOLEAN

true, false

none

none

true

Specifies whether transportable tablespace (TTS) feature is to be used for deploying tables in the transportable module. If set to true, tablespaces are copied from source to target using the server TTS mechanism. If set to false, tables are individually extracted and deployed using Oracle Data Pump available in Oracle10g or later; but tablespaces are not transported. Since Oracle Data Pump is new in Oracle 10g, setting this parameter to false is only allowed if both source and target databases are with Oracle 10g or a higher versions.

WHAT_TO_DEPLOY

STRING

ALL_OBJECTS, TABLES_ONLY

none

none

ALL_OBJECTS

Specifies whether only tables in the transportable module are deployed or everything in it is deployed.

WORK_DIRECTORY

STRING

none

none

none

empty string

The full path of work directory on target machine, where temporary files, logs and tablespace datafiles may be stored. If left unspecified, OWB's runtime home directory is used as the work directory. It is highly recommended that users specify dedicated directory for transportable module deployment.

See Also

OMBCREATE

OMBALTER TRANSPORTABLE_MODULE

OMBRETRIEVE TRANSPORTABLE_MODULE

OMBDROP TRANSPORTABLE_MODULE

OMBDEPLOY

OMBCREATE UNQUOTED_STRING

Purpose

To create a module based on a platform. You can create a module for seeded platforms (DB2, SQL Server) as well as for unseeded platforms that are created using OMBCREATE PLATFORM.

UNQUOTED_STRING represents <PLATFORM NAME>_MODULE and must be defined using upper case.

For example, to create a DB2 module called MODULE1, the command is:

OMBCREATE DB2UDB_MODULE 'MODULE1'

Note that the module name is specified within quotes.

Prerequisites

Should be in the context of project.

Syntax

parseCreateCommand =  OMBCREATE ( "UNQUOTED_STRING" "QUOTED_STRING" [ SET (
           "setPropertiesClause" [ SET "setReferenceClauseForDataMetadataModule"
           ] | "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

getPropertiesClause

Basic properties for module:

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

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

See Also

OMBCREATE

OMBCREATE VARYING_ARRAY

Purpose

To create an Varying Array (or Varray)

Prerequisites

Should be in the context of an Oracle Module

Syntax

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

Parameters

createVaryingArrayCommand

Creates a Varying Array with the given name.

setPropertiesClause

Sets properties (core, logical, physical, user-defined) for Varying Array . Valid properties are shown below:

getPropertiesClause

Basic properties for VARYING_ARRAY:

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

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

Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Base Element of the Varying Array

setReferenceIconSetClause

Sets reference icon set.

propertyNameList

The list of properties.

propertyValueList

The list of property values.

propertyValue

This clause adds the property values.

VARYING_ARRAY Object

Table 10-2 VARYING_ARRAY Object

Property
Type
Choices
Min
Max
Default
Description

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBCREATE

OMBALTER VARYING_ARRAY

OMBDROP VARYING_ARRAY

OMBCREATE VIEW

Purpose

To create a view.

Prerequisites

In the context of an Oracle Module.

Syntax

createViewCommand =  OMBCREATE ( VIEW "QUOTED_STRING" [ SET (
          "setPropertiesClause" [ SET ( REF | REFERENCE )
          "setReferenceIconSetClause" ] | ( REF | REFERENCE )
          "setReferenceIconSetClause" ) ] [ "addViewSCOandDependentClause" ] )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferenceIconSetClause =  ICONSET "QUOTED_STRING"
     addViewSCOandDependentClause =  ADD ( "addColumnClause" |
          "addViewConstraintClause" | "addRelationalDependentClause" ) [
          "addViewSCOandDependentClause" ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addColumnClause =  COLUMN "QUOTED_STRING" [ AT POSITION "INTEGER_LITERAL" ]
           [ SET "setPropertiesClause" ]
     addViewConstraintClause =  "addUkPkClause" | "addFkClause"
     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" ]
     setUkPkPropertiesAndReferencesColumnsClauses =  "setPropertiesClause" [ SET
           ( REF | REFERENCE ) "constraintColumnReferencesClause" ] | ( REF |
          REFERENCE ) "constraintColumnReferencesClause"
     setFkSubClauses =  "setPropertiesClause" [ SET ( REF | REFERENCE )
          "setFkReferencesClauses" ] | ( REF | REFERENCE )
          "setFkReferencesClauses"
     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

createViewCommand

This command creates a view.

QUOTED_STRING

Specify the name of the view to be created.

setPropertiesClause

Used to set properties (core, logical, physical, user-defined) for views and their columns, 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.

addViewSCOandDependentClause

This clause adds components like columns and constraints, as well as dependencies to some other relational objects.

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.

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.

setUkPkPropertiesAndReferencesColumnsClauses

This clause adds properties and references to columns.

setFkSubClauses

This clause sets references to a foreign key.

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.

VIEW Object

Table 10-3 VIEW Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

false

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

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string

Use the Tablespace parameter to specify the name of tablespace.

ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string

Use the error table name to specify the name of Error Table.

GENERATE_ERROR_TABLE_ONLY

BOOLEAN

true, false

none

none

false

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

COLUMN Object

Table 10-4 COLUMN Object

Property
Type
Choices
Min
Max
Default
Description

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 10-5 UNIQUE_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 10-6 FOREIGN_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBCREATE

OMBALTER VIEW

OMBDROP VIEW

OMBRETRIEVE VIEW

OMBCREATE WEB_SERVICE

Purpose

To create a Web Service.

Prerequisites

Should be in the context of a Web Service Package or an Application Server Module, public web service should be in the context of public Application Server Module.

Syntax

createWebServiceCommand =  OMBCREATE WEB_SERVICE "QUOTED_STRING" SET ( (
          "setPropertiesClause" [ SET ( REF | REFERENCE )
          "setReferencedObjectClauses" ] ) | ( ( REF | REFERENCE )
          "setReferencedObjectClauses" ) )
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     setReferencedObjectClauses =  ( MAPPING | PROCESS_FLOW | TRANSFORMATION |
          DATA_AUDITOR | TABLE | MODULE ) "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createWebServiceCommand

Create a web service under an application server module or web service package.

setPropertiesClause

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

getPropertiesClause

Base properties for WEB_SERVICE:
Basic properties for Web Service:

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

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

Name: WSDLURL
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
WSDL url of the public Web Service :

Name: SPEC
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
SPECIFICATION of the Web Service :

setReferencedObjectClauses

Set the reference object for the non-public web service. Valid object types including: MAPPING, PROCESS_FLOW, TRANSFORMATION, DATA_AUDITOR, TABLE (tables for change data capture) and MODULE (native modules for change data capture).

propertyNameList

A list of property names.

propertyValueList

A list of property values.

propertyValue

The property value of the object.

WEB_SERVICE Object

Table 10-7 WEB_SERVICE Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

The Web service is deployable or not

See Also

OMBCREATE

OMBALTER WEB_SERVICE

OMBRETRIEVE WEB_SERVICE

OMBDROP WEB_SERVICE

OMBCREATE WEB_SERVICE_PACKAGE

Purpose

To create a Web Service Package.

Prerequisites

Should be in the context of a Application Server Module.

Syntax

createWebServicePackageCommand =  OMBCREATE WEB_SERVICE_PACKAGE
          "QUOTED_STRING" [ SET "setPropertiesClause" ]
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

createWebServicePackageCommand

Create a web service package under an non-public application server module.

setPropertiesClause

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

getPropertiesClause

Basic properties for WEB_SERVICE_PACKAGE:

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

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

propertyNameList

A list of property names.

propertyValueList

A list of property values.

propertyValue

The property value of the object.

WEB_SERVICE_PACKAGE Object

Table 10-8 WEB_SERVICE_PACKAGE Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

The Web service package is deployable or not

See Also

OMBCREATE

OMBALTER WEB_SERVICE_PACKAGE

OMBRETRIEVE WEB_SERVICE_PACKAGE

OMBDROP WEB_SERVICE_PACKAGE

OMBDAC

Purpose

Display the name of the active configuration of a project.

Prerequisites

Must be in the context of a project.

Syntax

parseDisplayActiveConfigurationCommand =  OMBDAC

Parameters

parseDisplayActiveConfigurationCommand

Specify Display Active Configuration command.

See Also

OMBCAC

OMBDCC

Purpose

Display Current Context command displays the current context (location) and, for contexts other than the root ('/'), the type of the current folder.

Prerequisites

Must be connected to a OWB workspace of the repository.

Syntax

parseDisplayCurrentContextCommand =  OMBDCC

Parameters

parseDisplayCurrentContextCommand

Specify display current context command.

See Also

OMBCC

OMBDEBUG MAPPING

Purpose

Debug a mapping by stepping through map execution one operator at a time.

Prerequisites

The current context must be in an Oracle module which contains at least one map.

Syntax

debugMappingCommand =  OMBDEBUG MAPPING "mappingName" "debugClause"+
     mappingName =  "QUOTED_STRING"
     debugClause =  START [ DEBUG ] SESSION | END [ DEBUG ] SESSION | STEP | SKP
           | RESUME | DISPLAY ( [ "INTEGER_LITERAL" ROWS OF ] [
          "dataDisplayGroupDirection" ] DEBUG_DATA [ FOR "groupBottomUpLocator"
          ] | CURRENT_STEP_GROUP ) | SET ( BREAKPOINT AT
          "operatorBottomUpLocator" | STARTING_POINT AT
          "operatorBottomUpLocator" ) | CLEAR ( BREAKPOINT AT
          "operatorBottomUpLocator" | STARTING_POINT AT
          "operatorBottomUpLocator" ) | REINITIALIZE | RESET
     dataDisplayGroupDirection =  INPUT | OUTPUT
     groupBottomUpLocator =  GROUP "groupName" OF "operatorBottomUpLocator"
     operatorBottomUpLocator =  OPERATOR "operatorName" [
          "pluggableMapBottomUpLocator" ]
     groupName =  "QUOTED_STRING"
     operatorName =  "QUOTED_STRING"
     pluggableMapBottomUpLocator =  ( OF PLUGGABLE_MAPPING "pluggableMapName" [
          "pluggableMapBottomUpLocator" ] )
     pluggableMapName =  "QUOTED_STRING"

Parameters

debugMappingCommand

Debug an existing mapping.

mappingName

Name of the mapping.

debugClause

Specify the action to be performed for the current debug session.

START

Start a new debug session.

END

End the current debug session.

STEP

Step through one row of data.

SKP

Skip to the next operator in the graph.

RESUME

Resume the debug session.

DISPLAY

Display debug data for the current step, or a specified attribute group

BREAKPOINT

Set a new breakpoint or remove an existing breakpoint.

STARTING_POINT

Set or remove the starting point for the debug session.

REINITIALIZE

Reinitialize the current debug session.

RESET

Reset the current debug session.

dataDisplayGroupDirection

Specify the direction of the attribute group to display debug data, can be either INPUT or OUTPUT.

groupBottomUpLocator

Location of a mapping group.

operatorBottomUpLocator

Location of a mapping operator.

groupName

Name of a mapping group.

operatorName

Name of a mapping operator.

pluggableMapBottomUpLocator

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

pluggableMapName

Name of the pluggable map.

OMBDEFINE ASSOCIATION_DEFINITION

Purpose

To define an association between two classes (types).

Prerequisites

Association definition to be defined should not already exist. User must have CREATE_EXTENSIONMODEL system privilege and has to be connected in single user mode to run this command.

Syntax

parseDefineAssociationCommand =  OMBDEFINE ASSOCIATION_DEFINITION
          "QUOTED_STRING" [ ( ON | OF ) "modelClause" ]
          "setAssociationDefinitionPropertiesClause" {
          "addDependencyDefinitionClause" }
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" |
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM
          "QUOTED_STRING" )
     setAssociationDefinitionPropertiesClause =  SET PROPERTIES "("
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")"
     addDependencyDefinitionClause =  ADD DEPENDENCY_DEFINITION "QUOTED_STRING"
          [ "setDependencyDefinitionPropertiesClause" ]
     propertyNameList =  "propertyNameClause" { "," "propertyNameClause" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setDependencyDefinitionPropertiesClause =  SET PROPERTIES "("
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")"
     propertyNameClause =  ( "UNQUOTED_STRING" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseDefineAssociationCommand

Define an association between two classes..

getAssociationPropertiesClause

Basic properties for ASSOCIATION_DEFINITION:

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: N/A
A descriptive text for this association.

Name: CLASS_1
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Class on one side of the association.

NAME: CLASS_2
Type: STRING(200)
Value Values: N/A
Default: N/A
Class on the other side of the association.

Name: ROLE_1
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Role on one side of the association.

Name: ROLE_2
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Role on the other side of the association.

Name: ROLE_1_MIN_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Minimum cardinality of role 1. Value can be positive integer.

Name: ROLE_1_MAX_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Maximum cardinality of role 1. Value can be positive integer or 'INFINITE'.

Name: ROLE_1_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side default is false.
Navigability of role 1.

Name: ROLE_2_MIN_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Minimum cardinality of role 2. Value can be positive integer.

Name: ROLE_2_MAX_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Maximum cardinality of role 2. Value can be positive integer or 'INFINITE'.

Name: ROLE_2_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side default is false.
Navigability of role 2.

addDependencyDefinitionClause

Mark this association so that the dependency engine will consider it when computing the lineage and impact dependencies. The only dependency type allowed here for now is 'DATAFLOW'.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

setDependencyDefinitionPropertiesClause

Basic dependency-related properties for this association:

Name: SOURCE_ROLE_ID

Type: STRING(200)

Valid Values: ROLE_1, ROLE_2

Default: If one of the ends is a OWB class, then that is the default source. If both ends are user defined classes, then the association is default bidirectional.

Identifies the role (end) of the association which serves as the source for the dependency flow.

Name: BIDIRECTIONAL

Type: BOOLEAN

Valid Values: true, false

Default: If one of the ends is a OWB class, then default is false. If both ends are user defined classes, then default is true.

Specifies whether the association is bi-directional for the dependency flow.

propertyNameClause

Name of a property.

propertyValue

Value of a property.

See Also

OMBDESCRIBE ASSOCIATION_DEFINITION

OMBDEFINE CLASS_DEFINITION

Purpose

To define a class (user defined object type).

Prerequisites

Class definition to be defined should not already exist.

Syntax

parseDefineClassCommand =  OMBDEFINE [ ( FIRST_CLASS_OBJECT |
          SECOND_CLASS_OBJECT | FOLDER | MODULE ) ] CLASS_DEFINITION
          "QUOTED_STRING" [ ( ON | OF ) "modelClause" ] [ (
          "setClassDefinitionPropertiesClause" |
          "setClassDefinitionIconSetClause" ) ] [ "addSubDefinitionsClause" ]
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" |
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM
          "QUOTED_STRING" )
     setClassDefinitionPropertiesClause =  SET PROPERTIES "(" "propertyNameList"
           ")" VALUES "(" "propertyValueList" ")"
     setClassDefinitionIconSetClause =  SET REF ICONSET "QUOTED_STRING"
     addSubDefinitionsClause =  ( "addPropertyDefinitionClause" |
          "addPropertyGroupDefinitionClause" | "addChildTypeClause" )+
     propertyNameList =  "propertyNameClause" { "," "propertyNameClause" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addPropertyDefinitionClause =  ( ADD [ ( ( CONFIGURATION |
          PHYSICAL_CONFIGURATION ) | LOGICAL | USER_DEFINED ) ]
          PROPERTY_DEFINITION "QUOTED_STRING"
          "setPropertyDefinitionPropertiesClause" )
     addPropertyGroupDefinitionClause =  ADD PROPERTY_GROUP_DEFINITION
          "QUOTED_STRING" "setPropertyGroupDefinitionPropertiesClause"
     addChildTypeClause =  ( ADD CHILD_TYPE "QUOTED_STRING" )
     propertyNameClause =  ( "UNQUOTED_STRING" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setPropertyDefinitionPropertiesClause =  SET PROPERTIES "("
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")"
     setPropertyGroupDefinitionPropertiesClause =  SET PROPERTIES "("
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")"

Parameters

parseDefineClassCommand

Define a class.

FOLDER

Class definition is folder.

MODULE

Class definition is module.

QUOTED_STRING

Name of the class.

setClassDefinitionPropertiesClause

Set the properties on the class definition. Valid properties are BUSINESS_NAME, DESCRIPTION, DISPLAY_NAME, PLURAL_NAME.

setClassDefinitionIconSetClause

Assign an icon to the class definition.

propertyNameList

The list of property names.

propertyValueList

The list of values.

addPropertyDefinitionClause

Add a property definition to the class definition.

addPropertyGroupDefinitionClause

Add a property group definition to the class definition.

addChildTypeClause

Add a aggregate child type to the class definition.

propertyNameClause

The name of the property.

UNQUOTED_STRING

The name of the property for the class definition.

propertyValue

The value of the property.

QUOTED_STRING

The value in string format of the property for the class definition.

INTEGER_LITERAL

The integer value of the property for the class definition.

FLOATING_POINT_LITERAL

The float value of the property for the class definition.

setPropertyDefinitionPropertiesClause

Set the properties for the property definition. Valid properties are TYPE, DEFAULT_VALUE, POSITION, HIDDEN.

See Also

OMBDESCRIBE CLASS_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

OMBDEFINE DOMAIN_DEFINITION

Purpose

To define a domain.

Prerequisites

Domain is a type with constraints on some other type. For example, you can define a domain which contains a list of valid values of some existing type, or you can define a domain which contains ranges of some existing type.

Syntax

parseDefineDomainCommand =  OMBDEFINE DOMAIN_DEFINITION "QUOTED_STRING" [ (
           ON | OF ) "modelClause" ] "setDomainPropertiesClause" {
          "addRangeClause" | "addValueClause" }
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" |
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM
          "QUOTED_STRING" )
     setDomainPropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")"
          VALUES "(" "propertyValueList" ")"
     addRangeClause =  ADD RANGE_DEFINITION "QUOTED_STRING"
          "setRangePropertiesClause"
     addValueClause =  ADD DOMAIN_VALUE "QUOTED_STRING"
     propertyNameList =  "propertyNameClause" { "," "propertyNameClause" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setRangePropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")"
          VALUES "(" "propertyValueList" ")"
     propertyNameClause =  ( "UNQUOTED_STRING" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseDefineDomainCommand

Define a domain.

QUOTED_STRING

Name of the domain.

setDomainPropertiesClause

Set the properties on the domain. Valid properties are BASE_TYPE, DESCRIPTION.

addRangeClause

Add range to the domain.

addValueClause

Add value to the domain.

propertyNameList

The list of property names.

propertyValueList

The list of values.

setRangePropertiesClause

Set the properties on the range. Valid properties are MIN_VALUE_STRING, MIN_VALUE_INCLUSIVE, MAX_VALUE_STRING, MAX_VALUE_INCLUSIVE, DESCRIPTION. MIN_VALUE_STRING is the minimum value for this range. MIN_VALUE_INCLUSIVE equal to true means the minimum value is in the range. MAX_VALUE_STRING is the maximum for this range. MAX_VALUE_INCLUSIVE equal to true means the maximum value is in the range.

propertyNameClause

The name of the property.

UNQUOTED_STRING

The name of the property for the class definition.

propertyValue

The value of the property.

QUOTED_STRING

The value in string format of the property for the class definition.

INTEGER_LITERAL

The integer value of the property for the class definition.

FLOATING_POINT_LITERAL

The float value of the property for the class definition.

See Also

OMBDEFINE FOLDER_DEFINITION

Purpose

To define a folder definition.

Prerequisites

The class definition for the folder should already exist. The class must be a folder.

Syntax

parseDefineFolderCommand =  OMBDEFINE FOLDER_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

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.

OMBDEINSTALL WORKSPACE

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.

OMBDEPLOY

Purpose

To Deploy Action Plans to Control Centers or File Systems.

Prerequisites

If the Deployment is NOT from a Deployment Specification XML file then the following are true. A Control Center connection and a named Deployment Action Plan are required. Also, the current Context must be either an Oracle Module, a Process Flow Module or a Location.

Syntax

parseDeployCommand =  OMBDEPLOY ( ( DEPLOYMENT_ACTION_PLAN "QUOTED_STRING"
          [ ( AS ( SPECIFICATION | SCRIPT ) TO "QUOTED_STRING" ) |
          CONTROL_CENTER_ONLY ] ) | ( SPECIFICATION FROM "QUOTED_STRING" ) ) [
          ASYNCHRONOUS ]

Parameters

parseDeployCommand

Specify Deploy command.

DEPLOYMENT_ACTION_PLAN

Deploy a Deployment Action Plan.

QUOTED_STRING

The Deployment Action Plan name. Or, the directory (if AS SCRIPT) or file name (if AS SPECIFICATION) into which the deployment is performed. Or, the source XML filename (if SPECIFICATION FROM).

AS

Perform the Deployment to a File System.

SPECIFICATION

Deploy as a Deployment Specification XML file.

SCRIPT

Deploy as a set of Oracle Script files.

CONTROL_CENTER_ONLY

Do not perform a Deployment but only update the Control Center Audit.

FROM

Perform the Deployment from a file on a File System.

ASYNCHRONOUS

Deploy in an asynchronous mode.

OMBDERIVE

Purpose

Derives business definition objects from OWB design objects.

Prerequisites

Should be in an appropriate context for the design object or use the full path for the design object.

The Business Definition Module named in the TO clause should already exist within the current project.

Any Business Areas named should already exist within the Business Definition Module.

Syntax

parseDeriveCommand =  OMBDERIVE ( ORACLE_MODULE | GATEWAY_MODULE |
          DIMENSION | CUBE | TABLE | VIEW | MATERIALIZED_VIEW | EXTERNAL_TABLE |
           FUNCTION | "UNQUOTED_STRING" | COLLECTION ) "QUOTED_STRING" TO ( (
          BUSINESS_DEFINITION_MODULE "QUOTED_STRING" [ BUSINESS_AREAS "("
          "BANameList" ")" ] ) | ( OBIEE_BUSINESS_DEFINITION_MODULE
          "QUOTED_STRING" [ CATALOG_FOLDERS "(" "BANameList" ")" ] ) ) [
          "parseDeriveCommandParams" ]
     BANameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     parseDeriveCommandParams =  "parseRuleParameters" { "parseRuleParameters" }
     parseRuleParameters =  SET [ ( ORACLE_MODULE | GATEWAY_MODULE | DIMENSION |
           CUBE | TABLE | MATERIALIZED_VIEW | VIEW | EXTERNAL_TABLE | FUNCTION |
           "UNQUOTED_STRING" | COLLECTION ) ] "(" "parameterNameList" ")" VALUES
           "(" "parameterValueList" ")"
     parameterNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     parameterValueList =  "parameterValue" { "," "parameterValue" }
     parameterValue =  ( "QUOTED_STRING" )

Parameters

parseDeriveCommand

Derives business definition objects from OWB design objects.

The quoted string following TO should be the name of a Business Definition Module in the current project, into which the business definition objects are derived.

BANameList

List of the target business areas.

parseDeriveCommandParams

The global derivation parameters.

parseRuleParameters

The rule derivation parameters.

parameterNameList

List of the parameters.

parameterValueList

List of the parameter values.

parameterValue

The parameter value.

OMBDESCRIBE ASSOCIATION_DEFINITION

Purpose

To describe an association definition.

Prerequisites

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

Syntax

parseDescribeAssociationCommand =  OMBDESCRIBE ASSOCIATION_DEFINITION
          "QUOTED_STRING" [ ( ON | OF ) "modelClause" ] ( GET (
          "getAssociationPropertiesClause" | DEPENDENCY_DEFINITIONS ) | (
          DEPENDENCY_DEFINITION "QUOTED_STRING" GET
          "getDependencyPropertiesClause" ) )
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" |
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM
          "QUOTED_STRING" )
     getAssociationPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getDependencyPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "propertyNameClause" { "," "propertyNameClause" }
     propertyNameClause =  ( "UNQUOTED_STRING" )

Parameters

parseDescribeAssociationCommand

Describe an association definition.

getAssociationPropertiesClause

Basic properties for ASSOCIATION_DEFINITION:

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: N/A
A descriptive text for this association.

Name: CLASS_1
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Class on one side of the association.

NAME: CLASS_2
Type: STRING(200)
Value Values: N/A
Default: N/A
Class on the other side of the association.

Name: ROLE_1
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Role on one side of the association.

Name: ROLE_2
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Role on the other side of the association.

Name: ROLE_1_MIN_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Minimum cardinality of role 1. Value can be positive integer.

Name: ROLE_1_MAX_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Maximum cardinality of role 1. Value can be positive integer or 'INFINITE'.

Name: ROLE_1_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side default is false.
Navigability of role 1.

Name: ROLE_2_MIN_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Minimum cardinality of role 2. Value can be positive integer.

Name: ROLE_2_MAX_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Maximum cardinality of role 2. Value can be positive integer or 'INFINITE'.

Name: ROLE_2_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side default is false.
Navigability of role 2.

getDependencyPropertiesClause

Basic dependency-related properties for this association:

Name: SOURCE_ROLE_ID

Type: STRING(200)

Valid Values: ROLE_1, ROLE_2

Default: If one of the ends is a OWB class, then that is the default source. If both ends are user defined classes, then the association is default bidirectional.

Identifies the role (end) of the association which serves as the source for the dependency flow.

Name: BIDIRECTIONAL

Type: BOOLEAN

Valid Values: true, false

Default: If one of the ends is a OWB class, then default is false. If both ends are user defined classes, then default is true.

Specifies whether the association is bi-directional for the dependency flow.

propertyNameList

The list of property names.

propertyNameClause

Name of a property.

See Also

OMBDEFINE ASSOCIATION_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.

See Also

OMBDEFINE CLASS_DEFINITION

OMBREDEFINE CLASS_DEFINITION

OMBDESCRIBE MODEL

Purpose

To describe a model. A model is usually composed of types and relationships among them. The only model currently supported is 'OWB'. Using this command you can introspect 'OWB' model to list classes and other type definitions, association definitions and domain definitions.

Prerequisites

Must be connected to a workspace.

Syntax

parseDescribeModelCommand =  OMBDESCRIBE "modelClause" GET ( [ USER_DEFINED
           ] ( [ FIRST_CLASS_OBJECT | SECOND_CLASS_OBJECT | FOLDER | MODULE ]
          CLASS_DEFINITIONS | ( COMPONENT_DEFINITIONS | FOLDER_DEFINITIONS ) ) |
           TYPE_DEFINITIONS | DOMAIN_DEFINITIONS | ASSOCIATION_DEFINITIONS |
          PRIMITIVE_TYPES )
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" |
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM
          "QUOTED_STRING" )

Parameters

parseDescribeModelCommand

Describe a model. The only model currently supported is 'OWB'.

11 OMBDISC to OMBDROP CONFIGURATION

OMBDISC

OMBDISC CONTROL_CENTER

OMBDISCONNECT

OMBDISCONNECT CONTROL_CENTER

OMBDISPLAYCURRENTMODE

OMBDROP

OMBDROP ACTIVITY_TEMPLATE

OMBDROP ACTIVITY_TEMPLATE_FOLDER

OMBDROP ADVANCED_QUEUE

OMBDROP ALTERNATIVE_SORT_ORDER

OMBDROP ANALYZE_ACTION_PLAN

OMBDROP APPLICATION_SERVER_MODULE

OMBDROP BUSINESS_AREA

OMBDROP BUSINESS_DEFINITION_MODULE

OMBDROP CALENDAR

OMBDROP CALENDAR_MODULE

OMBDROP CATALOG_FOLDER

OMBDROP CMI_DEFINITION

OMBDROP CMI_MODULE

OMBDROP COLLECTION

OMBDROP CONFIGURATION

OMBDISC

Purpose

To disconnect from a OWB workspace or the named Control Center.

Prerequisites

Currently need to be connected to a OWB workspace on the repository or the named Control Center.

Syntax

parseDisconnectCommand =  ( ( OMBDISCONNECT | OMBDISC ) [ CONTROL_CENTER ]
          )

Parameters

parseDisconnectCommand

Specify disconnect command.

See Also

OMBCONNECT

OMBDISC CONTROL_CENTER

Purpose

To disconnect from a OWB workspace or the named Control Center.

Prerequisites

Currently need to be connected to a OWB workspace on the repository or the named Control Center.

Syntax

parseDisconnectCommand =  ( ( OMBDISCONNECT | OMBDISC ) [ CONTROL_CENTER ]
          )

Parameters

parseDisconnectCommand

Specify disconnect command.

See Also

OMBCONNECT

OMBDISCONNECT

Purpose

To disconnect from a OWB workspace or the named Control Center.

Prerequisites

Currently need to be connected to a OWB workspace on the repository or the named Control Center.

Syntax

parseDisconnectCommand =  ( ( OMBDISCONNECT | OMBDISC ) [ CONTROL_CENTER ]
          )

Parameters

parseDisconnectCommand

Specify disconnect command.

See Also

OMBCONNECT

OMBDISCONNECT CONTROL_CENTER

Purpose

To disconnect from a OWB workspace or the named Control Center.

Prerequisites

Currently need to be connected to a OWB workspace on the repository or the named Control Center.

Syntax

parseDisconnectCommand =  ( ( OMBDISCONNECT | OMBDISC ) [ CONTROL_CENTER ]
          )

Parameters

parseDisconnectCommand

Specify disconnect command.

See Also

OMBCONNECT

OMBDISPLAYCURRENTMODE

Purpose

Displays the current connection mode to the workspace. Returns either SINGLE_USER_MODE (i.e. exclusive) or MULTIPLE_USER_MODE.

Prerequisites

Must be connected to an OWB workspace. If not already connected, use OMBCONNECT first.

Syntax

parseDisplayModeCommand =  ( OMBDISPLAYCURRENTMODE | OMBDCM )

Parameters

parseDisplayModeCommand

Specify display mode command.

See Also

OMBSWITCHMODE

OMBCONNECT

OMBSAVE

OMBREVERT

OMBDROP

Purpose

Drop a component.

Prerequisites

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

Syntax

dropCommand =  OMBDROP "fco_type" "fco_name"

Parameters

dropCommand

Specify the component to drop.

fco_type

The type of the component.

fco_name

The physical name of the component in single quotes.

See Also

OMBCREATE

OMBALTER

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.

See Also

OMBDROP

OMBCREATE ACTIVITY_TEMPLATE

OMBALTER ACTIVITY_TEMPLATE

OMBDROP ACTIVITY_TEMPLATE_FOLDER

Purpose

To drop an activity template folder.

Prerequisites

Should be in the context of a Project.

Syntax

dropActivityTemplateFolder =  OMBDROP ACTIVITY_TEMPLATE_FOLDER
          "QUOTED_STRING"

Parameters

dropActivityTemplateFolder

Drop the specified activity template folder.

See Also

OMBDROP

OMBCREATE ACTIVITY_TEMPLATE_FOLDER

OMBALTER ACTIVITY_TEMPLATE_FOLDER

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.

See Also

OMBDROP

OMBCREATE ADVANCED_QUEUE

OMBALTER ADVANCED_QUEUE

OMBRETRIEVE ADVANCED_QUEUE

OMBDROP ALTERNATIVE_SORT_ORDER

Purpose

To drop an Alternative Sort Order.

Prerequisites

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

Syntax

dropAlternativeSortOrderCommand =  OMBDROP ALTERNATIVE_SORT_ORDER
          "QUOTED_STRING"

Parameters

dropAlternativeSortOrderCommand

To drop an Alternative Sort Order.

See Also

OMBRETRIEVE ALTERNATIVE_SORT_ORDER

OMBCREATE ALTERNATIVE_SORT_ORDER

OMBALTER ALTERNATIVE_SORT_ORDER

OMBDROP ANALYZE_ACTION_PLAN

Purpose

To drop a profile action plan.

Prerequisites

An action plan for profiling must already exist.

Syntax

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

Parameters

DropActionPlanCommand

Drop profile action plan

QUOTED_STRING

Name of profile action plan.

See Also

OMBCREATE ANALYZE_ACTION_PLAN

OMBPROFILE

OMBDROP APPLICATION_SERVER_MODULE

Purpose

Delete the Application Server Module.

Prerequisites

Should be in the context of a project.

Syntax

dropApplicationServerModuleCommand =  OMBDROP ( APPLICATION_SERVER_MODULE
          "QUOTED_STRING" )

Parameters

dropApplicationServerModuleCommand

Drop the application server module.

See Also

OMBDROP

OMBCREATE APPLICATION_SERVER_MODULE

OMBALTER APPLICATION_SERVER_MODULE

OMBDROP BUSINESS_AREA

Purpose

To drop a Business Area.

Prerequisites

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

Syntax

dropBusinessAreaCommand =  OMBDROP BUSINESS_AREA "QUOTED_STRING"

Parameters

dropBusinessAreaCommand

To drop a Business Area.

See Also

OMBRETRIEVE BUSINESS_AREA

OMBCREATE BUSINESS_AREA

OMBALTER BUSINESS_AREA

OMBDROP BUSINESS_DEFINITION_MODULE

Purpose

Delete the business definition module.

Prerequisites

Should be in the context of project.

Syntax

dropEULModuleCommand =  OMBDROP ( BUSINESS_DEFINITION_MODULE
          "QUOTED_STRING" )

Parameters

dropEULModuleCommand

Remove an existing business definition module.

QUOTED_STRING

Name of the existing business definition module in quotes.

See Also

OMBDROP

OMBCREATE BUSINESS_DEFINITION_MODULE

OMBALTER BUSINESS_DEFINITION_MODULE

OMBDROP CALENDAR

Purpose

To drop a calendar.

Prerequisites

Should be in the context of a Calendar Folder.

Syntax

parseDropCalendarCommand =  OMBDROP CALENDAR "QUOTED_STRING"

Parameters

parseDropCalendarCommand

Drop the specified calendar.

See Also

OMBDROP

OMBCREATE CALENDAR

OMBALTER CALENDAR

OMBDROP CALENDAR_MODULE

Purpose

To drop a calendar module.

Prerequisites

Should be in the context of a Project.

Syntax

parseDropCalendarModuleCommand =  OMBDROP CALENDAR_MODULE "QUOTED_STRING"

Parameters

parseDropCalendarModuleCommand

Drop the specified calendar module.

See Also

OMBDROP

OMBCREATE CALENDAR_MODULE

OMBALTER CALENDAR_MODULE

OMBDROP CATALOG_FOLDER

Purpose

To drop a Catalog Folder.

Prerequisites

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

Syntax

dropCatalogFolderCommand =  OMBDROP CATALOG_FOLDER "QUOTED_STRING"

Parameters

dropCatalogFolderCommand

To drop a Catalog Folder.

See Also

OMBRETRIEVE CATALOG_FOLDER

OMBCREATE CATALOG_FOLDER

OMBALTER CATALOG_FOLDER

OMBDROP CMI_DEFINITION

Purpose

Delete the CMI definition.

Prerequisites

Should be in the root context.

Syntax

dropMIVDefinitionCommand =  OMBDROP ( CMI_DEFINITION "QUOTED_STRING" )

Parameters

dropMIVDefinitionCommand

Remove an existing CMI definition.

QUOTED_STRING

Name of the existing CMI definition in quotes.

See Also

OMBDROP

OMBCREATE CMI_DEFINITION

OMBDROP CMI_MODULE

Purpose

Delete the CMI module.

Prerequisites

Should be in the context of project.

Syntax

dropMIVModuleCommand =  OMBDROP ( CMI_MODULE "QUOTED_STRING" )

Parameters

dropMIVModuleCommand

Remove an existing CMI module.

QUOTED_STRING

Name of the existing CMI module in quotes.

See Also

OMBDROP

OMBCREATE CMI_MODULE

OMBALTER CMI_MODULE

OMBDROP COLLECTION

Purpose

Drop the collection object from this project.

Prerequisites

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

Syntax

dropCollectionCommand =  OMBDROP ( COLLECTION "QUOTED_STRING" )

Parameters

dropCollectionCommand

Drop a collection of objects.

See Also

OMBDROP

OMBALTER COLLECTION

OMBCREATE COLLECTION

OMBDROP CONFIGURATION

Purpose

Delete the Configuration.

Prerequisites

Should be in the context of a project.

Syntax

dropConfigurationCommand =  OMBDROP ( CONFIGURATION "QUOTED_STRING" )

Parameters

dropConfigurationCommand

Remove an existing Configuration.

See Also

OMBDROP

OMBALTER CONFIGURATION

OMBCREATE CONFIGURATION

12 OMBDROP CONFIGURATION_TEMPLATE to OMBDROP FLAT_FILE_MODULE

OMBDROP CONFIGURATION_TEMPLATE

OMBDROP CONNECTOR

OMBDROP CONTROL_CENTER

OMBDROP CORRECTION_MAPS_ACTION_PLAN

OMBDROP CORRECTION_SCHEMA_ACTION_PLAN

OMBDROP CT

OMBDROP CT_FOLDER

OMBDROP CUBE

OMBDROP DATA_AUDITOR

OMBDROP DATA_PROFILE

OMBDROP DATA_RULE

OMBDROP DEPLOYMENT

OMBDROP DEPLOYMENT_ACTION_PLAN

OMBDROP DIMENSION

OMBDROP DRILL_PATH

OMBDROP DRILL_TO_DETAIL

OMBDROP EXPERT

OMBDROP EXPERT_MODULE

OMBDROP EXTERNAL_TABLE

OMBDROP FLAT_FILE

OMBDROP FLAT_FILE_MODULE

OMBDROP CONFIGURATION_TEMPLATE

Purpose

Delete the configuration template.

Prerequisites

None.

Syntax

dropConfigurationTemplateCommand =  OMBDROP ( CONFIGURATION_TEMPLATE
          "QUOTED_STRING" )

Parameters

dropConfigurationTemplateCommand

Remove an existing configuration template.

See Also

OMBDROP

OMBALTER CONFIGURATION_TEMPLATE

OMBCREATE CONFIGURATION_TEMPLATE

OMBDROP CONNECTOR

Purpose

Delete a connector. Connector name is specified as parent location name and a connector name separated by a '/' as follows: 'LOCATION_NAME/CONNECTOR_NAME'.

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

dropConnectorCommand =  OMBDROP ( CONNECTOR "QUOTED_STRING" )

Parameters

dropConnectorCommand

Drops the named connector from the repository.

See Also

OMBDROP

OMBCREATE CONNECTOR

OMBALTER CONNECTOR

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.

See Also

OMBDROP

OMBCREATE CONTROL_CENTER

OMBALTER CONTROL_CENTER

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.

See Also

OMBCREATE CORRECTION_MAPS_ACTION_PLAN

OMBPROFILE

OMBDROP CORRECTION_SCHEMA_ACTION_PLAN

Purpose

Drop an action plan for creating a correction schema

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 correction schema action plan

QUOTED_STRING

Name of correction schema action plan.

See Also

OMBCREATE CORRECTION_SCHEMA_ACTION_PLAN

OMBPROFILE

OMBDROP CT

Purpose

To drop an expert.

Prerequisites

In the context of an expert module.

Syntax

dropCTCommand =  OMBDROP CT "QUOTED_STRING"

Parameters

dropCTCommand

Drop the specified CT (Code Template).

See Also

OMBDROP

OMBALTER CT

OMBRETRIEVE CT

OMBDROP CT_FOLDER

Purpose

To drop a CT (Code Template) folder.

Prerequisites

In the context of a project.

Syntax

dropCTModuleCommand =  OMBDROP ( CT_FOLDER "QUOTED_STRING" )

Parameters

dropCTModuleCommand

Delete a CT (Code Template) folder.

See Also

OMBDROP

OMBDROP CUBE

Purpose

This command drops a Cube.

Prerequisites

Should be in Oracle Module context.

Syntax

dropCubeCommand =  OMBDROP CUBE "cubeName"
     cubeName =  "QUOTED_STRING"

Parameters

dropCubeCommand

This clause drops a cube.

cubeName

The name of the cube in QUOTED_STRING.

See Also

OMBCREATE CUBE

OMBALTER CUBE

OMBRETRIEVE CUBE

OMBDROP DATA_AUDITOR

Purpose

Drop an existing data auditor.

Prerequisites

The current context of scripting must be an Oracle

Syntax

dropDataAuditorCommand =  OMBDROP DATA_AUDITOR "dataAuditorName"
     dataAuditorName =  "QUOTED_STRING"

Parameters

dropDataAuditorCommand

Drop an existing data auditor.

dataAuditorName

Name of data auditor.

See Also

OMBCREATE DATA_AUDITOR

OMBALTER DATA_AUDITOR

OMBRETRIEVE DATA_AUDITOR

OMBDROP DATA_PROFILE

Purpose

Delete the Data Profile.

Prerequisites

Should be in the context of project.

Syntax

dropDataProfileCommand =  OMBDROP ( DATA_PROFILE "QUOTED_STRING" )

Parameters

dropDataProfileCommand

Remove an existing Data Profile.

QUOTED_STRING

Name of the existing Data Profile in quotes.

See Also

OMBDROP

OMBCREATE DATA_PROFILE

OMBALTER DATA_PROFILE

OMBDROP DATA_RULE

Purpose

Drop an existing data rule.

Prerequisites

The current context of scripting must be a data rule module.

Syntax

dropDataRuleCommand =  OMBDROP DATA_RULE "QUOTED_STRING"

Parameters

dropDataRuleCommand

This clause drops a data rule.

QUOTED_STRING

Data rule name.

See Also

OMBRETRIEVE DATA_RULE

OMBCREATE DATA_RULE

OMBALTER DATA_RULE

OMBDROP DEPLOYMENT

Purpose

Delete the Deployment.

Prerequisites

Should be in the context of a Configuration.

Syntax

dropDeploymentCommand =  OMBDROP ( DEPLOYMENT "QUOTED_STRING" )

Parameters

dropDeploymentCommand

Remove an existing Deployment.

See Also

OMBDROP

OMBALTER DEPLOYMENT

OMBCREATE DEPLOYMENT

OMBDROP DEPLOYMENT_ACTION_PLAN

Purpose

Remove an existing deployment action plan.

Prerequisites

There must be a current working project.

Syntax

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

Parameters

DropActionPlanCommand

Remove an existing deployment action plan.

See Also

OMBCREATE DEPLOYMENT_ACTION_PLAN

OMBDEPLOY

OMBDROP DIMENSION

Purpose

This command drops a dimension.

Prerequisites

Should be in Oracle Module context.

Syntax

dropDimensionCommand =  OMBDROP DIMENSION "dimensionName"
     dimensionName =  "QUOTED_STRING"

Parameters

dropDimensionCommand

This is a command for dropping a Dimension.

dimensionName

The name of the Dimension to be dropped.

See Also

OMBCREATE DIMENSION

OMBALTER DIMENSION

OMBRETRIEVE DIMENSION

OMBDROP DRILL_PATH

Purpose

To drop a Drill Path.

Prerequisites

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

Syntax

dropDrillPathCommand =  OMBDROP DRILL_PATH "QUOTED_STRING"

Parameters

dropDrillPathCommand

To drop a Drill Path.

See Also

OMBRETRIEVE DRILL_PATH

OMBCREATE DRILL_PATH

OMBALTER DRILL_PATH

OMBDROP DRILL_TO_DETAIL

Purpose

To drop a Drill to Detail.

Prerequisites

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

Syntax

dropDrillToDetailCommand =  OMBDROP DRILL_TO_DETAIL "QUOTED_STRING"

Parameters

dropDrillToDetailCommand

To drop a Drill to Detail.

See Also

OMBRETRIEVE DRILL_TO_DETAIL

OMBCREATE DRILL_TO_DETAIL

OMBALTER DRILL_TO_DETAIL

OMBDROP EXPERT

Purpose

To drop an expert.

Prerequisites

In the context of an expert module.

Syntax

dropExpertCommand =  OMBDROP EXPERT "QUOTED_STRING"

Parameters

dropExpertCommand

Drop the specified expert.

See Also

OMBDROP

OMBCREATE EXPERT

OMBALTER EXPERT

OMBRETRIEVE EXPERT

OMBDROP EXPERT_MODULE

Purpose

To drop an expert module.

Prerequisites

In the context of a project.

Syntax

dropExpertModuleCommand =  OMBDROP ( EXPERT_MODULE "QUOTED_STRING" )

Parameters

dropExpertModuleCommand

Delete an expert module.

See Also

OMBDROP

OMBCREATE EXPERT_MODULE

OMBALTER EXPERT_MODULE

OMBDROP EXTERNAL_TABLE

Purpose

Delete the external table.

Prerequisites

Should be in the context of an Oracle module.

Syntax

dropExternalTableCommand =  OMBDROP EXTERNAL_TABLE "QUOTED_STRING"

Parameters

dropExternalTableCommand

Drop an external table from the repository.

QUOTED_STRING

The name of the external table to drop.

See Also

OMBDROP

OMBCREATE EXTERNAL_TABLE

OMBALTER EXTERNAL_TABLE

OMBRETRIEVE EXTERNAL_TABLE

OMBDROP FLAT_FILE

Purpose

Delete a flat file.

Prerequisites

Should be in the context of a flat file module.

Syntax

dropFlatFileCommand =  OMBDROP FLAT_FILE "QUOTED_STRING"

Parameters

dropFlatFileCommand

Drop a flat file.

QUOTED_STRING

The name of the flat file to drop.

See Also

OMBDROP

OMBCREATE FLAT_FILE

OMBALTER FLAT_FILE

OMBDROP FLAT_FILE_MODULE

Purpose

Delete a flat file module.

Prerequisites

Should be in the context of a project.

Syntax

dropFlatFileModuleCommand =  OMBDROP ( FLAT_FILE_MODULE "QUOTED_STRING" )

Parameters

dropFlatFileModuleCommand

Drop a flat file module.

QUOTED_STRING

The name of the flat file module to drop.

See Also

OMBDROP

OMBCREATE FLAT_FILE_MODULE

OMBALTER FLAT_FILE_MODULE

13 OMBDROP FOLDER to OMBDROP PLATFORM

OMBDROP FOLDER

OMBDROP FUNCTION

OMBDROP GATEWAY_MODULE

OMBDROP ICONSET

OMBDROP IMPORT_ACTION_PLAN

OMBDROP ITEM_FOLDER

OMBDROP J2EE_USER

OMBDROP LIST_OF_VALUES

OMBDROP LOCATION

OMBDROP LOGICAL_TABLE

OMBDROP MAPPING

OMBDROP MAPPING_MODULE

OMBDROP MATERIALIZED_VIEW

OMBDROP MDL_ACTION_PLAN

OMBDROP NESTED_TABLE

OMBDROP OBIEE_BUSINESS_DEFINITION_MODULE

OMBDROP OBJECT_TYPE

OMBDROP ORACLE_EBS_MODULE

OMBDROP ORACLE_MODULE

OMBDROP PACKAGE

OMBDROP PLATFORM

OMBDROP FOLDER

Purpose

Delete the folder.

Prerequisites

Should be in the context of a module (Oracle, Non-Oracle, Aplications, Process Flow types) or folder.

Syntax

dropUserFolderCommand =  OMBDROP ( FOLDER "QUOTED_STRING" )

Parameters

dropUserFolderCommand

Remove an existing folder.

QUOTED_STRING

Name of the existing folder in quotes.

See Also

OMBDROP

OMBALTER FOLDER

OMBCREATE FOLDER

OMBDROP FUNCTION

Purpose

Delete the Function.

Prerequisites

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

A Transformation Module may be WB_CUSTOM_TRANS for Public Transformations.

WB_CUSTOM_TRANS may by modified by an administrator.

WB_CUSTOM_TRANS is not dependent on any project.

Syntax

dropFunctionCommand =  OMBDROP ( FUNCTION "QUOTED_STRING" )

Parameters

dropFunctionCommand

Remove an existing Function.

QUOTED_STRING

Name of the existing Function in quotes.

See Also

OMBDROP

OMBCREATE FUNCTION

OMBALTER FUNCTION

OMBDROP GATEWAY_MODULE

Purpose

Delete the Gateway module.

Prerequisites

Should be in the context of project.

Syntax

dropGatewayModuleCommand =  OMBDROP ( GATEWAY_MODULE "QUOTED_STRING" )

Parameters

dropGatewayModuleCommand

Remove an existing Gateway module.

QUOTED_STRING

Name of the existing Gateway m odule in quotes.

See Also

OMBDROP

OMBCREATE GATEWAY_MODULE

OMBALTER GATEWAY_MODULE

OMBDROP ICONSET

Purpose

To remove an iconset from the workspace.

Prerequisites

Any context.

Syntax

dropIconSetCommand =  OMBDROP ICONSET "QUOTED_STRING"

Parameters

dropIconSetCommand

This command removes an iconset from the workspace.

QUOTED_STRING

The name of the iconset to be removed.

See Also

OMBCREATE ICONSET

OMBALTER ICONSET

OMBDROP IMPORT_ACTION_PLAN

Purpose

To drop a transient import action plan.

Prerequisites

In the context of a project

Syntax

dropImportActionPlanCommand =  ( OMBDROP ( IMPORT_ACTION_PLAN )
          "QUOTED_STRING" )

Parameters

dropImportActionPlanCommand

This command is for dropping an import action plan.

QUOTED_STRING

The name of the import action plan to be dropped.

See Also

OMBCREATE IMPORT_ACTION_PLAN

OMBIMPORT

OMBDROP ITEM_FOLDER

Purpose

To drop an Item Folder.

Prerequisites

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

Syntax

dropItemFolderCommand =  OMBDROP ITEM_FOLDER "QUOTED_STRING"

Parameters

dropItemFolderCommand

To drop an Item Folder.

See Also

OMBRETRIEVE ITEM_FOLDER

OMBCREATE ITEM_FOLDER

OMBALTER ITEM_FOLDER

OMBDROP J2EE_USER

Purpose

To drop a J2EE user that will be removed from the runtime.

Prerequisites

J2EE runtime must be up and running.

Syntax

parseDropJ2eeUserCommand =  OMBDROP J2EE_USER "QUOTED_STRING"
          "J2eePropertiesClause"
     J2eePropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")" VALUES
          "(" "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseDropJ2eeUserCommand

This clause drops a J2EE runtime user.

J2eePropertiesClause

Properties for making J2EE connection to create or drop J2EE users.

propertyNameList

Connection property names : USER, PASSWORD, HOST, PORT, JSR88TYPE, ROOT, INSTANCE, PROTOCOL

propertyValueList

List of connection property value for the property name. See the example for detail.

propertyValue

The value for the connection property. See example for detail.

See Also

OMBCREATE J2EE_USER

OMBDROP LIST_OF_VALUES

Purpose

To drop a List Of Values.

Prerequisites

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

Syntax

dropListOfValuesCommand =  OMBDROP LIST_OF_VALUES "QUOTED_STRING"

Parameters

dropListOfValuesCommand

To drop a List Of Values.

See Also

OMBRETRIEVE LIST_OF_VALUES

OMBCREATE LIST_OF_VALUES

OMBALTER LIST_OF_VALUES

OMBDROP LOCATION

Purpose

Delete the location.

Prerequisites

Can be in any context.

Syntax

dropLocationCommand =  OMBDROP ( LOCATION "QUOTED_STRING" )

Parameters

dropLocationCommand

Drop a location from the repository.

See Also

OMBDROP

OMBCREATE LOCATION

OMBALTER LOCATION

OMBDROP LOGICAL_TABLE

Purpose

To drop a Logical Table.

Prerequisites

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

Syntax

dropLogicalTableCommand =  OMBDROP LOGICAL_TABLE "QUOTED_STRING"

Parameters

dropLogicalTableCommand

To drop a Logical Table.

See Also

OMBRETRIEVE LOGICAL_TABLE

OMBCREATE LOGICAL_TABLE

OMBALTER LOGICAL_TABLE

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.

See Also

OMBDROP

OMBCREATE MAPPING

OMBALTER MAPPING

OMBRETRIEVE MAPPING

OMBDROP MAPPING_MODULE

Purpose

Delete a mapping module.

Prerequisites

Should be in the context of a project.

Syntax

dropMapModuleCommand =  OMBDROP ( MAPPING_MODULE "QUOTED_STRING" )

Parameters

dropMapModuleCommand

Drop a mapping module.

QUOTED_STRING

The name of the mapping module to drop.

See Also

OMBDROP

OMBCREATE MAPPING_MODULE

OMBALTER MAPPING_MODULE

OMBDROP MATERIALIZED_VIEW

Purpose

To drop a materialized view.

Prerequisites

In the context of an Oracle Module.

Syntax

dropMaterializedViewCommand =  OMBDROP MATERIALIZED_VIEW "QUOTED_STRING"

Parameters

dropMaterializedViewCommand

This clause drops a MaterializedView.

See Also

OMBDROP

OMBCREATE MATERIALIZED_VIEW

OMBALTER MATERIALIZED_VIEW

OMBRETRIEVE MATERIALIZED_VIEW

OMBDROP MDL_ACTION_PLAN

Purpose

Remove an existing metadata loader action plan.

Prerequisites

Connection must be established to the repository.

Syntax

dropMDLActionPlanCommand =  ( OMBDROP ( MDL_ACTION_PLAN ) "QUOTED_STRING" )

Parameters

dropMDLActionPlanCommand

Remove an existing metadata loader action plan.

QUOTED_STRING

Enclose the name of the metadata loader action plan in single quotes.

See Also

OMBCREATE MDL_ACTION_PLAN

OMBALTER MDL_ACTION_PLAN

OMBRETRIEVE MDL_ACTION_PLAN

OMUEXPORT MDL_FILE

OMBDROP NESTED_TABLE

Purpose

Delete the Nested Table.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

dropNestedTableCommand =  OMBDROP NESTED_TABLE "QUOTED_STRING"

Parameters

dropNestedTableCommand

Deletes the Nested Table with the given name.

See Also

OMBRETRIEVE NESTED_TABLE

OMBCREATE NESTED_TABLE

OMBALTER NESTED_TABLE

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.

See Also

OMBDROP

OMBCREATE OBIEE_BUSINESS_DEFINITION_MODULE

OMBALTER OBIEE_BUSINESS_DEFINITION_MODULE

OMBDROP OBJECT_TYPE

Purpose

Delete the Object Type.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

dropObjectTypeCommand =  OMBDROP OBJECT_TYPE "QUOTED_STRING"

Parameters

dropObjectTypeCommand

Drops the Object Type with given name.

See Also

OMBDROP

OMBCREATE OBJECT_TYPE

OMBALTER OBJECT_TYPE

OMBDROP ORACLE_EBS_MODULE

Purpose

dropOracleEBSModuleCommandPurposeTag??

Prerequisites

dropOracleEBSModuleCommandPreTag??

Syntax

dropOracleEBSModuleCommand =  OMBDROP ( ORACLE_EBS_MODULE "QUOTED_STRING" )

Parameters

See Also

OMBDROP

OMBCREATE ORACLE_EBS_MODULE

OMBALTER ORACLE_EBS_MODULE

OMBDROP ORACLE_MODULE

Purpose

Delete the Oracle module.

Prerequisites

Should be in the context of project.

Syntax

dropOracleModuleCommand =  OMBDROP ( ORACLE_MODULE "QUOTED_STRING" )

Parameters

dropOracleModuleCommand

Remove an existing Oracle module.

QUOTED_STRING

Name of the existing Oracle module in quotes.

See Also

OMBDROP

OMBCREATE ORACLE_MODULE

OMBALTER ORACLE_MODULE

OMBDROP PACKAGE

Purpose

Delete the Package.

Prerequisites

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

A Transformation Module may be WB_CUSTOM_TRANS for Public Transformations.

WB_CUSTOM_TRANS may by modified by an administrator.

WB_CUSTOM_TRANS is not dependent on any project.

Syntax

dropPackageCommand =  OMBDROP ( PACKAGE "QUOTED_STRING" )

Parameters

dropPackageCommand

Remove an existing Package.

QUOTED_STRING

Name of the existing Package in quotes.

See Also

OMBDROP

OMBCREATE PACKAGE

OMBALTER PACKAGE

OMBDROP PLATFORM

Purpose

Drop the platform from this workspace.

Prerequisites

Should be in the context of a project, before dropping a platform.

Syntax

dropPlatformCommand =  OMBDROP ( PLATFORM "QUOTED_STRING" )

Parameters

dropPlatformCommand

Drop a platform definition from the repository. This drops the platform, its datatypes and data type mappings.

See Also

OMBDROP

OMBALTER PLATFORM

OMBCREATE PLATFORM

14 OMBDROP PLSQL_RECORD_TYPE to OMBDROP TABLE

OMBDROP PLSQL_RECORD_TYPE

OMBDROP PLSQL_REF_CURSOR_TYPE

OMBDROP PLSQL_TABLE_TYPE

OMBDROP PLUGGABLE_MAPPING

OMBDROP PLUGGABLE_MAPPING_FOLDER

OMBDROP PROCEDURE

OMBDROP PROCESS_FLOW

OMBDROP PROCESS_FLOW_MODULE

OMBDROP PROCESS_FLOW_PACKAGE

OMBDROP PROJECT

OMBDROP PSFT_MODULE

OMBDROP QUEUE_PROPAGATION

OMBDROP QUEUE_TABLE

OMBDROP REAL_TIME_MAPPING

OMBDROP REGISTERED_FUNCTION

OMBDROP ROLE

OMBDROP SAP_MODULE

OMBDROP SEQUENCE

OMBDROP SIEBEL_MODULE

OMBDROP SNAPSHOT

OMBDROP TABLE

OMBDROP PLSQL_RECORD_TYPE

Purpose

Delete the PLSQL Record Type.

Prerequisites

Should be in the context of a Package.

Syntax

dropPlSqlRecordTypeCommand =  OMBDROP PLSQL_RECORD_TYPE "QUOTED_STRING"

Parameters

dropPlSqlRecordTypeCommand

Drops the PLSQL Record Type with given name.

See Also

OMBDROP

OMBCREATE PLSQL_RECORD_TYPE

OMBALTER PLSQL_RECORD_TYPE

OMBDROP PLSQL_REF_CURSOR_TYPE

Purpose

Delete the Ref-cursor Type.

Prerequisites

Should be in the context of a Package.

Syntax

dropPlSqlRefCursorTypeCommand =  OMBDROP PLSQL_REF_CURSOR_TYPE
          "QUOTED_STRING"

Parameters

dropPlSqlRefCursorTypeCommand

Drops the Ref-cursor Type with given name.

See Also

OMBDROP

OMBCREATE PLSQL_REF_CURSOR_TYPE

OMBALTER PLSQL_REF_CURSOR_TYPE

OMBDROP PLSQL_TABLE_TYPE

Purpose

Delete the Table Type.

Prerequisites

Should be in the context of a Package.

Syntax

dropPlSqlTableTypeCommand =  OMBDROP PLSQL_TABLE_TYPE "QUOTED_STRING"

Parameters

dropPlSqlTableTypeCommand

Drops the Table Type with given name.

See Also

OMBDROP

OMBCREATE PLSQL_TABLE_TYPE

OMBALTER PLSQL_TABLE_TYPE

OMBDROP PLUGGABLE_MAPPING

Purpose

Drop an existing pluggable mapping.

Prerequisites

The current context of scripting must be a project or pluggable map folder.

Syntax

dropPluggableMappingCommand =  OMBDROP PLUGGABLE_MAPPING "pluggableMapName"
     pluggableMapName =  "QUOTED_STRING"

Parameters

dropPluggableMappingCommand

Drop an existing pluggable map folder.

pluggableMapName

Name of the pluggable map.

See Also

OMBDROP

OMBCREATE PLUGGABLE_MAPPING

OMBALTER PLUGGABLE_MAPPING

OMBRETRIEVE PLUGGABLE_MAPPING

OMBDROP PLUGGABLE_MAPPING_FOLDER

Purpose

Drop an existing pluggable map folder.

Prerequisites

The current context of scripting must be a project.

Syntax

dropPluggableMappingLibraryCommand =  OMBDROP ( PLUGGABLE_MAPPING_FOLDER |
          PLUGGABLE_MAPPING_LIBRARY ) "pluggableMapLibraryName"
     pluggableMapLibraryName =  "QUOTED_STRING"

Parameters

dropPluggableMappingLibraryCommand

Drop an existing pluggable map folder.

pluggableMapLibraryName

Name of the pluggable map folder.

See Also

OMBDROP

OMBDROP PROCEDURE

Purpose

Delete the Procedure.

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

dropProcedureCommand =  OMBDROP ( PROCEDURE "QUOTED_STRING" )

Parameters

dropProcedureCommand

Remove an existing Procedure.

QUOTED_STRING

Name of the existing Procedure in quotes.

See Also

OMBDROP

OMBCREATE PROCEDURE

OMBALTER PROCEDURE

OMBDROP PROCESS_FLOW

Purpose

Delete the Process Flow.

Prerequisites

Should be in the context of a Process Flow Package.

Syntax

dropProcessFlowCommand =  OMBDROP ( PROCESS_FLOW "QUOTED_STRING" )

Parameters

dropProcessFlowCommand

Delete a process flow.

See Also

OMBDROP

OMBCREATE PROCESS_FLOW

OMBALTER PROCESS_FLOW

OMBDROP PROCESS_FLOW_MODULE

Purpose

Delete the Process Flow Module.

Prerequisites

Should be in the context of a project.

Syntax

dropProcessFlowModuleCommand =  OMBDROP ( PROCESS_FLOW_MODULE
          "QUOTED_STRING" )

Parameters

dropProcessFlowModuleCommand

Drop an existing process flow module.

See Also

OMBDROP

OMBCREATE PROCESS_FLOW_MODULE

OMBALTER PROCESS_FLOW_MODULE

OMBDROP PROCESS_FLOW_PACKAGE

Purpose

Delete the Process Flow Package.

Prerequisites

Should be in the context of a Process Flow Module.

Syntax

dropProcessFlowPackageCommand =  OMBDROP ( PROCESS_FLOW_PACKAGE
          "QUOTED_STRING" )

Parameters

dropProcessFlowPackageCommand

Delete a process flow package.

See Also

OMBDROP

OMBCREATE PROCESS_FLOW_PACKAGE

OMBALTER PROCESS_FLOW_PACKAGE

OMBDROP PROJECT

Purpose

Delete the project.

Prerequisites

Should be in the top level context.

Syntax

dropProjectCommand =  OMBDROP ( PROJECT "QUOTED_STRING" )

Parameters

dropProjectCommand

Remove an existing project.

QUOTED_STRING

Name of the existing project in quotes.

See Also

OMBDROP

OMBCREATE PROJECT

OMBALTER PROJECT

OMBDROP PSFT_MODULE

Purpose

dropPSFTModuleCommandPurposeTag??

Prerequisites

dropPSFTModuleCommandPreTag??

Syntax

dropPSFTModuleCommand =  OMBDROP ( PSFT_MODULE "QUOTED_STRING" )

Parameters

See Also

OMBDROP

OMBCREATE PSFT_MODULE

OMBALTER PSFT_MODULE

OMBDROP QUEUE_PROPAGATION

Purpose

Delete the Queue Propagation.

Prerequisites

Should be in the context of an Advanced Queue.

Syntax

dropQPCommand =  OMBDROP QUEUE_PROPAGATION "QUOTED_STRING"

Parameters

dropQPCommand

Drops the Queue Propagation with the given name.

See Also

OMBDROP

OMBCREATE QUEUE_PROPAGATION

OMBALTER QUEUE_PROPAGATION

OMBRETRIEVE QUEUE_PROPAGATION

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.

See Also

OMBDROP

OMBCREATE QUEUE_TABLE

OMBALTER QUEUE_TABLE

OMBRETRIEVE QUEUE_TABLE

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.

See Also

OMBDROP

OMBCREATE REAL_TIME_MAPPING

OMBALTER REAL_TIME_MAPPING

OMBRETRIEVE REAL_TIME_MAPPING

OMBDROP REGISTERED_FUNCTION

Purpose

To drop an IO Function.

Prerequisites

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

Syntax

dropRegisteredFunctionCommand =  OMBDROP REGISTERED_FUNCTION
          "QUOTED_STRING"

Parameters

dropRegisteredFunctionCommand

To drop an IO Function.

See Also

OMBRETRIEVE REGISTERED_FUNCTION

OMBCREATE REGISTERED_FUNCTION

OMBALTER REGISTERED_FUNCTION

OMBDROP ROLE

Purpose

To drop a Warehouse Builder role.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseDropRoleCommand =  ( OMBDROP ROLE "QUOTED_STRING" )

Parameters

parseDropRoleCommand

This clause drops a Warehouse Builder role.

See Also

OMBCREATE ROLE

OMBALTER ROLE

OMBRETRIEVE ROLE

OMBLIST ROLES

OMBDROP SAP_MODULE

Purpose

Remove an existing SAP module.

Prerequisites

You must open a project to drop a SAP module.

Syntax

dropSAPModuleCommand =  OMBDROP ( SAP_MODULE "QUOTED_STRING" )

Parameters

dropSAPModuleCommand

Remove an existing SAP module.

See Also

OMBDROP

OMBDROP SEQUENCE

Purpose

To drop a sequence.

Prerequisites

In the context of an Oracle Module.

Syntax

dropSequenceCommand =  OMBDROP SEQUENCE "QUOTED_STRING"

Parameters

dropSequenceCommand

This clause drops a Sequence.

See Also

OMBDROP

OMBCREATE SEQUENCE

OMBALTER SEQUENCE

OMBRETRIEVE SEQUENCE

OMBDROP SIEBEL_MODULE

Purpose

dropSiebelModuleCommandPurposeTag??

Prerequisites

dropSiebelModuleCommandPreTag??

Syntax

dropSiebelModuleCommand =  OMBDROP ( SIEBEL_MODULE "QUOTED_STRING" )

Parameters

See Also

OMBDROP

OMBCREATE SIEBEL_MODULE

OMBALTER SIEBEL_MODULE

OMBDROP SNAPSHOT

Purpose

Delete the module.

Prerequisites

Should be in the context of project.

Syntax

parseDropCommand =  OMBDROP ( SNAPSHOT "QUOTED_STRING" )

Parameters

parseDropCommand

To drop a snapshot.

QUOTED_STRING

Name of snapshot to be dropped.

See Also

OMBCREATE SNAPSHOT

OMBALTER SNAPSHOT

OMBRESTORE SNAPSHOT

OMBCOMPARE SNAPSHOT

OMBLIST SNAPSHOT

OMBRETRIEVE SNAPSHOT

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.

See Also

OMBDROP

OMBCREATE TABLE

OMBALTER TABLE

OMBRETRIEVE TABLE

15 OMBDROP TABLE_FUNCTION to OMBIMPORT CT_FILE

OMBDROP TABLE_FUNCTION

OMBDROP TIME_DIMENSION

OMBDROP TRANSPORTABLE_MODULE

OMBDROP UNQUOTED_STRING

OMBDROP VARYING_ARRAY

OMBDROP VIEW

OMBDROP WEB_SERVICE

OMBDROP WEB_SERVICE_PACKAGE

OMBENV

OMBEXPORT

OMBEXPORT ENTIRE_REPOSITORY

OMBEXPORT MDL_FILE

OMBGRANT DEFAULT_OBJ_PRIV

OMBGRANT J2EE_ROLE

OMBGRANT OBJ_PRIV

OMBGRANT ROLE

OMBGRANT SYS_PRIV

OMBHELP

OMBIMPACT

OMBIMPORT

OMBIMPORT CT_FILE

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

See Also

OMBDROP

OMBCREATE TABLE_FUNCTION

OMBALTER TABLE_FUNCTION

OMBDROP TIME_DIMENSION

Purpose

This command drops a time dimension.

Prerequisites

Should be in Oracle Module context.

Syntax

dropTimeDimensionCommand =  OMBDROP TIME_DIMENSION "TimeDimensionName"
     TimeDimensionName =  "QUOTED_STRING"

Parameters

dropTimeDimensionCommand

This clause drops a time dimension.

TimeDimensionName

The name of the time dimension.

See Also

OMBCREATE TIME_DIMENSION

OMBALTER TIME_DIMENSION

OMBRETRIEVE TIME_DIMENSION

OMBDROP TRANSPORTABLE_MODULE

Purpose

To drop a transportable module.

Prerequisites

In the context of a project.

Syntax

dropTMCommand =  OMBDROP TRANSPORTABLE_MODULE "QUOTED_STRING"

Parameters

dropTMCommand

This command is for dropping a transportable module.

QUOTED_STRING

The transportable module to be dropped.

See Also

OMBCREATE TRANSPORTABLE_MODULE

OMBDROP UNQUOTED_STRING

Purpose

Delete the module.

Prerequisites

Should be in the context of project.

Syntax

parseDropCommand =  OMBDROP ( "UNQUOTED_STRING" "QUOTED_STRING" )

Parameters

See Also

OMBCREATE

OMBDROP VARYING_ARRAY

Purpose

Delete the Varying Array.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

dropVaryingArrayCommand =  OMBDROP VARYING_ARRAY "QUOTED_STRING"

Parameters

dropVaryingArrayCommand

Deletes the Varying Array with the given name.

See Also

OMBRETRIEVE VARYING_ARRAY

OMBCREATE VARYING_ARRAY

OMBALTER VARYING_ARRAY

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.

See Also

OMBDROP

OMBCREATE VIEW

OMBALTER VIEW

OMBRETRIEVE VIEW

OMBDROP WEB_SERVICE

Purpose

Delete the Web Service.

Prerequisites

Should be in the context of a Web Service Package or an Application Server Module, public web service should be in the context of public Application Service Module.

Syntax

dropWebServiceCommand =  OMBDROP WEB_SERVICE "QUOTED_STRING"

Parameters

dropWebServiceCommand

Drop the web service.

See Also

OMBDROP

OMBCREATE WEB_SERVICE

OMBALTER WEB_SERVICE

OMBRETRIEVE WEB_SERVICE

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.

See Also

OMBDROP

OMBCREATE WEB_SERVICE_PACKAGE

OMBALTER WEB_SERVICE_PACKAGE

OMBRETRIEVE WEB_SERVICE_PACKAGE

OMBENV

Purpose

This command will list the values for all set OMBPlus environment variables. OMBPlus environment variables are regular Tcl variables, so they can be set using standard Tcl "set" command, and unset using standard "unset" command.

Prerequisites

None.

Syntax

parseEnvironmentCommand =  OMBENV

Parameters

parseEnvironmentCommand

Specify environment command. The environment variables recognized by OMBPlus are:

OMBPROMPT if set, will display the current context as the prompt

OMBLOG if set with a file name, will log the output to that file

OMBTIMER if set, will display the time taken by the executed command. Note that the elapsed time will be appended to the command result, therefore the user should not set this variable when the result of the command is expected to be processed

OMBCONTINUE_ON_ERROR if set, will continue the execution of the script, even when some OMB commands fail. Note that if this variable is set, OMB commands no longer return Tcl errors, so any enclosing 'catch' command will not be effective.

OMBEXPORT

Purpose

Exports current metadata, metadata definitions, or snapshot metadata to a metadata loader file.

Prerequisites

Connection must be established to repository to be exported from.

Syntax

mdlExportCommand =  ( [ TO ] MDL_FILE "QUOTED_STRING" [ "fileFormatClause"
          ] [ FROM ] [ "projectClause" ] [ "componentsClause" ] [ (
          "classesClause" | ALL_CLASS_DEFINITIONS ) ] [ WITH ] [
          "dependeeDepthClause" ] [ "includeGrantsClause" ] [
          "includeCMIDefsClause" ] [ "useFieldSeparatorClause" ] [
          "controlFileClause" ] [ "includeUserDefsClause" ] [
          "supportedLangsClause" ] [ "outputLogClause" ] )
     fileFormatClause =  FILE_FORMAT ( ZIP | TEXT )
     projectClause =  PROJECT "QUOTED_STRING"
     componentsClause =  COMPONENTS "(" "componentsList" ")"
     classesClause =  CLASS_DEFINITIONS "(" "QUOTED_STRING" { ","
          "QUOTED_STRING" } ")"
     dependeeDepthClause =  DEPENDEE_DEPTH ( MAX | "INTEGER_LITERAL" )
     includeGrantsClause =  INCLUDE_GRANTS
     includeCMIDefsClause =  INCLUDE_CMI_DEFINITIONS
     useFieldSeparatorClause =  [ USE ] FIELD_SEPARATOR "UNQUOTED_STRING"
     controlFileClause =  CONTROL_FILE "QUOTED_STRING"
     includeUserDefsClause =  INCLUDE_USER_DEFINITIONS
     supportedLangsClause =  SUPPORTED_LANGUAGES "(" "supportedLangsList" ")"
     outputLogClause =  OUTPUT LOG [ TO ] "QUOTED_STRING"
     componentsList =  "objectTypeValue" "QUOTED_STRING" { "," "objectTypeValue"
           "QUOTED_STRING" }
     supportedLangsList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     objectTypeValue =  "UNQUOTED_STRING"

Parameters

mdlExportCommand

Export metadata from an Oracle Warehouse Builder repository to a file.

QUOTED_STRING

Enclose the name of the export metadata file in single quotes.

ALL_CLASS_DEFINITIONS

Exports all the metadata definitions belonging to a workspace.

fileFormatClause

Specify the file format for the exported file.

ZIP

Defaults to a ZIP file format which is a compressed binary file.

TEXT

Readable file format.

projectClause

Specify the project to be exported.

QUOTED_STRING

Enclose the name of the project to be exported in single quotes.

componentsClause

List components to be exported.

classesClause

List of class definitions to be exported.

QUOTED_STRING

Enclose in single quotes the class definition name.

dependeeDepthClause

Specify how many levels of dependent objects should be exported for components specified for export. Use MAX for all dependents, 0 for no dependents, 1 for one level of dependents. The default is 0.

includeGrantsClause

Use to request that security related metadata be included in the export.

includeCMIDefsClause

Use to request that related CMI Definitions for CMI Modules be included in the export.

useFieldSeparatorClause

Do not use this option. It is an obsolete option that was used to specify character to be used as the field separator in the old metadata file format.

UNQUOTED_STRING

Do not use this option. Obsolete metadata file field separator for old MDL file format. Use BAR or CARAT. The default is BAR.

controlFileClause

Specify a control file with export options not directly supported by OMBEXPORT command.

QUOTED_STRING

Enclose the control file name in single quotes.

includeUserDefsClause

Use to request that metadata definitions be included in the export.

supportedLangsClause

List supported languages to be exported.

outputLogClause

Export log file for export messages and statistics.

QUOTED_STRING

Enclose the log file name in single quotes.

componentsList

Comma separated list of components to be exported.

QUOTED_STRING

Enclose in single quotes the absolute or relative path name of an object (e.g. 'MODULE_X/TABLE_Y').

supportedLangsList

Comma separated list of supported languages to be exported.

QUOTED_STRING

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

objectTypeValue

Specify the first class object type to be exported (e.g. TABLE, VIEW, CUBE, DIMENSION, etc.).

See Also

OMBIMPORT

OMBEXPORT ENTIRE_REPOSITORY

Purpose

Exports the entire Oracle Warehouse Builder repository to a metadata loader file.

Prerequisites

You must not be connected to a design repository. If connected, then use OMBDISCONNECT to disconnect.

This command only supports 10g Release 2 or a later release.

Exporting entire repository from 10g Release 2 requires the repository owner credentials.

Exporting entire repository from 11g or later requires the OWBSYS credentials.

Syntax

repositoryUpgradeExportCommand =  ( ENTIRE_REPOSITORY [ TO ] MDL_FILE
          "QUOTED_STRING" [ "outputLogClause" ] USING CREDENTIAL
          "UNQUOTED_STRING" [ NET_SERVICE_NAME "QUOTED_STRING" ] )
     outputLogClause =  OUTPUT LOG [ TO ] "QUOTED_STRING"

Parameters

repositoryUpgradeExportCommand

Export the entire repository metadata to a file.

QUOTED_STRING

= Enclose the name of the exported repository file in single quotes.

UNQUOTED_STRING

Specify the repository credential in the format username/password@host:port:servicename

outputLogClause

Export log file for export messages and statistics.

QUOTED_STRING

Enclose the log file name in single quotes.

See Also

OMBIMPORT ENTIRE_REPOSITORY MDL_FILE

OMBEXPORT MDL_FILE

Purpose

Exports current metadata, metadata definitions, or snapshot metadata to a metadata loader file.

Prerequisites

Connection must be established to repository to be exported from.

Syntax

mdlExportCommand =  ( [ TO ] MDL_FILE "QUOTED_STRING" [ "fileFormatClause"
          ] [ FROM ] [ "projectClause" ] [ "componentsClause" ] [ (
          "classesClause" | ALL_CLASS_DEFINITIONS ) ] [ WITH ] [
          "dependeeDepthClause" ] [ "includeGrantsClause" ] [
          "includeCMIDefsClause" ] [ "useFieldSeparatorClause" ] [
          "controlFileClause" ] [ "includeUserDefsClause" ] [
          "supportedLangsClause" ] [ "outputLogClause" ] )
     fileFormatClause =  FILE_FORMAT ( ZIP | TEXT )
     projectClause =  PROJECT "QUOTED_STRING"
     componentsClause =  COMPONENTS "(" "componentsList" ")"
     classesClause =  CLASS_DEFINITIONS "(" "QUOTED_STRING" { ","
          "QUOTED_STRING" } ")"
     dependeeDepthClause =  DEPENDEE_DEPTH ( MAX | "INTEGER_LITERAL" )
     includeGrantsClause =  INCLUDE_GRANTS
     includeCMIDefsClause =  INCLUDE_CMI_DEFINITIONS
     useFieldSeparatorClause =  [ USE ] FIELD_SEPARATOR "UNQUOTED_STRING"
     controlFileClause =  CONTROL_FILE "QUOTED_STRING"
     includeUserDefsClause =  INCLUDE_USER_DEFINITIONS
     supportedLangsClause =  SUPPORTED_LANGUAGES "(" "supportedLangsList" ")"
     outputLogClause =  OUTPUT LOG [ TO ] "QUOTED_STRING"
     componentsList =  "objectTypeValue" "QUOTED_STRING" { "," "objectTypeValue"
           "QUOTED_STRING" }
     supportedLangsList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     objectTypeValue =  "UNQUOTED_STRING"

Parameters

mdlExportCommand

Export metadata from an Oracle Warehouse Builder repository to a file.

QUOTED_STRING

Enclose the name of the export metadata file in single quotes.

ALL_CLASS_DEFINITIONS

Exports all the metadata definitions belonging to a workspace.

fileFormatClause

Specify the file format for the exported file.

ZIP

Defaults to a ZIP file format which is a compressed binary file.

TEXT

Readable file format.

projectClause

Specify the project to be exported.

QUOTED_STRING

Enclose the name of the project to be exported in single quotes.

componentsClause

List components to be exported.

classesClause

List of class definitions to be exported.

QUOTED_STRING

Enclose in single quotes the class definition name.

dependeeDepthClause

Specify how many levels of dependent objects should be exported for components specified for export. Use MAX for all dependents, 0 for no dependents, 1 for one level of dependents. The default is 0.

includeGrantsClause

Use to request that security related metadata be included in the export.

includeCMIDefsClause

Use to request that related CMI Definitions for CMI Modules be included in the export.

useFieldSeparatorClause

Do not use this option. It is an obsolete option that was used to specify character to be used as the field separator in the old metadata file format.

UNQUOTED_STRING

Do not use this option. Obsolete metadata file field separator for old MDL file format. Use BAR or CARAT. The default is BAR.

controlFileClause

Specify a control file with export options not directly supported by OMBEXPORT command.

QUOTED_STRING

Enclose the control file name in single quotes.

includeUserDefsClause

Use to request that metadata definitions be included in the export.

supportedLangsClause

List supported languages to be exported.

outputLogClause

Export log file for export messages and statistics.

QUOTED_STRING

Enclose the log file name in single quotes.

componentsList

Comma separated list of components to be exported.

QUOTED_STRING

Enclose in single quotes the absolute or relative path name of an object (e.g. 'MODULE_X/TABLE_Y').

supportedLangsList

Comma separated list of supported languages to be exported.

QUOTED_STRING

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

objectTypeValue

Specify the first class object type to be exported (e.g. TABLE, VIEW, CUBE, DIMENSION, etc.).

See Also

OMBIMPORT MDL_FILE

OMBGRANT DEFAULT_OBJ_PRIV

Purpose

To change the default object privilege setting property of a user, basically it will grant a list of default object privileges to a list of users or roles. These object privileges will really be granted to the specified user or role on the new objects whenever the owner creates them.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseGrantDefObjPrivCommand =  OMBGRANT DEFAULT ( OBJ_PRIV |
          OBJECT_PRIVILEGE ) "objPrivNameList" TO ( USER "userOrRoleNameList" |
          ROLE "userOrRoleNameList" ) [ FOR USER "QUOTED_STRING" ]
     objPrivNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     userOrRoleNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }

Parameters

parseGrantDefObjPrivCommand

This clause change the default object privilege setting property of a user through granting a list of default object privileges to a list of users or roles.

objPrivNameList

Object privileges. Valid object privileges are: READ, COMPILE, EDIT, FULL_CONTROL.

userOrRoleNameList

List of valid OWB user names or OWB role names.

See Also

OMBGRANT J2EE_ROLE

Purpose

To grant a list of J2EE roles to a list of J2EE users. Note role can not be granted to another role.

Prerequisites

Must be have a valid J2EE runtime up and running.

Syntax

parseGrantJ2EERoleCommand =  OMBGRANT J2EE_ROLE "userOrRoleNameList" TO
          J2EE_USER "userOrRoleNameList" "J2eePropertiesClause"
     userOrRoleNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     J2eePropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")" VALUES
          "(" "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseGrantJ2EERoleCommand

This clause grants a list of J2EE roles to a list of J2EE users.

userOrRoleNameList

List of valid OWB user names or OWB role names.

J2eePropertiesClause

Properties for making J2EE connection.

propertyNameList

Connection property names : USER, PASSWORD, HOST, PORT, JSR88TYPE, ROOT, INSTANCE, PROTOCOL

propertyValueList

List of connection property value for the property name. See the example for detail.

propertyValue

The value for the connection property. See example for detail.

See Also

OMBREVOKE J2EE_ROLE

OMBGRANT OBJ_PRIV

Purpose

To grant a list of object privileges on the specified objects to a list of users or roles.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseGrantObjPrivCommand =  OMBGRANT ( OBJ_PRIV | OBJECT_PRIVILEGE )
          "objPrivNameList" ON "UNQUOTED_STRING" "QUOTED_STRING" [ CASCADE ] TO
          ( USER "userOrRoleNameList" | ROLE "userOrRoleNameList" )
     objPrivNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     userOrRoleNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }

Parameters

parseGrantObjPrivCommand

This clause grants a list of object privileges on the specified objects to a list of users or roles.

UNQUOTED_STRING

The type of the objects to be listed.Valid object types are: PROJECT, ORACLE_MODULE, FLAT_FILE_MODULE, PROCESS_FLOW_MODULE, SAP_MODULE, BUSINESS_DEFINITION_MODULE, OBIEE_BUSINESS_DEFINITION_MODULE, BUSINESS_PRESENTATION_MODULE, TRANSFORMATION_MODULE, PACKAGE, ADVANCED_QUEUE, BUSINESS_AREA, COLLECTION, CONNECTOR, CUBE, DIMENSION, EXTERNAL_TABLE, FLAT_FILE, FUNCTION, REGISTERED_FUNCTION, MAPPING, MATERIALIZED_VIEW, OBJECT_TYPE, PROCEDURE, ITEM_FOLDER, DRILL_PATH, DRILLS_TO_DETAIL, ALTERNATIVE_SORT_ORDER, LISTS_OF_VALUE, PRESENTATION_TEMPLATE, SEQUENCE, TABLE, PROCESS_FLOW, PROCESS_FLOW_PACKAGE, LOCATION, CONTROL_CENTER, CONFIGURATION, DEPLOYMENT, VIEW.

QUOTED_STRING

an object name or a regular expression refers to a list of objects whose name matches the regular expression.

CASCADE

grant the specified object privileges on a folder object and all its child objects cascade down. Note: if CASCADE is used, the string used to specify the object can only refer to one object and not be a regular experssion .

objPrivNameList

Object privileges. Valid object privileges are: READ, COMPILE, EDIT, FULL_CONTROL.

userOrRoleNameList

List of valid OWB user names or OWB role names.

See Also

OMBREVOKE OBJ_PRIV

OMBLIST OBJ_PRIVS

OMBGRANT ROLE

Purpose

To grant a list of Warehouse Builder roles to a list of Warehouse Builder users. Note role can not be granted to another role.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseGrantRoleCommand =  OMBGRANT ROLE "userOrRoleNameList" TO USER
          "userOrRoleNameList"
     userOrRoleNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }

Parameters

parseGrantRoleCommand

This clause grants a list of Warehouse Builder roles to a list of Warehouse Builder users.

userOrRoleNameList

List of valid OWB user names or OWB role names.

See Also

OMBREVOKE ROLE

OMBLIST ROLES

OMBGRANT SYS_PRIV

Purpose

To grant a list of system privileges to a list of users or roles.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseGrantSysPrivCommand =  OMBGRANT ( SYS_PRIV | SYSTEM_PRIVILEGE )
          "sysPrivNameList" TO ( USER "userOrRoleNameList" | ROLE
          "userOrRoleNameList" )
     sysPrivNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     userOrRoleNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }

Parameters

parseGrantSysPrivCommand

This clause grants a list of system privileges to a list of users or roles.

sysPrivNameList

List of system privileges. Valid system privileges are:ACCESS_PUBLICVIEW_BROWSER, CONTROL_CENTER_DEPLOYMENT, CONTROL_CENTER_EXECUTION,CONTROL_CENTER_VIEW,CREATE_EXTENSIONMODEL,CREATE_PROJECT, CREATE_SNAPSHOT

userOrRoleNameList

List of valid OWB user names or OWB role names.

See Also

OMBREVOKE SYS_PRIV

OMBLIST SYS_PRIVS

OMBHELP

Purpose

Displays the manual page for OMB commands.

Prerequisites

None.

Syntax

parseHelpCommand =  OMBHELP [ HELPID ] [ DETAIL ]

Parameters

parseHelpCommand

Specifies the command for which to invoke help.

HELPID

An unquoted string that represents either the command name and the optional additional parameter on the command.

DETAIL

Use this keyword to display the manual page in long format.

OMBIMPACT

Purpose

To fetch the impact of a change for an object.

Prerequisites

In the context of an object's parent module.

Syntax

parseImpactCommand =  OMBIMPACT DEPENDENCYTYPE "parseType" "parseFCO" [
          "parseSCO" ] [ "parseDetail" ]
     parseType =  "QUOTED_STRING"
     parseFCO =  ( ADVANCED_QUEUE | ALTERNATIVE_SORT_ORDER | CUBE | DATA_RULE |
          DIMENSION | DRILL_PATH | DRILL_TO_DETAIL | EXTERNAL_TABLE | FLAT_FILE
          | FUNCTION | WEB_SERVICE | ITEM_FOLDER | LOGICAL_TABLE |
          LIST_OF_VALUES | MATERIALIZED_VIEW | NESTED_TABLE | OBJECT_TYPE |
          PLUGGABLE_MAPPING | PROCEDURE | QUEUE_TABLE | REGISTERED_FUNCTION |
          SEQUENCE | TABLE | TIME_DIMENSION | VARYING_ARRAY | VIEW )
          "QUOTED_STRING"
     parseSCO =  "UNQUOTED_STRING" "QUOTED_STRING" { "UNQUOTED_STRING"
          "QUOTED_STRING" }
     parseDetail =  GET MAPPING CONTENTS

Parameters

parseImpactCommand

Specify OMBIMPACT command.

parseType

The type of impact. Allowable values are: DATAFLOW or DEPLOYMENT.

parseFCO

The object whose impact needs to be fetched.

parseSCO

The second class object whose impact needs to be fetched, specified in the form: SCO_type SCO_name. The second class object has to belong to the first class object specified by the previous clause. If the second class object is not direct child of the first class object, then the whole hierarchy path has to be listed (for example: parent_SCO_type parent_SCO_name child_SCO_type child_SCO_name).

parseDetail

Expands mappings and show operators involved in the impact.

OMBIMPORT

Purpose

Imports metadata from a Metadata Loader file, or from the default metadata location specified in the module.

Please refer to OMBHELP OMBIMPORT MDL_FILE or OMBHELP OMBIMPORT METADATA_LOCATION.

Prerequisites

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

Syntax

ImportCommand =  OMBIMPORT [ FROM ] ( "mdlImportCommand" |
          "oracleDBImportCommand" | "odiKMImportCommand" |
          "mdlRepositoryImportCommand" )
     mdlImportCommand =  ( MDL_FILE "QUOTED_STRING" [ "noUpgradeClause" ] [
          "includeUserDefsClause" ] [ "useModeClause" | "asSnapshotClause" ] [
          "matchByClause" ] [ "includeGrantsClause" ] [ "includeCMIDefsClause" ]
           [ "controlFileClause" ] [ "supportedLangsClause" ] [
          "allowDiffBaseLangClause" ] [ "outputLogClause" ] [
          "usingCredentialClause" ] [ "netServiceNameClause" ] )
     oracleDBImportCommand =  ( METADATA_LOCATION [ FOR ] IMPORT_ACTION_PLAN
          "QUOTED_STRING" [ "setImportOptions" ] )
     odiKMImportCommand =  ( CT_FILE "QUOTED_STRING" [ "kmNameClause" ] [
          "kmModuleClause" ] )
     mdlRepositoryImportCommand =  ( ENTIRE_REPOSITORY MDL_FILE "QUOTED_STRING"
          [ "controlFileClause" ] [ "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"
     setImportOptions =  SET OPTIONS "(" "optionNameList" ")" VALUES "("
          "optionValueList" ")"
     kmNameClause =  CT_NAME "QUOTED_STRING"
     kmModuleClause =  CT_FOLDER_NAME "QUOTED_STRING"
     modeValue =  ( CREATE_MODE | REPLACE_MODE | UPDATE_MODE | MERGE_MODE )
     matchByValue =  ( UNIVERSAL_IDENTIFIER | NAMES )
     supportedLangsList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     optionNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     optionValueList =  "optionValue" { "," "optionValue" }
     optionValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

ImportCommand

Import metadata from a Metadata Loader file, or from the default metadata location specified in the module.

mdlImportCommand

Import metadata from a file.

oracleDBImportCommand

To import from the default metadata location based on the import action plan.

QUOTED_STRING

The name of the transient action plan.

odiKMImportCommand

Import an ODI knowledge module from a file.

mdlRepositoryImportCommand

Import an entire repository from a metadata loader file.

QUOTED_STRING

Enclose the name of the imported repository file in single quotes.

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.

setImportOptions

Currently no import options are available to be set.

kmNameClause

Name assigned to imported code template. A generated name will be used if this is not set.

kmModuleClause

CT folder used to contain the code template. If the module name is prefaced by "PUBIC_PROJECT/" the importer will create/use the ct module in the public project. If the PUBLIC_PROJECT is not set, the ct module created/used will be in the current project. If CT_FOLDER_NAME is not set, then the importer will use ODI_KM in the current project.

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').

optionNameList

Comma separated list of option names for import.

UNQUOTED_STRING

An unquoted string representing the name of a option.

optionValueList

Comma separated list of option values for import.

optionValue

The value of an import option.

See Also

OMBIMPORT MDL_FILE

OMBIMPORT METADATA_LOCATION

OMBIMPORT CT_FILE

Purpose

Imports a code template from an ODI (Oracle Data Integrator) knowledge module file.

Prerequisites

Must be in a project context

Syntax

odiKMImportCommand =  ( CT_FILE "QUOTED_STRING" [ "kmNameClause" ] [
          "kmModuleClause" ] )
     kmNameClause =  CT_NAME "QUOTED_STRING"
     kmModuleClause =  CT_FOLDER_NAME "QUOTED_STRING"

Parameters

odiKMImportCommand

Import an ODI knowledge module from a file.

kmNameClause

Name assigned to imported code template. A generated name will be used if this is not set.

kmModuleClause

CT folder used to contain the code template. If the module name is prefaced by "PUBIC_PROJECT/" the importer will create/use the ct module in the public project. If the PUBLIC_PROJECT is not set, the ct module created/used will be in the current project. If CT_FOLDER_NAME is not set, then the importer will use ODI_KM in the current project.

16 OMBIMPORT ENTIRE_REPOSITORY MDL_FILE to OMBMENU REMOVE EXPERT

OMBIMPORT ENTIRE_REPOSITORY MDL_FILE

OMBIMPORT MDL_FILE

OMBIMPORT METADATA_LOCATION

OMBINSTALL OWB_RAC

OMBINSTALL OWB_REPOSITORY

OMBINSTALL WORKSPACE

OMBLINEAGE

OMBLIST

OMBLIST ALL OBJ_PRIVS

OMBLIST ALL SYS_PRIVS

OMBLIST DEFAULT_OBJ_PRIVS

OMBLIST ICONSETS

OMBLIST OBJ_PRIVS

OMBLIST ROLES

OMBLIST SNAPSHOT

OMBLIST SYS_PRIVS

OMBLIST USERS

OMBLOCK

OMBMENU ADD EXPERT

OMBMENU GET EXPERT

OMBMENU REMOVE EXPERT

OMBIMPORT ENTIRE_REPOSITORY MDL_FILE

Purpose

Imports an entire Oracle Warehouse Builder repository from a Metadata Loader File.

Prerequisites

You must not be connected to a design repository. If connected, then use OMBDISCONNECT to disconnect.

This command only supports an exported entire repository metadata loader file. Importing an entire repository requires the OWBSYS credentials.

Syntax

mdlRepositoryImportCommand =  ( ENTIRE_REPOSITORY MDL_FILE "QUOTED_STRING"
          [ "controlFileClause" ] [ "outputLogClause" ] [
          "usingCredentialClause" ] [ "netServiceNameClause" ] )
     controlFileClause =  CONTROL_FILE "QUOTED_STRING"
     outputLogClause =  OUTPUT LOG [ TO ] "QUOTED_STRING"
     usingCredentialClause =  USING CREDENTIAL "UNQUOTED_STRING"
     netServiceNameClause =  NET_SERVICE_NAME "QUOTED_STRING"

Parameters

mdlRepositoryImportCommand

Import an entire repository from a metadata loader file.

QUOTED_STRING

Enclose the name of the imported repository file in single quotes.

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.

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.

See Also

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').

See Also

OMBEXPORT MDL_FILE

OMBIMPORT METADATA_LOCATION

Purpose

Import metadata from the default metadata location specified in the module. Currently we only support tables/views/sequences for Oracle/Gateway/SAP/MIV modules.

Prerequisites

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

Syntax

oracleDBImportCommand =  ( METADATA_LOCATION [ FOR ] IMPORT_ACTION_PLAN
          "QUOTED_STRING" [ "setImportOptions" ] )
     setImportOptions =  SET OPTIONS "(" "optionNameList" ")" VALUES "("
          "optionValueList" ")"
     optionNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     optionValueList =  "optionValue" { "," "optionValue" }
     optionValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

oracleDBImportCommand

To import from the default metadata location based on the import action plan.

QUOTED_STRING

The name of the transient action plan.

setImportOptions

Currently no import options are available to be set.

optionNameList

Comma separated list of option names for import.

UNQUOTED_STRING

An unquoted string representing the name of a option.

optionValueList

Comma separated list of option values for import.

optionValue

The value of an import option.

See Also

OMBINSTALL OWB_RAC

Purpose

Register RAC instance (only for RAC 's second instance onwards).

Prerequisites

This command should be run locally on the database server. The value of USING CREDENTIAL must be OWBSYS' database user credential.

Syntax

parseRegisterRACCommand =  OMBINSTALL OWB_RAC USING CREDENTIAL
          "UNQUOTED_STRING" [ NET_SERVICE_NAME "QUOTED_STRING" ]

Parameters

parseRegisterRACCommand

Specify OMBINSTALL OWB_RAC command.

UNQUOTED_STRING

Specify the connection string to the database using this format: owbsys/owbsys_password@host:port:service name OR specify the user name and password using this format username/password.

OMBINSTALL OWB_REPOSITORY

Purpose

Create a workspace in the OWB repository schema OWBSYS.

Prerequisites

To create a workspace, within the same OMBPlus session, no other OMB commands should be issued before or after the OMBINSTALL WORKSPACE command. Each workspace name must be unique for a specified owning db user.

Syntax

parseInstallOWBRepositoryCommand =  OMBINSTALL ( OWB_REPOSITORY | WORKSPACE
           ) "QUOTED_STRING" USING CREDENTIAL "UNQUOTED_STRING"

Parameters

parseInstallOWBRepositoryCommand

Specify an OMBINSTALL 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.

OMBINSTALL WORKSPACE

Purpose

Create a workspace in the OWB repository schema OWBSYS.

Prerequisites

To create a workspace, within the same OMBPlus session, no other OMB commands should be issued before or after the OMBINSTALL WORKSPACE command. Each workspace name must be unique for a specified owning db user.

Syntax

parseInstallOWBRepositoryCommand =  OMBINSTALL ( OWB_REPOSITORY | WORKSPACE
           ) "QUOTED_STRING" USING CREDENTIAL "UNQUOTED_STRING"

Parameters

parseInstallOWBRepositoryCommand

Specify an OMBINSTALL 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.

OMBLINEAGE

Purpose

To fetch the data lineage.

Prerequisites

In the context of an object's parent module.

Syntax

parseLineageCommand =  OMBLINEAGE DEPENDENCYTYPE "parseType" "parseFCO" [
          "parseSCO" ] [ "parseDetail" ]
     parseType =  "QUOTED_STRING"
     parseFCO =  ( ADVANCED_QUEUE | ALTERNATIVE_SORT_ORDER | CUBE | DATA_RULE |
          DIMENSION | DRILL_PATH | DRILL_TO_DETAIL | EXTERNAL_TABLE | FLAT_FILE
          | FUNCTION | WEB_SERVICE | ITEM_FOLDER | LOGICAL_TABLE |
          LIST_OF_VALUES | MATERIALIZED_VIEW | NESTED_TABLE | OBJECT_TYPE |
          PLUGGABLE_MAPPING | PROCEDURE | QUEUE_TABLE | REGISTERED_FUNCTION |
          SEQUENCE | TABLE | TIME_DIMENSION | VARYING_ARRAY | VIEW )
          "QUOTED_STRING"
     parseSCO =  "UNQUOTED_STRING" "QUOTED_STRING" { "UNQUOTED_STRING"
          "QUOTED_STRING" }
     parseDetail =  GET MAPPING CONTENTS

Parameters

parseLineageCommand

Specify OMBLINEAGE command.

parseType

The type of lineage. Allowable values are: DATAFLOW or DEPLOYMENT.

parseFCO

The object whose lineage needs to be fetched.

parseSCO

The second class object whose lineage needs to be fetched, specified in the form: SCO_type SCO_name. The second class object has to belong to the first class object specified by the previous clause. If the second class object is not direct child of the first class object, then the whole hierarchy path has to be listed (for example: parent_SCO_type parent_SCO_name child_SCO_type child_SCO_name).

parseDetail

Expands mappings and show operators involved in the lineage.

OMBLIST

Purpose

This command lists the specified Warehouse Builder objects under the current folder. You can also provide a regular expression to list objects in a different folder and/or to list objects with names matching a pattern. Some global objects (e.g. LOCATIONS, CONTROL_CENTERS, USERS, ROLES, CONFIGURATION_TEMPLATES, ICONSETS) can be listed from any context. Before displaying the objects, this command first refreshes the object list from the repository. This means that the list of objects returned also reflects any additions or deletions by other users.

Prerequisites

Must be connected to a OWB workspace of the repository.

Syntax

parseListCommand =  "listActionPlans" | "listGeneral"
     listActionPlans =  OMBLIST DEPLOYMENT_ACTION_PLANS [ "QUOTED_STRING" ]
     listGeneral =  OMBLIST "UNQUOTED_STRING" [ "QUOTED_STRING" ]

Parameters

parseListCommand

Specify the list command.

listActionPlans

Deployment action plans are listed.

listGeneral

OWB objects of the specified type are listed.

UNQUOTED_STRING

The type (plural) of the objects to be listed. Valid object types are: ACTIVITY_TEMPLATES, ACTIVITY_TEMPLATE_FOLDERS, ADVANCED_QUEUES, ALTERNATIVE_SORT_ORDERS, BUSINESS_AREAS, BUSINESS_DEFINITION_MODULES, OBIEE_BUSINESS_DEFINITION_MODULES, BUSINESS_PRESENTATION_MODULES, CALENDARS, CALENDAR_MODULES, CMI_DEFINITIONS, CMI_MODULES, COLLECTIONS, CONFIGURATIONS, CONNECTORS, CONTROL_CENTERS, CUBES, DATA_AUDITORS, DATA_PROFILES, DATA_RULES, DATA_RULE_MODULES, DEPLOYMENTS, DEPLOYMENT_ACTION_PLANS, DIMENSIONS, DRILL_PATHS, DRILLS_TO_DETAIL, EXPERTS, EXPERT_MODULES, EXTERNAL_TABLES, FLAT_FILES, FLAT_FILE_MODULES, FOLDERS, FUNCTIONS, GATEWAY_MODULES, ICONSETS, ITEM_FOLDERS, CTS, CT_FOLDERS, LISTS_OF_VALUES, LOCATIONS, MAPPINGS, MATERIALIZED_VIEWS, NESTED_TABLES, OBJECT_TYPES, ORACLE_MODULES, PACKAGES, PLSQL_RECORD_TYPES, PLSQL_REF_CURSOR_TYPES, PLSQL_TABLE_TYPES, PLUGGABLE_MAPPINGS, PLUGGABLE_MAPPING_LIBRARIES, PRESENTATION_TEMPLATES, PROCEDURES, PROCESS_FLOWS, PROCESS_FLOW_MODULES, PROCESS_FLOW_PACKAGES, PROJECTS, QUEUE_PROPAGATIONS, QUEUE_TABLES, REAL_TIME_MAPPINGS, REGISTERED_FUNCTIONS, ROLES, SAP_MODULES, SEQUENCES, SNAPSHOTS, STREAMS_CAPTURE_PROCESSES, STREAMS_QUEUES, TABLES, TABLE_FUNCTIONS, TIME_DIMENSIONS, TRANSFORMATION_MODULES, TRANSPORTABLE_MODULES, USERS, VARYING_ARRAYS, VIEWS.

QUOTED_STRING

Mandatory for CONNECTORS, specify a location name; optionally for all other objects, specify a regular expression, which is used to filter the results.

The syntax of the regular expressions follow the syntax from TCL.

Here are some of the quantifiers:

* -- represents a sequence of 0 or more matches of the atom.

+ -- represents a sequence of 1 or more matches of the atom.

? -- represents a sequence of 0 or 1 matches of the atom.

Here are some of the atoms:

. -- matches any single character

k -- (where k is a non-alphanumeric character) matches that character taken as an ordinary character,

e.g. \\ matches a backslash character.

c -- where c is alphanumeric(possibly followed by other characters), an escape.

(re) -- (where re is any regular expression) matches a match for re, with the match noted for possible reporting.

[char] -- a bracket expression, matching any one of the chars.

Further documentation on the syntax can be found at the TCL manual page under the command 'regexp'.

OMBLIST ALL OBJ_PRIVS

Purpose

To list all the object privileges granted to a specified user on a specified object, some of which my be inherited from granted roles. Note: A role will not be granted to another role, so OMBLIST OBJ_PRIVS and OMBLIST ALL OBJ_PRIVS actually will list the same result for roles.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseListAllObjPrivs =  OMBLIST ALL ( OBJ_PRIVS | OBJECT_PRIVILEGES ) ON
          "UNQUOTED_STRING" "QUOTED_STRING" ( OF ( USER | ROLE ) "QUOTED_STRING"
           )

Parameters

parseListAllObjPrivs

This clause lists all the object privileges granted to a specified user on a specified object, some of which my be inherited from granted roles. Note: A role will not be granted to another role, so OMBLIST OBJ_PRIVS and OMBLIST ALL OBJ_PRIVS actually will list the same result for roles.

OMBLIST ALL SYS_PRIVS

Purpose

To list all the system privileges granted to a user or a role, some of the privileges may be inherited from the granted roles. Note: A role will not be granted to another role, so OMBLIST SYS_PRIVS and OMBLIST ALL SYS_PRIVS actually will list the same result for roles.

Prerequisites

All System privileges granted to a user or a role can be listed from any context.

Syntax

parseListAllSysPrivs =  OMBLIST ALL ( SYS_PRIVS | SYSTEM_PRIVILEGES ) ( OF
          USER "QUOTED_STRING" )

Parameters

parseListAllSysPrivs

This clause lists the overall system privileges granted to a user or a role. Some of the privileges may inherited from granted roles. Note: A role will not be granted to another role, so OMBLIST SYS_PRIVS and OMBLIST ALL SYS_PRIVS actually will list the same result for roles.

OMBLIST DEFAULT_OBJ_PRIVS

Purpose

To list all the default object privileges granted to a specified role or user from the owner, some of which may be inherited from the granted roles. These object privileges will really be granted to the specified user or role on the new object whenever the owner creates it.

Prerequisites

The default object privileges can be listed from any context.

Syntax

parseListAllDefObjPrivs =  OMBLIST ALL DEFAULT ( OBJ_PRIVS |
          OBJECT_PRIVILEGES ) ( OF ( USER | ROLE ) "QUOTED_STRING" ) [ FOR USER
          "QUOTED_STRING" ]

Parameters

parseListAllDefObjPrivs

This clause will show the default object privilege setting property of a user, basically will list all the default object privileges granted to a specified role or user from the owner. The list result includes the default object privileges granted directly to a user and the default object privileges inherited by the user. Note: A role will not be granted to another role, so OMBLIST DEFAULT OBJ_PRIVS and OMBLIST ALL DEFAULT OBJ_PRIVS actually will list the same result for roles. The default object privileges will be really ganted to the specified user or role on the newly created object by the owner.

OMBLIST ICONSETS

Purpose

To list the icon sets in the current workspace.

Prerequisites

Must be connected to a workspace, in any context.

Syntax

listIconSetCommand =  OMBLIST ICONSETS [ "QUOTED_STRING" ] [ OF
          "QUOTED_STRING" ]

Parameters

listIconSetCommand

This command lists the iconsets in a workspace.

QUOTED_STRING

A regular expression that describes the name of the icon set. Or the name of the group to which iconsets belong.

See Also

OMBCREATE ICONSET

OMBLIST OBJ_PRIVS

Purpose

To list the object privileges granted to a specified user on a specified object.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseListObjPrivs =  OMBLIST ( OBJ_PRIVS | OBJECT_PRIVILEGES ) ON
          "UNQUOTED_STRING" "QUOTED_STRING" ( OF ( USER | ROLE ) "QUOTED_STRING"
           )

Parameters

parseListObjPrivs

This clause lists the object privileges granted to a specified user on a specified object.

UNQUOTED_STRING

The type of the objects to be listed.Valid object types are: PROJECT, ORACLE_MODULE, FLAT_FILE_MODULE, PROCESS_FLOW_MODULE, SAP_MODULE, BUSINESS_DEFINITION_MODULE, OBIEE_BUSINESS_DEFINITION_MODULE, BUSINESS_PRESENTATION_MODULE, TRANSFORMATION_MODULE, PACKAGE, ADVANCED_QUEUE, BUSINESS_AREA, COLLECTION, CONNECTOR, CUBE, DIMENSION, EXTERNAL_TABLE, FLAT_FILE, FUNCTION, REGISTERED_FUNCTION, MAPPING, MATERIALIZED_VIEW, OBJECT_TYPE, PROCEDURE, ITEM_FOLDER, DRILL_PATH, DRILLS_TO_DETAIL, ALTERNATIVE_SORT_ORDER, LISTS_OF_VALUE, PRESENTATION_TEMPLATE, SEQUENCE, TABLE, PROCESS_FLOW, PROCESS_FLOW_PACKAGE, LOCATION, CONTROL_CENTER, CONFIGURATION, DEPLOYMENT, VIEW.

OMBLIST ROLES

Purpose

To list existing roles or list existing roles whose names match the given regular expression or list the granted roles of a given user.

Prerequisites

Warehouse Builder users can be list from any context.

Syntax

parseListRole =  OMBLIST ROLES ( [ "QUOTED_STRING" | ( OF USER
          "QUOTED_STRING" ) ] )

Parameters

parseListRole

This clause lists existing roles or lists existing roles whose names match the given regular expression or lists the granted roles of a given user.

OMBLIST SNAPSHOT

Purpose

This command lists all the snapshots existing or all snapshots for a specific component.

Prerequisites

Snapshots can be listed from any context.

Syntax

parseListCommand =  OMBLIST "listSnapshotCommand"
     listSnapshotCommand =  SNAPSHOTS [ "QUOTED_STRING" ] [ FOR (
          "UNQUOTED_STRING" "QUOTED_STRING" ) ]

Parameters

parseListCommand

Root production of OMBLIST SNAPSHOT.

listSnapshotCommand

To list existing snapshots.

SNAPSHOTS

Lists all the snapshots existing in the workspace. You can also provide a regular expression to restrict the list of snapshots to those with names matching a pattern.

QUOTED_STRING

When optionally used in the SNAPSHOTS clause, a regular expression to restrict the list of snapshots. When used in the FOR clause, the specific component whose snapshots will be listed. Any regular expression filtering is also applied to the list of snapshots for a specific component. See OMBLIST basic syntax for a description of regular expression syntax.

FOR

Lists all the snapshots existing for a specific component or folder. You can also provide a regular expression to restrict the list of snapshots to those with names matching a pattern.

UNQUOTED_STRING

The type (singular) of the objects to be listed. See OMBLIST basic syntax for the list of valid object types.

See Also

OMBCREATE SNAPSHOT

OMBALTER SNAPSHOT

OMBDROP SNAPSHOT

OMBRESTORE SNAPSHOT

OMBCOMPARE SNAPSHOT

OMBRETRIEVE SNAPSHOT

OMBLIST SYS_PRIVS

Purpose

To list the system privileges granted to a user or a role.

Prerequisites

System privileges granted to a user or a role can be listed from any context.

Syntax

parseListSysPrivs =  OMBLIST ( SYS_PRIVS | SYSTEM_PRIVILEGES ) ( OF ( USER
          | ROLE ) "QUOTED_STRING" )

Parameters

parseListSysPrivs

This clause lists the system privileges granted to a user or a role.

OMBLIST USERS

Purpose

To list existing Warehouse Builder users.

Prerequisites

Warehouse Builder users can be list from any context.

Syntax

parseListUser =  OMBLIST USERS ( [ "QUOTED_STRING" | ( OF ROLE
          "QUOTED_STRING" ) ] )

Parameters

parseListUser

This clause lists existing Warehouse Builder users or list existing users matches the given regular expression or list granted users of a given role.

OMBLOCK

Purpose

Lock one or more objects. If a list of objects is specified, the objects will be locked one by one in the given order. The command will behave atomically, i.e. if it fails to lock any of the objects in the list, then it will lock none of them.

Prerequisites

No other user should have a lock on any of the objects.

Syntax

parseLockCommand =  OMBLOCK "parseTypeNameList"
     parseTypeNameList =  "objectType" "QUOTED_STRING" { "," "objectType"
          "QUOTED_STRING" }
     objectType =  ( ADVANCED_QUEUE | BUSINESS_AREA | CATALOG_FOLDER |
          COLLECTION | CONNECTOR | CONFIGURATION | DEPLOYMENT | CUBE | DIMENSION
           | EXPERT | EXPERT_MODULE | CT | CT_FOLDER | EXTERNAL_TABLE |
          FLAT_FILE_MODULE | FLAT_FILE | FUNCTION | TABLE_FUNCTION |
          GATEWAY_MODULE | BUSINESS_DEFINITION_MODULE |
          OBIEE_BUSINESS_DEFINITION_MODULE | REGISTERED_FUNCTION | LOCATION |
          LOGICAL_TABLE | MAPPING | MATERIALIZED_VIEW | OBJECT_TYPE |
          VARYING_ARRAY | NESTED_TABLE | ORACLE_MODULE | PACKAGE | PROCEDURE |
          PROCESS_FLOW | PROCESS_FLOW_MODULE | PROCESS_FLOW_PACKAGE |
          WEB_SERVICE | WEB_SERVICE_PACKAGE | APPLICATION_SERVER_MODULE |
          PROJECT | ITEM_FOLDER | DRILL_PATH | LIST_OF_VALUES | DRILL_TO_DETAIL
          | ALTERNATIVE_SORT_ORDER | CONTROL_CENTER | MODULE | SAP_MODULE |
          CMI_MODULE | SEQUENCE | TABLE | VIEW | CMI_DEFINITION |
          PLSQL_RECORD_TYPE | "UNQUOTED_STRING" )

Parameters

parseLockCommand

Specify lock command.

parseTypeNameList

Specify the object or the list of objects to be locked.

QUOTED_STRING

Name of the object to be locked. Can be specified as an absolute path or as a path relative to the current context. However, there is the restriction that all objects to be locked must be in the current project.

objectType

Type of the object to be locked.

See Also

OMBUNLOCK

OMBMENU ADD EXPERT

Purpose

Add an expert to the context menu of the specified object type, or to the Tools menu.

Prerequisites

To maintain context menu experts, must have a project set first. For the context menu, only experts from the current project or the public project can be used. For the Tools menu, only experts from the public project can be used. Valid actions are 'NEW' and 'OPEN'.

Syntax

addMenuCommand =  OMBMENU ADD EXPERT "QUOTED_STRING" TO ( ( CONTEXT_MENU
          FOR "getType" WITH "QUOTED_STRING" ) | CONSOLE_MENU )
     getType =  "UNQUOTED_STRING"

Parameters

addMenuCommand

Add an expert to the context menu or the Tools menu.

getType

Unquoated string specifying the object type whose context menu experts will be changed.

See Also

OMBMENU REMOVE EXPERT

OMBMENU GET EXPERT

OMBMENU GET EXPERT

Purpose

List the experts on the context menu of the specified object type, or the experts on the Tools menu. Note that if one or more experts have been added to the context menu of the same object type and the same action in the public project, those experts are also listed.

Prerequisites

To list context menu experts, must have a project set first. Valid actions are 'NEW' and 'OPEN'.

Syntax

getMenuCommand =  OMBMENU GET EXPERT ON ( ( CONTEXT_MENU FOR "getType" WITH
           "QUOTED_STRING" ) | CONSOLE_MENU )
     getType =  "UNQUOTED_STRING"

Parameters

getMenuCommand

List the experts on the context menu of an object type or the Tools menu.

getType

Unquoated string specifying the object type whose context menu experts will be listed.

See Also

OMBMENU ADD EXPERT

OMBMENU REMOVE EXPERT

OMBMENU REMOVE EXPERT

Purpose

Remove an expert from a context menu of the specified object type, or from the Tools menu.

Prerequisites

To maintain context menu experts, must have a project set first. For the context menu, only experts from the current project or the public project can be used. For the Tools menu, only experts from the public project can be used. Valid actions are 'NEW' and 'OPEN'.

Syntax

removeMenuCommand =  OMBMENU REMOVE EXPERT "QUOTED_STRING" FROM ( (
          CONTEXT_MENU FOR "getType" WITH "QUOTED_STRING" ) | CONSOLE_MENU )
     getType =  "UNQUOTED_STRING"

Parameters

removeMenuCommand

Remove an expert from the context menu or the Tools menu.

getType

Unquoated string specifying the object type whose context menu experts will be changed.

See Also

OMBMENU REMOVE EXPERT

OMBMENU GET EXPERT

17 OMBMLSUPDATE to OMBRETRIEVE CATALOG_FOLDER

OMBMLSUPDATE

OMBMOVE

OMBOPTIMIZE

OMBPROFILE

OMBREDEFINE ASSOCIATION_DEFINITION

OMBREDEFINE CLASS_DEFINITION

OMBREGISTER LOCATION

OMBREGISTER USER

OMBRESTORE SNAPSHOT

OMBRETRIEVE

OMBRETRIEVE ACTIVITY_TEMPLATE

OMBRETRIEVE ACTIVITY_TEMPLATE_FOLDER

OMBRETRIEVE ADVANCED_QUEUE

OMBRETRIEVE ALTERNATIVE_SORT_ORDER

OMBRETRIEVE ANALYZE_ACTION_PLAN

OMBRETRIEVE APPLICATION_SERVER_MODULE

OMBRETRIEVE BUSINESS_AREA

OMBRETRIEVE BUSINESS_DEFINITION_MODULE

OMBRETRIEVE CALENDAR

OMBRETRIEVE CALENDAR_MODULE

OMBRETRIEVE CATALOG_FOLDER

OMBMLSUPDATE

Purpose

Add more languages into an existing OWB repository to support the object translation.

Prerequisites

OWB repository schema OWBSYS should already exists in the database. The value of USING CREDENTIAL must be OWBSYS' database user credential.

Syntax

parseUpdateMlsOWBRepositoryCommand =  OMBMLSUPDATE [ SUPPORTED_LANGUAGES
          "(" "QUOTED_STRING" { "," "QUOTED_STRING" } ")" ] USING CREDENTIAL
          "UNQUOTED_STRING" [ NET_SERVICE_NAME "QUOTED_STRING" ]

Parameters

parseUpdateMlsOWBRepositoryCommand

Specify an OMBMLSUPDATE command.

QUOTED_STRING

Specify the language name.

UNQUOTED_STRING

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

OMBMOVE

Purpose

Move one or more objects of the same object type. The replace option allows you to overwrite.

Prerequisites

Use of relative path specifications requires awareness of the current context.

Syntax

parseMoveCommand =  OMBMOVE "moveObjectType" "QUOTED_STRING" { ( OPERATOR |
           GROUP | ATTRIBUTE ) "QUOTED_STRING" } TO "QUOTED_STRING" { ( OPERATOR
           | GROUP | ATTRIBUTE ) "QUOTED_STRING" } [ USE REPLACE_MODE ]
     moveObjectType =  ( "UNQUOTED_STRING" )

Parameters

parseMoveCommand

Specifies the source object type, source path, and target path for the object to move. Moving objects is subject to the following restrictions: 1. You can only move objects within the current project; you cannot move objects between projects. 2. You cannot move an object within the same parent folder; if your purpose is to rename the object, use the 'OMBALTER...RENAME TO...' command.

QUOTED_STRING

Source and target path specifications can be absolute or relative. To move multiple objects, include a regular expression as the final step of the source path. If you are moving multiple objects, the final step of the target path must be the folder to which the objects are being copied. If you are only moving one object, you can specify the object's original name or a new name as the final step of the target path.

REPLACE_MODE

Use this option to overwrite existing target objects.

moveObjectType

The type of the object(s) to be copied. Valid types are: PROJECT, ORACLE_MODULE, FLAT_FILE_MODULE, BUSINESS_DEFINITION_MODULE, OBIEE_BUSINESS_DEFINITION_MODULE, BUSINESS_PRESENTATION_MODULE, SAP_MODULE, CMI_MODULE, PROCESS_FLOW_MODULE, PROCESS_FLOW_PACKAGE, PROCESS_FLOW, EXPERT_MODULE, EXPERT, CT, CT_FOLDER, FLAT_FILE, ADVANCED_QUEUE, STREAMS_QUEUE, QUEUE_TABLE, QUEUE_PROPAGATION, STREAMS_CAPTURE_PROCESS, OBJECT_TYPE, VARYING_ARRAY, NESTED_TABLE, TABLE, VIEW, MATERIALIZED_VIEW, SEQUENCE, DIMENSION, CUBE, DATA_AUDITOR, DATA_PROFILE, DATA_RULE, DATA_RULE_MODULE, MAPPING, REAL_TIME_MAPPING, PACKAGE, FUNCTION, TABLE_FUNCTION, PROCEDURE, BUSINESS_AREA, COLLECTION, EXTERNAL_TABLE, REGISTERED_FUNCTION, ITEM_FOLDER, DRILL_PATH, LIST_OF_VALUES, DRILL_TO_DETAIL, ALTERNATIVE_SORT_ORDER, PRESENTATION_TEMPLATE and any user defined object types.

See Also

OMBCOPY

OMBOPTIMIZE

Purpose

Perform optimize action on the repository (statistics will be gathered on all schema objects).

Prerequisites

Must be connected to a OWB workspace of the repository.

Syntax

parseOptimizeCommand =  OMBOPTIMIZE

Parameters

parseOptimizeCommand

Specify optimize command.

OMBPROFILE

Purpose

To execute the action plans associated with profiling. You can do profiling, correction schema generation and correction map generation with this command.

Prerequisites

This command must be done in the context of a Data Profile. Furthermore, the corresponding transient action plans need to have been created before invoking this command.

Syntax

parseProfileCommand =  OMBPROFILE ( ( ANALYZE_ACTION_PLAN "QUOTED_STRING" )
           | ( ( CORRECTION_SCHEMA_ACTION_PLAN "QUOTED_STRING" IN ORACLE_MODULE
          "QUOTED_STRING" ) [ ( DROP PREVIOUS CORRECTIONS ) ] ) | ( (
          CORRECTION_MAPS_ACTION_PLAN "QUOTED_STRING" IN ORACLE_MODULE
          "QUOTED_STRING" ) [ ( DROP PREVIOUS CORRECTIONS ) ] ) )

Parameters

parseProfileCommand

Executes the analyze action plan.

OMBREDEFINE ASSOCIATION_DEFINITION

Purpose

To redefine an association between two classes (types).

Prerequisites

Association definition to be redefined should already exist. This command can be executed for any association definition regardless of current context. User must have CREATE_EXTENSIONMODEL system privilege and has to be connected in single user mode to run this command.

Syntax

parseRedefineAssociationCommand =  OMBREDEFINE ASSOCIATION_DEFINITION
          "QUOTED_STRING" [ ( ON | OF ) "modelClause" ] ( RENAME TO
          "QUOTED_STRING" | "setAssociationDefinitionPropertiesClause" | (
          "modifyDependencyDefinitionClause" |
          "deleteDependencyDefinitionClause" | "addDependencyDefinitionClause"
          )+ )
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" |
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM
          "QUOTED_STRING" )
     setAssociationDefinitionPropertiesClause =  SET PROPERTIES "("
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")"
     modifyDependencyDefinitionClause =  MODIFY DEPENDENCY_DEFINITION
          "QUOTED_STRING" "setDependencyDefinitionPropertiesClause"
     deleteDependencyDefinitionClause =  DELETE DEPENDENCY_DEFINITION
          "QUOTED_STRING"
     addDependencyDefinitionClause =  ADD DEPENDENCY_DEFINITION "QUOTED_STRING"
          [ "setDependencyDefinitionPropertiesClause" ]
     propertyNameList =  "propertyNameClause" { "," "propertyNameClause" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setDependencyDefinitionPropertiesClause =  SET PROPERTIES "("
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")"
     propertyNameClause =  ( "UNQUOTED_STRING" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseRedefineAssociationCommand

Redefine an association between two classes..

setAssociationDefinitionPropertiesClause

Basic properties for re-defining ASSOCIATION_DEFINITION:

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: N/A
A descriptive text for this association.

Name: ROLE_1_MIN_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Minimum cardinality of role 1. Value can be positive integer.

Name: ROLE_1_MAX_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Maximum cardinality of role 1. Value can be positive integer or 'INFINITE'.

Name: ROLE_1_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side default is false.
Navigability of role 1.

Name: ROLE_2_MIN_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Minimum cardinality of role 2. Value can be positive integer.

Name: ROLE_2_MAX_CARDINALITY
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: N/A
Maximum cardinality of role 2. Value can be positive integer or 'INFINITE'.

Name: ROLE_2_NAVIGABLE
Type: BOOLEAN
Valid Values: true, false
Default: From user defined class side default is true. From OWB class side default is false.
Navigability of role 2.

modifyDependencyDefinitionClause

Modifies the properties of the specified dependency for this association.

deleteDependencyDefinitionClause

Un-mark this association so that the dependency engine will ignore it when computing the lineage and impact dependencies of that type.

addDependencyDefinitionClause

Mark this association so that the dependency engine will consider it when computing the lineage and impact dependencies of the specified type. The only dependency type allowed here for now is 'DATAFLOW'.

propertyNameList

The list of property names.

propertyValueList

The list of property values being set.

setDependencyDefinitionPropertiesClause

Basic dependency-related properties for this association:

Name: SOURCE_ROLE_ID

Type: STRING(200)

Valid Values: ROLE_1, ROLE_2

Default: If one of the ends is a OWB class, then that is the default source. If both ends are user defined classes, then the association is default bidirectional.

Identifies the role (end) of the association which serves as the source for the dependency flow.

Name: BIDIRECTIONAL

Type: BOOLEAN

Valid Values: true, false

Default: If one of the ends is a OWB class, then default is false. If both ends are user defined classes, then default is true.

Specifies whether the association is bi-directional for the dependency flow.

propertyNameClause

Name of a property.

propertyValue

Value of a property.

See Also

OMBDEFINE ASSOCIATION_DEFINITION

OMBDESCRIBE ASSOCIATION_DEFINITION

OMBREDEFINE CLASS_DEFINITION

Purpose

To redefine a class.

Prerequisites

Class definition to be redefined should already exist. This command can be executed for any class definition regardless of current context. User must have CREATE_EXTENSIONMODEL system privilege, and user has to connect in single user mode.

The valid types to define user defined properties are: INTEGER, STRING, FLOAT, DOUBLE, DATE, TIMESTAMP, BOOLEAN, LONG, FILE, URL

Syntax

parseRedefineClassCommand =  OMBREDEFINE CLASS_DEFINITION "QUOTED_STRING" [
           ( ON | OF ) "modelClause" ] ( ( "setClassDefinitionPropertiesClause"
          | "setClassDefinitionIconSetClause" |
          "unsetClassDefinitionIconSetClause" ) [ "modifySubDefinitionsClause" ]
           | "modifySubDefinitionsClause" )
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" |
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM
          "QUOTED_STRING" )
     setClassDefinitionPropertiesClause =  SET PROPERTIES "(" "propertyNameList"
           ")" VALUES "(" "propertyValueList" ")"
     setClassDefinitionIconSetClause =  SET REF ICONSET "QUOTED_STRING"
     unsetClassDefinitionIconSetClause =  UNSET REF ICONSET
     modifySubDefinitionsClause =  ( "addPropertyDefinitionClause" |
          "modifyPropertyDefinitionClause" | "deletePropertyDefinitionClause" |
          "addPropertyGroupDefinitionClause" |
          "modifyPropertyGroupDefinitionClause" |
          "deletePropertyGroupDefinitionClause" | "addChildTypeClause" |
          "deleteChildTypeClause" )+
     propertyNameList =  "propertyNameClause" { "," "propertyNameClause" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     addPropertyDefinitionClause =  ( ADD [ ( ( CONFIGURATION |
          PHYSICAL_CONFIGURATION ) | LOGICAL | USER_DEFINED ) ]
          PROPERTY_DEFINITION "QUOTED_STRING"
          "setPropertyDefinitionPropertiesClause" )
     modifyPropertyDefinitionClause =  ( MODIFY PROPERTY_DEFINITION
          "QUOTED_STRING" ( RENAME TO "QUOTED_STRING" |
          "setPropertyDefinitionPropertiesClause" ) )
     deletePropertyDefinitionClause =  ( DELETE PROPERTY_DEFINITION
          "QUOTED_STRING" )
     addPropertyGroupDefinitionClause =  ADD PROPERTY_GROUP_DEFINITION
          "QUOTED_STRING" "setPropertyGroupDefinitionPropertiesClause"
     modifyPropertyGroupDefinitionClause =  ( MODIFY PROPERTY_GROUP_DEFINITION
          "QUOTED_STRING" ( RENAME TO "QUOTED_STRING" |
          "setPropertyGroupDefinitionPropertiesClause" ) )
     deletePropertyGroupDefinitionClause =  ( DELETE PROPERTY_GROUP_DEFINITION
          "QUOTED_STRING" )
     addChildTypeClause =  ( ADD CHILD_TYPE "QUOTED_STRING" )
     deleteChildTypeClause =  ( DELETE CHILD_TYPE "QUOTED_STRING" )
     propertyNameClause =  ( "UNQUOTED_STRING" )
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     setPropertyDefinitionPropertiesClause =  SET PROPERTIES "("
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")"
     setPropertyGroupDefinitionPropertiesClause =  SET PROPERTIES "("
          "propertyNameList" ")" VALUES "(" "propertyValueList" ")"

Parameters

parseRedefineClassCommand

Redefine a class definition.

CLASS_DEFINITION

Redefine a class definition.

QUOTED_STRING

Name of the class definition.

propertyNameList

The list of properties for the class definition.

propertyValueList

The list of values provided for the class definition.

propertyNameClause

The name of the property.

UNQUOTED_STRING

The name of the property for the class definition.

propertyValue

The value of the property.

QUOTED_STRING

The value in string format of the property for the class definition.

INTEGER_LITERAL

The integer value of the property for the class definition.

FLOATING_POINT_LITERAL

The float value of the property for the class definition.

See Also

OMBDESCRIBE CLASS_DEFINITION

OMBREGISTER LOCATION

Purpose

Register a location with a Control Center.

Prerequisites

Must be in the context of a project and connected to a Control Center.

Syntax

registerLocationCommand =  OMBREGISTER LOCATION "QUOTED_STRING" [ REUSE ] [
           UPDATE_DESIGN ]

Parameters

registerLocationCommand

Register a location.

QUOTED_STRING

The name of the location to register.

OMBREGISTER USER

Purpose

To register a database user as a Warehouse Builder user.When you issue this command, the operation is implicitly committed.

Prerequisites

Commit or Rollback is needed if there is any change.

Syntax

parseRegisterUserCommand =  ( OMBREGISTER USER "QUOTED_STRING" [ SET
          PROPERTIES "(" "propertyNameList" ")" VALUES "(" "propertyValueList"
          ")" ] [ WITH CREATE DBUSER OPTION IDENTIFIED BY "QUOTED_STRING" [
          DEFAULT_TABLESPACE2 "QUOTED_STRING" ] [ TEMPORARY_TABLESPACE
          "QUOTED_STRING" ] THROUGH SYSDBA CONNECTION "UNQUOTED_STRING" ] )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseRegisterUserCommand

This command registers a Warehouse Builder user.

propertyNameList

A list of valid properties are shown below.

getPropertiesClause

Basic properties for USER:

getPropertiesClause

Name: PROMPT_FOR_COMMIT
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: PROMPT_FOR_JOB_NAME
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: PROMPT_FOR_EXECUTION_PARAMS
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_MONITOR
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_DEPLOYMENT_COMPLETION
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_DEPLOYMENT_DEPENDENCIES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_MONITOR_RESULTS
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_MONITOR_LOGFILE
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: PERSONALITY
Type: STRING
Valid Values: Any valid character string in supported character set.
Default:  Default

Name: SHOW_GUIDED_ASSISTANCE
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: HIDE_WIZARD_WELCOME_PAGES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_DELETE_CONFIRMATION
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: RECYCLE_DELETED_OBJECTS
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: EMPTY_RECYCLE_BIN
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: CLEAR_CLIPBOARD
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_GENERATION_PROJECT
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_GENERATION_MODULE
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_GENERATION_LOCATION
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_GENERATION_ACTION
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_GENERATION_TYPE
Type: BOOLEAN
Valid Values: true, false
Default:  true

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

Name: LOG_FILE_NAME
Type: STRING(1000)
Valid Values: Any valid character string in supported character set.
Default:  log

Name: LOG_FILE_MAX_SIZE
Type: STRING
Valid Values: 1-10000000
Default:  100

Name: LOG_ERROR_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: LOG_WARNING_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: LOG_INFORMATION_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: NAMING_MODE
Type: STRING
Valid Values: PHYSICAL_NAMING_MODE, BUSINESS_NAMING_MODE
Default:  PHYSICAL_NAMING_MODE

Name: PROPAGATE_NAME_CHANGES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: DESIGNREPOS_PWD_PERSIST
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: RUNTIMEREPOS_PWD_SHARE
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: DEFAULT_SEC_POLICY
Type: STRING
Valid Values: MINIMUM_SECURITY, MAXIMUM_SECURITY
Default:  MINIMUM_SECURITY

propertyValueList

A list of valid property values. Refer to section of Basic properties for USER.

propertyValue

The valid property value. Refer to section of Basic properties for USER.

See Also

OMBUNREGISTER USER

OMBALTER USER

OMBRETRIEVE USER

OMBRESTORE SNAPSHOT

Purpose

A snapshot is a history point of individual or group of components. The user can recover the components' previously captured states by using the snapshot restore functionality.

Prerequisites

A component can be restored from a snapshot into the current workspace.

Syntax

parseRestoreCommand =  OMBRESTORE "restoreSnapshotCommand"
     restoreSnapshotCommand =  ( SNAPSHOT "QUOTED_STRING" [ CASCADE UP ] [
          IGNORE CLASS_DEFINITION ( DIFFERENCES | DIFF ) ] [ FOR (
          "UNQUOTED_STRING" "QUOTED_STRING" ) ] )

Parameters

parseRestoreCommand

Root production for OMBRESTORE SNAPSHOT.

restoreSnapshotCommand

To restore snapshot components into the workspace.

QUOTED_STRING

Name of the snapshot from which components are to be restored.

CASCADE

CASCADE UP - Optional clause for letting the user restore a component even if its parent does not exist in the current workspace.

CLASS_DEFINITION

IGNORE CLASS_DEFINITION DIFF - Optional clause for letting the user restore a snapshot whether or not the meta-model of the snapshot is different from that of the current workspace.

FOR

Optional component clause for partial restore. This can be used to specify which components of a snapshot are to be restored.

See Also

OMBCREATE SNAPSHOT

OMBALTER SNAPSHOT

OMBDROP SNAPSHOT

OMBCOMPARE SNAPSHOT

OMBLIST SNAPSHOT

OMBRETRIEVE SNAPSHOT

OMBRETRIEVE

Purpose

Retrieve metadata of a component.

Prerequisites

Can be in any context. Component to retrieve can be specified by either absolute or relative path.

Syntax

retrieveCommand =  OMBRETRIEVE "fco_type" "fco_name" { "sco_type"
          "sco_name" } ( "getPropertiesClause" | "getSCOClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getSCOClause =  GET [ ( REF | REFERENCE ) [ "qualifier" ] ] "sco_type" [ AT
           POSITION "pos" ]
     propertyNameList =  "propertyName" { "," "propertyName" }
     propertyName =  "UNQUOTED_STRING"

Parameters

retrieveCommand

Specify the component from which to retrieve metadata.

fco_type

The type of the component.

fco_name

The physical name of the component in single quotes.

getPropertiesClause

Retrieve properties of an object.

getSCOClause

Retrieve a list of child object names of a given type.

qualifier

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

propertyNameList

A list of property names.

propertyName

An unquoted string representing the name of a property.

See Also

OMBCREATE

OMBALTER

OMBRETRIEVE ACTIVITY_TEMPLATE

Purpose

To retrieve the details of an activity template.

Prerequisites

Should be in the context of an Activity Template Folder.

Syntax

parseRetrieveTemplateCommand =  OMBRETRIEVE ACTIVITY_TEMPLATE
          "QUOTED_STRING" ( "getParameterPropertiesClause" |
          "getTemplatePropertiesClause" )
     getParameterPropertiesClause =  PARAMETER "QUOTED_STRING" GET PROPERTIES
          "propertyKeyList"
     getTemplatePropertiesClause =  ( GET ( ( PROPERTIES "propertyKeyList" ) |
          PARAMETERS | ( ( REFERENCE | REF ) [ "getReferenceIconSetClause" ] ) )
           )
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     getReferenceIconSetClause =  ICONSET
     propertyKey =  "UNQUOTED_STRING"

Parameters

parseRetrieveTemplateCommand

This command retrieves the details of an activity template.

getParameterPropertiesClause

Get the values of the specified properties of the activity template.

getParameterPropertiesClause

Description of the Activity Template Core properties for Activity Parameter:

Name: DATATYPE
Type: STRING
Valid Values: INTEGER, FLOAT, DATE, STRING, BOOLEAN
Default: STRING
Sets the datatype of a Parameter

Name: DIRECTION
Type: STRING
Valid Values: IN
Default: IN
Sets the direction of a Parameter

Name: DEFAULT_VALUE
Type: STRING
Valid Values: Examples '123', '123.456', 'Jan-08-2003', 'I am String', 'true'
Default: Empty string
Sets the default value of a Parameter

getTemplatePropertiesClause

Get the values of the specified properties of the parameter.

getTemplatePropertiesClause

Basic properties for ACTIVITY_TEMPLATE:

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

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

propertyKeyList

The list of property keys.

getReferenceIconSetClause

Retrieve the icon set referenced by this activity template.

propertyKey

A property key for an object.

PARAMETER Object

Table 17-1 PARAMETER Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBDROP

OMBCREATE ACTIVITY_TEMPLATE

OMBALTER ACTIVITY_TEMPLATE

OMBRETRIEVE ACTIVITY_TEMPLATE_FOLDER

Purpose

To retrieve the details of an activity template folder.

Prerequisites

Should be in the context of a Project.

Syntax

parseRetrieveTemplateFolderCommand =  OMBRETRIEVE ACTIVITY_TEMPLATE_FOLDER
          "QUOTED_STRING" "getTemplateFolderPropertiesClause"
     getTemplateFolderPropertiesClause =  ( GET ( ( PROPERTIES "propertyKeyList"
           ) | ( ( REFERENCE | REF ) "getReferenceIconSetClause" ) ) )
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     getReferenceIconSetClause =  ICONSET
     propertyKey =  "UNQUOTED_STRING"

Parameters

parseRetrieveTemplateFolderCommand

This command retrieves the details of an activity template folder.

getTemplateFolderPropertiesClause

Get the values of the specified properties of the activity template folder.

getTemplateFolderPropertiesClause

Basic properties for ACTIVITY_TEMPLATE_FOLDER:

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

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

propertyKeyList

The list of property keys.

getReferenceIconSetClause

Retrieve the icon set referenced by this activity template folder.

propertyKey

A property key for an object.

See Also

OMBDROP

OMBCREATE ACTIVITY_TEMPLATE_FOLDER

OMBALTER ACTIVITY_TEMPLATE_FOLDER

OMBRETRIEVE ADVANCED_QUEUE

Purpose

Retrieve details of the Advanced Queue.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

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

Parameters

retrieveAQCommand

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

getPropertiesClause

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

getPropertiesClause

Basic properties for ADVANCED_QUEUE:

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

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

Name: QTABLE
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Queue Table for the Advanced Queue. This has to be the name of a Queue Table(QUEUE_TABLE) existing in the same Oracle Module.

getReferenceIconSetClause

Get the Icon Set.

propertyNameList

The list of properties.

ADVANCED_QUEUE Object

Table 17-2 ADVANCED_QUEUE Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

DEQUEUE_ENABLED

BOOLEAN

true, false

none

none

true

ENQUEUE_ENABLED

BOOLEAN

true, false

none

none

true

GENERATE_ADVANCED_QUEUE

BOOLEAN

true, false

none

none

true

GENERATE_TEMPORARY_TABLE

BOOLEAN

true, false

none

none

true

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

MAX_RETRIES

NUMBER

none

none

none

5

RETENTION_TIME

NUMBER

none

none

none

0

RETRY_DELAY

NUMBER

none

none

none

0

See Also

OMBRETRIEVE

OMBALTER ADVANCED_QUEUE

OMBCREATE ADVANCED_QUEUE

OMBDROP ADVANCED_QUEUE

OMBRETRIEVE ALTERNATIVE_SORT_ORDER

Purpose

Retrieve details of an Alternative Sort Order.

Prerequisites

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

Syntax

retrieveAlternativeSortOrderCommand =  OMBRETRIEVE ALTERNATIVE_SORT_ORDER
          "QUOTED_STRING" "retrieveAlternativeSortOrderClauseDetails"
     retrieveAlternativeSortOrderClauseDetails =  GET (
          "getPropertiesClauseforLOVandD2D" | "getReferenceIconSetClause" | (
          REF | REFERENCE ) DEFINING ITEM | ( REF | REFERENCE ) ORDERED ITEM | (
           REF | REFERENCE ) ITEMS | DEPENDENTS )
     getPropertiesClauseforLOVandD2D =  PROPERTIES "("
          "propertyNameListforLOVandD2D" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     propertyNameListforLOVandD2D =  ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
          "," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }

Parameters

retrieveAlternativeSortOrderCommand

Retrieves the alternative sort order.

QUOTED_STRING

name of the alternative sort order.

retrieveAlternativeSortOrderClauseDetails

This clause retrieves the contents of an alternative sort order.

GET

This clause retrieves the following

REF DEFINING ITEM retrieves the Item that holds the individual values for this alternative sort order.

REF ORDERED ITEM retrieves the Item that holds the order of the values for this alternative sort order.

REF ITEMS retrieves the list of Items that use this alternative sort order.

DEPENDENTS retrieves a list of Item Folders that the alternative sort order depends on.

(This will return the Item Folder containing any Values and Order Items).

getPropertiesClauseforLOVandD2D

This clause gets the properties of the object.

getPropertiesClauseforLOVandD2D

Basic properties for ALTERNATIVE_SORT_ORDER:

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

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

Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the alternative sort order enables drilling between the item folders containing the items that use the alternative sort order

Name: RETRIEVE_VALUES_GROUP_SIZE
Type: Number
Valid Values: Any valid character string in supported character set.
Default: '100'
The number of rows to be fetched from the database at a time

Name: CACHE_VALUES
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the list of values should be cached in memory

Name: REQUIRE_SEARCH
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether search criteria should be requested

Name: SHOW_IN_NAVIGATOR
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be shown in the item navigator

Name: SORTED_DISTINCT
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be displayed sorted with duplicates hidden

getReferenceIconSetClause

Get specified Icon Set.

propertyNameListforLOVandD2D

This is the list of property names.

ALTERNATIVE_SORT_ORDER Object

Table 17-3 ALTERNATIVE_SORT_ORDER Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER ALTERNATIVE_SORT_ORDER

OMBCREATE ALTERNATIVE_SORT_ORDER

OMBRETRIEVE ANALYZE_ACTION_PLAN

Purpose

To retrieve a profile action plan.

Prerequisites

An action plan for profiling must already exist.

Syntax

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

Parameters

RetrieveActionPlanCommand

Retrieve a profile action plan

getActionsClause

Get a list of actions from an action plan.

retrieveActionClause

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

QUOTED_STRING

Action name

getPropertiesClause

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

getReferenceClause

Retrieve the object associated with an action.

propertyNameList

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

See Also

OMBCREATE ANALYZE_ACTION_PLAN

OMBPROFILE

OMBRETRIEVE APPLICATION_SERVER_MODULE

Purpose

Retrieve details of the Application Server Module.

Prerequisites

Should be in the context of a project.

Syntax

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

Parameters

retrieveApplicationServerModuleCommand

Retrieve the detail of the application server module.

getPropertiesClause

Get properties of the application server module.

getPropertiesClause

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

getReferenceLocationClause

Get the ref location of the application server module.

getReferenceIconSetClause

Get the ref icon set of the application server module.

propertyNameList

A list of the property names.

See Also

OMBRETRIEVE

OMBRETRIEVE BUSINESS_AREA

Purpose

Retrieve details of a Business Area.

Prerequisites

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

Syntax

retrieveBusinessAreaCommand =  OMBRETRIEVE BUSINESS_AREA "QUOTED_STRING"
          "retrieveBusinessAreaClause"
     retrieveBusinessAreaClause =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | "getBASCOClause" )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getBASCOClause =  ITEM_FOLDERS
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveBusinessAreaCommand

To retrieve a business area.

QUOTED_STRING

name of the business area.

retrieveBusinessAreaClause

Retrieves the contents of the business area.

getPropertiesClause

Retrieves the properties of the object.

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

getReferenceIconSetClause

Get specified Icon Set.

getBASCOClause

Retrieves the item folder shortcuts from the business area.

propertyNameList

This is the list of property names.

BUSINESS_AREA Object

Table 17-4 BUSINESS_AREA Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER BUSINESS_AREA

OMBCREATE BUSINESS_AREA

OMBRETRIEVE BUSINESS_DEFINITION_MODULE

Purpose

Retrieve details of the business definition module.

Prerequisites

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

Syntax

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

Parameters

retrieveEULModuleCommand

This command retrieves the details of a business definition module.

QUOTED_STRING

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

getPropertiesClause

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

getPropertiesClause

Basic properties for 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 business definition module

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

BUSINESS_DEFINITION_MODULE Object

Table 17-5 BUSINESS_DEFINITION_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

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

OBJECT_MATCHING

STRING

BY_IDENTIFIER, BY_NAME

none

none

BY_IDENTIFIER

Whether import should match up objects by identifier or by name

See Also

OMBRETRIEVE

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.

See Also

OMBDROP

OMBCREATE CALENDAR_MODULE

OMBALTER CALENDAR_MODULE

OMBRETRIEVE CALENDAR_MODULE

Purpose

Retrieve details of a Calendar Module.

Prerequisites

Should be in the context of a Project

Syntax

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

Parameters

retrieveCalendarClause

Retrieve the specified calendar module.

getCalendarPropertiesClause

Describe the keys of properties for the calendar object

getReferenceIconSetClause

Describe Icon Set.

getSchedulePropertiesClause

Describe the keys of properties for the schedule object

propertyKeyList

The list of property keys.

propertyKey

A property key for an object.

See Also

OMBDROP

OMBCREATE CALENDAR_MODULE

OMBALTER CALENDAR_MODULE

OMBRETRIEVE CATALOG_FOLDER

Purpose

Retrieve details of a Catalog Folder.

Prerequisites

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

Syntax

retrieveCatalogFolderCommand =  OMBRETRIEVE CATALOG_FOLDER "QUOTED_STRING"
          "retrieveCatalogFolderClause"
     retrieveCatalogFolderClause =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | "getCFSCOClause" )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getCFSCOClause =  LOGICAL_TABLES | DRILL_PATHS
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveCatalogFolderCommand

To retrieve a catalog folder.

QUOTED_STRING

name of the catalog folder.

retrieveCatalogFolderClause

Retrieves the contents of the catalog folder.

getPropertiesClause

Retrieves the properties of the object.

getPropertiesClause

Basic properties for CATALOG_FOLDER:

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

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

getReferenceIconSetClause

Get specified Icon Set.

getCFSCOClause

Retrieves the logical table/drill path shortcuts from the catalog folder.

propertyNameList

This is the list of property names.

CATALOG_FOLDER Object

Table 17-6 CATALOG_FOLDER Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER CATALOG_FOLDER

OMBCREATE CATALOG_FOLDER

18 OMBRETRIEVE CMI_DEFINITION to OMBRETRIEVE DRILL_TO_DETAIL

OMBRETRIEVE CMI_DEFINITION

OMBRETRIEVE CMI_MODULE

OMBRETRIEVE COLLECTION

OMBRETRIEVE CONFIGURATION

OMBRETRIEVE CONFIGURATION_TEMPLATE

OMBRETRIEVE CONNECTOR

OMBRETRIEVE CONTROL_CENTER

OMBRETRIEVE CORRECTION_MAPS_ACTION_PLAN

OMBRETRIEVE CORRECTION_SCHEMA_ACTION_PLAN

OMBRETRIEVE CT

OMBRETRIEVE CT_FOLDER

OMBRETRIEVE CUBE

OMBRETRIEVE DATA_AUDITOR

OMBRETRIEVE DATA_PROFILE

OMBRETRIEVE DATA_RULE

OMBRETRIEVE DATA_RULE_MODULE

OMBRETRIEVE DEPLOYMENT

OMBRETRIEVE DEPLOYMENT_ACTION_PLAN

OMBRETRIEVE DIMENSION

OMBRETRIEVE DRILL_PATH

OMBRETRIEVE DRILL_TO_DETAIL

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

Property
Type
Choices
Min
Max
Default
Description

LOCATION_UOID

STRING

none

none

none

empty string

Location Warehouse Builder should use to retrieve the data.

See Also

OMBRETRIEVE

OMBRETRIEVE CMI_MODULE

Purpose

Retrieve details of the CMI module.

Prerequisites

Should be in the context of project.

Syntax

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

Parameters

retrieveMIVModuleCommand

This command retrieves the details of an CMI Module

QUOTED_STRING

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

getPropertiesClause

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

getPropertiesClause

Basic properties for CMI_MODULE:

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

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of an CMI 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 CMI module.

getReferenceIconSetClause

Retrieve the icon set referenced by this CMI module.

getReferenceLocationsClause

Retrieve all of the data locations referenced by this module.

propertyNameList

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

CMI_MODULE Object

Table 18-2 CMI_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE

OMBRETRIEVE COLLECTION

Purpose

Retrieve details of the collection, including its shortcuts.

Prerequisites

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

Syntax

retrieveCollectionCommand =  OMBRETRIEVE COLLECTION "QUOTED_STRING" GET (
          "propertiesClause" | "referenceIconSetClause" | "UNQUOTED_STRING"
          REFERENCES )
     propertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     referenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveCollectionCommand

Retrieve details regarding a collection of objects.

propertiesClause

Retrieve values for a number of properties.

propertiesClause

Basic properties for COLLECTION:

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

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

referenceIconSetClause

Get icon set for the collection.

propertyNameList

Comma separated list of property names to retrieve values. Property names are unquoted.

See Also

OMBLIST

OMBRETRIEVE CONFIGURATION

Purpose

Retrieve details of the Configuration.

Prerequisites

Should be in the context of a project.

Syntax

retrieveConfigurationCommand =  OMBRETRIEVE CONFIGURATION "QUOTED_STRING" (
           "getPropertiesClause" | "getReferenceIconSetClause" |
          "getReferenceConfigTemplateClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     getReferenceConfigTemplateClause =  GET ( REF | REFERENCE )
          CONFIGURATION_TEMPLATE
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveConfigurationCommand

This command retrieves the details of a Configuration.

getPropertiesClause

Retrieve a set of properties that is associated with a Configuration.

getPropertiesClause

Basic properties for CONFIGURATION:

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

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

getReferenceIconSetClause

Retrieve the Icon Set associated with a Configuration.

getReferenceConfigTemplateClause

Retrieve the Configuration Template associated with a Configuration.

propertyNameList

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

See Also

OMBLIST

OMBRETRIEVE CONFIGURATION_TEMPLATE

Purpose

Retrieve the details of the configuration template.

Prerequisites

None.

Syntax

retrieveConfigurationTemplateCommand =  OMBRETRIEVE CONFIGURATION_TEMPLATE
          "QUOTED_STRING" ( "getPropertiesClause" | "getReferenceIconSetClause"
          | "getTemplateValuesClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     getTemplateValuesClause =  GET TEMPLATE_VALUES "(" "propertyNameList" ")"
          FOR "getType" ON PLATFORM "QUOTED_STRING"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     getType =  "UNQUOTED_STRING"

Parameters

retrieveConfigurationTemplateCommand

This command retrieves the details of a configuration template.

getPropertiesClause

Retrieve a set of properties that is associated with a configuration template.

getPropertiesClause

Basic properties for CONFIGURATION_TEMPLATE:

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

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

getReferenceIconSetClause

Retrieve the Icon Set associated with a configuration template.

getTemplateValuesClause

Retrieve the values of the overriden properties.

propertyNameList

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

getType

The class definition that contains the property.

See Also

OMBLIST

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

Property
Type
Choices
Min
Max
Default
Description

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

OMBRETRIEVE CONTROL_CENTER

Purpose

Retrieve details from a control center.

Prerequisites

Can be in any context.

Syntax

retrieveControlCenterCommand =  OMBRETRIEVE CONTROL_CENTER "QUOTED_STRING"
          ( "retrieveControlCenterClause" | "getReferenceIconSetClause" |
          "retrieveReferenceLocationClause" )
     retrieveControlCenterClause =  "getPropertiesClause" | GET
          "getReferenceLocationsClause"
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     retrieveReferenceLocationClause =  GET ( REFERENCE | REF ) LOCATION
          "QUOTED_STRING" "getPropertiesClause"
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceLocationsClause =  ( REFERENCE | REF ) LOCATIONS
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveControlCenterCommand

Retrieve details from a control center.

retrieveControlCenterClause

Retrieve the specified properties or referenced locations.

getReferenceIconSetClause

Retrieve the icon set from a control center.

retrieveReferenceLocationClause

Get the specified properties of the referenced location.

getPropertiesClause

Get the specified properties of the control center.

getReferenceLocationsClause

Get the list of all referenced locations of this control center.

propertyNameList

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

propertyNameList

Properties for CONTROL_CENTER:

Name: HOST
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The host machine the control center is installed on.

Name: PORT
Type: NUMBER
Valid Values: 1 - 65535
Default: 1521
The port number of the database in which the control center is installed.

Name: SERVICE_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The service name of the database in which the control center is installed.

Name: USER
Synonym: USER_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The name of the database user you wish to connect to the control center as.

Name: PASSWORD
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The password.

Name: WORKSPACE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The name of the workspace to which to connect.

All of the preceding properties (except of PASSWORD) are mandatory for OMBCREATE CONTROL_CENTER.

Basic properties for CONTROL_CENTER:

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

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

Properties for a referenced location of the control center:

Name: IS_SOURCE
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, then a referenced location is a source location.

Name: IS_TARGET
Type: BOOLEAN
Valid Values: true, false
Default: true
If true, then a referenced location is a target location.

Name: CONNECTION_TYPE
Type: STRING
Valid Values: 'HOST_PORT_SERVICE', 'SQL_NET_CONNECTION'
Default: 'HOST_PORT_SERVICE'
The control center connection details format.

CONTROL_CENTER Object

Table 18-4 CONTROL_CENTER Object

Property
Type
Choices
Min
Max
Default
Description

CONNECTION_TYPE

STRING

HOST:PORT:SERVICE, SQL*NET Connection

none

none

HOST:PORT:SERVICE

Type of J2EE connection to use

DISPLAY_TYPE

STRING

none

none

none

CMPLocation_RuntimeRepository

Type of the location

HOST

STRING

none

none

none

empty string

Host of the location

NET_SERVICE_NAME

STRING(2000)

none

none

none

empty string

Net Service Name of the location

PASSWORD

STRING(30)

none

none

none

empty string

PLATFORM_NAME

STRING

none

none

none

empty string

Platform for the location.

PORT

NUMBER

none

none

none

1521

SCHEMA

STRING

none

none

none

empty string

Workspace owner.name to use for deployment

SERVICE_NAME

STRING

none

none

none

empty string

Service name of the web service activity

USER

STRING

none

none

none

empty string

VERSION

STRING

none

none

none

0

Version of the location

See Also

OMBRETRIEVE

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.

See Also

OMBCREATE CORRECTION_MAPS_ACTION_PLAN

OMBPROFILE

OMBRETRIEVE CORRECTION_SCHEMA_ACTION_PLAN

Purpose

To retrieve properties of a correction schema action plan.

Prerequisites

In the context of a data profile.

Syntax

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

Parameters

RetrieveActionPlanCommand

Retrieve a correction schema action plan.

getActionsClause

Get a list of actions from an action plan.

retrieveActionClause

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

QUOTED_STRING

Action name

getPropertiesClause

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

getReferenceClause

Retrieve the object associated with an action.

propertyNameList

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

See Also

OMBCREATE CORRECTION_SCHEMA_ACTION_PLAN

OMBPROFILE

OMBRETRIEVE CT

Purpose

To retrieve metadata on a CT (Code Template).

Prerequisites

In the context of an CT module.

Syntax

retrieveCTCommand =  OMBRETRIEVE CT "QUOTED_STRING" ( "getCTClauses" |
          "retrieveCTTaskClause" | "retrieveTransitionClause" |
          "retrieveParameterClause" | "retrieveVariableClause" )
     getCTClauses =  GET ( "getPropertiesClause" | "getReferenceIconSetClause" |
           TASKS | "TASK_TYPE" TASKS | NESTED_CT TASKS | TRANSITIONS |
          PARAMETERS | VARIABLES )
     retrieveCTTaskClause =  TASK "QUOTED_STRING" ( GET ( "getPropertiesClause"
          | "getReferenceIconSetClause" | PARAMETERS | INCOMING TRANSITIONS |
          OUTGOING TRANSITIONS ) | "retrieveParameterClause" )
     retrieveTransitionClause =  TRANSITION "QUOTED_STRING" GET (
          "getPropertiesClause" | SOURCE TASK | DESTINATION TASK )
     retrieveParameterClause =  PARAMETER "QUOTED_STRING" GET (
          "getPropertiesClause" | "getBindingClause" )
     retrieveVariableClause =  VARIABLE "QUOTED_STRING" GET
          "getPropertiesClause"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getBindingClause =  BOUND ( VARIABLE | PARAMETER )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveCTCommand

Retrieve definition of the CT.

retrieveTransitionClause

Retrieve definition of a transition.

retrieveParameterClause

Retrieve definition of an code template or a task parameter.

retrieveVariableClause

Retrieve definition of a variable.

getPropertiesClause

Get the values of the specified properties.

getPropertiesClause

Basic properties for EXPERT:

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

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

Basic properties for TASK:

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

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the task.  This is equivalent to the Goal of task in the expert editor.

Name: INSTRUCTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The instruction for the task

Name: PREPROCESSING
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The pre-processing script for the task

Name: MAIN
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The main script for the task

Name: POSTPROCESSING
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The post-processing script for the task

Basic propeties for START TASK:

Name: PROC_DECL
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The procedure declaration for the expert.

Basic properties for TRANSITION:

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

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

Name: TRANSITION_CONDITION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Condition of the transition

Name: TRANSITION_ORDER
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: N/A
Order of the transition

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: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the parameter

Name: DIRECTION
Type: STRING
Valid Values: IN, OUT, INOUT
Default: IN
Direction of the parameter.
Direction of custom expert parameter can only be IN or OUT.
For some tasks, direction of custom parameter can be IN, OUT or INOUT.

Name: VALUE
Type: Same as datatype of the parameter
Valid Values: Any valid character string in supported character set.
Default: N/A
The static value of the parameter

Basic properties for VARIABLE:

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

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

Name: DATATYPE
Type: STRING
Valid Values: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the variable

Name: VALUE
Type: Same as datatype of the variable
Valid Values: Any valid character string in supported character set.
Default: N/A
The static value of the variable

getReferenceIconSetClause

Retrieve the icon set referenced by this CT module.

getBindingClause

Get the bound variable or parameter.

propertyNameList

The list of property names.

EXPERT Object

Table 18-5 EXPERT Object

Property
Type
Choices
Min
Max
Default
Description

CLOSE_ASSISTANT_ON_COMPLETION

BOOLEAN

true, false

none

none

true

Sets whether the task assistant should be automatically closed after the expert has been run.

CLOSE_WINDOWS_ON_EXECUTION

BOOLEAN

true, false

none

none

true

Close all open windows when this expert is run.

FINISH_DIALOG_ON_COMPLETION

BOOLEAN

true, false

none

none

true

Shows the finish dialog upon completion of expert.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

LOGGING

BOOLEAN

true, false

none

none

false

MENU_ITEM_DISPLAY_STRING

STRING

none

none

none

empty string

The display string when this expert is added as a menu item.

ONLY_RUN_FROM_MENU

BOOLEAN

true, false

none

none

false

Only allow this expert to be run when it is attached to a menu item.

REVERT_TO_SAVED_ON_ERROR

BOOLEAN

true, false

none

none

false

Revert to saved metadata if error occurs when the expert is run.

RUN_STANDALONE

BOOLEAN

true, false

none

none

true

Sets whether the expert should be run as a standalone in expert assistant mode or not.

SAVE_ALL_BEFORE_START

BOOLEAN

true, false

none

none

false

Save all metadata before running the expert.

SHOW_BUSY_DIALOG

BOOLEAN

true, false

none

none

true

Sets whether busy dialog should be shown when OMB or Java tasks are executed in non-standalone mode.

SHOW_LOG_WINDOW

BOOLEAN

true, false

none

none

false

Sets whether the log window should be shown when running the expert.

SHOW_PROGRESS_GRAPH

BOOLEAN

true, false

none

none

true

Sets whether the progress graph dialog should be shown when running the expert.

SHOW_TASK_ASSISTANT

BOOLEAN

true, false

none

none

true

Sets whether the task assistant should be shown when running the expert.

See Also

OMBRETRIEVE

OMBALTER CT

OMBDROP CT

OMBRETRIEVE CT_FOLDER

Purpose

To retrieve metadata on a CT (Code Template) folder.

Prerequisites

In the context of a project.

Syntax

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

Parameters

retrieveCTModuleCommand

Retrieve definition of a CT (Code Template) folder.

getPropertiesClause

Get the values of the specified properties.

getPropertiesClause

Basic properties for CT_FOLDER:

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

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

getReferenceIconSetClause

Retrieve the icon set referenced by this CT folder.

propertyNameList

The list of property names to get.

See Also

OMBRETRIEVE

OMBRETRIEVE CUBE

Purpose

This command retrieves a Cube.

Prerequisites

Should be in Oracle Module context.

Syntax

retrieveCubeCommand =  OMBRETRIEVE CUBE "cubeName" ( GET ( PROPERTIES
          "propertyKeyList" | "getReferenceIconSetClause" | MEASURES |
          COMPOSITE_DIMENSION | DIMENSION_USES | IMPLEMENTED_OBJECT | PARTITION
          ( LEVEL | HIERARCHY ) ) | GET AGGREGATE_FUNCTION | "measureLocator"
          GET ( PROPERTIES "propertyKeyList" | IMPLEMENTED_OBJECT |
          AGGREGATE_FUNCTIONS FOR DIMENSIONS "dimensionList" | PRECOMPUTE_LEVELS
           FOR DIMENSIONS "dimensionList" | CALCULATED_EXPRESSION ) |
          "dimensionUseLocator" GET ( PROPERTIES "propertyKeyList" | ( REF |
          REFERENCE ) ( DIMENSION | LEVEL | ROLE ) | IMPLEMENTED_OBJECT |
          DIMENSION_USE_POSITION ) | "compositeDimensionLocator" GET ( REF |
          REFERENCE ) DIMENSIONS )
     cubeName =  "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     measureLocator =  MEASURE "measureName"
     dimensionList =  "(" "dimension" { "," "dimension" } ")"
     dimensionUseLocator =  DIMENSION_USE "dimensionUseName"
     compositeDimensionLocator =  COMPOSITE_DIMENSION "compositeDimensionName"
     propertyKey =  "UNQUOTED_STRING"
     measureName =  "QUOTED_STRING"
     dimension =  "QUOTED_STRING"
     dimensionUseName =  "QUOTED_STRING"
     compositeDimensionName =  "QUOTED_STRING"

Parameters

retrieveCubeCommand

This clause retrives information about a CUBE and other details such as: PROPERTIES, MEASURES, COMPOSITE_DIMENSION, DIMENSION_USES, IMPLEMENTED_OBJECT, PARTITION, LEVEL, HIERARCHY, AGGREGATE_FUNCTION, AGGREGATE_FUNCTIONS, FOR, DIMENSIONS, PRECOMPUTE_LEVELS, CALCULATED_EXPRESSION, DIMENSION, ROLE, DIMENSION_USE_POSITION.

cubeName

The name of the cube in QUOTED_STRING.

propertyKeyList

The clause sets the list of property keys.

getReferenceIconSetClause

The clauses gets the reference ICONSET.

measureLocator

This clause finds the MEASURE.

dimensionList

This clause retrieves the dimension list.

dimensionUseLocator

The is retrieves DIMENSION_USE.

compositeDimensionLocator

This key locates the COMPOSITE_DIMENSION.

propertyKey

The name of property key in UNQUOTED_STRING.

propertyKey

Basic properties for CUBE, MEASURE and  DIMENSION_USE:

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

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

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: 'true', 'false'
Default: 'true'
The dimension is visible to OLAP end user

Name: UNIQUE_KEY_CONSTRAINT
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
set the Unique Key constraint on the Business Key

Name: STORAGE
Type: STRING
Valid Values: 'RELATIONAL', 'MOLAP'
Default: 'RELATIONAL'
The storage of a cube can be relational or molap

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

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

Name: USE_GLOBAL_INDEX
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Gets the flag to say whether to generate a composite for measure partition combination

Name: BITMAP_INDEX
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
gets the flag to say whether to generate a bitmap for a cube

Name: SPARSITY_ULTRA_COMPRESS
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Gets the flag to say whether its a compressed cube. Only valid for Molap cube.

Name: LOAD_POLICY_FOR_NULL_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_DIMENSION_RECORD'
Default: 'NO_MAINTENANCE'
Data policy for loading cube where OWB mapping code relies on
database constraints to detect the orphans (null parent references).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_DIMENSION_RECORD', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

Name: LOAD_POLICY_FOR_INVALID_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_DIMENSION_RECORD'
Default: 'NO_MAINTENANCE'
Data policy for loading cube where OWB mapping code relies on
database constraints to detect the orphans (could contain a value that is not actually found in the parent).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_DIMENSION_RECORD', the policy for loading cube where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

propertyKey

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

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

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: 'true', 'false'
Default: 'true'
The measure is visible to OLAP end user

Name: CALCULATED_MEASURE
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
Gets the measure to be aggregatable

Name: AUTO_SOLVE
Type: STRING
Valid Values: 'true', 'false'
Default: 'false'
gets the flag to say whether the measure is Auto Solve

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

Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH TIME ZONE, TIMESTAMP WITH LOCAL TIME ZONE, VARCHAR, VARCHAR2, XMLFORMAT
Default: NUMBER
Gets the datatype of a Cube Measure

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

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

Name: PRECISION
Type: NUMBER
Valid Values: 0 - 39
Default: 1
The precision of a number.

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

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

Name: DIMENSION_USE_POSITION
Type: INTEGER
Valid Values: Any valid character string in supported character set.
Default: Empty string

measureName

The name of the measure in QUOTED_STRING.

dimension

The name of the dimensin in QUOTED_STRING.

dimensionUseName

The name of dimension use in QUOTED_STRING.

compositeDimensionName

The name of composite dimension in QUOTED_STRING.

CUBE Object

Table 18-6 CUBE Object

Property
Type
Choices
Min
Max
Default
Description

COSTBASEDPERCENTAGE

NUMBER

none

none

none

0

Cost Based Aggregation

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_AGGREGATION, DEPLOY_ALL, DEPLOY_DATA_OBJECTS_ONLY, DEPLOY_TO_CATALOG_ONLY

none

none

DEPLOY_DATA_OBJECTS_ONLY

Warehouse Builder generates a set of scripts for cube, they are DDL Scripts for Relational Cube or Scripts for OLAP API-II or Scripts for AW.

ENABLE_MV_REFRESH

BOOLEAN

true, false

none

none

false

Enable MV Refresh

ERROR_TABLE_COLUMN_NAMES

STRING

none

none

none

empty string

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

MATERIALIZED_VIEW_INDEX_TABLESPACE

STRING

none

none

none

USERS

Tablespace for materialized view indexes.

MATERIALIZED_VIEW_TABLESPACE

STRING

none

none

none

USERS

Tablespace for materialized view.

MVCONSTRAINTS

STRING

, ENFORCED, TRUSTED

none

none

TRUSTED

MV Constraints

NEXTDATE

STRING

none

none

none

empty string

Refresh Next Date

QUERY_REWRITE

STRING

, DISABLE, ENABLE

none

none

DISABLE

Enable Query Rewrite

REFRESH

STRING

, COMPLETE, FAST, FORCE

none

none

FORCE

Refresh Mode

REFRESH_ON

STRING

, COMMIT, DEMAND, ONDATE

none

none

DEMAND

Refresh On

STARTWITH

STRING

none

none

none

empty string

Refresh Start Date

VISIBLE

BOOLEAN

true, false

none

none

true

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

See Also

OMBRETRIEVE

OMBCREATE CUBE

OMBALTER CUBE

OMBDROP CUBE

OMBRETRIEVE DATA_AUDITOR

Purpose

Retrieve data auditor details such as the number of operators.

Prerequisites

The current context must be in an Oracle Module.

Syntax

retrieveDataAuditorCommand =  OMBRETRIEVE DATA_AUDITOR "dataAuditorName"
          "getDataAuditorDetailClause"
     dataAuditorName =  "QUOTED_STRING"
     getDataAuditorDetailClause =  GET ( PROPERTIES "propertyKeyList" |
          "getReferenceIconSetClause" | [ "operatorType" ] OPERATORS |
          "childType" ) | "getChildDetailClause" | "operatorLocator"
          "getOperatorDetailClause"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     operatorType =  "UNQUOTED_STRING"
     childType =  "UNQUOTED_STRING"
     getChildDetailClause =  ( "childType" "childName" )+ GET ( PROPERTIES
          "propertyKeyList" | "childType" )
     operatorLocator =  OPERATOR "operatorName"
     getOperatorDetailClause =  GET ( PROPERTIES "propertyKeyList" |
          BOUND_OBJECT | "childType" ) | "getChildDetailClause"
     propertyKey =  "UNQUOTED_STRING"
     childName =  "QUOTED_STRING"
     operatorName =  "QUOTED_STRING"

Parameters

retrieveDataAuditorCommand

Retrieve the detail of a data auditor such as how many operators are there.

dataAuditorName

Name of data auditor.

getDataAuditorDetailClause

Get properties or operators from the data auditor.

propertyKeyList

The list of property keys.

getReferenceIconSetClause

Retrieve the icon set referenced by the data auditor.

operatorType

Type of a mapping operator. The following operator types are available: CUBE, DIMENSION, MATERIALIZED_VIEW, TABLE, VIEW.

childType

Type of a child that belongs to data auditor or operator

getChildDetailClause

Get the desired detail of a child object that belongs to the data auditor or operator.

operatorLocator

Locate operator.

getOperatorDetailClause

Get the desired detail of a data auditor operator.

propertyKey

A property key for an object.

propertyKey

Basic properties for DATA_AUDITOR:

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

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

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

#

childName

Name of a child that belongs to data auditor, operator.

operatorName

Name of an operator.

DATA_AUDITOR Object

Table 18-7 DATA_AUDITOR Object

Property
Type
Choices
Min
Max
Default
Description

ANALYZE_TABLE_SAMPLE_PERCENTAGE

NUMBER

none

none

none

90

The default percentage of rows to be sampled when the target tables are analyzed for statistics to improve performance during insertion.

ANALYZE_TABLE_STATEMENTS

BOOLEAN

true, false

none

none

true

Generate statistics collection statement if this is true.

ANSI_SQL_SYNTAX

BOOLEAN

true, false

none

none

true

A switch between ANSI and Oracle SQL Syntax.

BULK_PROCESSING_CODE

BOOLEAN

true, false

none

none

true

Generate bulk processing code if this is true.

BULK_SIZE

NUMBER

none

none

none

50

COMMIT_CONTROL

STRING

AUTO_COMMIT, AUTO_CORR_COMMIT, MANUAL_COMMIT

none

none

AUTO_COMMIT

Options for how commit is performed

COMMIT_FREQUENCY

NUMBER

none

none

none

1000

DEBUG_RUNTIME_CONNECTION

STRING

none

none

none

empty string

Runtime schema connection info for debug.

DEFAULT_AUDIT_LEVEL

STRING

COMPLETE, ERROR_DETAILS, NONE, STATISTICS

none

none

STATISTICS

The default audit level when the step is executed.

DEFAULT_OPERATING_MODE

STRING

ROW_BASED, ROW_BASED_TARGET_ONLY, SET_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY

none

none

SET_BASED

The default operating mode.

DEFAULT_PURGE_GROUP

STRING

none

none

none

WB

The default purge group to be used when the step is executed.

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

ENABLE_PARALLEL_DML

BOOLEAN

true, false

none

none

false

Determine if PDML is enabled at runtime.

ERROR_TRIGGER

STRING

none

none

none

empty string

Error trigger procedure name.

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

PLSQL, UNDEFINED

none

none

UNDEFINED

The language used when generating code for the mapping.

GENERATION_MODE

STRING

ALL_MODES, ROW_BASED, ROW_BASED_TARGET_ONLY, SET_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED, SET_BASED_FAIL_OVER_TO_ROW_BASED_TARGET_ONLY

none

none

SET_BASED

The operating modes for which code should be generated.

MAXIMUM_NUMBER_OF_ERRORS

NUMBER

none

none

none

50

The default maximum number of errors encountered before aborting the step execution.

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.

OPTIMIZED_CODE

BOOLEAN

true, false

none

none

true

Attempt to generate optimized code if this is true.

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.

TARGET_LOAD_ORDERING

BOOLEAN

true, false

none

none

true

Generate target load ordering code.

THRESHOLD_MODE

STRING

PERCENTAGE, SIX_SIGMA

none

none

PERCENTAGE

Use six sigma or percentage for failure thresholds.

OPERATOR Object

Table 18-8 OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBRETRIEVE

OMBCREATE DATA_AUDITOR

OMBALTER DATA_AUDITOR

OMBDROP DATA_AUDITOR

OMBRETRIEVE DATA_PROFILE

Purpose

Retrieve details of the Data Profile.

Prerequisites

Should be in the context of project.

Syntax

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

Parameters

retrieveDataProfileCommand

This command retrieves the details of a Data Profile

QUOTED_STRING

Name of the existing Data Profile or path to the Data Profile.

getPropertiesClause

Retrieve a set of properties that is associated with a Data Profile.

getReferenceLocationClause

Retrieve the location that is set to the Data Profile.

getReferenceIconSetClause

Retrieve the icon set referenced by this Data Profile.

propertyNameList

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

DATA_PROFILE Object

Table 18-9 DATA_PROFILE Object

Property
Type
Choices
Min
Max
Default
Description

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

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

See Also

OMBRETRIEVE

OMBRETRIEVE DATA_RULE

Purpose

Retrieve data rule details such as the data rule type.

Prerequisites

The current context of scripting must be a data rule module.

Syntax

retrieveDataRuleCommand =  OMBRETRIEVE DATA_RULE "QUOTED_STRING"
          "retrieveDataRuleClause"
     retrieveDataRuleClause =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | "getGroupsClause" |
          "getDomainValuesClause" ) | GROUP "retrieveGroupClause"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getGroupsClause =  GROUPS
     getDomainValuesClause =  DOMAIN_VALUES
     retrieveGroupClause =  "QUOTED_STRING" ( GET ( "getGroupPropertiesClause" |
           "getAttributesClause" ) | "retrieveAttributeClause" )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     getGroupPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getAttributesClause =  ATTRIBUTES
     retrieveAttributeClause =  ATTRIBUTE "QUOTED_STRING"
          "getAttributePropertiesClause"
     getAttributePropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"

Parameters

retrieveDataRuleCommand

Retreive a data rule

QUOTED_STRING

Data rule name.

retrieveDataRuleClause

Gets the groups, domain values or properties of a data rule.

getPropertiesClause

This clause retrieves all the properties.

getPropertiesClause

Properties of Data Rule are:

Basic properties for DATA_RULE:

Name: DATA_NAME

Type: STRING(200)

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

Default: Empty string

Business name of the Data Rule

Name: DESCRIPTION

Type: STRING(4000)

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

Default: Empty string

Description of the Data Rule

Name: RULE_TYPE

Type: STRING

Valid Values: ATTR_VALUE_RULE

DOMAIN_NO_NULL_RULE

DOMAIN_LIST_RULE

DOMAIN_PATTERN_LIST_RULE

DOMAIN_RANGE_RULE

DOMAIN_FORMAT_TELEPHONE_RULE

DOMAIN_FORMAT_IP_RULE

DOMAIN_FORMAT_SSN_RULE

DOMAIN_FORMAT_DATE_RULE

DOMAIN_FORMAT_NUMBER_RULE

DOMAIN_FORMAT_URL_RULE

DOMAIN_FORMAT_EMAIL_RULE

FUNCTIONAL_DEP_RULE

SET_RULE

IDENTITY_RULE

REFERENCE_RULE

Default: ATTR_VALUE_RULE

Data Rule type

Name: ATTR_VALUE_CLAUSE

Type: STRING(4000)

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

Default: Empty string

Expression used in the ATTR_VALUE_RULE

Name: LOCAL_MIN_COUNT

Type: STRING

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

Default: 1

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: LOCAL_MAX_COUNT

Type: STRING

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

Default: n

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: REMOTE_MIN_COUNT

Type: STRING

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

Default: 0

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: REMOTE_MAX_COUNT

Type: STRING

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

Default: 'n'

Used in the REFERENCE_RULE to set the max and min counts for the local and remote side of a relation. For a 1-n relationship, set the local max count to 1 and remote min count to 0 or 1. For an n-1 relationship, set the local max count to n and remote max count to 1.

Name: MAX_VALUE

Type: STRING

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

Default: Empty string

Used in the DOMAIN_RANGE_RULE. Leave the min or max value blank is not used. For instance, the rule: attr &gt;= 10 would have a max value and no min_value.

Name: MIN_VALUE

Type: STRING

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

Default: Empty string

Used in the DOMAIN_RANGE_RULE. Leave the min or max value blank is not used. For instance, the rule: attr &gt;= 10 would have a max value and no min_value.

Name: IGNORE_NULLS

Type: BOOLEAN

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

Default: false

Used in identity and reference rules. If set, then records containing null values will not evaluated.

Properties of Data Rule Attribute are:

Name: DATATYPE

Type: STRING

Valid Values: DATE, NUMBER, VARCHAR2

Default: NUMBER

Set the data type for Parameter. Should be set for attributes on ATTR_VALUE and DOMAIN_RANGE rules

getReferenceIconSetClause

Retrieve the icon set referenced by the data rule.

getGroupsClause

Retrieves all the groups of a data rule.

getDomainValuesClause

Retreives all the domain values.

retrieveGroupClause

Retrieve a data rule group.

QUOTED_STRING

Group name.

propertyNameList

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

getGroupPropertiesClause

This clause retrieves all the properties of the data rule group.

getAttributesClause

Retrieves all the attributes of a data rule group.

retrieveAttributeClause

Retrieve a data rule group attribute.

QUOTED_STRING

Attribute name.

getAttributePropertiesClause

This clause retrieves all the properties of the data rule group attribute.

DATA_RULE Object

Table 18-10 DATA_RULE Object

Property
Type
Choices
Min
Max
Default
Description

ATTR_VALUE_CLAUSE

STRING

none

none

none

empty string

Description not available.

DIAGRAM_LAYOUT

STRING

none

none

none

empty string

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

Description not available.

FUNCTIONAL_DEP_THRESHOLD

NUMBER

none

none

none

0

Description not available.

IGNORE_NULLS

BOOLEAN

true, false

none

none

false

Description not available.

LOCAL_MAX_COUNT

STRING

none

none

none

n

Description not available.

LOCAL_MIN_COUNT

STRING

none

none

none

1

Description not available.

MAX_VALUE

STRING

none

none

none

empty string

Description not available.

MIN_VALUE

STRING

none

none

none

empty string

Description not available.

NAMEADDR_PASS_CONDITION

STRING

PASS_PARSED, PASS_POSTALMATCHED_AVAIL

none

none

PASS_PARSED

Description not available.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Description not available.

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Description not available.

REMOTE_MAX_COUNT

STRING

none

none

none

n

Description not available.

REMOTE_MIN_COUNT

STRING

none

none

none

empty string

Description not available.

RULE_TYPE

STRING

, ATTR_VALUE_RULE, DOMAIN_FORMAT_DATE_RULE, DOMAIN_FORMAT_EMAIL_RULE, DOMAIN_FORMAT_IP_RULE, DOMAIN_FORMAT_NUMBER_RULE, DOMAIN_FORMAT_SSN_RULE, DOMAIN_FORMAT_TELEPHONE_RULE, DOMAIN_FORMAT_URL_RULE, DOMAIN_LIST_RULE, DOMAIN_NO_NULL_RULE, DOMAIN_PATTERN_LIST_RULE, DOMAIN_RANGE_RULE, FUNCTIONAL_DEP_RULE, IDENTITY_RULE, NAMEADDRESS_RULE, REFERENCE_RULE, SET_RULE

none

none

empty string

Description not available.

See Also

OMBRETRIEVE

OMBRETRIEVE DATA_RULE_MODULE

Purpose

Retrieve details of the data rule module.

Prerequisites

Should be in the context of project.

Syntax

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

Parameters

retrieveDataRuleModuleCommand

Retrieve the data rule module.

QUOTED_STRING

Data rule module name.

getPropertiesClause

This clause retrieves all the properties.

getReferenceIconSetClause

Retrieve the icon set referenced by the data rule module.

propertyNameList

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

See Also

OMBRETRIEVE

OMBRETRIEVE DEPLOYMENT

Purpose

Retrieve details of the Deployment.

Prerequisites

Should be in the context of a Configuration.

Syntax

retrieveDeploymentCommand =  OMBRETRIEVE DEPLOYMENT "QUOTED_STRING" (
          "getPropertiesClause" | "getReferencedControlCenterClause" |
          "getReferencedAgentClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferencedControlCenterClause =  GET ( REF | REFERENCE ) CONTROL_CENTER
     getReferencedAgentClause =  GET ( REF | REFERENCE ) AGENT
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveDeploymentCommand

This command retrieves the details of a Deployment.

getPropertiesClause

Retrieve a set of properties that is associated with a Deployment.

getReferencedControlCenterClause

Retrieve the Control Center associated with a Deployment.

getReferencedAgentClause

Retrieve the Remote Agent associated with a Deployment.

propertyNameList

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

See Also

OMBLIST

OMBRETRIEVE DEPLOYMENT_ACTION_PLAN

Purpose

Retrieve the details of an existing deployment action plan.

Prerequisites

There must be a current working project.

Syntax

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

Parameters

RetrieveActionPlanCommand

Retrieve the details of an existing deployment action plan.

getActionsClause

Get a list of actions from an action plan.

retrieveActionClause

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

getPropertiesClause

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

PROPERTIES

OPERATION, which specifies the type of action to be taken. DEPLOYMENT_LOCATION, which sets the target location for a Code Template.

getReferenceClause

Retrieve the object associated with an action.

propertyNameList

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

See Also

OMBCREATE DEPLOYMENT_ACTION_PLAN

OMBDEPLOY

OMBRETRIEVE DIMENSION

Purpose

This command retrieves a dimension.

Prerequisites

Should be in Oracle Module context.

Syntax

retrieveDimensionCommand =  OMBRETRIEVE DIMENSION "dimensionName" ( GET (
          PROPERTIES "propertyKeyList" | "getReferenceIconSetClause" |
          DIMENSION_ATTRIBUTES | LEVELS | HIERARCHIES | DIMENSION_ROLES | ( REF
          | REFERENCE ) SEQUENCE | DIMENSION_KEY COLUMN | SURROGATE_KEY |
          PARENT_KEY | BUSINESS_KEYS | IMPLEMENTED_OBJECTS ) |
          "dimensionAttributeDetailClause" | "levelDetailClause" |
          "hierarchyDetailClause" | "roleDetailClause" )
     dimensionName =  "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     getReferenceIconSetClause =  ( REFERENCE | REF ) ICONSET
     dimensionAttributeDetailClause =  "dimensionAttributeLocator" GET
          PROPERTIES "propertyKeyList"
     levelDetailClause =  "levelLocator" ( GET ( PROPERTIES "propertyKeyList" |
          LEVEL_ATTRIBUTES | IMPLEMENTED_OBJECT ) | "levelAttributeDetailClause"
           | "levelRelationshipDetailClause" |
          "skipLevelRelationshipDetailClause" )
     hierarchyDetailClause =  "hierarchyLocator" GET ( PROPERTIES
          "propertyKeyList" | ( REF | REFERENCE ) LEVELS | SKIP_LEVELS )
     roleDetailClause =  "roleLocator" ( GET ( PROPERTIES "propertyKeyList" |
          DIMENSION ) )
     propertyKey =  "UNQUOTED_STRING"
     dimensionAttributeLocator =  DIMENSION_ATTRIBUTE "dimensionAttributeName"
     levelLocator =  LEVEL "levelName"
     levelAttributeDetailClause =  "levelAttributeLocator" GET ( PROPERTIES
          "propertyKeyList" | ( REF | REFERENCE ) ( DIMENSION_ATTRIBUTE |
          TYPE_THREE_SCD_PREVIOUS LEVEL_ATTRIBUTE | TYPE_THREE_SCD_CURRENT
          LEVEL_ATTRIBUTE ) | IMPLEMENTED COLUMN )
     levelRelationshipDetailClause =  LEVEL_RELATIONSHIP IN "hierarchyLocator"
          GET ( IMPLEMENTED COLUMN | PROPERTIES "propertyKeyList" )
     skipLevelRelationshipDetailClause =  SKIP_LEVEL_RELATIONSHIP IN
          "hierarchyLocator" GET ( PARENT LEVEL | IMPLEMENTED COLUMN |
          PROPERTIES "propertyKeyList" )
     hierarchyLocator =  HIERARCHY "hierarchyName"
     roleLocator =  DIMENSION_ROLE "roleName"
     dimensionAttributeName =  "QUOTED_STRING"
     levelName =  "QUOTED_STRING"
     levelAttributeLocator =  LEVEL_ATTRIBUTE "levelAttributeName"
     hierarchyName =  "QUOTED_STRING"
     roleName =  "QUOTED_STRING"
     levelAttributeName =  "QUOTED_STRING"

Parameters

retrieveDimensionCommand

This clause retrieves dimension's information: PROPERTIES, DIMENSION_ATTRIBUTES, LEVELS, HIERARCHIES, DIMENSION_ROLES, SEQUENCE, DIMENSION_KEY, COLUMN, SURROGATE_KEY, PARENT_KEY, BUSINESS_KEYS, IMPLEMENTED_OBJECTS.

dimensionName

The name of the dimension in QUOTED_STRING.

propertyKeyList

The list of properties.

getReferenceIconSetClause

This clause gets the reference to iconsets.

dimensionAttributeDetailClause

This clause gets dimension attribute details.

levelDetailClause

This clause gets the details of levels: PROPERTIES, LEVEL_ATTRIBUTES, IMPLEMENTED_OBJECT.

hierarchyDetailClause

This clause gets the details of hierarchy: PROPERTIES, LEVELS, SKIP_LEVELS.

roleDetailClause

This clause gets the details of a role: PROPERTIES, DIMENSION

propertyKey

The name of the property key in UNQUOTED_STRING

propertyKey

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

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

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

Name: SCD_TYPE
Type: INTEGER
Valid Values: 1, 2, 3
Default: 1
Slowly changing policy to be applied on the dimension. Give Interger values 1, 2, 3
for Slowly changing type one, two and three

Name: LOAD_POLICY_FOR_NULL_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_PARENT'
Default: 'NO_MAINTENANCE'
Data policy for loading dimension where OWB mapping code relies on
database constraints to detect the orphans (null parent references).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally an error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_PARENT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

Name: LOAD_POLICY_FOR_INVALID_KEY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'NO_MAINTENANCE_WITH_ERROR_TABLE', 'REJECT', 'DEFAULT_PARENT'
Default: 'NO_MAINTENANCE'
Data policy for loading dimension where OWB mapping code relies on
database constraints to detect the orphans (could contain a value that is not actually found in the parent).
'NO_MAINTENANCE', OWB does not actively enforce the parentage integrity rule that requires every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally an error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and reject them.
'DEFAULT_PARENT', the policy for loading dimension where OWB mapping code will actively detect the orphans (level records without parent) and assign them under default parent.

Name: REMOVE_POLICY
Type: STRING
Valid Values: 'NO_MAINTENANCE', 'REJECT'
Default: 'NO_MAINTENANCE'
Data policy for remove dimension data where OWB relies on database
constraints to detect removal of parent records who still have child records.
'NO_MAINTENANCE', does not actively enforce the parentage integrity rule that requires
every child record to have a parent.
'NO_MAINTENANCE_WITH_ERROR_TABLE', Same as NO_MAINTENANCE, and additionally an error table will be deployed, thus orphan management can be switched on at the map level.
'REJECT', data policy for loading dimension where OWB mapping code will actively
reject the removal of parent records who still have child records.
#'CASCADE', data policy for removing dimension data where OWB mapping code will
#actively detect the removal of parent records who still have child records,
#and remove all of the descendents.

propertyKey

Name: TYPE
Type: STRING
Valid Values: NONE, TIME
Default: NONE
'NONE'  it does not recognize it as any specific type of dimension.
'TIME' dimension is a time dimension

Name: OLAP_TYPE
Type: STRING
Valid Values: NONE, TIME
Default: NONE
Dimension type for OLAP, set regular dimension 'NONE' and for OLAP Time Dimension 'TIME'

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The dimension is visible to OLAP end user

Name: UNIQUE_KEY_CONSTRAINT
Type: STRING
Valid Values: true, false
Default: false
set the Unique Key constraint on the Business Key

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

Name: AW_NAME
Type: STRING(32)
Valid Values: 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

Name: USE_BUSINESS_KEYS
Type: STRING
Valid Values: true, false
Default: false
get the flag of Analytical Workspace dimension to use Business Keys as data source

propertyKey

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
Description of the Dimension_Attribute

Name: DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH TIME ZONE, TIMESTAMP WITH LOCAL TIME ZONE, VARCHAR, VARCHAR2
Default: NUMBER
Sets the datatype of a Dimension_Attribute

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

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

Name: PRECISION
Type: NUMBER
Valid Values: 0 - 39
Default: 1
The precision of a number.

Name: DESCRIPTOR
Type: STRING
Valid Values: 'NONE', 'SHORT_DESCRIPTION', 'LONG_DESCRIPTION', 'END_DATE', 'TIME_SPAN', 'PRIOR_PERIOD', 'YEAR_AGO_PERIOD'
Default: 'NONE'
The following properties are set on dimension attribute so that it is recognized by OLAP service
'NONE' it is not specially recognized type by OLAP service
'SHORT_DESCRIPTION' sets as a short description
'LONG_DESCRIPTION' sets as a long description
'END_DATE' sets as a last date of a period.
'TIME_SPAN' sets as a number of days in a period.
'PRIOR_PERIOD' sets as the prior period number.
'YEAR_AGO_PERIOD' sets as the time period a year before this period

propertyKey

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: 'true', 'false'
Default: 'true'
The dimension attribute is visible to OLAP end user

Name: TYPE
Type: STRING
Valid Values: 'NONE', 'START_DATE', 'END_DATE', 'TIME_SPAN'
Default: 'NONE'
'NONE'  dimension attribute so OWB does not recognize it as any specific type.
'START_DATE' dimension attribute of time dimension as the start date of a period
'END_DATE' dimension attribute of time dimension as the end date of a period
'TIME_SPAN' dimension attribute of time dimension as the time span

Name: AW_ATTRIBUTE_NAME
Type: STRING(32)
Valid Values: Any valid character string in supported character set.
Default: Empty string
set the AW object name implementing the dimension attribute
Basic properties for Level :
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Level

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

Name: TYPE
Type: STRING
Valid Values: NONE, DAY, FISCAL_WEEK, FISCAL_MONTH, FISCAL_QUARTER, FISCAL_YEAR, CALENDAR_WEEK, CALENDAR_MONTH, CALENDAR_QUARTER, CALENDAR_YEAR
Default: NONE
For regular relational dimension level (non-time dimension level) use 'NONE'. For Relational Time Dimension use other values.

Name: OLAP_TYPE
Type: STRING
Valid Values: NONE,DAY,MONTH,QUARTER,YEAR,TOTAL
Default: NONE
Level has an olap-type for OLAP-based levels, use 'NONE' for regular levels, and other values for OLAP Time Dimension.

Name: OLAP_USER_VISIBLE
Type: STRING
Valid Values: true, false
Default: true
The level is visible to OLAP end user

propertyKey

coreGetPropertiesForDimension4??

propertyKey

coreGetPropertiesForDimension5??

dimensionAttributeLocator

This clause locates a DIMENSION_ATTRIBUTE.

levelLocator

This clause finds a LEVEL.

levelAttributeDetailClause

This clause gets the details of level attributes: PROPERTIES, DIMENSION_ATTRIBUTE, TYPE_THREE_SCD_PREVIOUS, LEVEL_ATTRIBUTE, TYPE_THREE_SCD_CURRENT, IMPLEMENTED, COLUMN

levelRelationshipDetailClause

This clause gets details of LEVEL_RELATIONSHIP, IMPLEMENTED, COLUMN, PROPERTIES.

skipLevelRelationshipDetailClause

This clause gets the details of skip level relationship: PARENT, LEVEL, IMPLEMENTED, COLUMN, PROPERTIES

hierarchyLocator

This clause finds a HIERARCHY.

roleLocator

This clause finds a DIMENSION_ROLE.

dimensionAttributeName

The name of the dimension attribute in QUOTED_STRING.

levelName

The name of a level in QUOTED_STRING.

levelAttributeLocator

This clause finds the LEVEL_ATTRIBUTE.

hierarchyName

The name of the hierarchy as a QUOTED_STRING.

roleName

The name of the role as a QUOTED_STRING.

levelAttributeName

The name of the level attribute as a QUOTED_STRING.

DIMENSION Object

Table 18-11 DIMENSION Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE

OMBCREATE DIMENSION

OMBALTER DIMENSION

OMBDROP DIMENSION

OMBRETRIEVE DRILL_PATH

Purpose

Retrieve details of a Drill Path.

Prerequisites

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

Syntax

retrieveDrillPathCommand =  OMBRETRIEVE DRILL_PATH "QUOTED_STRING"
          "retrieveDrillPathClauseDetails"
     retrieveDrillPathClauseDetails =  ( "retrieveDrillLevelClause" | GET (
          "getPropertiesClause" | "getReferenceIconSetClause" | DRILL_LEVELS |
          DEFAULT_ROOT DRILL_LEVEL | ROOT DRILL_LEVELS | ( REF | REFERENCE )
          HIERARCHY | ( REF | REFERENCE ) DIMENSION | ( REF | REFERENCE ) ROLE |
           DEPENDENTS | ( REF | REFERENCE ) CATALOG_FOLDERS ) )
     retrieveDrillLevelClause =  DRILL_LEVEL "QUOTED_STRING" (
          "retrieveDrillLevelKeyClause" | GET ( "getPropertiesClause" | ( REF |
          REFERENCE ) ITEMS | USING JOINS | ( REF | REFERENCE ) LEVEL | CHILDREN
           | PARENTS | DRILL_LEVEL_KEYS ) )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     retrieveDrillLevelKeyClause =  DRILL_LEVEL_KEY "QUOTED_STRING" ( GET (
          "getPropertiesClause" | ( REF | REFERENCE ) ITEMS ) )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveDrillPathCommand

Retrieves the drill path.

QUOTED_STRING

name of the drill path.

retrieveDrillPathClauseDetails

This clause retrieves the contents of a drill path.

retrieveDrillLevelClause

Retrieves a specific drill level.

QUOTED_STRING

name of the drill level.

GET

For drill level this clause retrieves the following

REF ITEMS retrieves the list of Items referenced by this Drill Level.

REF USING JOINS retrieves the list of Joins used to join the Item Folder containing Items in this Drill Level to the Item Folder containing Items in the parent Drill Level.

REF LEVEL retrieves the dimensional Level corresponding to the Drill Level.

CHILDREN retrieves the child Drill Levels.

getPropertiesClause

Retrieves the properties of the object.

getPropertiesClause

Basic properties for DRILL_PATH:

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

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

Name: TIMEDIMENSION
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the drill path represents a time dimension. Oracle Business Intelligence Modules (OBIEE) only

Basic properties for DRILL_LEVEL:

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

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

Name: DEFAULT_ROOT_LEVEL
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level is a default root. Oracle Business Intelligence Modules (OBIEE) only

Name: GRAND_TOTAL_LEVEL
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level is a grand total level. Oracle Business Intelligence Modules (OBIEE) only

Name: SUPPORTS_ROLLUP
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the level supports rollup to a higher level of aggregation. Oracle Business Intelligence Modules (OBIEE) only

Basic properties for DRILL_LEVEL_KEY (Oracle Business Intelligence (OBIEE):

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

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

Name: PRIMARYKEY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level key is the primary key for the drill level. Oracle Business Intelligence Modules (OBIEE) only

Name: CHRONOLOGICALKEY
Type: BOOLEAN
Valid Values: Y,N
Default: 'N'
Whether the level key is the chronological key for a time dimension. Oracle Business Intelligence Modules (OBIEE) only

Name: USE_FOR_DRILLDOWN
Type: BOOLEAN
Valid Values: Y,N
Default: 'Y'
Whether the level key is used for drill down. Oracle Business Intelligence Modules (OBIEE) only

getReferenceIconSetClause

Get specified Icon Set.

retrieveDrillLevelKeyClause

Retrieves the drill level key of a drill path.

propertyNameList

This is the list of property names.

DRILL_PATH Object

Table 18-12 DRILL_PATH Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER DRILL_PATH

OMBCREATE DRILL_PATH

OMBRETRIEVE DRILL_TO_DETAIL

Purpose

Retrieve details of a Drill to Detail.

Prerequisites

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

Syntax

retrieveDrillToDetailCommand =  OMBRETRIEVE DRILL_TO_DETAIL "QUOTED_STRING"
           "retrieveDrillToDetailClauseDetails"
     retrieveDrillToDetailClauseDetails =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | ( REF | REFERENCE ) ITEMS )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveDrillToDetailCommand

Retrieves the drill to detail.

QUOTED_STRING

name of the drill to detail.

retrieveDrillToDetailClauseDetails

This clause retrieves the contents of a drill to detail.

GET

This clause retrieves the following

REF ITEMS retrieves the list of Items that use this drill to detail.

getPropertiesClause

Retrieves the properties of the object.

getPropertiesClause

Basic properties for DRILL_TO_DETAIL:

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

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

getReferenceIconSetClause

Get specified Icon Set.

propertyNameList

This is the list of property names.

DRILL_TO_DETAIL Object

Table 18-13 DRILL_TO_DETAIL Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER DRILL_TO_DETAIL

OMBCREATE DRILL_TO_DETAIL

19 OMBRETRIEVE EXPERT to OMBRETRIEVE OBIEE_BUSINESS_DEFINITION_MODULE

OMBRETRIEVE EXPERT

OMBRETRIEVE EXPERT_MODULE

OMBRETRIEVE EXTERNAL_TABLE

OMBRETRIEVE FLAT_FILE

OMBRETRIEVE FLAT_FILE_MODULE

OMBRETRIEVE FOLDER

OMBRETRIEVE FUNCTION

OMBRETRIEVE GATEWAY_MODULE

OMBRETRIEVE ICONSET

OMBRETRIEVE IMPORT_ACTION_PLAN

OMBRETRIEVE ITEM_FOLDER

OMBRETRIEVE LIST_OF_VALUES

OMBRETRIEVE LOCATION

OMBRETRIEVE LOGICAL_TABLE

OMBRETRIEVE MAPPING

OMBRETRIEVE MAPPING_MODULE

OMBRETRIEVE MATERIALIZED_VIEW

OMBRETRIEVE MDL_ACTION_PLAN

OMBRETRIEVE MODULE

OMBRETRIEVE NESTED_TABLE

OMBRETRIEVE OBIEE_BUSINESS_DEFINITION_MODULE

OMBRETRIEVE EXPERT

Purpose

To retrieve metadata on an expert.

Prerequisites

In the context of an expert module.

Syntax

retrieveExpertCommand =  OMBRETRIEVE EXPERT "QUOTED_STRING" (
          "retrieveExpertClause" | "retrieveTaskClause" |
          "retrieveTransitionClause" | "retrieveParameterClause" |
          "retrieveVariableClause" )
     retrieveExpertClause =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | "getExpertSCOClauses" )
     retrieveTaskClause =  TASK "QUOTED_STRING" ( GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | PARAMETERS | INCOMING TRANSITIONS |
          OUTGOING TRANSITIONS | ( REF | REFERENCE ) ( EXPERT | CT ) ) |
          "retrieveParameterClause" )
     retrieveTransitionClause =  TRANSITION "QUOTED_STRING" GET (
          "getPropertiesClause" | SOURCE TASK | DESTINATION TASK )
     retrieveParameterClause =  PARAMETER "QUOTED_STRING" GET (
          "getPropertiesClause" | "getBindingClause" )
     retrieveVariableClause =  VARIABLE "QUOTED_STRING" GET
          "getPropertiesClause"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getExpertSCOClauses =  ( TASKS | "TASK_TYPE" TASKS | NESTED_EXPERT TASKS |
          TRANSITIONS | PARAMETERS | VARIABLES )
     getBindingClause =  BOUND ( VARIABLE | PARAMETER )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveExpertCommand

Retrieve definition of the expert.

retrieveExpertClause

Retrieve either the properties or the child object definitions for the expert.

retrieveTaskClause

Retrieve definition of a task.

retrieveTransitionClause

Retrieve definition of a transition.

retrieveParameterClause

Retrieve definition of an expert or a task parameter.

retrieveVariableClause

Retrieve definition of a variable.

getPropertiesClause

Get the values of the specified properties.

getPropertiesClause

Basic properties for EXPERT:

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

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

Basic properties for TASK:

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

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the task.  This is equivalent to the Goal of task in the expert editor.

Name: INSTRUCTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The instruction for the task

Name: PREPROCESSING
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The pre-processing script for the task

Name: MAIN
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The main script for the task

Name: POSTPROCESSING
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
The post-processing script for the task

Basic propeties for START TASK:

Name: PROC_DECL
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
The procedure declaration for the expert.

Basic properties for TRANSITION:

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

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

Name: TRANSITION_CONDITION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Condition of the transition

Name: TRANSITION_ORDER
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: N/A
Order of the transition

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: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the parameter

Name: DIRECTION
Type: STRING
Valid Values: IN, OUT, INOUT
Default: IN
Direction of the parameter.
Direction of custom expert parameter can only be IN or OUT.
For some tasks, direction of custom parameter can be IN, OUT or INOUT.

Name: VALUE
Type: Same as datatype of the parameter
Valid Values: Any valid character string in supported character set.
Default: N/A
The static value of the parameter

Basic properties for VARIABLE:

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

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

Name: DATATYPE
Type: STRING
Valid Values: STRING, NUMBER, BOOLEAN, ARRAY
Default: STRING
Datatype of the variable

Name: VALUE
Type: Same as datatype of the variable
Valid Values: Any valid character string in supported character set.
Default: N/A
The static value of the variable

getReferenceIconSetClause

Retrieve the icon set referenced by this expert module.

getExpertSCOClauses

Get a list of child object of the specified type for the expert.

getBindingClause

Get the bound variable or parameter.

propertyNameList

The list of property names.

EXPERT Object

Table 19-1 EXPERT Object

Property
Type
Choices
Min
Max
Default
Description

CLOSE_ASSISTANT_ON_COMPLETION

BOOLEAN

true, false

none

none

true

Sets whether the task assistant should be automatically closed after the expert has been run.

CLOSE_WINDOWS_ON_EXECUTION

BOOLEAN

true, false

none

none

true

Close all open windows when this expert is run.

FINISH_DIALOG_ON_COMPLETION

BOOLEAN

true, false

none

none

true

Shows the finish dialog upon completion of expert.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

LOGGING

BOOLEAN

true, false

none

none

false

MENU_ITEM_DISPLAY_STRING

STRING

none

none

none

empty string

The display string when this expert is added as a menu item.

ONLY_RUN_FROM_MENU

BOOLEAN

true, false

none

none

false

Only allow this expert to be run when it is attached to a menu item.

REVERT_TO_SAVED_ON_ERROR

BOOLEAN

true, false

none

none

false

Revert to saved metadata if error occurs when the expert is run.

RUN_STANDALONE

BOOLEAN

true, false

none

none

true

Sets whether the expert should be run as a standalone in expert assistant mode or not.

SAVE_ALL_BEFORE_START

BOOLEAN

true, false

none

none

false

Save all metadata before running the expert.

SHOW_BUSY_DIALOG

BOOLEAN

true, false

none

none

true

Sets whether busy dialog should be shown when OMB or Java tasks are executed in non-standalone mode.

SHOW_LOG_WINDOW

BOOLEAN

true, false

none

none

false

Sets whether the log window should be shown when running the expert.

SHOW_PROGRESS_GRAPH

BOOLEAN

true, false

none

none

true

Sets whether the progress graph dialog should be shown when running the expert.

SHOW_TASK_ASSISTANT

BOOLEAN

true, false

none

none

true

Sets whether the task assistant should be shown when running the expert.

See Also

OMBRETRIEVE

OMBCREATE EXPERT

OMBALTER EXPERT

OMBDROP EXPERT

OMBRETRIEVE EXPERT_MODULE

Purpose

To retrieve metadata on an expert module.

Prerequisites

In the context of a project.

Syntax

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

Parameters

retrieveExpertModuleCommand

Retrieve definition of an expert module.

getPropertiesClause

Get the values of the specified properties.

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

getReferenceIconSetClause

Retrieve the icon set referenced by this expert module.

propertyNameList

The list of property names to get.

See Also

OMBRETRIEVE

OMBRETRIEVE EXTERNAL_TABLE

Purpose

Retrieve details of an external table.

Prerequisites

Should be in the context of an Oracle module.

Syntax

retrieveExternalTableCommand =  OMBRETRIEVE EXTERNAL_TABLE "QUOTED_STRING"
          ( "retrieveExternalTableClause" | "retrieveExternalTableColumnClause"
          | "retrieveExternalTableDatafileClause" |
          "retrieveDataRuleUsageClause" )
     retrieveExternalTableClause =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | "getExternalTableObjectsClause" )
     retrieveExternalTableColumnClause =  COLUMN "QUOTED_STRING" GET (
          "getPropertiesClause" | FIELD )
     retrieveExternalTableDatafileClause =  DATA_FILE "QUOTED_STRING" GET
          "getPropertiesClause"
     retrieveDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" ( GET (
          "getPropertiesClause" | GROUPS ) | GROUP "QUOTED_STRING" ( GET (
          "getPropertiesClause" | ATTRIBUTES | REF ( TABLE | VIEW |
          MATERIALIZED_VIEW | EXTERNAL_TABLE ) ) | ATTRIBUTE "QUOTED_STRING" (
          GET ( "getPropertiesClause" | REF COLUMN ) ) ) )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getExternalTableObjectsClause =  COLUMNS | FLAT_FILE | RECORD |
          DEFAULT_LOCATION | DATA_FILES | COLUMN AT POSITION "INTEGER_LITERAL" |
           DATA_RULE_USAGES
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveExternalTableCommand

Retrieve details from an external table.

QUOTED_STRING

The name of the external table.

retrieveExternalTableClause

Retrieve details from an external table.

retrieveExternalTableColumnClause

Retrieve details from an external table column.

retrieveExternalTableDatafileClause

Retrieve details from one of the external table's data files.

retrieveDataRuleUsageClause

This clause retrieves the data rule usages.

QUOTED_STRING

Name of data rule usage, group or attribute.

GROUPS

Retrieve the names of all relation groups in the data rule usage.

ATTRIBUTES

Retrieve the names of all attributes in a data rule usage group.

TABLE

Table name associated withthe data rule usage group.

VIEW

View name associated withthe data rule usage group.

MATERIALIZED_VIEW

Materialized view name associated with the data rule usage group.

EXTERNAL_TABLE

External table name associated with the data rule usage group.

COLUMN

Column name associated with the data rule usage group attribute.

getPropertiesClause

Retrieve specified properties.

getReferenceIconSetClause

Get specified Icon Set.

getExternalTableObjectsClause

Retrieve a record reference, flat file reference, columns, or data files.

propertyNameList

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

propertyNameList

propertyNameList

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: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2
Default: NUMBER
The datatype of a column

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

Name: PRECISION
Type: NUMBER
Valid Values: 0 - 38
Default: 1
The precision of a number. Use 0 to specify floating-point numbers.

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

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

EXTERNAL_TABLE Object

Table 19-2 EXTERNAL_TABLE Object

Property
Type
Choices
Min
Max
Default
Description

BAD_FILE_LOCATION

STRING

none

none

none

USE_DEFAULT_LOCATION

BAD_FILE_NAME

STRING

none

none

none

empty string

CONFIGURATION_DEFAULT_LOCATION

STRING

none

none

none

empty string

Customized location default within each configuration of an external table. If not defined, overall default location of an external table is used.

DEPLOYABLE

BOOLEAN

true, false

none

none

true

Description not available.

DISCARD_FILE_LOCATION

STRING

none

none

none

USE_DEFAULT_LOCATION

DISCARD_FILE_NAME

STRING

none

none

none

empty string

ENDIAN

STRING

BIG, LITTLE, PLATFORM

none

none

PLATFORM

Description not available.

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string

Description not available.

ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string

Description not available.

GENERATE_ERROR_TABLE_ONLY

BOOLEAN

true, false

none

none

false

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

LOAD_NULLS_WHEN_MISSING_VALUES

BOOLEAN

true, false

none

none

false

Description not available.

LOG_FILE_LOCATION

STRING

none

none

none

USE_DEFAULT_LOCATION

LOG_FILE_NAME

STRING

none

none

none

empty string

The name of the file that will store the log messages

NLS_CHARACTERSET

STRING

none

none

none

empty string

NLS Characterset of the file. When the Access Parameters property is specified for the External Table, this configuration parameter is ignored.

NUMBER_OF_REJECTS_ALLOWED

NUMBER

none

0

2147483647

0

Description not available.

PARALLEL_ACCESS_DRIVERS

NUMBER

none

1

63999

1

Description not available.

PARALLEL_ACCESS_MODE

BOOLEAN

true, false

none

none

false

Description not available.

REJECTS_ARE_UNLIMITED

BOOLEAN

true, false

none

none

true

Description not available.

STRING_SIZES_IN

STRING

BYTES, CHARACTERS

none

none

BYTES

Description not available.

TRIM

STRING

BOTH, LEFT, NONE, RIGHT, SQL*LOADER

none

none

NONE

See Also

OMBRETRIEVE

OMBCREATE EXTERNAL_TABLE

OMBALTER EXTERNAL_TABLE

OMBDROP EXTERNAL_TABLE

OMBRETRIEVE FLAT_FILE

Purpose

Retrieve details of a flat file.

Prerequisites

Create and change context to a flat file module.

Syntax

retrieveFlatFileCommand =  OMBRETRIEVE FLAT_FILE "QUOTED_STRING" (
          "retrieveFlatFileClause" | "retrieveFlatFileObjectsClause" )
     retrieveFlatFileClause =  GET ( "getPropertiesClause" | "getRecordsClause"
          | "getReferenceIconSetClause" )
     retrieveFlatFileObjectsClause =  RECORD "QUOTED_STRING" ( ( GET
          "getPropertiesClause" ) | "getFieldsClause" | "retrieveFieldClause" )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getRecordsClause =  RECORDS
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getFieldsClause =  GET FIELDS
     retrieveFieldClause =  "getFieldByNameClause" | "getFieldAtPositionClause"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     getFieldByNameClause =  FIELD "QUOTED_STRING" GET "getPropertiesClause"
     getFieldAtPositionClause =  GET FIELD AT POSITION "INTEGER_LITERAL"

Parameters

retrieveFlatFileCommand

Retrieve the details of a flat file.

QUOTED_STRING

The name of a flat file in quotes.

retrieveFlatFileClause

Retrieve properties of the flat file.

retrieveFlatFileObjectsClause

Retrieve details of the flat file's records and fields.

getPropertiesClause

Retrieve specified properties from the flat file, record, or field.

getRecordsClause

Retrieve a list of records from the flat file.

getReferenceIconSetClause

Get the referenced icon set

getFieldsClause

Retrieve a list of fields from the record.

retrieveFieldClause

Identify a specific field to retrieve properties from.

propertyNameList

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

propertyNameList

Properties for FLAT_FILE:

Name: DATA_FILE_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default ''
The name of the "sampled" file.  Also the default data file value used in SQL*Loader maps and External Tables.

Name: IS_DELIMITED
Type: BOOLEAN
Valid Values: true, false, 1, 0
Default: true
True indicates that this flat file is delimited.  False indicates that its fields are defined by fixed lengths

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

Name: RECORD_DELIMITER
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The character(s) which denote the end of a physical record in a data file.  A hex value may be entered by entering embedded single quotes twice as:   'x''0f''' (all are single quotes).  The outside single quote indicates a quoted string and the inside single quotes  single-quote  x  single-quote single-quote   0F  single-quote single-quote single-quote.  (Please note that this is not the FIELD_DELIMITER.

Name: RECORD_LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0 (Records are delimited by default)
The length (in characters) of the records in the data file.

Name: RECORD_TYPE_COLUMN_NUMBER
Type: NUMBER
Valid Values: 0+
Default: 0
The column which contains the record type values for a delimited, multi-record type file.

Name: RECORD_TYPE_START_POSITION
Type: NUMBER
Valid Values: 0+
Default: 0
The starting position of the field (relative to 0) which contains the record type values for a fixed-length, multi-record type file.

Name: RECORD_TYPE_END_POSITION
Type: NUMBER
Valid Values: 0+
Default: 0
The ending position of the field (relative to 0) which contains the record type values for a fixed-length, multi-record type file.

propertyNameList

Name: NUMBER_OF_RECORDS_TO_SKIP
Type: NUMBER
Valid Values: 0 - 1000
Default: 0
The default number of records to skip when loading this file.

Name: FIELD_DELIMITER
Type: STRING
Valid Values: Any single character
Default: ',' (Comma)
The character to divide the fields in a delimited file.

Name: FIELD_LEFT_ENCLOSURE
Type: STRING
Valid Values: Any single character
Default: None
A character to enclose fields which may contain the field delimiter.

Name: FIELD_RIGHT_ENCLOSURE
Type: STRING
Valid Values: Any single character
Default: None
A character to enclose fields which may contain the field delimiter.

Name: NUMBER_OF_PHYSICAL_RECORDS_PER_LOGICAL
Type: Number
Valid Values: 0+
Default: 0
Set this value if you wish to concatenate a fixed number of physical records to form a single logical record.

Name: CONTINUE_IF_ENDS_WITH
Type: STRING
Valid Values: Any single character
Default: None
Set this value if you wish to concatenate a variable number of physical records to form a single logical record, determined by records ending with this character.

Name: CONTINUE_IF_STARTS_WITH
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: None
Set this value if you wish to concatenate a variable number of physical records to form a single logical record, determined by records beginning with this character.

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

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

Properties for RECORD:

Name: RECORD_TYPE_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: None
This is a mandatory property for each record of a multi-record type file.  It is the string which will identify this record type in the data file.

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

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

Properties for FIELD:

Name: DATATYPE
Type: STRING
Valid Values: BYTEINT, CHAR, DATE, DECIMAL, DECIMAL EXTERNAL, DOUBLE, FLOAT, FLOAT EXTERNAL, GRAPHIC, GRAPHIC EXTERNAL, INTEGER, INTEGER EXTERNAL, INTEGER UNSIGNED, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, LONG VARRAW, RAW, SMALLINT, SMALLINT UNSIGNED, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARCHAR, VARCHARC, VARRAW, VARRAWC, ZONED, ZONED EXTERNAL
Default: CHAR
This is the SQL*Loader data type for the field.

Name: MAXIMUM_LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0
This is the maximum length of the field.

Name: LENGTH
Type: NUMBER
Valid Values: 0+
Default: 0
Depreciated.  This is the length of the field in a fixed length file.  This is the max length of the field in a delimited file.

Name: PRECISION
Type: NUMBER
Valid Values: Depends on data type
Default: 0
Precision of the field.

Name SCALE
Type: NUMBER
Valid Values: Depends on data type
Default: 0
Scale of the field

Name: START_POSITION
Type: NUMBER
Valid Values: 1+
Default: 1
The starting position of a field for a fixed length file.

Name: END_POSITION
Type: NUMBER
Valid Values: 1+
Default: 1
The ending position of a field for a fixed length file.

propertyNameList

Name: SQL_DATATYPE
Type: STRING
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: DEFAULT.  This will derive the SQL_DATATYPE from the value of DATATYPE.
The data type which the field will be treated as in mapping and for External Tables.

Name: SQL_LENGTH
Type: NUMBER
Valid Values: 1 - 4000
Default: 0

Name: SQL_PRECISION
Type: NUMBER
Valid Values: 1 - 38
Default: 1

Name: SQL_SCALE
Type: NUMBER
Valid Values: -84 - 127
Default: 0

Name: MASK
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: None
This is the mask used to define the format of DATE fields in the data file.

Name: NULL_IF
Type: STRING
Valid Values: Either = or != followed by either 'BLANKS', a single quoted string, or a hexadecimal string
Default: None
If this condition is true for a field, the value loaded will be NULL.

Name: DEFAULT_IF
Type: STRING
Valid Values: Either = or != followed by either 'BLANKS', a single quoted string, or a hexadecimal string
Default: None
If this condition is true for a field, the value loaded will be either NULL or 0, dependent on data type.

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

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

getFieldByNameClause

Identify a specific field by its name.

getFieldAtPositionClause

Identify a specific field by its position in the record.

See Also

OMBRETRIEVE

OMBRETRIEVE FLAT_FILE_MODULE

Purpose

Retrieve details from a flat file module.

Prerequisites

Should be in the context of a project.

Syntax

retrieveFlatFileModuleCommand =  OMBRETRIEVE FLAT_FILE_MODULE
          "QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause"
           | "getReferenceDefaultLocationClause" |
          "getReferenceMetadataLocationClause" | "getReferenceIconSetClause" |
          "getReferenceLocationsClause" | "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

retrieveFlatFileModuleCommand

Retrieve details from a flat file module.

QUOTED_STRING

The name of the flat file module to retrieve details from.

getPropertiesClause

Retrieve specified property values from the flat file module.

getReferenceLocationClause

Retrieve the 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 flat file module.

getReferenceIconSetClause

Retrieve the icon set referenced by this flat file module.

getReferenceLocationsClause

Retrieve all of the data locations referenced by this module.

propertyNameList

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

propertyNameList

Basic properties for FLAT_FILE_MODULE:

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

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

See Also

OMBRETRIEVE

OMBRETRIEVE FOLDER

Purpose

Retrieve details of the folder.

Prerequisites

Should be in the context of a module (Oracle, Non-Oracle, Aplications, Process Flow types) or folder.

Syntax

retrieveUserFolderCommand =  OMBRETRIEVE FOLDER "QUOTED_STRING" ( GET ( (
          "getContainedObjClause" | "propertiesClause" ) ) |
          "getReferenceIconSetClause" )+
     getContainedObjClause =  CONTAINED_OBJECT "UNQUOTED_STRING"
     propertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveUserFolderCommand

This command retrieves the details of a folder.

QUOTED_STRING

Name of the existing folder.

getContainedObjClause

Retrieve the list of the folder's contained objects - all or by type.

propertiesClause

Retrieve a set of properties that is associated with a folder.

propertiesClause

Basic properties for FOLDER:

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

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

getReferenceIconSetClause

Retrieve the icon set referenced by this folder.

propertyNameList

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

See Also

OMBLIST

OMBRETRIEVE FUNCTION

Purpose

Retrieve details of the Function.

Prerequisites

Should be in the context of a Oracle Module or Package or Transformation Module.

A Transformation Module may be WB_CUSTOM_TRANS for Public Transformations or WB_PREDEFINED_TRANS for Predefined Transformations.

WB_CUSTOM_TRANS may by modified by an administrator. WB_PREDEFINED_TRANS may not be modified.

WB_CUSTOM_TRANS and WB_PREDEFINED_TRANS are not dependent on any project.

Syntax

retrieveFunctionCommand =  OMBRETRIEVE FUNCTION "QUOTED_STRING" (
          "getPropertiesClause" | "getFuncProcParameterClause" |
          "getFuncProcParameterPositionClause" | "getFuncProcSignatureClause" |
          "retrieveFuncProcParameterClause" | "getFuncProcImplementationClause"
          | "retrieveFuncProcImplementationClause" |
          "getFuncProcCodeTemplateClause" | "retrieveFuncProcCodeTemplateClause"
           | "getRelationalDependentsClause" | "getReferenceIconSetClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getFuncProcParameterClause =  GET PARAMETERS
     getFuncProcParameterPositionClause =  GET PARAMETER AT POSITION
          "INTEGER_LITERAL"
     getFuncProcSignatureClause =  GET SIGNATURE
     retrieveFuncProcParameterClause =  PARAMETER "QUOTED_STRING"
          "getPropertiesClause"
     getFuncProcImplementationClause =  GET FUNCTION_IMPLEMENTATIONS
     retrieveFuncProcImplementationClause =  FUNCTION_IMPLEMENTATION
          "QUOTED_STRING" "getFuncImplPropertiesClause"
     getFuncProcCodeTemplateClause =  GET CODE_TEMPLATES
     retrieveFuncProcCodeTemplateClause =  GET CODE_TEMPLATE FOR PLATFORM
          "QUOTED_STRING" OPTIONS "(" "propertyNameList" ")"
     getRelationalDependentsClause =  GET ( REF | REFERENCE ) ( TABLES | VIEWS |
           MATERIALIZED_VIEWS | SEQUENCES | FUNCTIONS | PROCEDURES | PACKAGES )
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     getFuncImplPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"

Parameters

retrieveFunctionCommand

This command retrieves the details of a Function

QUOTED_STRING

Name of the existing Function or path to the Function.

getPropertiesClause

Used to get properties (core, user-defined) for function. Valid properties are 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

getFuncProcParameterClause

Get all the parameter names of the Function

getFuncProcParameterPositionClause

Get the parameter position of Function

getFuncProcSignatureClause

Get the complete signature of the Function which includes parameter names, datatype, in/out type and default values

retrieveFuncProcParameterClause

Get the parameter information such as datatype, default value, in/out type and position

QUOTED_STRING

Name of the existing Parameter

getFuncProcImplementationClause

Used to get all implementations of current function.

retrieveFuncProcImplementationClause

Used to retrieve an implementation of current function by implementation name.

getRelationalDependentsClause

This clause retrieves referential dependencies to other relational objects.

getReferenceIconSetClause

Used to get function reference icon set.

propertyNameList

Comma separated list of property names. Property names are unquoted.

getFuncImplPropertiesClause

Used to retrieve function implementation properties.

FUNCTION Object

Table 19-3 FUNCTION Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE

OMBRETRIEVE GATEWAY_MODULE

Purpose

Retrieve details of a gateway module.

Prerequisites

Should be in the context of project.

Syntax

retrieveGatewayModuleCommand =  OMBRETRIEVE GATEWAY_MODULE "QUOTED_STRING"
          ( "getPropertiesClause" | "getReferenceLocationClause" |
          "getReferenceDefaultLocationClause" |
          "getReferenceMetadataLocationClause" | "getReferenceIconSetClause" |
          "getReferenceLocationsClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceLocationClause =  GET ( REF | REFERENCE ) LOCATION
     getReferenceDefaultLocationClause =  GET ( REF | REFERENCE ) DEFAULT
          LOCATION
     getReferenceMetadataLocationClause =  GET ( REF | REFERENCE )
          METADATA_LOCATION
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     getReferenceLocationsClause =  GET ( REF | REFERENCE ) LOCATIONS
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveGatewayModuleCommand

Specify the gateway module from which to retrieve details.

getPropertiesClause

Retrieve the properties of a gateway module.

getPropertiesClause

Basic properties for GATEWAY_MODULE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the gateway module

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the gateway module

Name: GATEWAY_TYPE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
Type of gateway 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 gateway module.

getReferenceLocationsClause

Retrieve all of the data locations referenced by this module.

propertyNameList

A list of property names.

See Also

OMBRETRIEVE

OMBRETRIEVE ICONSET

Purpose

To retrieve the properties of an iconset.

Prerequisites

Any context.

Syntax

retrieveIconSetCommand =  OMBRETRIEVE ICONSET "QUOTED_STRING" GET
          "getPropertiesClause"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveIconSetCommand

This command retrieves the properties of an iconset.

QUOTED_STRING

The name of the iconset to retrive.

getPropertiesClause

This clause gets the values for a list of properties.

getPropertiesClause

Basic properties for ICONSET:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the iconset

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the iconset

Name: BELONGS_TO_GROUP
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Name of the Group to which the iconset belongs

Name: CANVAS_ICON
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
URL of the canvas icon (36x36)

Name: PALETTE_ICON
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
URL of the palette icon (18x18)

Name: TREE_ICON
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
URL of the tree icon (16x16)

propertyNameList

The list of properties.

See Also

OMBCREATE ICONSET

OMBALTER ICONSET

OMBDROP ICONSET

OMBLIST ICONSETS

OMBRETRIEVE IMPORT_ACTION_PLAN

Purpose

To display the details of a transient import action plan.

Prerequisites

In the context of a project.

Syntax

retrieveImportActionPlanCommand =  OMBRETRIEVE ( IMPORT_ACTION_PLAN )
          "QUOTED_STRING" ( "getActionsClause" | "retrieveActionClause" )
     getActionsClause =  GET ACTIONS
     retrieveActionClause =  ACTION "QUOTED_STRING" GET ( "getPropertiesClause"
          | "getRefSourceOrTargetClause" )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getRefSourceOrTargetClause =  ( REF | REFERENCE ) ( SOURCE | TARGET )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveImportActionPlanCommand

This command is for displaying details in an import action plan.

QUOTED_STRING

The name of the import action plan to be accessed.

getActionsClause

For listing actions in the import action plan.

retrieveActionClause

For displaying information of an action in the import action plan.

QUOTED_STRING

The name of the action to be accessed.

getPropertiesClause

For retrieving properties associated with the action. For the current release, there are no predefined properties for import actions.

See Also

OMBCREATE IMPORT_ACTION_PLAN

OMBIMPORT

OMBRETRIEVE ITEM_FOLDER

Purpose

Retrieve details of an item folder.

Prerequisites

Should be in the context of a Business Definition Module or use the full path.

Syntax

retrieveItemFolderCommand =  OMBRETRIEVE ITEM_FOLDER "QUOTED_STRING" (
          "retrieveItemFolderClause" | "retrieveItemFolderItemClauseIF" |
          "retrieveItemFolderJoinClause" | "retrieveItemFolderConditionClause" )
     retrieveItemFolderClause =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | "getItemFolderSCOClause" )
     retrieveItemFolderItemClauseIF =  ITEM "QUOTED_STRING" GET (
          "getPropertiesClause" | SOURCE_OBJECTS | ( REF | REFERENCE ) DEFINING
          LISTS_OF_VALUES | ( REF | REFERENCE ) DEFINING ALTERNATIVE_SORT_ORDERS
           | ( REF | REFERENCE ) ORDERED ALTERNATIVE_SORT_ORDERS | ( REF |
          REFERENCE ) LIST_OF_VALUES | ( REF | REFERENCE ) DRILL_TO_DETAIL | (
          REF | REFERENCE ) ALTERNATIVE_SORT_ORDER | ( REF | REFERENCE )
          DRILL_LEVELS | ( REF | REFERENCE ) LOCAL JOINS | ( REF | REFERENCE )
          REMOTE JOINS )
     retrieveItemFolderJoinClause =  JOIN "QUOTED_STRING" (
          "retrieveItemFolderJoinComponentClause" | GET ( "getPropertiesClause"
          | JOIN_COMPONENTS | ( REF | REFERENCE ) FOREIGN_KEY | ( REF |
          REFERENCE ) ITEM_FOLDERS | ( REF | REFERENCE ) REMOTE ITEM_FOLDER ) )
     retrieveItemFolderConditionClause =  CONDITION "QUOTED_STRING" GET
          "getPropertiesClauseforCondition"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getItemFolderSCOClause =  ITEMS | JOINS | CONDITIONS | SOURCE_OBJECTS |
          DERIVATION_SOURCE | USING JOINS | ( REF | REFERENCE ) BUSINESS_AREAS |
           ( 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 )
     getPropertiesClauseforCondition =  PROPERTIES "("
          "propertyNameListforCondition" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyNameListforCondition =  ( "UNQUOTED_STRING" | CONDITION ) { "," (
          "UNQUOTED_STRING" | CONDITION ) }

Parameters

retrieveItemFolderCommand

To retrieve an item folder.

QUOTED_STRING

name of the item folder.

retrieveItemFolderClause

This clause retrieves the contents of an item folder.

GET

For an item folder, this clause retrieves the following

ITEMS retrieves the items in the item folder.

JOINS retrieves the joins in the item folder.

CONDITIONS retrieves the conditions in the item folder.

SOURCE_OBJECTS retrieves the objects the item folder is based on.

DERIVATION_SOURCE retrieves the source object derived into this item folder.

REF USING JOINS retrieves the join usages for the item folder.

REF BUSINESS_AREAS retrieves the business areas the item folder belongs to.

REF ROLE retrieves the dimension use reference for the item folder.

REF LEVEL retrieves the level reference for the item folder.

DEPENDENTS retrieves the dependents for the item folder.

retrieveItemFolderItemClauseIF

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 LIST_OF_VALUES retrieves the List of Values associated with the item.

REF DRILL_TO_DETAIL retrieves the Drill to Detail associated with the item.

REF ALTERNATIVE_SORT_ORDER retrieves the Alternative Sort Order associated with the item.

REF DEFINING LISTS_OF_VALUES retrieves a list of Lists of Values that use this Item to define their values.

REF DEFINING ALTERNATIVE_SORT_ORDERS retrieves a list of Alternative Sort Orders that use this Item to define their values.

REF ORDERED ALTERNATIVE_SORT_ORDERS retrieves a list of Alternative Sort Orders that use this Item to define their order.

REF DRILL LEVELS retrieves the list of Drill Levels that reference this Item.

REF LOCAL JOINS retrieves the list of Join Components that reference this Item as their local Item.

REF REMOTE JOINS retrieves the list of Join Components that reference this Item as their remote Item.

retrieveItemFolderJoinClause

Retrieves a specific join.

QUOTED_STRING

name of the join.

GET

For join this clause retrieves the following

JOIN_COMPONENTS retrieves the list of Join Components of this Join.

REF FOREIGN_KEY retrieves the foreign key associated with this join.

REF ITEM_FOLDERS retrieves the list of complex Item Folders that use this Join to join their component Item Folders.

retrieveItemFolderConditionClause

Retrieves a specific condition.

QUOTED_STRING

name of the condition.

getPropertiesClause

Retrieves the properties of the object.

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.

getItemFolderSCOClause

Retrieves the contents of the item folder.

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.

getPropertiesClauseforCondition

Gets the properties of a condition.

propertyNameList

This is the list of property names.

propertyNameListforCondition

Names of the condition properties.

ITEM_FOLDER Object

Table 19-4 ITEM_FOLDER Object

Property
Type
Choices
Min
Max
Default
Description

DB_LOCATION

STRING

none

none

none

empty string

Location for the referenced database object

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

EXTERNAL_TABLE_NAME

STRING

none

none

none

empty string

The physical name for the corresponding table or view.

OBJECT_TYPE

STRING

none

none

none

empty string

OPTIMIZER_HINT

STRING

none

none

none

empty string

Optimizer Hint to be added when this Item Folder is used in a query

VISIBLE

BOOLEAN

true, false

none

none

false

Whether this object is visible for use in query definitions.

See Also

OMBALTER ITEM_FOLDER

OMBCREATE ITEM_FOLDER

OMBRETRIEVE LIST_OF_VALUES

Purpose

Retrieve details of a List Of Values.

Prerequisites

Should be in the context of a Business Definition Module or use the full path.

Syntax

retrieveListOfValuesCommand =  OMBRETRIEVE LIST_OF_VALUES "QUOTED_STRING"
          "retrieveListOfValuesClauseDetails"
     retrieveListOfValuesClauseDetails =  GET (
          "getPropertiesClauseforLOVandD2D" | "getReferenceIconSetClause" | (
          REF | REFERENCE ) DEFINING ITEM | ( REF | REFERENCE ) ITEMS |
          DEPENDENTS )
     getPropertiesClauseforLOVandD2D =  PROPERTIES "("
          "propertyNameListforLOVandD2D" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     propertyNameListforLOVandD2D =  ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) {
          "," ( "UNQUOTED_STRING" | DRILL_TO_DETAIL ) }

Parameters

retrieveListOfValuesCommand

Retrieves the list of values.

QUOTED_STRING

name of the list of values.

retrieveListOfValuesClauseDetails

This clause retrieves the contents of a list of values.

GET

This clause retrieves the following

REF DEFINING ITEM retrieves the Item that holds the individual values for this list of values.

REF ITEMS retrieves the list of Items that use this list of values.

DEPENDENTS retrieves a list of Item Folders that the list of values depends on.

(This will return the Item Folder containing the Values Item).

getPropertiesClauseforLOVandD2D

This clause gets the properties of the object.

getPropertiesClauseforLOVandD2D

Basic properties for LIST_OF_VALUES:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the list of values

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the list of values

Name: DRILL_TO_DETAIL
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether the list of values enables drilling between the item folders containing the items that use the list of values

Name: RETRIEVE_VALUES_GROUP_SIZE
Type: Number
Valid Values: Any valid character string in supported character set.
Default: '100'
The number of rows to be fetched from the database at a time

Name: CACHE_VALUES
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the list of values should be cached in memory

Name: REQUIRE_SEARCH
Type: Boolean
Valid Values: Y,N
Default: 'N'
Whether search criteria should be requested

Name: SHOW_IN_NAVIGATOR
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be shown in the item navigator

Name: SORTED_DISTINCT
Type: Boolean
Valid Values: Y,N
Default: 'Y'
Whether the values should be displayed sorted with duplicates hidden

getReferenceIconSetClause

Get specified Icon Set.

propertyNameListforLOVandD2D

This is the list of property names.

LIST_OF_VALUES Object

Table 19-5 LIST_OF_VALUES Object

Property
Type
Choices
Min
Max
Default
Description

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

OMBALTER LIST_OF_VALUES

OMBCREATE LIST_OF_VALUES

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

Property
Type
Choices
Min
Max
Default
Description

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

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

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER LOGICAL_TABLE

OMBCREATE LOGICAL_TABLE

OMBRETRIEVE MAPPING

Purpose

Retrieve mapping details such as the number of operators and their connections.

Prerequisites

The current context must be in an Oracle Module.

Syntax

retrieveMappingCommand =  OMBRETRIEVE MAPPING "mappingName" (
          "retrieveOperatorOwnerDetailClause" | "testConnectionClause" )
     mappingName =  "QUOTED_STRING"
     retrieveOperatorOwnerDetailClause =  GET ( PROPERTIES "propertyKeyList" |
          "getCodeTemplateClause" | "getControlCodeTemplateClause" |
          "getReferenceIconSetClause" | [ "operatorType" ] OPERATORS [
          "connectionConditionClause" ] | "childType" | "getExecutionUnitClause"
           | "getExecutionUnitDetailClause" ) | VALIDATE_EXPRESSION PROPERTIES
          "propertyKeyList" | "getChildDetailClause" | "operatorLocator"
          "getOperatorDetailClause"
     testConnectionClause =  HAS CONNECTION FROM "mappableBottomUpLocator" TO
          "mappableBottomUpLocator"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     getCodeTemplateClause =  ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS "("
          "optionValueList" ")" | ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS | (
          REF | REFERENCE ) CODE_TEMPLATE
     getControlCodeTemplateClause =  ( REF | REFERENCE ) CONTROL_CODE_TEMPLATE
          OPTIONS "(" "optionValueList" ")" | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE OPTIONS | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     operatorType =  PLUGGABLE_MAPPING | "UNQUOTED_STRING"
     connectionConditionClause =  CONNECTED ( FROM "mappableBottomUpLocator" |
          TO "mappableBottomUpLocator" )
     childType =  "UNQUOTED_STRING"
     getExecutionUnitClause =  EXECUTION_UNITS
     getExecutionUnitDetailClause =  EXECUTION_UNIT "executionUnitName" GET (
          OPERATORS | "getEUCodeTemplateClause" |
          "getEUControlCodeTemplateClause" )
     getChildDetailClause =  ( "childType" "childName" )+ ( GET ( PROPERTIES
          "propertyKeyList" | "childType" ) | VALIDATE_EXPRESSION PROPERTIES
          "propertyKeyList" )
     operatorLocator =  [ "pluggableMapLocator" ] OPERATOR "operatorName"
     getOperatorDetailClause =  GET ( PROPERTIES "propertyKeyList" | [
          "groupDirection" ] GROUPS [ "connectionConditionClause" ] |
          OPERATOR_TYPE | BOUND_OBJECT | "childType" ) | VALIDATE_EXPRESSION
          PROPERTIES "propertyKeyList" | "getChildDetailClause" | "groupLocator"
           "getGroupDetailClause"
     mappableBottomUpLocator =  "operatorBottomUpLocator" |
          "groupBottomUpLocator" | "attributeBottomUpLocator"
     propertyKey =  "UNQUOTED_STRING" | FILE_FORMAT
     optionValueList =  "propertyValue" { "," "propertyValue" }
     executionUnitName =  "QUOTED_STRING"
     getEUCodeTemplateClause =  ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS "("
          "optionValueList" ")" | ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS | (
          REF | REFERENCE ) CODE_TEMPLATE
     getEUControlCodeTemplateClause =  ( REF | REFERENCE ) CONTROL_CODE_TEMPLATE
           OPTIONS "(" "optionValueList" ")" | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE OPTIONS | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE
     childName =  "QUOTED_STRING"
     pluggableMapLocator =  ( PLUGGABLE_MAPPING "pluggableMapName" [
          "pluggableMapLocator" ] )
     operatorName =  "QUOTED_STRING"
     groupDirection =  INPUT | OUTPUT | INPUT_OUTPUT
     groupLocator =  GROUP "groupName"
     getGroupDetailClause =  GET ( PROPERTIES "propertyKeyList" | ATTRIBUTES [
          "connectionConditionClause" ] | BOUND_OBJECT | REF GROUP | "childType"
           ) | VALIDATE_EXPRESSION PROPERTIES "propertyKeyList" |
          "getChildDetailClause" | "attributeLocator" "getAttributeDetailClause"
     operatorBottomUpLocator =  OPERATOR "operatorName" [
          "pluggableMapBottomUpLocator" ]
     groupBottomUpLocator =  GROUP "groupName" OF "operatorBottomUpLocator"
     attributeBottomUpLocator =  ATTRIBUTE "attributeName" OF
          "groupBottomUpLocator"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     pluggableMapName =  "QUOTED_STRING"
     groupName =  "QUOTED_STRING"
     attributeLocator =  ATTRIBUTE "attributeName"
     getAttributeDetailClause =  GET ( PROPERTIES "propertyKeyList" |
          BOUND_OBJECT | "childType" ) | VALIDATE_EXPRESSION PROPERTIES
          "propertyKeyList" | "getChildDetailClause"
     pluggableMapBottomUpLocator =  ( OF PLUGGABLE_MAPPING "pluggableMapName" [
          "pluggableMapBottomUpLocator" ] )
     attributeName =  "QUOTED_STRING"

Parameters

retrieveMappingCommand

Retrieve the detail of a mapping such as how many mapping operators are there or which mapping operators are connected to each other.

mappingName

Name of the mapping.

retrieveOperatorOwnerDetailClause

Retrieve the desired detail of a mapping or a pluggable mapping.

testConnectionClause

Verify if there is a connection between mapping operators, mapping groups or mapping attributes.

propertyKeyList

The list of property keys.

getReferenceIconSetClause

Retrieve the icon set for the map.

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.

connectionConditionClause

List objects only if they are connected from or to objects specified in the connection condition.

childType

Type of a child that belongs to map, mapping operator, mapping group or mapping attribute.

getExecutionUnitClause

Retrieve the name of the execution units of the map.

getExecutionUnitDetailClause

Retrieve the operators contained in, of the specified execution unit, or its code template settings.

getChildDetailClause

Get the desired detail of a child object that belongs to the mapping, map variable, mapping operator, mapping group or mapping attribute.

operatorLocator

Location of a mapping operator.

getOperatorDetailClause

Get the desired detail of a mapping operator.

mappableBottomUpLocator

Location of the object to be bound to a mapping mapping operator or mapping attribute.

propertyKey

A property key for an object.

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

optionValueList

Describe the list of option names or the option values for the code template.

executionUnitName

The name of the execution unit to be created, modified or deleted.

childName

Name of a child that belongs to map, mapping operator, mapping group or mapping attribute.

pluggableMapLocator

Location of a child pluggable mapping within a mapping or another pluggable mapping.

operatorName

Name of a mapping operator.

groupDirection

Direction of a mapping group.

groupLocator

Location of a mapping group.

getGroupDetailClause

Get the desired detail of a mapping group.

operatorBottomUpLocator

Location of a mapping operator.

groupBottomUpLocator

Location of a mapping group.

attributeBottomUpLocator

Location of a mapping attribute.

propertyValue

A single property value. It can be a number, float, boolean or single-quoted string.

pluggableMapName

Name of the pluggable map.

groupName

Name of a mapping group.

attributeLocator

Location of a mapping attribute.

getAttributeDetailClause

Get the desired detail of a mapping attribute.

pluggableMapBottomUpLocator

Location of a child pluggable mapping within a mapping or another pluggable mapping.

attributeName

Name of a mapping attribute.

MAPPING Object

Table 19-8 MAPPING Object

Property
Type
Choices
Min
Max
Default
Description

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 19-9 OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 19-10 GROUP Object

Property
Type
Choices
Min
Max
Default
Description

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

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 19-11 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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 19-12 AGGREGATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

none

none

none

0

ANYDATA_CAST_OPERATOR Object

Table 19-13 ANYDATA_CAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 19-14 CONSTANT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 19-15 CONSTRUCT_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 19-16 CUBE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 19-17 DATA_GENERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 19-18 DEDUPLICATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 19-19 DIMENSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 19-20 EXPAND_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 19-21 EXPRESSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 19-22 EXTERNAL_TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FILTER_OPERATOR Object

Table 19-23 FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

FILTER_CONDITION

STRING

none

none

none

empty string

The boolean filtering condition that identifies what data is to be processed. Any row with a false condition will be ignored.

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

SUBQUERY_FILTER_OPERATOR Object

Table 19-24 SUBQUERY_FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SUBQUERY_FILTER_CONDITION

STRING

none

none

none

empty string

The Filter Condition for the subquery operator, if blank then the subquery stands alone with no join to the top-level query.

SUBQUERY_INPUT_ROLE

STRING(16)

EXISTS, IN, NOT_EXISTS, NOT_IN

none

none

EXISTS

The role the input stream plays in the subquery filter condition.

SUBQUERY_JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FLAT_FILE_OPERATOR Object

Table 19-25 FLAT_FILE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CONCATENATE_RECORDS

NUMBER

none

none

none

0

Number of Physical Records per Logical Record.

CONTINUATION_CHARACTER

STRING

none

none

none

empty string

Character that indicates the record is continued on the next line.

CONTINUATION_CHARACTER_ON_NEXT_LINE

BOOLEAN

true, false

none

none

FALSE

If there is a continuation character, is it at the start of the line.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The name of the directory in which to open the target data file. The directory must be deployed before the file can be created.

DEBUG_TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

ESCAPE_CHARACTER_FOR_ENCLOSURE

STRING

none

none

none

empty string

Escape character for data containing the enclosure character. This is only applicable with delimited files having enclosure characters.

FIELD_ENCLOSURE_CHARACTERS

STRING

none

none

none

empty string

Characters that wrap fields. Example ' or ".

FIELD_NAMES_IN_THE_FIRST_ROW

BOOLEAN

true, false

none

none

FALSE

Indicates whether file contains a header row.

FIELD_TERMINATION_CHARACTER

STRING

none

none

none

,

Character that separates the fields of a delimited file.

FILE_FORMAT

STRING

DELIMITED, FIXED

none

none

DELIMITED

File Format (Fixed or Delimited).

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LOADING_TYPE

STRING(16)

INSERT, NONE, UPDATE

none

none

INSERT

The loading operation to be performed

NLS_CHARACTERSET

STRING

none

none

none

WE8MSWIN1252

NLS Characterset

OUTPUT_AS_XML

BOOLEAN

true, false

none

none

false

Output data to file in XML format.

RECORDS_TO_SKIP

NUMBER

none

0

none

0

Number of logical records to skip

RECORD_DELIMITER

STRING

none

none

none

empty string

Character that indicates the end of the record.

RECORD_SIZE

NUMBER

none

none

none

0

Size of a fixed length record.

RECORD_TYPE_LENGTH

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the length of the data that identifies the type of record. It is used with the Record Type Position.

RECORD_TYPE_POSITION

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the position of the field that identifies the type of record.

SAMPLED_FILE_NAME

STRING

none

none

none

empty string

The default name of the physical file to be used by sqlloader. If the file was sampled, the default was set from sampled file name.

SOURCE_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The Location of the File Module of this Flat File at the time of reconciliation. Stored as UOID.

TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The location used to access referenced entity.

TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

INPUT_PARAMETER_OPERATOR Object

Table 19-26 INPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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

INPUT_SIGNATURE_OPERATOR Object

Table 19-27 INPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ITERATOR_OPERATOR Object

Table 19-28 ITERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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

JOINER_OPERATOR Object

Table 19-29 JOINER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

JOIN_CONDITION

STRING

none

none

none

empty string

The Join Condition for the join operator

JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

LOOKUP_OPERATOR Object

Table 19-30 LOOKUP_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRCAST_OPERATOR Object

Table 19-31 LCRCAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRSPLITTER_OPERATOR Object

Table 19-32 LCRSPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCHMERGE_OPERATOR Object

Table 19-33 MATCHMERGE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCH_KEYS

STRING

none

none

none

empty string

Ordered list of attributes that control the set of records to be matched at any at any particular time.

MATCH_NEW_RECORDS

BOOLEAN

true, false

none

none

false

MATCH_NEW_RECORD_CONDITION

STRING

none

none

none

empty string

MERGED_PREFIX

STRING

none

none

none

empty string

Set the prefix used for the merged attributes in the cross-reference group.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

MATERIALIZED_VIEW_OPERATOR Object

Table 19-34 MATERIALIZED_VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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).

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.

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

NAME_AND_ADDRESS_OPERATOR Object

Table 19-35 NAME_AND_ADDRESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

ADDRESS_LINE_1

STRING

none

none

none

empty string

Address line 1

ADDRESS_LINE_2

STRING

none

none

none

empty string

Address line 2

ADDRESS_LINE_3

STRING

none

none

none

empty string

Address line 3

ADDRESS_LINE_4

STRING

none

none

none

empty string

Address line 4

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

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

A dual address refers to two address lines for the same destination. For example, a record contains both a street address and a P.O. Box; this is common with business data. Select which of the two address lines should be assigned in these cases.

GENERATE_CASS_REPORT

STRING

NA_NO, NA_YES

none

none

NA_NO

Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS report is a text file specified by the United States Postal Service. The report is written to the [nas/bin/admin/reports] folder under the home folder of the name/address server.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LIST_NAME

STRING

none

none

none

empty string

The list name is optional and provides a reference for tracking multiple CASS reports.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Select a name-address parsing type to be performed on the input data

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Select the primary parsing country which best represents the input data. Input addresses having the same country as the primary parsing country will only need to be parsed once. Input addresses having a different country than the primary parsing country may be reparsed by a different parser. For performance reasons, it is best to minimize the percentage of 2-pass parses by selecting the optimal parser.

PROCESSOR_NAME

STRING

none

none

none

empty string

The processor name is the name of the organization submitting the CASS report.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

OUTPUT_PARAMETER_OPERATOR Object

Table 19-36 OUTPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

The name to use when refering to this entity in generated code.

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

OUTPUT_SIGNATURE_OPERATOR Object

Table 19-37 OUTPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_OPERATOR Object

Table 19-38 PIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_GROUP_SIZE

NUMBER

none

1

1000

2

A number specifying the pivot group size for the pivot operation. Pivot group size determines the number of output rows that are produced from each input row.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PLUGGABLE_MAPPING_OPERATOR Object

Table 19-39 PLUGGABLE_MAPPING_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

POSTMAPPING_PROCESS_OPERATOR Object

Table 19-40 POSTMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

POSTMAPPING_PROCESS_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING

none

none

ON_SUCCESS

Indicates under what condition of the mapping the post-mapping process will be run.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PREMAPPING_PROCESS_OPERATOR Object

Table 19-41 PREMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

MAPPING_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS

none

none

ON_SUCCESS

Indicates under what condition of the pre-mapping process the mapping will be run.

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

QUEUE_OPERATOR Object

Table 19-42 QUEUE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_AQ_UOID

STRING

none

none

none

empty string

The UOID of the Advanced Qeue object to which this stage component is bound to.

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.

DB_LOCATION

STRING

none

none

none

empty string

The location used to access this entity during mapping.

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

GENERATE_SUBSCRIBER

BOOLEAN

true, false

none

none

true

This only applies to batch mappings. This specifies whether the subscriber is generated. The name of the subscriber is the owning map. If the queue being sourced is a propagation queue with the same name as the owning map, then set to false.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

IS_REALTIME_SOURCE

BOOLEAN

true, false

none

none

false

IS_STREAMS_QUEUE

BOOLEAN

true, false

none

none

false

PAYLOAD_NAME

STRING

none

none

none

empty string

The name of payload type.

QUEUE_TABLE_NAME

STRING

none

none

none

empty string

The name of the queue table that is used to perist the messages in this Advanced Queue.

REAL_TIME_DATA_FORMAT

STRING

LOGICAL_CHANGE_RECORD, MESSAGE

none

none

MESSAGE

The format for this message, either user-defined or LCR

SOURCE_TABLES

STRING

none

none

none

empty string

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.

TEMPORARY_TABLE_NAME

STRING

none

none

none

empty string

The name of the temporary table that will stage the messages from the Advanced Queue.

UDT

STRING

none

none

none

empty string

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SEQUENCE_OPERATOR Object

Table 19-43 SEQUENCE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SET_OPERATION_OPERATOR Object

Table 19-44 SET_OPERATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SET_OPERATION

STRING

INTERSECT, MINUS, UNION, UNIONALL

none

none

UNION

Specifies the set operation that is to be performed by this operator.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SORTER_OPERATOR Object

Table 19-45 SORTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ORDER_BY_CLAUSE

STRING

none

none

none

empty string

The Order By Clause

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SPLITTER_OPERATOR Object

Table 19-46 SPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

TABLE_FUNCTION_OPERATOR Object

Table 19-47 TABLE_FUNCTION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

TABLE_FUNCTION_IS_TARGET

BOOLEAN

true, false

none

none

false

Description not available.

TABLE_FUNCTION_NAME

STRING

none

none

none

empty string

The name of the Table Function

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

TABLE_OPERATOR Object

Table 19-48 TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

Description not available.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

CONFLICT_RESOLUTION

BOOLEAN

true, false

none

none

true

Detect and resolve any conflicts that may arise during DML using the LCR APIs

CONTROL_CK

STRING

none

none

none

empty string

Set Control Code Template Params for Check Constraint.

CONTROL_DATA_RULES

STRING

none

none

none

empty string

Set Control Code Template Params for Data Rules.

CONTROL_FK

STRING

none

none

none

empty string

Set Control Code Template Params for Foreign Keys.

CONTROL_NN

STRING

none

none

none

empty string

Set Control Code Template Params for Not Null attributes.

CONTROL_PK

STRING

none

none

none

empty string

Set Control Code Template Params for Primary Keys.

CONTROL_UK

STRING

none

none

none

empty string

Set Control Code Template Params for Unique Keys.

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_LOCATION

STRING(30)

none

none

none

empty string

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

ISAPPLYSOURCE

BOOLEAN

true, false

none

none

false

Generate Non Trigger Apply uptime script considering this is a leading source for the map

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_ERROR_TABLE

BOOLEAN

true, false

none

none

false

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_STATIC_TABLE

BOOLEAN

true, false

none

none

false

Check source table operator static

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

IS_USER-DEFINED_DATA

BOOLEAN

true, false

none

none

false

If TRUE, test data for this source or target is user-defined

JOINRANK

FLOAT

none

none

none

0

Join Rank

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

OPTIMIZE_MERGE

BOOLEAN

true, false

none

none

false

Optimize the execution of expressions by deferring them until really needed

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.

USE_LCR_API

BOOLEAN

true, false

none

none

true

Use LCR APIs if possible to perform the DML

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

ZDT_DOWNTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Downtime Extraction Index Hints

ZDT_DOWNTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

ZDT_UPTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Uptime Extraction Index Hints

ZDT_UPTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

TRANSFORMATION_OPERATOR Object

Table 19-49 TRANSFORMATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

RETURN_TYPE

STRING

none

none

none

empty string

Description not available.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

UNPIVOT_OPERATOR Object

Table 19-50 UNPIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

VIEW_OPERATOR Object

Table 19-51 VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

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_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150

INLINED

BOOLEAN

true, false

none

none

false

If set to true, the view query will be used as an inline subquery in the generated code.

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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

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.

VIEW_QUERY

STRING

none

none

none

empty string

The query text for this view.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

See Also

OMBRETRIEVE

OMBCREATE MAPPING

OMBALTER MAPPING

OMBDROP MAPPING

OMBRETRIEVE MAPPING_MODULE

Purpose

Retrieve details from a mapping module.

Prerequisites

Should be in the context of a project.

Syntax

retrieveMapModuleCommand =  OMBRETRIEVE MAPPING_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

retrieveMapModuleCommand

Retrieve details from a mapping module.

QUOTED_STRING

The name of the mapping module to retrieve details from.

getPropertiesClause

Retrieve specified property values from the mapping module.

getPropertiesClause

Basic properties for MAPPING_MODULE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of the mapping module.

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the mapping 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 mapping module.

getReferenceIconSetClause

Retrieve the icon set referenced by this mapping module.

getReferenceLocationsClause

Retrieve all of the data locations referenced by this module.

propertyNameList

The names of the properties whose values you want to retrieve.

MAPPING_MODULE Object

Table 19-52 MAPPING_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

ABAP_DIRECTORY

STRING

none

none

none

abap\

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

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.

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

none

empty string

END_OF_LINE

STRING

none

none

none

\r\n

End of Line

INPUT_DIRECTORY

STRING

none

none

none

input\

Input Directory

INVALID_DIRECTORY

STRING

none

none

none

invalid\

Directory for SQL*Loader errors and rejected records

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

PLSQL_DIRECTORY

STRING

none

none

none

pls\

Location where PL/SQL scripts are stored.

PLSQL_EXTENSION

STRING

none

none

none

.pls

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

SORT_DIRECTORY

STRING

none

none

none

sort\

Sort Directory

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

WORK_DIRECTORY

STRING

none

none

none

work\

Work Directory

See Also

OMBRETRIEVE

OMBRETRIEVE MATERIALIZED_VIEW

Purpose

To retrieve properties of a materialized view.

Prerequisites

In the context of an Oracle Module

Syntax

retrieveMaterializedViewCommand =  OMBRETRIEVE MATERIALIZED_VIEW
          "QUOTED_STRING" ( "retrieveMaterializedViewClause" |
          "retrieveColumnClause" | "retrieveUkPkClause" | "retrieveFkClause" |
          "retrieveCheckConstraintClause" | "retrieveIndexConfigurationClause" |
           "retrievePartitionConfigurationClause" |
          "retrievePartitionKeyConfigurationClause" |
          "retrieveTemplateSubpartitionConfigurationClause" |
          "retrieveSubPartitionConfigurationClause" |
          "retrieveSubPartitionKeyConfigurationClause" |
          "retrieveDataRuleUsageClause" )
     retrieveMaterializedViewClause =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" |
          "getMaterializedViewSCOorDependentsClause" )
     retrieveColumnClause =  COLUMN "QUOTED_STRING" GET "getPropertiesClause"
     retrieveUkPkClause =  ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" GET (
          "getPropertiesClause" | COLUMNS )
     retrieveFkClause =  FOREIGN_KEY "QUOTED_STRING" GET ( "getPropertiesClause"
           | COLUMNS | UNIQUE_KEY | PRIMARY_KEY | REFERENCED_KEY )
     retrieveCheckConstraintClause =  CHECK_CONSTRAINT "QUOTED_STRING" GET
          "getPropertiesClause"
     retrieveIndexConfigurationClause =  INDEX "QUOTED_STRING" ( GET (
          "getConfigurationPropertiesClause" | INDEX_COLUMNS | INDEX_PARTITIONS
          | INDEX_PARTITION_KEYS ) | ( INDEX_COLUMN "QUOTED_STRING" GET
          "getConfigurationPropertiesClause" ) | ( INDEX_PARTITION_KEY
          "QUOTED_STRING" GET "getConfigurationPropertiesClause" ) | (
          INDEX_PARTITION "QUOTED_STRING" GET "getConfigurationPropertiesClause"
           ) )
     retrievePartitionConfigurationClause =  PARTITION "QUOTED_STRING" GET
          "getConfigurationPropertiesClause"
     retrievePartitionKeyConfigurationClause =  PARTITION_KEY "QUOTED_STRING"
          GET "getConfigurationPropertiesClause"
     retrieveTemplateSubpartitionConfigurationClause =  TEMPLATE_SUBPARTITION
          "QUOTED_STRING" GET "getConfigurationPropertiesClause"
     retrieveSubPartitionConfigurationClause =  SUBPARTITION "QUOTED_STRING" OF
          PARTITION "QUOTED_STRING" GET "getConfigurationPropertiesClause"
     retrieveSubPartitionKeyConfigurationClause =  SUBPARTITION_KEY
          "QUOTED_STRING" GET "getConfigurationPropertiesClause"
     retrieveDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" ( GET (
          "getPropertiesClause" | GROUPS ) | GROUP "QUOTED_STRING" ( GET (
          "getPropertiesClause" | ATTRIBUTES | REF ( TABLE | VIEW |
          MATERIALIZED_VIEW | EXTERNAL_TABLE ) ) | ATTRIBUTE "QUOTED_STRING" (
          GET ( "getPropertiesClause" | REF COLUMN ) ) ) )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getMaterializedViewSCOorDependentsClause =  COLUMNS | UNIQUE_KEYS |
          PRIMARY_KEYS | PRIMARY_KEY | FOREIGN_KEYS | COLUMN AT POSITION
          "INTEGER_LITERAL" | INDEXES | PARTITIONS | PARTITION_KEYS |
          SUBPARTITION_KEYS | DATA_RULE_USAGES | ATTRIBUTE_SETS | ( REF |
          REFERENCE ) ( TABLES | VIEWS | MATERIALIZED_VIEWS )
     getConfigurationPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveMaterializedViewCommand

This clause retrieves a materialized view.

QUOTED_STRING

name of the materialized view.

retrieveMaterializedViewClause

This clause retrieves a properties of a materialized view.

retrieveColumnClause

This clause will retrieve columns.

QUOTED_STRING

Name of the column.

retrieveUkPkClause

This clause will retrieve a unique key or primary key.

QUOTED_STRING

Name of the unique key or the primary key.

retrieveFkClause

This clause will retrieve a key referenced by a foreign key, either a unique key or primary key. Use REFERENCED_KEY to retrieve the referenced key for a foreign key regardless of the type of referenced key (unique or primary).

QUOTED_STRING

Name of the foreign key.

retrieveCheckConstraintClause

This clause gets the check constraint.

QUOTED_STRING

Name of the check constraint.

retrieveIndexConfigurationClause

Gets the index in this clause.

QUOTED_STRING

Name of the index.

retrievePartitionConfigurationClause

Gets the partition.

QUOTED_STRING

The partition name.

retrievePartitionKeyConfigurationClause

This clause gets the partition key.

QUOTED_STRING

The name of the partition key.

retrieveDataRuleUsageClause

This clause retrieves the data rule usages.

QUOTED_STRING

Name of data rule usage, group or attribute.

GROUPS

Retrieve the names of all relation groups in the data rule usage.

ATTRIBUTES

Retrieve the names of all attributes in a data rule usage group.

TABLE

Table name associated withthe data rule usage group.

VIEW

View name associated withthe data rule usage group.

MATERIALIZED_VIEW

Materialized view name associated with the data rule usage group.

EXTERNAL_TABLE

External table name associated with the data rule usage group.

COLUMN

Column name associated with the data rule usage group attribute.

getPropertiesClause

This clause retrieves all the properties.

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.

getMaterializedViewSCOorDependentsClause

This clause will retrieves materialized view components like columns, keys, etc. or relational objects that this materialized view have referential dependency on.

getConfigurationPropertiesClause

This clauses gets the configuration properties of the object.

propertyNameList

The list of properties.

MATERIALIZED_VIEW Object

Table 19-53 MATERIALIZED_VIEW Object

Property
Type
Choices
Min
Max
Default
Description

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 19-54 COLUMN Object

Property
Type
Choices
Min
Max
Default
Description

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 19-55 UNIQUE_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 19-56 FOREIGN_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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.

INDEX Object

Table 19-57 INDEX Object

Property
Type
Choices
Min
Max
Default
Description

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 19-58 PARTITION Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBRETRIEVE

OMBCREATE MATERIALIZED_VIEW

OMBALTER MATERIALIZED_VIEW

OMBDROP MATERIALIZED_VIEW

OMBRETRIEVE MDL_ACTION_PLAN

Purpose

Retrieve the details of an existing metadata loader action plan.

Prerequisites

Connection must be established to the repository.

Syntax

retrieveMDLActionPlanCommand =  OMBRETRIEVE ( MDL_ACTION_PLAN )
          "QUOTED_STRING" ( "getActionsClause" | "retrieveActionClause" )
     getActionsClause =  GET ACTIONS
     retrieveActionClause =  ACTION "QUOTED_STRING" GET "getReferenceClause"
     getReferenceClause =  ( REF | REFERENCE )

Parameters

retrieveMDLActionPlanCommand

Retrieve the details of an existing metadata loader action plan.

getActionsClause

Get a list of actions from an action plan.

retrieveActionClause

Retrieve a set of references of an action.

getReferenceClause

Retrieve the object type and its references for an action.

See Also

OMBCREATE MDL_ACTION_PLAN

OMBALTER MDL_ACTION_PLAN

OMBDROP MDL_ACTION_PLAN

OMUEXPORT MDL_FILE

OMBRETRIEVE MODULE

Purpose

retrieveModuleCommandPurposeTag??

Prerequisites

retrieveModuleCommandPreTag??

Syntax

retrieveModuleCommand =  OMBRETRIEVE 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

Retrieve a set of properties that is associated with the module.

getPropertiesClause

Basic properties for module:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of the module

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the 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 module.

getReferenceLocationsClause

Retrieve all of the data locations referenced by this module.

propertyNameList

Comma separated list of property names. Property names are unquoted.

MODULE Object

Table 19-59 MODULE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE

OMBRETRIEVE NESTED_TABLE

Purpose

Retrieve details of the Nested Table.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

retrieveNestedTableCommand =  OMBRETRIEVE NESTED_TABLE "QUOTED_STRING" (
          GET ( "getPropertiesClause" | "getReferenceIconSetClause" ) )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveNestedTableCommand

Retrieves the details of the Nested Table with the given name.

getPropertiesClause

This clause retrieves all the properties.

getPropertiesClause

Basic properties for NESTED_TABLE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Nested Table

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Nested Table

Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Base Element of the Nested Table

getReferenceIconSetClause

Gets reference icon set.

propertyNameList

The list of properties.

NESTED_TABLE Object

Table 19-60 NESTED_TABLE Object

Property
Type
Choices
Min
Max
Default
Description

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBRETRIEVE

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

Property
Type
Choices
Min
Max
Default
Description

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

20 OMBRETRIEVE OBJECT_TYPE to OMBRETRIEVE REGISTERED_FUNCTION

OMBRETRIEVE OBJECT_TYPE

OMBRETRIEVE ORACLE_EBS_MODULE

OMBRETRIEVE ORACLE_MODULE

OMBRETRIEVE PACKAGE

OMBRETRIEVE PLATFORM

OMBRETRIEVE PLSQL_RECORD_TYPE

OMBRETRIEVE PLSQL_REF_CURSOR_TYPE

OMBRETRIEVE PLSQL_TABLE_TYPE

OMBRETRIEVE PLUGGABLE_MAPPING

OMBRETRIEVE PLUGGABLE_MAPPING_FOLDER

OMBRETRIEVE PROCEDURE

OMBRETRIEVE PROCESS_FLOW

OMBRETRIEVE PROCESS_FLOW_MODULE

OMBRETRIEVE PROCESS_FLOW_PACKAGE

OMBRETRIEVE PROFILE_REFERENCE

OMBRETRIEVE PROJECT

OMBRETRIEVE PSFT_MODULE

OMBRETRIEVE QUEUE_PROPAGATION

OMBRETRIEVE QUEUE_TABLE

OMBRETRIEVE REAL_TIME_MAPPING

OMBRETRIEVE REGISTERED_FUNCTION

OMBRETRIEVE OBJECT_TYPE

Purpose

Retrieve details of the Object Type.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

retrieveObjectTypeCommand =  OMBRETRIEVE OBJECT_TYPE "QUOTED_STRING" (
          "retrieveObjectTypeClause" | "retrieveAttributeClause" )
     retrieveObjectTypeClause =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | "getAttributesClause" )
     retrieveAttributeClause =  OBJECT_TYPE_ATTRIBUTE "QUOTED_STRING" GET
          "getPropertiesClause"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getAttributesClause =  OBJECT_TYPE_ATTRIBUTES
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveObjectTypeCommand

Retrieves the details of the Object Type with the given name.

retrieveObjectTypeClause

Gets the properties or the Attribute names.

retrieveAttributeClause

Gets the properties of the Attribute with the given name.

getPropertiesClause

This clause retrieves all the properties.

getPropertiesClause

Basic properties for OBJECT_TYPE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Object Type

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Object Type

Basic properties for OBJECT_TYPE_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, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Attribute

getReferenceIconSetClause

Gets reference icon set.

getAttributesClause

Gets the names of all the Attributes of the Object Type with the given name.

propertyNameList

The list of properties.

OBJECT_TYPE Object

Table 20-1 OBJECT_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

OBJECT_TYPE_ATTRIBUTE Object

Table 20-2 OBJECT_TYPE_ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBRETRIEVE

OMBALTER OBJECT_TYPE

OMBCREATE OBJECT_TYPE

OMBDROP OBJECT_TYPE

OMBRETRIEVE ORACLE_EBS_MODULE

Purpose

retrieveOracleEBSModuleCommandPurposeTag??

Prerequisites

retrieveOracleEBSModuleCommandPreTag??

Syntax

retrieveOracleEBSModuleCommand =  OMBRETRIEVE ORACLE_EBS_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

corePropertiesForOracleEBSModuleTag??

See Also

OMBRETRIEVE

OMBRETRIEVE ORACLE_MODULE

Purpose

Retrieve details of the Oracle module.

Prerequisites

Should be in the context of project.

Syntax

retrieveOracleModuleCommand =  OMBRETRIEVE ORACLE_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

retrieveOracleModuleCommand

This command retrieves the details of an Oracle Module

QUOTED_STRING

Name of the existing Oracle module or path to the Oracle module.

getPropertiesClause

Retrieve a set of properties that is associated with an Oracle Module.

getPropertiesClause

Basic properties for ORACLE_MODULE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of an Oracle Module

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of an Oracle 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 module.

getReferenceLocationsClause

Retrieve all of the data locations referenced by this module.

propertyNameList

Comma separated list of property names. Property names are unquoted.

ORACLE_MODULE Object

Table 20-3 ORACLE_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

ABAP_DIRECTORY

STRING

none

none

none

abap\

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

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.

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

none

empty string

END_OF_LINE

STRING

none

none

none

\r\n

End of Line

INPUT_DIRECTORY

STRING

none

none

none

input\

Input Directory

INVALID_DIRECTORY

STRING

none

none

none

invalid\

Directory for SQL*Loader errors and rejected records

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

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

SORT_DIRECTORY

STRING

none

none

none

sort\

Sort Directory

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

WORK_DIRECTORY

STRING

none

none

none

work\

Work Directory

See Also

OMBRETRIEVE

OMBRETRIEVE PACKAGE

Purpose

Retrieve details of the Package.

Prerequisites

Should be in the context of a Oracle Module or Transformation Module.

A Transformation Module may be WB_CUSTOM_TRANS for Public Transformations or WB_PREDEFINED_TRANS for Predefined Transformations.

WB_CUSTOM_TRANS may by modified by an administrator. WB_PREDEFINED_TRANS may not be modified.

WB_CUSTOM_TRANS and WB_PREDEFINED_TRANS are not dependent on any project.

Syntax

retrievePackageCommand =  OMBRETRIEVE PACKAGE "QUOTED_STRING" (
          "getPropertiesClause" | "getRelationalDependentsClause" |
          "getReferenceIconSetClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getRelationalDependentsClause =  GET ( REF | REFERENCE ) ( TABLES | VIEWS |
           MATERIALIZED_VIEWS | SEQUENCES | FUNCTIONS | PROCEDURES | PACKAGES )
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrievePackageCommand

This command retrieves the details of a Package

QUOTED_STRING

Name of the existing Package or path to the Package.

getPropertiesClause

Used to get properties (core, user-defined) for packages. Valid properties are shown below:

getPropertiesClause

Basic properties for PACKAGE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the package

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the package

Name: PACKAGE_SPEC
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Retrieves the Package Spec of Imported Package

Name: PACKAGE_BODY
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Retrieves the Package Body of Imported Package

Name: IS_IMPORTED
Type: BOOLEAN
Valid Values: Any valid character string in supported character set.
Default: Empty string
Retrieves 'true' if the Package is Imported otherwise 'false'

getRelationalDependentsClause

This clause retrieves referential dependencies to other relational objects.

getReferenceIconSetClause

Used to get package reference icon set.

propertyNameList

Comma separated list of property names. Property names are unquoted.

PACKAGE Object

Table 20-4 PACKAGE Object

Property
Type
Choices
Min
Max
Default
Description

AUTHID

STRING

, Current_User, Definer

none

none

empty string

Generate the package with selected AUTHID option. Function will be executed with the permissions defined by the AUTHID clause rather than the function owner's permissions.

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBRETRIEVE

OMBRETRIEVE PLATFORM

Purpose

Retrieve details of the platform including properties, platform data types and platform type mappings.

Prerequisites

Should be in the context of a project, before retrieving a platform.

Syntax

retrievePlatformCommand =  OMBRETRIEVE PLATFORM "QUOTED_STRING" (
          "platformTypeProperties" | "platformFromTypeProperties" |
          "platformToTypeProperties" | GET ( ( "platformTypesClause" |
          "platformToTypeMapsClause" | "platformFromTypeMapsClause" |
          "propertiesClause" | "platformCMIRefClause" |
          "platformDefaultCTClause" ) ) )+
     platformTypeProperties =  PLATFORM_TYPE "QUOTED_STRING" GET PROPERTIES "("
          "propertyNameList" ")"
     platformFromTypeProperties =  FROM_PLATFORM_TYPEMAP "QUOTED_STRING" GET
          PROPERTIES "(" "propertyNameList" ")"
     platformToTypeProperties =  TO_PLATFORM_TYPEMAP "QUOTED_STRING" GET
          PROPERTIES "(" "propertyNameList" ")"
     platformTypesClause =  PLATFORM_TYPES
     platformToTypeMapsClause =  TO_PLATFORM_TYPEMAPS
     platformFromTypeMapsClause =  FROM_PLATFORM_TYPEMAPS
     propertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     platformCMIRefClause =  REF CMI_DEFINITION
     platformDefaultCTClause =  DEFAULT_LOAD_CT FOR PROJECT "projectName" FOR
          SOURCE_PLATFORM "platformName" | DEFAULT_INTEGRATION_CT FOR PROJECT
          "projectName" | DEFAULT_ORACLE_TARGET_CT FOR PROJECT "projectName"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     projectName =  "QUOTED_STRING"
     platformName =  "QUOTED_STRING"

Parameters

retrievePlatformCommand

Retrieve details for a platform definition in the repository.

platformTypeProperties

Retrieve properties for a type.

platformTypeProperties

Basic properties for PLATFORM:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the platform

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the platform

platformTypeProperties

Properties for PLATFORM:
Name: COL_ALIAS_WORD
Type: STRING
Column alias word.

Name: DATE_FCT
Type: STRING
The function allowing the date and time to be returned - for example in Oracle this would by SYSDATE and DB2 UDB would be CURRENT TIMESTAMP

Name: DATE_MASK
Type: STRING
The syntax to be used to describe the Date datatype in DDL, for example in Oracle may be DATE in DB2 UDB TIMESTAMP.

Name: DDLNULL
Type: STRING
The word used to describe a column that can contain empty (null) values. For example in Oracle NULL is used.

Name: DEFAULT_MAX_NAME_LEN
Type: INTEGER
The default max length name of a relational access item (ie. a table).

Name: DEFAULT_NAME_LEN_SEMANTICS
Type: STRING
The name length semantics to be used (CHARACTER or BYTE).

Name: DELETE_IN_OVERRIDE
Type: BOOLEAN
Delete in override property

Name: DRIVER_CLASS
Type: STRING
The driver class name, all locations created for this platform will be created using this driver class.

Name: ENCLOSURE_CHAR
Type: STRING
The character used to delimit names ie. single quote, double quote etc.

Name: ESCAPE_CHAR
Type: STRING
Escape character.

Name: ILLEGAL_CHARS
Type: STRING
The list of illegal characters that can be in a name.

Name: ILLEGAL_LEADING_CHARS
Type: STRING
The list of illegal characters that a name can start with.

Name: LOCAL_OBJECT_MASK
Type: STRING
This determines how an object is named when you are connected to the location the object is based on. For Oracle this should be
%SCHEMA.%OBJECT The list of tags available for the mask include;
%CATALOG to represent the physical catalog name
%SCHEMA to represent the schema name
%OBJECT to represent the object name

Name: NUMERIC_MASK
Type: STRING
The syntax to be used to describe the Numerical datatype in DDL, the tags %L (data length) and %P (precision) can be used.

Name: REMOTE_OBJECT_MASK
Type: STRING
This determines how an object is named when you are not connected to the location the object is based on. For Oracle this should be
%SCHEMA.%OBJECT The list of tags available for the mask include;
%CATALOG to represent the physical catalog name
%SCHEMA to represent the schema name
%OBJECT to represent the object name
%DSERVER to represent the data server

Name: RESERVED_WORDS
Type: STRING
The list of reserved words which cannot be used for names of objects.

Name: SEEDED
Type: BOOLEAN
A flag to indicate if the platform was seeded.

Name: SPECIAL_MAX_NAME_LEN
Type: STRING
Name length for secondary objects such as column, index (the value has the following format INDEX=18:COLUMN=30:PACKAGE=18)

Name: SPECIAL_NAME_LEN_SEMANTICS
Type: STRING
SpecialNameLenSemantics

Name: TAB_ALIAS_WORD
Type: STRING
The element designed to separate a table name from its alias in a SQL FROM clause. This element may be left incomplete.

Name: URI_TEMPLATE
Type: STRING
A sample template URI for accessing the platform.

Name: VARCHAR_MASK
Type: STRING
The syntax to be used to describe the String datatype in DDL, the tags %L (data length) and %P (precision) can be used.

platformTypeProperties

Properties for PLATFORM_TYPE:
Name: IS_DEFAULT
Type: BOOLEAN
Is this the default datatype for the platform.

Name: P1
Type: STRING
Parameter from the following list (leave blank if not applicable);
size: for length
precision: for numbers
scale: for numbers

Name: P1DEFAULT
Type: STRING
Default value for P1; leave blank if not applicable

Name: P1MAX
Type: STRING
Maximum value for P1; leave blank if not applicable

Name: P1MIN
Type: STRING
Minimum value for P1; leave blank if not applicable

Name: P1TYPE
Type: STRING
Parameter type from the following supported list (Leave blank if not applicable): range

Name: SEEDED
Type: BOOLEAN
Seeded indicator for the platform types which are pre-seeded.

Name: SYNTAX
Type: STRING
DDL Syntax for columns of this data type, can use %size %precision %scale. For example CHAR(%size) is the syntax for defining a data type of CHAR which has a particular length

platformFromTypeProperties

Retrieve properties for a type mapping from this type to a generic type.

platformToTypeProperties

Retrieve properties for a type mapping to this type from a generic type.

platformTypesClause

Retrieve types for the platform.

platformToTypeMapsClause

Retrieve platform mappings from generic to this platform.

platformFromTypeMapsClause

Retrieve platform mappings from this platform to the generic set.

propertiesClause

Retrieve named properties for the platform definition. These properties include characteristics of the platform including the driver, display name, naming rules etc.

platformCMIRefClause

Retrieve the CMI reference for this platform.

platformDefaultCTClause

Retrieve the default CT for this platform.

propertyNameList

Comma separated list of property names to retrieve. Property names are unquoted.

projectName

The name for this project.

platformName

The name for this platform definition.

See Also

OMBLIST

OMBRETRIEVE PLSQL_RECORD_TYPE

Purpose

Retrieve details of the PLSQL Record Type.

Prerequisites

Should be in the context of a Package.

Syntax

retrievePlSqlRecordTypeCommand =  OMBRETRIEVE PLSQL_RECORD_TYPE
          "QUOTED_STRING" ( "retrievePlSqlRecordTypeClause" |
          "retrievePlSqlRecordAttributeClause" )
     retrievePlSqlRecordTypeClause =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | "getPlSqlRecordAttributesClause" )
     retrievePlSqlRecordAttributeClause =  ATTRIBUTE "QUOTED_STRING" GET
          "getPropertiesClause"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getPlSqlRecordAttributesClause =  ATTRIBUTES
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrievePlSqlRecordTypeCommand

Retrieves the details of the PLSQL Record Type with the given name.

retrievePlSqlRecordTypeClause

Gets the properties or the Attribute names.

retrievePlSqlRecordAttributeClause

Gets the properties of the Attribute with the given name.

getPropertiesClause

This clause retrieves all the properties.

getPropertiesClause

Basic properties for PLSQL_RECORD_TYPE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the PLSQL Record Type

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the PLSQL Record Type

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, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Attribute

getReferenceIconSetClause

Gets the PLSQL Record Type icon set.

getPlSqlRecordAttributesClause

Gets the names of all the attributes of the PLSQL Record Type

propertyNameList

The list of properties.

PLSQL_RECORD_TYPE Object

Table 20-5 PLSQL_RECORD_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

ATTRIBUTE Object

Table 20-6 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE

OMBALTER PLSQL_RECORD_TYPE

OMBCREATE PLSQL_RECORD_TYPE

OMBDROP PLSQL_RECORD_TYPE

OMBRETRIEVE PLSQL_REF_CURSOR_TYPE

Purpose

Retrieve details of the Ref-cursor Type.

Prerequisites

Should be in the context of a Package.

Syntax

retrieveRefCursorTypeCommand =  OMBRETRIEVE PLSQL_REF_CURSOR_TYPE
          "QUOTED_STRING" "retrieveRefCursorTypeClause"
     retrieveRefCursorTypeClause =  GET "getPropertiesClause"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveRefCursorTypeCommand

Retrieves the details of the Ref-cursor Type with the given name.

retrieveRefCursorTypeClause

Retrieves the details of the Ref-cursor Type with the given name.

getPropertiesClause

This clause retrieves all the properties.

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.

propertyNameList

The list of properties.

PLSQL_REF_CURSOR_TYPE Object

Table 20-7 PLSQL_REF_CURSOR_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

ATTRIBUTE Object

Table 20-8 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE

OMBALTER PLSQL_REF_CURSOR_TYPE

OMBCREATE PLSQL_REF_CURSOR_TYPE

OMBDROP PLSQL_REF_CURSOR_TYPE

OMBRETRIEVE PLSQL_TABLE_TYPE

Purpose

Retrieve details of the Table Type.

Prerequisites

Should be in the context of a Package.

Syntax

retrievePlSqlTableTypeCommand =  OMBRETRIEVE PLSQL_TABLE_TYPE
          "QUOTED_STRING" "retrievePlSqlTableTypeClause"
     retrievePlSqlTableTypeClause =  GET "getPropertiesClause"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrievePlSqlTableTypeCommand

Retrieves the details of the Table Type with the given name.

retrievePlSqlTableTypeClause

Retrieves the properties of the table type with the given name.

getPropertiesClause

This clause retrieves all the properties.

getPropertiesClause

Basic properties for PLSQL_TABLE_TYPE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Table Type

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Table Type

Name: RETURN_TYPE
Type: STRING(20)
Valid Values: NUMBER, VARCHAR2, VARCHAR, DATE, FLOAT
Default: Empty string
Return type of the Table Type. This can be a scalar type or a PLSQL Record Type.

propertyNameList

The list of properties.

PLSQL_TABLE_TYPE Object

Table 20-9 PLSQL_TABLE_TYPE Object

Property
Type
Choices
Min
Max
Default
Description

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

ATTRIBUTE Object

Table 20-10 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE

OMBALTER PLSQL_TABLE_TYPE

OMBCREATE PLSQL_TABLE_TYPE

OMBDROP PLSQL_TABLE_TYPE

OMBRETRIEVE PLUGGABLE_MAPPING

Purpose

Retrieve details of pluggable mapping such as the number of operators and their connections.

Prerequisites

The current context of scripting must be a project or pluggable map folder.

Syntax

retrievePluggableMappingCommand =  OMBRETRIEVE PLUGGABLE_MAPPING
          "pluggableMapName" ( "retrieveOperatorOwnerDetailClause" |
          "testConnectionClause" )
     pluggableMapName =  "QUOTED_STRING"
     retrieveOperatorOwnerDetailClause =  GET ( PROPERTIES "propertyKeyList" |
          "getCodeTemplateClause" | "getControlCodeTemplateClause" |
          "getReferenceIconSetClause" | [ "operatorType" ] OPERATORS [
          "connectionConditionClause" ] | "childType" | "getExecutionUnitClause"
           | "getExecutionUnitDetailClause" ) | VALIDATE_EXPRESSION PROPERTIES
          "propertyKeyList" | "getChildDetailClause" | "operatorLocator"
          "getOperatorDetailClause"
     testConnectionClause =  HAS CONNECTION FROM "mappableBottomUpLocator" TO
          "mappableBottomUpLocator"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     getCodeTemplateClause =  ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS "("
          "optionValueList" ")" | ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS | (
          REF | REFERENCE ) CODE_TEMPLATE
     getControlCodeTemplateClause =  ( REF | REFERENCE ) CONTROL_CODE_TEMPLATE
          OPTIONS "(" "optionValueList" ")" | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE OPTIONS | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     operatorType =  PLUGGABLE_MAPPING | "UNQUOTED_STRING"
     connectionConditionClause =  CONNECTED ( FROM "mappableBottomUpLocator" |
          TO "mappableBottomUpLocator" )
     childType =  "UNQUOTED_STRING"
     getExecutionUnitClause =  EXECUTION_UNITS
     getExecutionUnitDetailClause =  EXECUTION_UNIT "executionUnitName" GET (
          OPERATORS | "getEUCodeTemplateClause" |
          "getEUControlCodeTemplateClause" )
     getChildDetailClause =  ( "childType" "childName" )+ ( GET ( PROPERTIES
          "propertyKeyList" | "childType" ) | VALIDATE_EXPRESSION PROPERTIES
          "propertyKeyList" )
     operatorLocator =  [ "pluggableMapLocator" ] OPERATOR "operatorName"
     getOperatorDetailClause =  GET ( PROPERTIES "propertyKeyList" | [
          "groupDirection" ] GROUPS [ "connectionConditionClause" ] |
          OPERATOR_TYPE | BOUND_OBJECT | "childType" ) | VALIDATE_EXPRESSION
          PROPERTIES "propertyKeyList" | "getChildDetailClause" | "groupLocator"
           "getGroupDetailClause"
     mappableBottomUpLocator =  "operatorBottomUpLocator" |
          "groupBottomUpLocator" | "attributeBottomUpLocator"
     propertyKey =  "UNQUOTED_STRING" | FILE_FORMAT
     optionValueList =  "propertyValue" { "," "propertyValue" }
     executionUnitName =  "QUOTED_STRING"
     getEUCodeTemplateClause =  ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS "("
          "optionValueList" ")" | ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS | (
          REF | REFERENCE ) CODE_TEMPLATE
     getEUControlCodeTemplateClause =  ( REF | REFERENCE ) CONTROL_CODE_TEMPLATE
           OPTIONS "(" "optionValueList" ")" | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE OPTIONS | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE
     childName =  "QUOTED_STRING"
     pluggableMapLocator =  ( PLUGGABLE_MAPPING "pluggableMapName" [
          "pluggableMapLocator" ] )
     operatorName =  "QUOTED_STRING"
     groupDirection =  INPUT | OUTPUT | INPUT_OUTPUT
     groupLocator =  GROUP "groupName"
     getGroupDetailClause =  GET ( PROPERTIES "propertyKeyList" | ATTRIBUTES [
          "connectionConditionClause" ] | BOUND_OBJECT | REF GROUP | "childType"
           ) | VALIDATE_EXPRESSION PROPERTIES "propertyKeyList" |
          "getChildDetailClause" | "attributeLocator" "getAttributeDetailClause"
     operatorBottomUpLocator =  OPERATOR "operatorName" [
          "pluggableMapBottomUpLocator" ]
     groupBottomUpLocator =  GROUP "groupName" OF "operatorBottomUpLocator"
     attributeBottomUpLocator =  ATTRIBUTE "attributeName" OF
          "groupBottomUpLocator"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     groupName =  "QUOTED_STRING"
     attributeLocator =  ATTRIBUTE "attributeName"
     getAttributeDetailClause =  GET ( PROPERTIES "propertyKeyList" |
          BOUND_OBJECT | "childType" ) | VALIDATE_EXPRESSION PROPERTIES
          "propertyKeyList" | "getChildDetailClause"
     pluggableMapBottomUpLocator =  ( OF PLUGGABLE_MAPPING "pluggableMapName" [
          "pluggableMapBottomUpLocator" ] )
     attributeName =  "QUOTED_STRING"

Parameters

retrievePluggableMappingCommand

Retrieve the detail of a pluggable mapping such as how many mapping operators are there are which mapping operators are connected to each other.

pluggableMapName

Name of the pluggable map.

retrieveOperatorOwnerDetailClause

Retrieve the desired detail of a mapping or a pluggable mapping.

testConnectionClause

Verify if there is a connection between mapping operators, mapping groups or mapping attributes.

propertyKeyList

The list of property keys.

getReferenceIconSetClause

Retrieve the icon set for the pluggable map.

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.

connectionConditionClause

List objects only if they are connected from or to objects specified in the connection condition.

childType

Type of a child that belongs to map, mapping operator, mapping group or mapping attribute.

getExecutionUnitClause

Retrieve the name of the execution units of the map.

getExecutionUnitDetailClause

Retrieve the operators contained in, of the specified execution unit, or its code template settings.

getChildDetailClause

Get the desired detail of a child object that belongs to the mapping, map variable, mapping operator, mapping group or mapping attribute.

operatorLocator

Location of a mapping operator.

getOperatorDetailClause

Get the desired detail of a mapping operator.

mappableBottomUpLocator

Location of the object to be bound to a mapping mapping operator or mapping attribute.

propertyKey

A property key for an object.

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

optionValueList

Describe the list of option names or the option values for the code template.

executionUnitName

The name of the execution unit to be created, modified or deleted.

childName

Name of a child that belongs to map, mapping operator, mapping group or mapping attribute.

pluggableMapLocator

Location of a child pluggable mapping within a mapping or another pluggable mapping.

operatorName

Name of a mapping operator.

groupDirection

Direction of a mapping group.

groupLocator

Location of a mapping group.

getGroupDetailClause

Get the desired detail of a mapping group.

operatorBottomUpLocator

Location of a mapping operator.

groupBottomUpLocator

Location of a mapping group.

attributeBottomUpLocator

Location of a mapping attribute.

propertyValue

A single property value. It can be a number, float, boolean or single-quoted string.

groupName

Name of a mapping group.

attributeLocator

Location of a mapping attribute.

getAttributeDetailClause

Get the desired detail of a mapping attribute.

pluggableMapBottomUpLocator

Location of a child pluggable mapping within a mapping or another pluggable mapping.

attributeName

Name of a mapping attribute.

PLUGGABLE_MAPPING Object

Table 20-11 PLUGGABLE_MAPPING Object

Property
Type
Choices
Min
Max
Default
Description

DIAGRAM_LAYOUT

STRING

none

none

none

empty string

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 20-12 OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-13 GROUP Object

Property
Type
Choices
Min
Max
Default
Description

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

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 20-14 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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 20-15 AGGREGATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

none

none

none

0

ANYDATA_CAST_OPERATOR Object

Table 20-16 ANYDATA_CAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-17 CONSTANT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-18 CONSTRUCT_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-19 CUBE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-20 DATA_GENERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-21 DEDUPLICATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-22 DIMENSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-23 EXPAND_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-24 EXPRESSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-25 EXTERNAL_TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FILTER_OPERATOR Object

Table 20-26 FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

FILTER_CONDITION

STRING

none

none

none

empty string

The boolean filtering condition that identifies what data is to be processed. Any row with a false condition will be ignored.

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

SUBQUERY_FILTER_OPERATOR Object

Table 20-27 SUBQUERY_FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SUBQUERY_FILTER_CONDITION

STRING

none

none

none

empty string

The Filter Condition for the subquery operator, if blank then the subquery stands alone with no join to the top-level query.

SUBQUERY_INPUT_ROLE

STRING(16)

EXISTS, IN, NOT_EXISTS, NOT_IN

none

none

EXISTS

The role the input stream plays in the subquery filter condition.

SUBQUERY_JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FLAT_FILE_OPERATOR Object

Table 20-28 FLAT_FILE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CONCATENATE_RECORDS

NUMBER

none

none

none

0

Number of Physical Records per Logical Record.

CONTINUATION_CHARACTER

STRING

none

none

none

empty string

Character that indicates the record is continued on the next line.

CONTINUATION_CHARACTER_ON_NEXT_LINE

BOOLEAN

true, false

none

none

FALSE

If there is a continuation character, is it at the start of the line.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The name of the directory in which to open the target data file. The directory must be deployed before the file can be created.

DEBUG_TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

ESCAPE_CHARACTER_FOR_ENCLOSURE

STRING

none

none

none

empty string

Escape character for data containing the enclosure character. This is only applicable with delimited files having enclosure characters.

FIELD_ENCLOSURE_CHARACTERS

STRING

none

none

none

empty string

Characters that wrap fields. Example ' or ".

FIELD_NAMES_IN_THE_FIRST_ROW

BOOLEAN

true, false

none

none

FALSE

Indicates whether file contains a header row.

FIELD_TERMINATION_CHARACTER

STRING

none

none

none

,

Character that separates the fields of a delimited file.

FILE_FORMAT

STRING

DELIMITED, FIXED

none

none

DELIMITED

File Format (Fixed or Delimited).

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LOADING_TYPE

STRING(16)

INSERT, NONE, UPDATE

none

none

INSERT

The loading operation to be performed

NLS_CHARACTERSET

STRING

none

none

none

WE8MSWIN1252

NLS Characterset

OUTPUT_AS_XML

BOOLEAN

true, false

none

none

false

Output data to file in XML format.

RECORDS_TO_SKIP

NUMBER

none

0

none

0

Number of logical records to skip

RECORD_DELIMITER

STRING

none

none

none

empty string

Character that indicates the end of the record.

RECORD_SIZE

NUMBER

none

none

none

0

Size of a fixed length record.

RECORD_TYPE_LENGTH

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the length of the data that identifies the type of record. It is used with the Record Type Position.

RECORD_TYPE_POSITION

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the position of the field that identifies the type of record.

SAMPLED_FILE_NAME

STRING

none

none

none

empty string

The default name of the physical file to be used by sqlloader. If the file was sampled, the default was set from sampled file name.

SOURCE_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The Location of the File Module of this Flat File at the time of reconciliation. Stored as UOID.

TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The location used to access referenced entity.

TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

INPUT_PARAMETER_OPERATOR Object

Table 20-29 INPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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

INPUT_SIGNATURE_OPERATOR Object

Table 20-30 INPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ITERATOR_OPERATOR Object

Table 20-31 ITERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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

JOINER_OPERATOR Object

Table 20-32 JOINER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

JOIN_CONDITION

STRING

none

none

none

empty string

The Join Condition for the join operator

JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

LOOKUP_OPERATOR Object

Table 20-33 LOOKUP_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRCAST_OPERATOR Object

Table 20-34 LCRCAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRSPLITTER_OPERATOR Object

Table 20-35 LCRSPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCHMERGE_OPERATOR Object

Table 20-36 MATCHMERGE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCH_KEYS

STRING

none

none

none

empty string

Ordered list of attributes that control the set of records to be matched at any at any particular time.

MATCH_NEW_RECORDS

BOOLEAN

true, false

none

none

false

MATCH_NEW_RECORD_CONDITION

STRING

none

none

none

empty string

MERGED_PREFIX

STRING

none

none

none

empty string

Set the prefix used for the merged attributes in the cross-reference group.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

MATERIALIZED_VIEW_OPERATOR Object

Table 20-37 MATERIALIZED_VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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).

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.

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

NAME_AND_ADDRESS_OPERATOR Object

Table 20-38 NAME_AND_ADDRESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

ADDRESS_LINE_1

STRING

none

none

none

empty string

Address line 1

ADDRESS_LINE_2

STRING

none

none

none

empty string

Address line 2

ADDRESS_LINE_3

STRING

none

none

none

empty string

Address line 3

ADDRESS_LINE_4

STRING

none

none

none

empty string

Address line 4

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

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

A dual address refers to two address lines for the same destination. For example, a record contains both a street address and a P.O. Box; this is common with business data. Select which of the two address lines should be assigned in these cases.

GENERATE_CASS_REPORT

STRING

NA_NO, NA_YES

none

none

NA_NO

Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS report is a text file specified by the United States Postal Service. The report is written to the [nas/bin/admin/reports] folder under the home folder of the name/address server.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LIST_NAME

STRING

none

none

none

empty string

The list name is optional and provides a reference for tracking multiple CASS reports.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Select a name-address parsing type to be performed on the input data

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Select the primary parsing country which best represents the input data. Input addresses having the same country as the primary parsing country will only need to be parsed once. Input addresses having a different country than the primary parsing country may be reparsed by a different parser. For performance reasons, it is best to minimize the percentage of 2-pass parses by selecting the optimal parser.

PROCESSOR_NAME

STRING

none

none

none

empty string

The processor name is the name of the organization submitting the CASS report.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

OUTPUT_PARAMETER_OPERATOR Object

Table 20-39 OUTPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

The name to use when refering to this entity in generated code.

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

OUTPUT_SIGNATURE_OPERATOR Object

Table 20-40 OUTPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_OPERATOR Object

Table 20-41 PIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_GROUP_SIZE

NUMBER

none

1

1000

2

A number specifying the pivot group size for the pivot operation. Pivot group size determines the number of output rows that are produced from each input row.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PLUGGABLE_MAPPING_OPERATOR Object

Table 20-42 PLUGGABLE_MAPPING_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

POSTMAPPING_PROCESS_OPERATOR Object

Table 20-43 POSTMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

POSTMAPPING_PROCESS_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING

none

none

ON_SUCCESS

Indicates under what condition of the mapping the post-mapping process will be run.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PREMAPPING_PROCESS_OPERATOR Object

Table 20-44 PREMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

MAPPING_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS

none

none

ON_SUCCESS

Indicates under what condition of the pre-mapping process the mapping will be run.

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

QUEUE_OPERATOR Object

Table 20-45 QUEUE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_AQ_UOID

STRING

none

none

none

empty string

The UOID of the Advanced Qeue object to which this stage component is bound to.

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.

DB_LOCATION

STRING

none

none

none

empty string

The location used to access this entity during mapping.

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

GENERATE_SUBSCRIBER

BOOLEAN

true, false

none

none

true

This only applies to batch mappings. This specifies whether the subscriber is generated. The name of the subscriber is the owning map. If the queue being sourced is a propagation queue with the same name as the owning map, then set to false.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

IS_REALTIME_SOURCE

BOOLEAN

true, false

none

none

false

IS_STREAMS_QUEUE

BOOLEAN

true, false

none

none

false

PAYLOAD_NAME

STRING

none

none

none

empty string

The name of payload type.

QUEUE_TABLE_NAME

STRING

none

none

none

empty string

The name of the queue table that is used to perist the messages in this Advanced Queue.

REAL_TIME_DATA_FORMAT

STRING

LOGICAL_CHANGE_RECORD, MESSAGE

none

none

MESSAGE

The format for this message, either user-defined or LCR

SOURCE_TABLES

STRING

none

none

none

empty string

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.

TEMPORARY_TABLE_NAME

STRING

none

none

none

empty string

The name of the temporary table that will stage the messages from the Advanced Queue.

UDT

STRING

none

none

none

empty string

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SEQUENCE_OPERATOR Object

Table 20-46 SEQUENCE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SET_OPERATION_OPERATOR Object

Table 20-47 SET_OPERATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SET_OPERATION

STRING

INTERSECT, MINUS, UNION, UNIONALL

none

none

UNION

Specifies the set operation that is to be performed by this operator.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SORTER_OPERATOR Object

Table 20-48 SORTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ORDER_BY_CLAUSE

STRING

none

none

none

empty string

The Order By Clause

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SPLITTER_OPERATOR Object

Table 20-49 SPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

TABLE_FUNCTION_OPERATOR Object

Table 20-50 TABLE_FUNCTION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

TABLE_FUNCTION_IS_TARGET

BOOLEAN

true, false

none

none

false

Description not available.

TABLE_FUNCTION_NAME

STRING

none

none

none

empty string

The name of the Table Function

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

TABLE_OPERATOR Object

Table 20-51 TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

Description not available.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

CONFLICT_RESOLUTION

BOOLEAN

true, false

none

none

true

Detect and resolve any conflicts that may arise during DML using the LCR APIs

CONTROL_CK

STRING

none

none

none

empty string

Set Control Code Template Params for Check Constraint.

CONTROL_DATA_RULES

STRING

none

none

none

empty string

Set Control Code Template Params for Data Rules.

CONTROL_FK

STRING

none

none

none

empty string

Set Control Code Template Params for Foreign Keys.

CONTROL_NN

STRING

none

none

none

empty string

Set Control Code Template Params for Not Null attributes.

CONTROL_PK

STRING

none

none

none

empty string

Set Control Code Template Params for Primary Keys.

CONTROL_UK

STRING

none

none

none

empty string

Set Control Code Template Params for Unique Keys.

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_LOCATION

STRING(30)

none

none

none

empty string

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

ISAPPLYSOURCE

BOOLEAN

true, false

none

none

false

Generate Non Trigger Apply uptime script considering this is a leading source for the map

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_ERROR_TABLE

BOOLEAN

true, false

none

none

false

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_STATIC_TABLE

BOOLEAN

true, false

none

none

false

Check source table operator static

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

IS_USER-DEFINED_DATA

BOOLEAN

true, false

none

none

false

If TRUE, test data for this source or target is user-defined

JOINRANK

FLOAT

none

none

none

0

Join Rank

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

OPTIMIZE_MERGE

BOOLEAN

true, false

none

none

false

Optimize the execution of expressions by deferring them until really needed

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.

USE_LCR_API

BOOLEAN

true, false

none

none

true

Use LCR APIs if possible to perform the DML

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

ZDT_DOWNTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Downtime Extraction Index Hints

ZDT_DOWNTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

ZDT_UPTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Uptime Extraction Index Hints

ZDT_UPTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

TRANSFORMATION_OPERATOR Object

Table 20-52 TRANSFORMATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

RETURN_TYPE

STRING

none

none

none

empty string

Description not available.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

UNPIVOT_OPERATOR Object

Table 20-53 UNPIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

VIEW_OPERATOR Object

Table 20-54 VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

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_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150

INLINED

BOOLEAN

true, false

none

none

false

If set to true, the view query will be used as an inline subquery in the generated code.

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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

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.

VIEW_QUERY

STRING

none

none

none

empty string

The query text for this view.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

See Also

OMBRETRIEVE

OMBCREATE MAPPING

OMBALTER MAPPING

OMBDROP MAPPING

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

OMBRETRIEVE PROCEDURE

Purpose

Retrieve details of the Procedure.

Prerequisites

Should be in the context of a Oracle Module or Package or Transformation Module.

Syntax

retrieveProcedureCommand =  OMBRETRIEVE PROCEDURE "QUOTED_STRING" (
          "getPropertiesClause" | "getFuncProcParameterClause" |
          "getFuncProcParameterPositionClause" | "getFuncProcSignatureClause" |
          "retrieveFuncProcParameterClause" | "getRelationalDependentsClause" |
          "getReferenceIconSetClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getFuncProcParameterClause =  GET PARAMETERS
     getFuncProcParameterPositionClause =  GET PARAMETER AT POSITION
          "INTEGER_LITERAL"
     getFuncProcSignatureClause =  GET SIGNATURE
     retrieveFuncProcParameterClause =  PARAMETER "QUOTED_STRING"
          "getPropertiesClause"
     getRelationalDependentsClause =  GET ( REF | REFERENCE ) ( TABLES | VIEWS |
           MATERIALIZED_VIEWS | SEQUENCES | FUNCTIONS | PROCEDURES | PACKAGES )
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveProcedureCommand

This command retrieves the details of a Procedure

QUOTED_STRING

Name of the existing Procedure or path to the Procedure.

getPropertiesClause

Used to get properties (core, user-defined) for procedure. Valid properties are shown below:

getPropertiesClause

Basic properties for PROCEDURE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Procedure

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Procedure

Name: IMPLEMENTATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Set the code for Procedure which is included global variable declaration and code between BEGIN and END.

Basic properties for PARAMETER:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: 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

getFuncProcParameterClause

Get all the parameter names of the Procedure

getFuncProcParameterPositionClause

Get the parameter position of Function

getFuncProcSignatureClause

Get the complete signature of the Function which includes parameter names, datatype, in/out type and default values

retrieveFuncProcParameterClause

Get the parameter information such as datatype, default value, in/out type and position

QUOTED_STRING

Name of the existing Parameter

getRelationalDependentsClause

This clause retrieves referential dependencies to other relational objects.

getReferenceIconSetClause

Used to get procedure reference icon set.

propertyNameList

Comma separated list of property names. Property names are unquoted.

PROCEDURE Object

Table 20-55 PROCEDURE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE

OMBRETRIEVE PROCESS_FLOW

Purpose

Retrieves the details of the Process Flow.

Prerequisites

Should be in the context of a Process Flow Package.

Syntax

retrieveProcessFlowCommand =  OMBRETRIEVE PROCESS_FLOW "QUOTED_STRING" (
          "retrieveProcessFlowClause" | "retrieveActivityClause" |
          "retrieveTransitionClause" | "retrieveProcessParameterClause" |
          "retrieveProcessVariableClause" )
     retrieveProcessFlowClause =  "getPropertiesClause" |
          "getReferenceIconSetClause" | GET "getProcessFlowSCOClause"
     retrieveActivityClause =  ACTIVITY "QUOTED_STRING" ( "getPropertiesClause"
          | "getReferenceIconSetClause" | "getActivityBoundObject" |
          "getActivityTransitionClause" | "getActivityParameterClause" |
          "getActivityParameterPropertiesClause" )
     retrieveTransitionClause =  TRANSITION "QUOTED_STRING" (
          "getPropertiesClause" | GET "getTransitionActivityClause" )
     retrieveProcessParameterClause =  PARAMETER "QUOTED_STRING"
          "getPropertiesClause"
     retrieveProcessVariableClause =  VARIABLE "QUOTED_STRING"
          "getPropertiesClause"
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     getProcessFlowSCOClause =  ACTIVITIES | ( ( "UNQUOTED_STRING" |
          DATA_AUDITOR | USER_DEFINED | SUBPROCESS | MAPPING | TRANSFORMATION )
          ACTIVITIES ) | TRANSITIONS | PARAMETERS | VARIABLES
     getActivityBoundObject =  GET ( REFERENCE | REF )
     getActivityTransitionClause =  GET ( INCOMING_TRANSITIONS |
          OUTGOING_TRANSITIONS )
     getActivityParameterClause =  ( GET PARAMETERS )
     getActivityParameterPropertiesClause =  PARAMETER "QUOTED_STRING"
          "getPropertiesClause"
     getTransitionActivityClause =  ( SOURCE_ACTIVITY | DESTINATION_ACTIVITY )
     propertyNameList =  ( "UNQUOTED_STRING" | BINDING ) { "," (
          "UNQUOTED_STRING" | BINDING ) }

Parameters

retrieveProcessFlowCommand

Retrieve the details of an existing process flow.

retrieveProcessFlowClause

This clause retrieve the Process Flow.

retrieveActivityClause

This clause retrieves the Activity of a Process Flow.

retrieveTransitionClause

This clause retrieves the Transition of a Process Flow.

retrieveProcessParameterClause

This clause retrieves the Parameter of a Process Flow.

retrieveProcessVariableClause

Retrieve definition of a variable.

getPropertiesClause

Used to get properties (core, user-defined) for process flow. Valid properties are shown below:

getPropertiesClause

Base properties for Process Flow, Activity, Transition and Parameter:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of a Process Flow

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of a Process Flow

Basic properties for Transition:

Name: TRANSITION_CONDITION
Type: STRING
Valid Values: '', SUCCESS, ERROR, WARNING
Default: Empty string i.e. Unconditional
Gets the Transition Condition of a Transition
Basic properties for Activity Parameter :

Name: SIMPLE_CONDITION
Type: STRING
Valid Values: '', SUCCESS, ERROR, WARNING
Default: Empty string i.e. Unconditional
Sets the Simple Condition of a Transition

Name: COMPLEX_CONDITION
Type: STRING
Sets the Complex Condition of a Transition

Name: DATATYPE
Type: STRING
Valid Values: INTEGER, FLOAT, DATE, STRING, BOOLEAN
Default: STRING
Gets the datatype of a Activity Parameter

Name: DIRECTION
Type: STRING
Valid Values: IN
Default: IN
Gets the direction of a Activity Parameter

Name: ISLITERALVALUE
Type: STRING
Valid Values: TRUE FALSE
Default: TRUE
Whether the value stored is a literal value or an interpreted value, valid for PARAMETERS and VARIABLES.

Name: VALUE
Type: STRING
Valid Values: Examples '123', '123.456', 'Jan-08-2003', 'I am String', 'true'
Default: Empty string
Gets the value of a Activity Parameter

Name: BINDING
Type: STRING
Valid Values: Examples 'PROCESS_PARAM1', 'PROCESS_PARAM2'
Default: Empty string
Get the name of the process parameter that this parameter is bound to, empty if not bound.

Name: BOUND_NAME
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The name of the object which a process flow activity represents, for example, a mapping.

Name: DEPLOYED_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: USE_DEFAULT_LOCATION
The locaion to which the process flow is deployed.

Name: EXECUTION_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: NATIVE_EXECUTION
The location which is used to execute the process flow, which may differ from the deployment location.

Name: REMOTE_LOCATION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: USE_DEFAULT_LOCATION
The File location which is remote from the Working Location, used by FTP to connect to the remote FTP server and set the remote working directory.

Name: USE_RETURN_AS_STATUS
Type: BOOLEAN
Valid Values: true, false
Default: false
When TRUE, the returned result will directly control the outcome of the activity/operator, 1=SUCCESS, 2=WARNINGS, 3=FAILURE.

getReferenceIconSetClause

Retrieve the icon set referenced by this process flow.

getProcessFlowSCOClause

For the current process flow, retrieve all activities or only activities of a specific type.

getActivityBoundObject

Retrieve the name of the object that the current activity refers to, pertinent to only MAPPING, SUBPROCESS and TRANSFORMATION activities.

getActivityTransitionClause

This clause retrieves all Activities of a Process Flow.

getActivityParameterClause

Retrieve the activity parameters for the current activity.

getActivityParameterPropertiesClause

Retrieve the details of an activity parameter.

getTransitionActivityClause

This clause retrieves all Transitions of a Process Flow.

propertyNameList

A comma delimited set of property names to set.

See Also

OMBRETRIEVE

OMBRETRIEVE PROCESS_FLOW_MODULE

Purpose

Retrieve details of the Process Flow Module.

Prerequisites

Should be in the context of a project.

Syntax

retrieveProcessFlowModuleCommand =  OMBRETRIEVE PROCESS_FLOW_MODULE
          "QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause"
           | "getReferenceIconSetClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceLocationClause =  GET ( REF | REFERENCE ) LOCATION
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveProcessFlowModuleCommand

Retrieve the details of an existing process flow module.

getPropertiesClause

Used to get properties (core, user-defined) for process flow module.

getPropertiesClause

Base properties for PROCESS_FLOW_MODULE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of a Process Flow Module

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of a Process Flow Module

getReferenceLocationClause

Retrieve the name of the Workflow engine location referenced by this process flow module.

getReferenceIconSetClause

Retrieve the icon set referenced by this process flow module.

propertyNameList

Comma separated list of property names. Property names are not in quotation marks.

PROCESS_FLOW_MODULE Object

Table 20-56 PROCESS_FLOW_MODULE Object

Property
Type
Choices
Min
Max
Default
Description

DB_LOCATION

STRING

none

none

none

empty string

This value indicates the location where generated code will be deployed to.

EVAL_LOCATION

STRING

none

none

none

empty string

The location in which the process flow will be evaluated.

See Also

OMBRETRIEVE

OMBRETRIEVE PROCESS_FLOW_PACKAGE

Purpose

Retrieve details of the Process Flow Package.

Prerequisites

Should be in the context of a Process Flow Module.

Syntax

retrieveProcessFlowPackageCommand =  OMBRETRIEVE PROCESS_FLOW_PACKAGE
          "QUOTED_STRING" ( "getPropertiesClause" | "getReferenceIconSetClause"
          )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     propertyNameList =  ( "UNQUOTED_STRING" | BINDING ) { "," (
          "UNQUOTED_STRING" | BINDING ) }

Parameters

retrieveProcessFlowPackageCommand

Retrieve the details of an existing process flow package.

getPropertiesClause

Used to get properties (core, user-defined) for process flow packages. Valid properties are shown below:

getPropertiesClause

Basic properties for PROCESS_FLOW_PACKAGE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of a Process Flow Package

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of a Process Flow Package

getReferenceIconSetClause

Retrieve the icon set referenced by this process flow package.

propertyNameList

A comma delimited set of property names to set.

See Also

OMBRETRIEVE

OMBRETRIEVE PROFILE_REFERENCE

Purpose

To retrieve properties of a profile reference.

Prerequisites

In the context of a Data Profile.

Syntax

retrieveProfileReferenceCommand =  OMBRETRIEVE PROFILE_REFERENCE
          "QUOTED_STRING" ( "retrieveProfileReferenceClause" |
          "retrieveDataRuleUsageClause" | "retrieveProfileAttributeClause" |
          "retrieveProfileForeignKeyClause" | "retrieveProfileUniqueKeyClause" |
           "retrieveRowRelationshipClause" |
          "retrieveFunctionalDependencyClause" )
     retrieveProfileReferenceClause =  GET ( "getPropertiesClause" |
          "getProfileReferenceSCOClause" )
     retrieveDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" ( GET (
          "getPropertiesClause" | GROUPS ) | GROUP "QUOTED_STRING" ( GET (
          "getPropertiesClause" | ATTRIBUTES | REF TABLE ) | ATTRIBUTE
          "QUOTED_STRING" ( GET ( "getPropertiesClause" | REF COLUMN ) ) ) )
     retrieveProfileAttributeClause =  PROFILE_ATTRIBUTE "QUOTED_STRING" ( GET (
           "getPropertiesClause" | "getDomainValuesClause" |
          "getCharPatternValuesClause" | "getWordPatternValuesClause" ) |
          DOMAIN_VALUE "QUOTED_STRING" ( GET "getPropertiesClause" ) |
          CHARPATTERN_VALUE "QUOTED_STRING" ( GET "getPropertiesClause" ) |
          WORDPATTERN_VALUE "QUOTED_STRING" ( GET "getPropertiesClause" ) )
     retrieveProfileForeignKeyClause =  PROFILE_FOREIGN_KEY "QUOTED_STRING" (
          GET ( "getPropertiesClause" | "getRedundantAttributesForFKClause" |
          "getReferencingAttributesClause" | "getReferencingUKClauseForFK" ) |
          REDUNDANT_ATTRIBUTE "QUOTED_STRING" ( GET "getPropertiesClause" ) )
     retrieveProfileUniqueKeyClause =  PROFILE_UNIQUE_KEY "QUOTED_STRING" ( GET
          ( "getPropertiesClause" | "getReferencingAttributesClause" ) )
     retrieveRowRelationshipClause =  ROW_RELATIONSHIP "QUOTED_STRING" ( GET (
          "getPropertiesClause" | "getReferencingAttributesClause" |
          "getReferencingUKClauseForRR" ) )
     retrieveFunctionalDependencyClause =  FUNCTIONAL_DEPENDENCY "QUOTED_STRING"
           ( GET ( "getPropertiesClause" | "getDeterminantAttributesClause" |
          "getDependentAttributeClause" ) )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getProfileReferenceSCOClause =  PROFILE_ATTRIBUTES | PROFILE_ATTRIBUTE AT
          POSITION "INTEGER_LITERAL" | PROFILE_FOREIGN_KEYS |
          PROFILE_UNIQUE_KEYS | DATA_RULE_USAGES | FUNCTIONAL_DEPENDENCIES |
          ROW_RELATIONSHIPS
     getDomainValuesClause =  DOMAIN_VALUES
     getCharPatternValuesClause =  CHARPATTERN_VALUES
     getWordPatternValuesClause =  WORDPATTERN_VALUES
     getRedundantAttributesForFKClause =  REDUNDANT_ATTRIBUTES
     getReferencingAttributesClause =  PROFILE_ATTRIBUTES
     getReferencingUKClauseForFK =  UNIQUE_KEY
     getReferencingUKClauseForRR =  ROW_RELATIONSHIP
     getDeterminantAttributesClause =  DETERMINANT_ATTRIBUTES
     getDependentAttributeClause =  DEPENDENT_ATTRIBUTE
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveProfileReferenceCommand

This clause retrieves the results of a profile of a source.

retrieveProfileReferenceClause

This clause retrieves

retrieveDataRuleUsageClause

This clause retrieves the data rule usages defined or derived for this particular profile reference.

retrieveProfileAttributeClause

This clause retrieves profile attribute values.

retrieveProfileForeignKeyClause

This clause retrieves the discovered foreign keys for this particular profile reference.

retrieveProfileUniqueKeyClause

This clause retrieves the discovered unique keys for this particular profile reference.

retrieveRowRelationshipClause

This clause retrieves the discovered row relationships for this particular profile reference.

retrieveFunctionalDependencyClause

This clause retrieves the discovered functional dependencies for this particular profile reference. The format for discovered functional dependencies are A-&gt;B, where A is the determinant column/s and B is the dependent column.

getPropertiesClause

This clause retrieves the properties for a particular object.

getPropertiesClause

Configuration properties for PROFILE_REFERENCE 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 always 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

Setting this to true will enable common format discovery for the selected table.

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: 100

Valid Values: 1-100

Default: 100

This value will be the percent of total rows that will be randomly selected during loading.

getPropertiesClause

Configuration properties for PROFILE_REFERENCE 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.

getPropertiesClause

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.

Configuration properties for PROFILE_ATTRIBUTE that affect loading:

Name: USE_IN_LOADING

Type: BOOLEAN

Valid Values: true | false

Default: true

This tells the profiler if the data for this column is to be copied from the source schema to the profile workspace schema.

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.

getPropertiesClause

Configuration properties for PROFILE_ATTRIBUTE that affect loading:

Name: USE_IN_FK

Type: BOOLEAN

Valid Values: true | false

Default: true

This tells the profiler if this column is to be part of the determinant in functional dependency discovery.By default, all non-numeric columns set this property to false

Name: USE_IN_LOADING

Type: BOOLEAN

Valid Values: true | false

Default: true

Setting this to true will include this column in profiling.

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

Setting this to true will enable common format discovery for the selected table.

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.

Configuration properties for PROFILE_ATTRIBUTE that affect profiling:

Name: USE_IN_DETERMINANT

Type: BOOLEAN

Valid Values: true | false

Default: true

This tells the profiler if this column is to be part of the determinant in functional dependency discovery.By default, all non-numeric columns set this property to false

Name: CALCULATE_DOMAINS

Type: BOOLEAN

Valid Values: true | false

Default: true

This tells the profiler if domain values are to be discovered for this column.

Name: DOMAIN_MAX_COUNT

Type: NUMBER

Valid Values: 1-any number

Default: true

This tells the profiler the maximum number of distinct values this column can have to be considered as domain attributes.

Name: DOMAIN_MAX_PERCENT

Type: NUMBER

Valid Values: 1-100

Default: true

This tells the profiler the maximum number of distinct values as a percentage this column can have to be considered as domain attributes.

Name: DOMAIN_MIN_COUNT

Type: NUMBER

Valid Values: 1-any number

Default: true

This tells the profiler the minimum number of rows a particular value should have in order to be considered a domain value.

Name: DOMAIN_MIN_PERCENT

Type: NUMBER

Valid Values: 1-100

Default: true

This tells the profiler the minimum number of rows as a percentage a particular value should have in order to be considered a domain value.

getProfileReferenceSCOClause

This clause retrieves reference table values.

getDomainValuesClause

This clause retrieves doman values for an attribute.

getCharPatternValuesClause

This clause retrieves character pattern values for an attribute.

getWordPatternValuesClause

This clause retrieves word pattern values for an attribute.

getRedundantAttributesForFKClause

This clause retrieves redundant attributes for a foreign key.

getReferencingAttributesClause

This clause retrieves profile attributes for a row relationship, foreign key or unique key.

getReferencingUKClauseForFK

This clause retrieves the unique key for a foreign key.

getReferencingUKClauseForRR

This clause retrieves the unique key for a row relationship

getDeterminantAttributesClause

This clause retrieves the determinant attributes of a functional dependency.

getDependentAttributeClause

This clause retrieves the dependent attribute of a functional dependency.

propertyNameList

Comma separated list of property names. Property names are unquoted.

PROFILE_REFERENCE Object

Table 20-57 PROFILE_REFERENCE Object

Property
Type
Choices
Min
Max
Default
Description

ANALYZE_TABLE_ESTIMATE_PERCENT

STRING

none

none

none

empty string

Value represents the sample size as a percentage (0-100) of total rows. When set to a nonzero value, Builder generates a DDL script to analyze the table. The default is 99.

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.

CACHE_MODE

STRING

, CACHE, NOCACHE

none

none

empty string

Indicate how Oracle should store blocks in the buffer cache.

CALCULATE_COMMON_FORMATS

BOOLEAN

true, false

none

none

false

Setting this to true will enable common format discovery for the selected table.

CALCULATE_DATATYPES

BOOLEAN

true, false

none

none

true

Setting this to true will enable data type discovery for the selected table.

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 with respect to a foreign key-unique key pair.

CALCULATE_UK

BOOLEAN

true, false

none

none

true

Setting this to true will enable unique key discovery.

CDC_POSITION

NUMBER

none

none

none

0

Table position in change data capture.

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 a materialized view for each column in this table to enhance query performance during drill down.

DATA_RULE_SIGNATURE

STRING

none

none

none

empty string

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

false

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

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.

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string

Use the Tablespace parameter to specify the name of tablespace.

ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string

Use the error table name to specify the name of Error Table.

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, foreign 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.

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.

GENERATED_OBJECTS

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.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

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.

IS_CDC

BOOLEAN

true, false

none

none

false

Enable table for change data capture

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.

MAX_NUM_PATTERNS

NUMBER

none

none

none

10

This tells the profiler to get the top-N patterns for the attribute.

MINEXTENTS

STRING

none

none

none

empty string

Specify the total number of extents to allocate when the object is created.

MONITORING_MODE

STRING

, MONITORING, NOMONITORING

none

none

empty string

Specify MONITORING if you want modification statistics to be collected on this table.

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.

NULL_PERCENT

NUMBER

none

0

100

10

If the percentage of null values in a column is less than this threshold percent, then that column will be discovered as a possible Not Null column.

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.

NUM_ROWS

NUMBER

none

none

none

0

OVERFLOW

STRING

none

none

none

empty string

Enter a comma separated list of tablespaces for overflow data. For simple-partitoned object, it is used for HASH BY QUANTITY partition overflow tablespaces. The number of tablespaces does not have to equal the number of partitions. If the number of partitions is greater than the number of tablespaces, then Oracle cycles through the names of the 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 simple-partitoned object, it is used for HASH BY QUANTITY partition tablespaces. For composite-partitioned tables, it is used for subpartition template to store a list of tablespaces.

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.

PROFILE_DONE

BOOLEAN

true, false

none

none

false

REDUNDANT_MIN_PERCENT

NUMBER

none

0

100

75

This is the minimum percentage of rows that are redundant.

ROWDEPENDENCIES_MODE

STRING

, NOROWDEPENDENCIES, ROWDEPENDENCIES

none

none

empty string

Specify ROWDEPENDENCIES to use row-level dependency tracking.

ROW_MOVEMENT

STRING

, DISABLE, ENABLE

none

none

empty string

Specify whether Oracle can move a table row.

SAMPLE_RATE

NUMBER

none

0

100

100

This value will be the percent of total rows that will be randomly selected during loading.

TABLESPACE

STRING(30)

none

none

none

empty string

UK_MIN_PERCENT

NUMBER

none

0

100

75

This is the minimum percentage of rows that need to satisfy a unique key relationship.

WHERE_CLAUSE

STRING

none

none

none

empty string

Where clause to be applied on the source when loading data into the profile staging area.

See Also

OMBRETRIEVE

OMBRETRIEVE PROJECT

Purpose

Retrieve details of the project.

Prerequisites

Should be in the top level context.

Syntax

retrieveProjectCommand =  OMBRETRIEVE PROJECT "QUOTED_STRING" (
          "getPropertiesClause" | "getReferenceIconSetClause" )
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  GET ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveProjectCommand

Retrieve the details of a Project

QUOTED_STRING

Name of the existing project or path to the project.

getPropertiesClause

Retrieve a set of properties that is associated with a Project.

getPropertiesClause

Basic properties for PROJECT:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of a Project

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of a Project

getReferenceIconSetClause

Retrieve the icon set referenced by this project.

propertyNameList

Comma separated list of property names. Property names are unquoted.

See Also

OMBRETRIEVE

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

OMBRETRIEVE QUEUE_PROPAGATION

Purpose

Retrieve details of the Queue Propagation.

Prerequisites

Should be in the context of an Advanced Queue.

Syntax

retrieveQPCommand =  OMBRETRIEVE QUEUE_PROPAGATION "QUOTED_STRING" GET (
          "getQPPropertiesClause" | "getReferenceIconSetClause" )
     getQPPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveQPCommand

Retrieves the details of the Queue Propagation with the given name.

getQPPropertiesClause

Retrieves the values of the given Properties for the Queue Propagation with the given name.

getQPPropertiesClause

Basic properties for QUEUE_PROPAGATION:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Queue Propagation

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Queue Propagation

Name: TARGET_QUEUE
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Target Queue for the Queue Propagation. This has to be the name of a Queue existing in any Oracle Module.

getReferenceIconSetClause

Get the Icon Set.

propertyNameList

The list of properties.

QUEUE_PROPAGATION Object

Table 20-58 QUEUE_PROPAGATION Object

Property
Type
Choices
Min
Max
Default
Description

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.

DURATION

STRING

none

none

none

empty string

The duration of proagation to be done. The default value is null.Applicable only for non-streams queue propagation.

GENERATE_DBLINK

BOOLEAN

true, false

none

none

true

Generate script for Database Link which is used for propagation

GENERATE_QUEUE_PROPAGATION

BOOLEAN

true, false

none

none

true

Generate script for Queue Propagation

GENERATE_REPLICATION_RULE

BOOLEAN

true, false

none

none

false

Generate Ruleset and Rule for Replication purpose in Streams queue propagation

GENERATE_SCHEDULE_PROPAGATION

BOOLEAN

true, false

none

none

true

Generate script for Scheduling propagation. Applicable only for non-streams queue propagation.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

LATENCY

STRING

none

none

none

60

The latency for the queue propagation. By default the value is 60.Applicable only for non-streams queue propagation.

NEXT_TIME

STRING

none

none

none

empty string

Next time when the propagation to be done. The default value is null.Applicable only for non-streams queue propagation.

NOT_PERMITTED_TAG_VALUES

STRING

none

none

none

empty string

List of comma separated Tag values (in Hex numbers) which are not allowed for propagation

PERMITTED_TAG_VALUES

STRING

none

none

none

empty string

List of comma separated Tag values (in Hex numbers) which are allowed for propagation

START_TIME

STRING

none

none

none

SYSDATE

The start time for the propagation to happen. The default value is SYSDATE.Applicable only for non-streams queue propagation.

SUBCRIBER_TRANSFORMATION

STRING

none

none

none

empty string

A Transformation that will be applied before propagation to the target queue. Applicable only for non-streams queue propagation.

SUBSCRIBER_RULE_CONDITION

STRING

none

none

none

empty string

A Rule condition to check whether the message can be propagated to the subscriber. Applicable only for non-streams queue propagation.

See Also

OMBRETRIEVE

OMBALTER QUEUE_PROPAGATION

OMBCREATE QUEUE_PROPAGATION

OMBDROP QUEUE_PROPAGATION

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

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBRETRIEVE

OMBALTER QUEUE_TABLE

OMBCREATE QUEUE_TABLE

OMBDROP QUEUE_TABLE

OMBRETRIEVE REAL_TIME_MAPPING

Purpose

Retrieve Real Time mapping details such as the number of operators and their connections.

Prerequisites

The current context must be in an Oracle Module.

Syntax

retrieveRealTimeMappingCommand =  OMBRETRIEVE REAL_TIME_MAPPING
          "mappingName" ( "retrieveOperatorOwnerDetailClause" |
          "testConnectionClause" )
     mappingName =  "QUOTED_STRING"
     retrieveOperatorOwnerDetailClause =  GET ( PROPERTIES "propertyKeyList" |
          "getCodeTemplateClause" | "getControlCodeTemplateClause" |
          "getReferenceIconSetClause" | [ "operatorType" ] OPERATORS [
          "connectionConditionClause" ] | "childType" | "getExecutionUnitClause"
           | "getExecutionUnitDetailClause" ) | VALIDATE_EXPRESSION PROPERTIES
          "propertyKeyList" | "getChildDetailClause" | "operatorLocator"
          "getOperatorDetailClause"
     testConnectionClause =  HAS CONNECTION FROM "mappableBottomUpLocator" TO
          "mappableBottomUpLocator"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     getCodeTemplateClause =  ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS "("
          "optionValueList" ")" | ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS | (
          REF | REFERENCE ) CODE_TEMPLATE
     getControlCodeTemplateClause =  ( REF | REFERENCE ) CONTROL_CODE_TEMPLATE
          OPTIONS "(" "optionValueList" ")" | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE OPTIONS | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     operatorType =  PLUGGABLE_MAPPING | "UNQUOTED_STRING"
     connectionConditionClause =  CONNECTED ( FROM "mappableBottomUpLocator" |
          TO "mappableBottomUpLocator" )
     childType =  "UNQUOTED_STRING"
     getExecutionUnitClause =  EXECUTION_UNITS
     getExecutionUnitDetailClause =  EXECUTION_UNIT "executionUnitName" GET (
          OPERATORS | "getEUCodeTemplateClause" |
          "getEUControlCodeTemplateClause" )
     getChildDetailClause =  ( "childType" "childName" )+ ( GET ( PROPERTIES
          "propertyKeyList" | "childType" ) | VALIDATE_EXPRESSION PROPERTIES
          "propertyKeyList" )
     operatorLocator =  [ "pluggableMapLocator" ] OPERATOR "operatorName"
     getOperatorDetailClause =  GET ( PROPERTIES "propertyKeyList" | [
          "groupDirection" ] GROUPS [ "connectionConditionClause" ] |
          OPERATOR_TYPE | BOUND_OBJECT | "childType" ) | VALIDATE_EXPRESSION
          PROPERTIES "propertyKeyList" | "getChildDetailClause" | "groupLocator"
           "getGroupDetailClause"
     mappableBottomUpLocator =  "operatorBottomUpLocator" |
          "groupBottomUpLocator" | "attributeBottomUpLocator"
     propertyKey =  "UNQUOTED_STRING" | FILE_FORMAT
     optionValueList =  "propertyValue" { "," "propertyValue" }
     executionUnitName =  "QUOTED_STRING"
     getEUCodeTemplateClause =  ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS "("
          "optionValueList" ")" | ( REF | REFERENCE ) CODE_TEMPLATE OPTIONS | (
          REF | REFERENCE ) CODE_TEMPLATE
     getEUControlCodeTemplateClause =  ( REF | REFERENCE ) CONTROL_CODE_TEMPLATE
           OPTIONS "(" "optionValueList" ")" | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE OPTIONS | ( REF | REFERENCE )
          CONTROL_CODE_TEMPLATE
     childName =  "QUOTED_STRING"
     pluggableMapLocator =  ( PLUGGABLE_MAPPING "pluggableMapName" [
          "pluggableMapLocator" ] )
     operatorName =  "QUOTED_STRING"
     groupDirection =  INPUT | OUTPUT | INPUT_OUTPUT
     groupLocator =  GROUP "groupName"
     getGroupDetailClause =  GET ( PROPERTIES "propertyKeyList" | ATTRIBUTES [
          "connectionConditionClause" ] | BOUND_OBJECT | REF GROUP | "childType"
           ) | VALIDATE_EXPRESSION PROPERTIES "propertyKeyList" |
          "getChildDetailClause" | "attributeLocator" "getAttributeDetailClause"
     operatorBottomUpLocator =  OPERATOR "operatorName" [
          "pluggableMapBottomUpLocator" ]
     groupBottomUpLocator =  GROUP "groupName" OF "operatorBottomUpLocator"
     attributeBottomUpLocator =  ATTRIBUTE "attributeName" OF
          "groupBottomUpLocator"
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )
     pluggableMapName =  "QUOTED_STRING"
     groupName =  "QUOTED_STRING"
     attributeLocator =  ATTRIBUTE "attributeName"
     getAttributeDetailClause =  GET ( PROPERTIES "propertyKeyList" |
          BOUND_OBJECT | "childType" ) | VALIDATE_EXPRESSION PROPERTIES
          "propertyKeyList" | "getChildDetailClause"
     pluggableMapBottomUpLocator =  ( OF PLUGGABLE_MAPPING "pluggableMapName" [
          "pluggableMapBottomUpLocator" ] )
     attributeName =  "QUOTED_STRING"

Parameters

mappingName

Name of the mapping.

retrieveOperatorOwnerDetailClause

Retrieve the desired detail of a mapping or a pluggable mapping.

testConnectionClause

Verify if there is a connection between mapping operators, mapping groups or mapping attributes.

propertyKeyList

The list of property keys.

operatorType

Type of a mapping operator. The following operator types are available: ADVANCED_QUEUE, AGGREGATOR, 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.

connectionConditionClause

List objects only if they are connected from or to objects specified in the connection condition.

childType

Type of a child that belongs to map, mapping operator, mapping group or mapping attribute.

getExecutionUnitClause

Retrieve the name of the execution units of the map.

getExecutionUnitDetailClause

Retrieve the operators contained in, of the specified execution unit, or its code template settings.

getChildDetailClause

Get the desired detail of a child object that belongs to the mapping, map variable, mapping operator, mapping group or mapping attribute.

operatorLocator

Location of a mapping operator.

getOperatorDetailClause

Get the desired detail of a mapping operator.

mappableBottomUpLocator

Location of the object to be bound to a mapping mapping operator or mapping attribute.

propertyKey

A property key for an object.

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

optionValueList

Describe the list of option names or the option values for the code template.

executionUnitName

The name of the execution unit to be created, modified or deleted.

childName

Name of a child that belongs to map, mapping operator, mapping group or mapping attribute.

pluggableMapLocator

Location of a child pluggable mapping within a mapping or another pluggable mapping.

operatorName

Name of a mapping operator.

groupDirection

Direction of a mapping group.

groupLocator

Location of a mapping group.

getGroupDetailClause

Get the desired detail of a mapping group.

operatorBottomUpLocator

Location of a mapping operator.

groupBottomUpLocator

Location of a mapping group.

attributeBottomUpLocator

Location of a mapping attribute.

propertyValue

A single property value. It can be a number, float, boolean or single-quoted string.

pluggableMapName

Name of the pluggable map.

groupName

Name of a mapping group.

attributeLocator

Location of a mapping attribute.

getAttributeDetailClause

Get the desired detail of a mapping attribute.

pluggableMapBottomUpLocator

Location of a child pluggable mapping within a mapping or another pluggable mapping.

attributeName

Name of a mapping attribute.

MAPPING Object

Table 20-60 MAPPING Object

Property
Type
Choices
Min
Max
Default
Description

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 20-61 OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-62 GROUP Object

Property
Type
Choices
Min
Max
Default
Description

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

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 20-63 ATTRIBUTE Object

Property
Type
Choices
Min
Max
Default
Description

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 20-64 AGGREGATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

none

none

none

0

ANYDATA_CAST_OPERATOR Object

Table 20-65 ANYDATA_CAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-66 CONSTANT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-67 CONSTRUCT_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-68 CUBE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-69 DATA_GENERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-70 DEDUPLICATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-71 DIMENSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-72 EXPAND_OBJECT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-73 EXPRESSION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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 20-74 EXTERNAL_TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FILTER_OPERATOR Object

Table 20-75 FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

FILTER_CONDITION

STRING

none

none

none

empty string

The boolean filtering condition that identifies what data is to be processed. Any row with a false condition will be ignored.

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

SUBQUERY_FILTER_OPERATOR Object

Table 20-76 SUBQUERY_FILTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SUBQUERY_FILTER_CONDITION

STRING

none

none

none

empty string

The Filter Condition for the subquery operator, if blank then the subquery stands alone with no join to the top-level query.

SUBQUERY_INPUT_ROLE

STRING(16)

EXISTS, IN, NOT_EXISTS, NOT_IN

none

none

EXISTS

The role the input stream plays in the subquery filter condition.

SUBQUERY_JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

FLAT_FILE_OPERATOR Object

Table 20-77 FLAT_FILE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CONCATENATE_RECORDS

NUMBER

none

none

none

0

Number of Physical Records per Logical Record.

CONTINUATION_CHARACTER

STRING

none

none

none

empty string

Character that indicates the record is continued on the next line.

CONTINUATION_CHARACTER_ON_NEXT_LINE

BOOLEAN

true, false

none

none

FALSE

If there is a continuation character, is it at the start of the line.

DEBUG_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The name of the directory in which to open the target data file. The directory must be deployed before the file can be created.

DEBUG_TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

ESCAPE_CHARACTER_FOR_ENCLOSURE

STRING

none

none

none

empty string

Escape character for data containing the enclosure character. This is only applicable with delimited files having enclosure characters.

FIELD_ENCLOSURE_CHARACTERS

STRING

none

none

none

empty string

Characters that wrap fields. Example ' or ".

FIELD_NAMES_IN_THE_FIRST_ROW

BOOLEAN

true, false

none

none

FALSE

Indicates whether file contains a header row.

FIELD_TERMINATION_CHARACTER

STRING

none

none

none

,

Character that separates the fields of a delimited file.

FILE_FORMAT

STRING

DELIMITED, FIXED

none

none

DELIMITED

File Format (Fixed or Delimited).

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LOADING_TYPE

STRING(16)

INSERT, NONE, UPDATE

none

none

INSERT

The loading operation to be performed

NLS_CHARACTERSET

STRING

none

none

none

WE8MSWIN1252

NLS Characterset

OUTPUT_AS_XML

BOOLEAN

true, false

none

none

false

Output data to file in XML format.

RECORDS_TO_SKIP

NUMBER

none

0

none

0

Number of logical records to skip

RECORD_DELIMITER

STRING

none

none

none

empty string

Character that indicates the end of the record.

RECORD_SIZE

NUMBER

none

none

none

0

Size of a fixed length record.

RECORD_TYPE_LENGTH

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the length of the data that identifies the type of record. It is used with the Record Type Position.

RECORD_TYPE_POSITION

NUMBER

none

none

none

0

If this is a multi record file, this will indicate the position of the field that identifies the type of record.

SAMPLED_FILE_NAME

STRING

none

none

none

empty string

The default name of the physical file to be used by sqlloader. If the file was sampled, the default was set from sampled file name.

SOURCE_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The Location of the File Module of this Flat File at the time of reconciliation. Stored as UOID.

TARGET_DATA_FILE_LOCATION

STRING

none

none

none

empty string

The location used to access referenced entity.

TARGET_DATA_FILE_NAME

STRING

none

none

none

empty string

Name of the target data file, including extension (file type). This name should not include the file path. To specify where the target data file will be created/appended, set the Target Data File Location.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

INPUT_PARAMETER_OPERATOR Object

Table 20-78 INPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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

INPUT_SIGNATURE_OPERATOR Object

Table 20-79 INPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ITERATOR_OPERATOR Object

Table 20-80 ITERATOR_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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

JOINER_OPERATOR Object

Table 20-81 JOINER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

JOIN_CONDITION

STRING

none

none

none

empty string

The Join Condition for the join operator

JOIN_CONDITION_USER_MODIFIED_FLAG

BOOLEAN

true, false

none

none

false

The Join Condition has been modified by the user (do not generate default)

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

LOOKUP_OPERATOR Object

Table 20-82 LOOKUP_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRCAST_OPERATOR Object

Table 20-83 LCRCAST_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

LCRSPLITTER_OPERATOR Object

Table 20-84 LCRSPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCHMERGE_OPERATOR Object

Table 20-85 MATCHMERGE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

MATCH_KEYS

STRING

none

none

none

empty string

Ordered list of attributes that control the set of records to be matched at any at any particular time.

MATCH_NEW_RECORDS

BOOLEAN

true, false

none

none

false

MATCH_NEW_RECORD_CONDITION

STRING

none

none

none

empty string

MERGED_PREFIX

STRING

none

none

none

empty string

Set the prefix used for the merged attributes in the cross-reference group.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

MATERIALIZED_VIEW_OPERATOR Object

Table 20-86 MATERIALIZED_VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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).

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.

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

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

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

NAME_AND_ADDRESS_OPERATOR Object

Table 20-87 NAME_AND_ADDRESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

ADDRESS_LINE_1

STRING

none

none

none

empty string

Address line 1

ADDRESS_LINE_2

STRING

none

none

none

empty string

Address line 2

ADDRESS_LINE_3

STRING

none

none

none

empty string

Address line 3

ADDRESS_LINE_4

STRING

none

none

none

empty string

Address line 4

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

DUAL_ADDRESS_ASSIGNMENT

STRING

NA_DUALADDR_CLOSESTTOLASTLINE, NA_DUALADDR_POBOX, NA_DUALADDR_STREET

none

none

NA_DUALADDR_STREET

A dual address refers to two address lines for the same destination. For example, a record contains both a street address and a P.O. Box; this is common with business data. Select which of the two address lines should be assigned in these cases.

GENERATE_CASS_REPORT

STRING

NA_NO, NA_YES

none

none

NA_NO

Select "Yes" to generate CASS (Coding Accuracy Support System) report. CASS report is a text file specified by the United States Postal Service. The report is written to the [nas/bin/admin/reports] folder under the home folder of the name/address server.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

LIST_NAME

STRING

none

none

none

empty string

The list name is optional and provides a reference for tracking multiple CASS reports.

PARSING_TYPE

STRING

NA_ADDRESSONLY, NA_NAMEANDADDRESS, NA_NAMEONLY

none

none

NA_NAMEANDADDRESS

Select a name-address parsing type to be performed on the input data

PRIMARY_COUNTRY

STRING

NA_AND, NA_ARE, NA_ARG, NA_AUS, NA_AUT, NA_BEL, NA_BGD, NA_BGR, NA_BHS, NA_BLZ, NA_BMU, NA_BRA, NA_BRB, NA_BRN, NA_CAN, NA_CHE, NA_CHL, NA_CHN, NA_COL, NA_CZE, NA_DEU, NA_DNK, NA_EGY, NA_ESP, NA_EST, NA_FIN, NA_FRA, NA_GBR, NA_GRC, NA_GUM, NA_HKG, NA_HUN, NA_ICL, NA_IND, NA_IRL, NA_IRN, NA_IRQ, NA_ISR, NA_ITA, NA_JAM, NA_JOR, NA_JPN, NA_KHM, NA_KOR, NA_LIE, NA_LTU, NA_LUX, NA_LVA, NA_MEX, NA_MYS, NA_NLD, NA_NOR, NA_NZL, NA_PAK, NA_PER, NA_PHL, NA_POL, NA_PRT, NA_ROM, NA_RUS, NA_SGP, NA_SVN, NA_SWE, NA_THA, NA_UKR, NA_USA, NA_VEN, NA_YUG, NA_ZAF

none

none

NA_USA

Select the primary parsing country which best represents the input data. Input addresses having the same country as the primary parsing country will only need to be parsed once. Input addresses having a different country than the primary parsing country may be reparsed by a different parser. For performance reasons, it is best to minimize the percentage of 2-pass parses by selecting the optimal parser.

PROCESSOR_NAME

STRING

none

none

none

empty string

The processor name is the name of the organization submitting the CASS report.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

OUTPUT_PARAMETER_OPERATOR Object

Table 20-88 OUTPUT_PARAMETER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

The name to use when refering to this entity in generated code.

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

OUTPUT_SIGNATURE_OPERATOR Object

Table 20-89 OUTPUT_SIGNATURE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_OPERATOR Object

Table 20-90 PIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

PIVOT_GROUP_SIZE

NUMBER

none

1

1000

2

A number specifying the pivot group size for the pivot operation. Pivot group size determines the number of output rows that are produced from each input row.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PLUGGABLE_MAPPING_OPERATOR Object

Table 20-91 PLUGGABLE_MAPPING_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

POSTMAPPING_PROCESS_OPERATOR Object

Table 20-92 POSTMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

POSTMAPPING_PROCESS_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS, ON_WARNING

none

none

ON_SUCCESS

Indicates under what condition of the mapping the post-mapping process will be run.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

PREMAPPING_PROCESS_OPERATOR Object

Table 20-93 PREMAPPING_PROCESS_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

MAPPING_RUN_CONDITION

STRING(10)

ALWAYS, ON_ERROR, ON_SUCCESS

none

none

ON_SUCCESS

Indicates under what condition of the pre-mapping process the mapping will be run.

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

QUEUE_OPERATOR Object

Table 20-94 QUEUE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_AQ_UOID

STRING

none

none

none

empty string

The UOID of the Advanced Qeue object to which this stage component is bound to.

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.

DB_LOCATION

STRING

none

none

none

empty string

The location used to access this entity during mapping.

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

GENERATE_SUBSCRIBER

BOOLEAN

true, false

none

none

true

This only applies to batch mappings. This specifies whether the subscriber is generated. The name of the subscriber is the owning map. If the queue being sourced is a propagation queue with the same name as the owning map, then set to false.

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

IS_REALTIME_SOURCE

BOOLEAN

true, false

none

none

false

IS_STREAMS_QUEUE

BOOLEAN

true, false

none

none

false

PAYLOAD_NAME

STRING

none

none

none

empty string

The name of payload type.

QUEUE_TABLE_NAME

STRING

none

none

none

empty string

The name of the queue table that is used to perist the messages in this Advanced Queue.

REAL_TIME_DATA_FORMAT

STRING

LOGICAL_CHANGE_RECORD, MESSAGE

none

none

MESSAGE

The format for this message, either user-defined or LCR

SOURCE_TABLES

STRING

none

none

none

empty string

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.

TEMPORARY_TABLE_NAME

STRING

none

none

none

empty string

The name of the temporary table that will stage the messages from the Advanced Queue.

UDT

STRING

none

none

none

empty string

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SEQUENCE_OPERATOR Object

Table 20-95 SEQUENCE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SET_OPERATION_OPERATOR Object

Table 20-96 SET_OPERATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

SET_OPERATION

STRING

INTERSECT, MINUS, UNION, UNIONALL

none

none

UNION

Specifies the set operation that is to be performed by this operator.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SORTER_OPERATOR Object

Table 20-97 SORTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

ORDER_BY_CLAUSE

STRING

none

none

none

empty string

The Order By Clause

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

SPLITTER_OPERATOR Object

Table 20-98 SPLITTER_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

TABLE_FUNCTION_OPERATOR Object

Table 20-99 TABLE_FUNCTION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

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

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

TABLE_FUNCTION_IS_TARGET

BOOLEAN

true, false

none

none

false

Description not available.

TABLE_FUNCTION_NAME

STRING

none

none

none

empty string

The name of the Table Function

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

TABLE_OPERATOR Object

Table 20-100 TABLE_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

Description not available.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

CONFLICT_RESOLUTION

BOOLEAN

true, false

none

none

true

Detect and resolve any conflicts that may arise during DML using the LCR APIs

CONTROL_CK

STRING

none

none

none

empty string

Set Control Code Template Params for Check Constraint.

CONTROL_DATA_RULES

STRING

none

none

none

empty string

Set Control Code Template Params for Data Rules.

CONTROL_FK

STRING

none

none

none

empty string

Set Control Code Template Params for Foreign Keys.

CONTROL_NN

STRING

none

none

none

empty string

Set Control Code Template Params for Not Null attributes.

CONTROL_PK

STRING

none

none

none

empty string

Set Control Code Template Params for Primary Keys.

CONTROL_UK

STRING

none

none

none

empty string

Set Control Code Template Params for Unique Keys.

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_LOCATION

STRING(30)

none

none

none

empty string

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

ISAPPLYSOURCE

BOOLEAN

true, false

none

none

false

Generate Non Trigger Apply uptime script considering this is a leading source for the map

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_ERROR_TABLE

BOOLEAN

true, false

none

none

false

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_STATIC_TABLE

BOOLEAN

true, false

none

none

false

Check source table operator static

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

IS_USER-DEFINED_DATA

BOOLEAN

true, false

none

none

false

If TRUE, test data for this source or target is user-defined

JOINRANK

FLOAT

none

none

none

0

Join Rank

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

OPTIMIZE_MERGE

BOOLEAN

true, false

none

none

false

Optimize the execution of expressions by deferring them until really needed

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.

USE_LCR_API

BOOLEAN

true, false

none

none

true

Use LCR APIs if possible to perform the DML

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

ZDT_DOWNTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Downtime Extraction Index Hints

ZDT_DOWNTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

ZDT_UPTIME_EXTRACT_INDEX_NAME

STRING

none

none

none

empty string

Uptime Extraction Index Hints

ZDT_UPTIME_EXTRACT_INDEX_UOID

STRING

none

none

none

empty string

TRANSFORMATION_OPERATOR Object

Table 20-101 TRANSFORMATION_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

BOUND_NAME

STRING

none

none

none

empty string

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_BRKPT_ENABLED

BOOLEAN

true, false

none

none

false

DEBUG_BRKPT_SET

BOOLEAN

true, false

none

none

false

DEBUG_DB_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

BOOLEAN

true, false

none

none

false

FUNCTION_CALL

STRING

none

none

none

empty string

Expression template for procedure call

FUNCTION_NAME

STRING

none

none

none

empty string

HEIGHT

NUMBER

none

none

none

150

IS_MAXIMIZED

BOOLEAN

true, false

none

none

false

IS_MINIMIZED

BOOLEAN

true, false

none

none

false

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

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.

OWNER_IM

STRING(30)

none

none

none

empty string

Owning installed module of the entity used to create this mapping component.

RETURN_TYPE

STRING

none

none

none

empty string

Description not available.

ROW-BASED_ONLY

BOOLEAN

true, false

none

none

false

Indicates if this transformation must be used only Row Based mode. Some transformations can be used in SQL mode as well as Row Based mode.

ROW_COUNT

STRING

none

none

none

empty string

Row count

ROW_COUNT_ENABLED

BOOLEAN

true, false

none

none

false

Row count enabled

SCHEMA

STRING(30)

none

none

none

empty string

Schema

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

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

UNPIVOT_OPERATOR Object

Table 20-102 UNPIVOT_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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

VIEW_OPERATOR Object

Table 20-103 VIEW_OPERATOR Object

Property
Type
Choices
Min
Max
Default
Description

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.

CDC_FILTER_CONDITION

STRING

none

none

none

--INOUTGRP1.JRN_SUBSCRIBER = 'SUNOPSIS'

Set filter to capture for a specific subscriber.

CDC_METHOD

STRING

CONSISTENT, NONE, SIMPLE

none

none

NONE

Is the change data capture method consistent or not consistent.

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.

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_LOCATION

STRING(30)

none

none

none

empty string

DEBUG_USE_AS_SOURCE

BOOLEAN

true, false

none

none

false

DEBUG_WATCH_SET

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.

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.

EXTRACTION_HINT

STRING

none

none

none

empty string

Hint used when extracting from this table using SQL

HEIGHT

NUMBER

none

none

none

150

INLINED

BOOLEAN

true, false

none

none

false

If set to true, the view query will be used as an inline subquery in the generated code.

IS_CDC

BOOLEAN

true, false

none

none

false

Is change data capture enabled?

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_TRIGGER_CDC

BOOLEAN

true, false

none

none

false

Triggers on source tables are used to capture and propagate changes.

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(16)

CHECK_INSERT, DELETE, DELETE_INSERT, DERIVE_FROM_LCR, INSERT, INSERT_UPDATE, NONE, TRUNCATE_INSERT, UPDATE, UPDATE_INSERT

none

none

INSERT

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

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

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.

VIEW_QUERY

STRING

none

none

none

empty string

The query text for this view.

WIDTH

NUMBER

none

none

none

180

X_COORDINATE

NUMBER

none

none

none

0

Y_COORDINATE

NUMBER

none

none

none

0

See Also

OMBRETRIEVE

OMBCREATE REAL_TIME_MAPPING

OMBALTER REAL_TIME_MAPPING

OMBDROP REAL_TIME_MAPPING

OMBRETRIEVE REGISTERED_FUNCTION

Purpose

Retrieve details of a function.

Prerequisites

Should be in the context of a Business Definition Module or use the full path.

Syntax

retrieveRegisteredFunctionCommand =  OMBRETRIEVE REGISTERED_FUNCTION
          "QUOTED_STRING" ( "retrieveFunctionClause" |
          "retrieveFunctionArgClause" )
     retrieveFunctionClause =  GET ( "getPropertiesClauseforRegFun" |
          "getReferenceIconSetClause" | "getFunctionSCOClause" )
     retrieveFunctionArgClause =  PARAMETER "QUOTED_STRING" GET
          "getPropertiesClause"
     getPropertiesClauseforRegFun =  PROPERTIES "(" "propertyNameListforRegFun"
          ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getFunctionSCOClause =  PARAMETERS | DERIVATION_SOURCE
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameListforRegFun =  ( "UNQUOTED_STRING" | ( PACKAGE | SIGNATURE )
          ) { "," ( "UNQUOTED_STRING" | ( PACKAGE | SIGNATURE ) ) }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveRegisteredFunctionCommand

To retrieve a function.

QUOTED_STRING

name of the function.

retrieveFunctionClause

Retrieves the contents of the function.

GET

For registered function this clause retrieves the following

PARAMETERS retrieves the list of parameters owned by this registered function.

DERIVATION_SOURCE retrieves the component that the registered function was derived from.

retrieveFunctionArgClause

Retrieves properties of the function parameter.

getPropertiesClauseforRegFun

Retrieves the properties of the object.

getReferenceIconSetClause

Get specified Icon Set.

getFunctionSCOClause

Retrieves the parameters of the function.

getPropertiesClause

Retrieves 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

propertyNameListforRegFun

This is the list of property names.

propertyNameList

This is the list of property names.

REGISTERED_FUNCTION Object

Table 20-104 REGISTERED_FUNCTION Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBALTER REGISTERED_FUNCTION

OMBCREATE REGISTERED_FUNCTION

21 OMBRETRIEVE ROLE to OMBREVOKE SYS_PRIV

OMBRETRIEVE ROLE

OMBRETRIEVE SAP_MODULE

OMBRETRIEVE SEQUENCE

OMBRETRIEVE SIEBEL_MODULE

OMBRETRIEVE SNAPSHOT

OMBRETRIEVE TABLE

OMBRETRIEVE TABLE_FUNCTION

OMBRETRIEVE TIME_DIMENSION

OMBRETRIEVE TRANSPORTABLE_MODULE

OMBRETRIEVE UNQUOTED_STRING

OMBRETRIEVE USER

OMBRETRIEVE VARYING_ARRAY

OMBRETRIEVE VIEW

OMBRETRIEVE WEB_SERVICE

OMBRETRIEVE WEB_SERVICE_PACKAGE

OMBREVERT

OMBREVOKE DEFAULT_OBJ_PRIV

OMBREVOKE J2EE_ROLE

OMBREVOKE OBJ_PRIV

OMBREVOKE ROLE

OMBREVOKE SYS_PRIV

OMBRETRIEVE ROLE

Purpose

To retrieve properties of a Warehouse Builder role.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

retrieveRoleCommand =  OMBRETRIEVE ROLE "QUOTED_STRING" ( GET
          "getPropertiesClause" )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveRoleCommand

This clause retrieves properties of a Warehouse Builder role.

getPropertiesClause

Retrieve specified properties.

getPropertiesClause

Basic properties for ROLE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the role

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the role

propertyNameList

A list of valid properties are shown in section of Basic properties for Role.

See Also

OMBCREATE ROLE

OMBALTER ROLE

OMBDROP ROLE

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

OMBRETRIEVE SEQUENCE

Purpose

To retrieve properties of a sequence.

Prerequisites

In the context of an Oracle Module

Syntax

retrieveSequenceCommand =  OMBRETRIEVE SEQUENCE "QUOTED_STRING" ( GET (
          "getPropertiesClause" | "getReferenceIconSetClause" ) |
          "retrieveColumnClause" )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     retrieveColumnClause =  COLUMN "QUOTED_STRING" GET "getPropertiesClause"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveSequenceCommand

This clause retrieves properties of a sequence.

getPropertiesClause

This clause retrieves all the 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.

retrieveColumnClause

This clause will retrieve columns.

QUOTED_STRING

Name of the column.

propertyNameList

The list of properties.

SEQUENCE Object

Table 21-1 SEQUENCE Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE

OMBCREATE SEQUENCE

OMBALTER SEQUENCE

OMBDROP SEQUENCE

OMBRETRIEVE SIEBEL_MODULE

Purpose

retrieveSiebelModuleCommandPurposeTag??

Prerequisites

retrieveSiebelModuleCommandPreTag??

Syntax

retrieveSiebelModuleCommand =  OMBRETRIEVE SIEBEL_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

corePropertiesForSiebelModuleTag??

See Also

OMBRETRIEVE

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.

See Also

OMBCREATE SNAPSHOT

OMBALTER SNAPSHOT

OMBDROP SNAPSHOT

OMBRESTORE SNAPSHOT

OMBCOMPARE SNAPSHOT

OMBLIST SNAPSHOT

OMBRETRIEVE TABLE

Purpose

To retrieve properties of a table.

Prerequisites

In the context of an Oracle Module

Syntax

retrieveTableCommand =  OMBRETRIEVE TABLE "QUOTED_STRING" (
          "retrieveTableClause" | "retrieveColumnClause" | "retrieveUkPkClause"
          | "retrieveFkClause" | "retrieveAttributeSetClause" |
          "retrieveCheckConstraintClause" |
          "retrievePartitionConfigurationClause" |
          "retrievePartitionKeyConfigurationClause" |
          "retrieveTemplateSubpartitionConfigurationClause" |
          "retrieveSubPartitionConfigurationClause" |
          "retrieveSubPartitionKeyConfigurationClause" |
          "retrieveIndexConfigurationClause" | "retrieveDataRuleUsageClause" )
     retrieveTableClause =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | "getTableSCOClause" )
     retrieveColumnClause =  COLUMN "QUOTED_STRING" GET "getPropertiesClause"
     retrieveUkPkClause =  ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" GET (
          "getPropertiesClause" | COLUMNS )
     retrieveFkClause =  FOREIGN_KEY "QUOTED_STRING" GET ( "getPropertiesClause"
           | COLUMNS | UNIQUE_KEY | PRIMARY_KEY | REFERENCED_KEY )
     retrieveAttributeSetClause =  ATTRIBUTE_SET "QUOTED_STRING" GET (
          "getPropertiesClause" | ATTRIBUTES )
     retrieveCheckConstraintClause =  CHECK_CONSTRAINT "QUOTED_STRING" GET
          "getPropertiesClause"
     retrievePartitionConfigurationClause =  PARTITION "QUOTED_STRING" GET
          "getConfigurationPropertiesClause"
     retrievePartitionKeyConfigurationClause =  PARTITION_KEY "QUOTED_STRING"
          GET "getConfigurationPropertiesClause"
     retrieveTemplateSubpartitionConfigurationClause =  TEMPLATE_SUBPARTITION
          "QUOTED_STRING" GET "getConfigurationPropertiesClause"
     retrieveSubPartitionConfigurationClause =  SUBPARTITION "QUOTED_STRING" OF
          PARTITION "QUOTED_STRING" GET "getConfigurationPropertiesClause"
     retrieveSubPartitionKeyConfigurationClause =  SUBPARTITION_KEY
          "QUOTED_STRING" GET "getConfigurationPropertiesClause"
     retrieveIndexConfigurationClause =  INDEX "QUOTED_STRING" ( GET (
          "getConfigurationPropertiesClause" | INDEX_COLUMNS | INDEX_PARTITIONS
          | INDEX_PARTITION_KEYS ) | ( INDEX_COLUMN "QUOTED_STRING" GET
          "getConfigurationPropertiesClause" ) | ( INDEX_PARTITION_KEY
          "QUOTED_STRING" GET "getConfigurationPropertiesClause" ) | (
          INDEX_PARTITION "QUOTED_STRING" GET "getConfigurationPropertiesClause"
           ) )
     retrieveDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" ( GET (
          "getPropertiesClause" | GROUPS ) | GROUP "QUOTED_STRING" ( GET (
          "getPropertiesClause" | ATTRIBUTES | REF ( TABLE | VIEW |
          MATERIALIZED_VIEW | EXTERNAL_TABLE ) ) | ATTRIBUTE "QUOTED_STRING" (
          GET ( "getPropertiesClause" | REF COLUMN ) ) ) )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getTableSCOClause =  COLUMNS | UNIQUE_KEYS | PRIMARY_KEYS | PRIMARY_KEY |
          FOREIGN_KEYS | CHECK_CONSTRAINTS | COLUMN AT POSITION
          "INTEGER_LITERAL" | INDEXES | INDEX_PARTITION_KEYS OF INDEX
          "QUOTED_STRING" | INDEX_PARTITIONS OF INDEX "QUOTED_STRING" |
          PARTITIONS | SUBPARTITIONS OF PARTITION "QUOTED_STRING" |
          TEMPLATE_SUBPARTITIONS | PARTITION_KEYS | SUBPARTITION_KEYS |
          DATA_RULE_USAGES | ATTRIBUTE_SETS
     getConfigurationPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveTableCommand

This clause retrieves a table.

QUOTED_STRING

Name of the table.

retrieveTableClause

This clause retrieves a table.

retrieveColumnClause

This clause will retrieve columns.

QUOTED_STRING

Name of the column.

retrieveUkPkClause

This clause will retrieve a unique key or primary key.

QUOTED_STRING

Name of the unique key or the primary key.

retrieveFkClause

This clause will retrieve a key referenced by a foreign key, either a unique key or primary key. Use REFERENCED_KEY to retrieve the referenced key for a foreign key regardless of the type of referenced key (unique or primary).

QUOTED_STRING

Name of the foreign key.

retrieveCheckConstraintClause

This clause gets the check constraint.

QUOTED_STRING

Name of the check constraint.

retrievePartitionConfigurationClause

Gets the partition.

QUOTED_STRING

The partition name.

retrievePartitionKeyConfigurationClause

This clause gets the partition key.

QUOTED_STRING

The name of the partition key.

retrieveIndexConfigurationClause

Gets the index in this clause.

QUOTED_STRING

Name of the index.

retrieveDataRuleUsageClause

This clause retrieves the data rule usages.

QUOTED_STRING

Name of data rule usage, group or attribute.

GROUPS

Retrieve the names of all relation groups in the data rule usage.

ATTRIBUTES

Retrieve the names of all attributes in a data rule usage group.

TABLE

Table name associated withthe data rule usage group.

VIEW

View name associated withthe data rule usage group.

MATERIALIZED_VIEW

Materialized view name associated with the data rule usage group.

EXTERNAL_TABLE

External table name associated with the data rule usage group.

COLUMN

Column name associated with the data rule usage group attribute.

getPropertiesClause

This clause retrieves all the properties.

getPropertiesClause

Basic properties for TABLE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the table

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the table

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.

getTableSCOClause

This clause retrieves components like columns, indexes etc. of a table.

getConfigurationPropertiesClause

This clauses gets the configuration properties of the object.

propertyNameList

The list of properties.

TABLE Object

Table 21-2 TABLE Object

Property
Type
Choices
Min
Max
Default
Description

ANALYZE_TABLE_ESTIMATE_PERCENT

STRING

none

none

none

empty string

Value represents the sample size as a percentage (0-100) of total rows. When set to a nonzero value, Builder generates a DDL script to analyze the table. The default is 99.

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.

CACHE_MODE

STRING

, CACHE, NOCACHE

none

none

empty string

Indicate how Oracle should store blocks in the buffer cache.

CDC_POSITION

NUMBER

none

none

none

0

Table position in change data capture.

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

false

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string

Use the Tablespace parameter to specify the name of tablespace.

ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string

Use the error table name to specify the name of Error Table.

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.

GENERATE_ERROR_TABLE_ONLY

BOOLEAN

true, false

none

none

false

Create, drop, replace or upgrade only the error table.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

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.

IS_CDC

BOOLEAN

true, false

none

none

false

Enable table for change data capture

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.

MONITORING_MODE

STRING

, MONITORING, NOMONITORING

none

none

empty string

Specify MONITORING if you want modification statistics to be collected on this table.

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.

OVERFLOW

STRING

none

none

none

empty string

Enter a comma separated list of tablespaces for overflow data. For simple-partitoned object, it is used for HASH BY QUANTITY partition overflow tablespaces. The number of tablespaces does not have to equal the number of partitions. If the number of partitions is greater than the number of tablespaces, then Oracle cycles through the names of the 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 simple-partitoned object, it is used for HASH BY QUANTITY partition tablespaces. For composite-partitioned tables, it is used for subpartition template to store a list of tablespaces.

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.

ROWDEPENDENCIES_MODE

STRING

, NOROWDEPENDENCIES, ROWDEPENDENCIES

none

none

empty string

Specify ROWDEPENDENCIES to use row-level dependency tracking.

ROW_MOVEMENT

STRING

, DISABLE, ENABLE

none

none

empty string

Specify whether Oracle can move a table row.

TABLESPACE

STRING(30)

none

none

none

empty string

COLUMN Object

Table 21-3 COLUMN Object

Property
Type
Choices
Min
Max
Default
Description

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

PRIMARY_KEY Object

Table 21-4 PRIMARY_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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

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.

STREAMS_ADMINISTRATOR_LOCATION

STRING

none

none

none

empty string

The location corresponding to the Streams Administrator

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

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.

UNIQUE_KEY Object

Table 21-5 UNIQUE_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 21-6 FOREIGN_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 21-7 CHECK_CONSTRAINT Object

Property
Type
Choices
Min
Max
Default
Description

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 21-8 INDEX Object

Property
Type
Choices
Min
Max
Default
Description

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 21-9 PARTITION Object

Property
Type
Choices
Min
Max
Default
Description

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

See Also

OMBRETRIEVE

OMBCREATE TABLE

OMBALTER TABLE

OMBDROP TABLE

OMBRETRIEVE TABLE_FUNCTION

Purpose

Retrieve details of the 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 in corresponding Package.

Syntax

retrieveTableFunctionCommand =  OMBRETRIEVE TABLE_FUNCTION "QUOTED_STRING"
          ( "retrieveTableFunctionClause" | "retrieveParameterClause" )
     retrieveTableFunctionClause =  GET ( "propertiesClauseNoGet" |
          "getParametersClause" | "getOrderedFieldsClause" |
          "getPartitionedFieldsClause" | ( REF | REFERENCE ) ICONSET )
     retrieveParameterClause =  PARAMETER "QUOTED_STRING" "getPropertiesClause"
     propertiesClauseNoGet =  PROPERTIES "(" "propertyNameList" ")"
     getParametersClause =  PARAMETERS
     getOrderedFieldsClause =  ORDERED_FIELDS
     getPartitionedFieldsClause =  PARTITIONED_FIELDS
     getPropertiesClause =  GET PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveTableFunctionCommand

Retrieve details regarding a Table Function.

retrieveTableFunctionClause

Retrieve details regarding a Table Function.

retrieveParameterClause

Gets the properties of Parameter with the given name.

propertiesClauseNoGet

Gets the properties of the table function.

getParametersClause

Lists the Parameter names of this Table Function.

getOrderedFieldsClause

Lists the Field names of this Table Function on which the Ordering is to be done.

getPartitionedFieldsClause

Lists the Field names of this Table Function on which the Partitioning is to be done.

getPropertiesClause

Gets the properties of the Table Function or any of its Parameter

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

propertyNameList

Comma separated list of property names to retrieve values. Property names are unquoted.

TABLE_FUNCTION Object

Table 21-10 TABLE_FUNCTION Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE

OMBRETRIEVE TIME_DIMENSION

Purpose

This command retrieve metadata from the time dimension.

Prerequisites

Should be in Oracle Module context.

Syntax

retrieveTimeDimensionCommand =  OMBRETRIEVE TIME_DIMENSION
          "TimeDimensionName" ( GET ( PROPERTIES "propertyKeyList" | FISCAL
          PROPERTIES "propertyKeyList" | DIMENSION_ATTRIBUTES | LEVELS |
          HIERARCHIES | DIMENSION_ROLES | YEARS | START_YEAR |
          IMPLEMENTATION_STRATEGY | MAPPING | IMPLEMENTED_OBJECTS ) |
          "dimensionAttributeDetailClause" | "levelDetailClause" |
          "hierarchyDetailClause" | "roleDetailClause" )
     TimeDimensionName =  "QUOTED_STRING"
     propertyKeyList =  "(" "propertyKey" { "," "propertyKey" } ")"
     dimensionAttributeDetailClause =  "dimensionAttributeLocator" GET
          PROPERTIES "propertyKeyList"
     levelDetailClause =  "levelLocator" ( GET ( PROPERTIES "propertyKeyList" |
          LEVEL_ATTRIBUTES | IMPLEMENTED_OBJECT ) | "levelAttributeDetailClause"
           )
     hierarchyDetailClause =  "hierarchyLocator" GET ( PROPERTIES
          "propertyKeyList" | ( REF | REFERENCE ) LEVELS )
     roleDetailClause =  "roleLocator" ( GET ( PROPERTIES "propertyKeyList" ) )
     propertyKey =  "UNQUOTED_STRING"
     dimensionAttributeLocator =  DIMENSION_ATTRIBUTE "dimensionAttributeName"
     levelLocator =  LEVEL "levelName"
     levelAttributeDetailClause =  "levelAttributeLocator" GET ( PROPERTIES
          "propertyKeyList" | IMPLEMENTED COLUMN )
     hierarchyLocator =  HIERARCHY "hierarchyName"
     roleLocator =  ROLE "roleName"
     dimensionAttributeName =  "QUOTED_STRING"
     levelName =  "QUOTED_STRING"
     levelAttributeLocator =  LEVEL_ATTRIBUTE "levelAttributeName"
     hierarchyName =  "QUOTED_STRING"
     roleName =  "QUOTED_STRING"
     levelAttributeName =  "QUOTED_STRING"

Parameters

retrieveTimeDimensionCommand

This clause retrieves informtion about TIME_DIMENSION, PROPERTIES, FISCAL, DIMENSION_ATTRIBUTES, LEVELS, HIERARCHIES, DIMENSION_ROLES, YEARS, START_YEAR, IMPLEMENTATION_STRATEGY, MAPPING, IMPLEMENTED_OBJECTS.

TimeDimensionName

The name of the time dimension.

propertyKeyList

A list of time dimension properties.

dimensionAttributeDetailClause

This clause gets property details of dimension attribute.

levelDetailClause

This clause gets property details of a level.

hierarchyDetailClause

This clause gets property details of a hierarchy.

roleDetailClause

This clause gets property details of a role.

propertyKey

Property Key in a 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

dimensionAttributeLocator

Dimension Attribute Locator.

levelLocator

This clause gets the level.

levelAttributeDetailClause

This clause gets property details of a level attribute.

hierarchyLocator

This clause gets the hierarchy.

roleLocator

This clause finds a Time Dimension role.

dimensionAttributeName

Dimension Attribute Name in QUOTED_STRING.

levelName

The level name in QUOTED_STRING.

levelAttributeLocator

This clause gets the level Attribute.

hierarchyName

The name of a hierarchy.

roleName

A role name.

levelAttributeName

The level attribute name in QUOTED_STRING.

DIMENSION Object

Table 21-11 DIMENSION Object

Property
Type
Choices
Min
Max
Default
Description

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 21-12 HIERARCHY Object

Property
Type
Choices
Min
Max
Default
Description

HIERLOADLEVEL

STRING

none

none

none

empty string

See Also

OMBCREATE TIME_DIMENSION

OMBALTER TIME_DIMENSION

OMBDROP TIME_DIMENSION

OMBRETRIEVE TRANSPORTABLE_MODULE

Purpose

To retrieve properties of a transportable module, its contents and their properties, and source and target locations.

Prerequisites

In the context of a project.

Syntax

retrieveTMCommand =  OMBRETRIEVE TRANSPORTABLE_MODULE "QUOTED_STRING" GET (
           "getPropertiesClause" | "getTablespacePropertiesClause" |
          "getDatafilePropertiesClause" | "getSchemaPropertiesClause" |
          "getTablespacesClause" | "getDatafilesInTablespaceClause" |
          "getSchemasInTablespaceClause" | "getAllSchemasClause" |
          "getSourceLocationClause" | "getTargetLocationClause" |
          "getReferenceIconSetClause" )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getTablespacePropertiesClause =  TRANSPORTABLE_MODULE_TABLESPACE
          "QUOTED_STRING" PROPERTIES "(" "propertyNameList" ")"
     getDatafilePropertiesClause =  DATAFILE "QUOTED_STRING" PROPERTIES "("
          "propertyNameList" ")"
     getSchemaPropertiesClause =  TRANSPORTABLE_MODULE_SCHEMA "QUOTED_STRING"
          PROPERTIES "(" "propertyNameList" ")"
     getTablespacesClause =  TRANSPORTABLE_MODULE_TABLESPACES
     getDatafilesInTablespaceClause =  DATAFILES IN
          TRANSPORTABLE_MODULE_TABLESPACE "QUOTED_STRING"
     getSchemasInTablespaceClause =  TRANSPORTABLE_MODULE_SCHEMAS IN
          TRANSPORTABLE_MODULE_TABLESPACE "QUOTED_STRING"
     getAllSchemasClause =  ALL TRANSPORTABLE_MODULE_SCHEMAS
     getSourceLocationClause =  SOURCE_LOCATION
     getTargetLocationClause =  TARGET_LOCATION
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveTMCommand

This command is for querying information about the transportable module and its contents.

getPropertiesClause

Retrieve properties for the transportable module.

getTablespacePropertiesClause

Retrieve properties for a tablespace within the transportable module.

QUOTED_STRING

The name of the tablespace whose properties are to be retrieved.

getDatafilePropertiesClause

Retrieve properties for a datafile within the transportable module.

QUOTED_STRING

The name of the datafile whose properties are to be retrieved.

getSchemaPropertiesClause

Retrieve properties for a schema within the transportable module.

QUOTED_STRING

The name of the schema whose properties are to be retrieved.

getTablespacesClause

Retrieve names of all tablespaces in the transportable module.

getDatafilesInTablespaceClause

Retrieve names of all datafiles of a tablespace within the transportable module.

QUOTED_STRING

The name of the tablespace whose datafile names are to be retrieved.

getSchemasInTablespaceClause

Retrieve names of schemas that are parts of the named tablespace.

QUOTED_STRING

The name of the tablespace whose component schemas names are to be retrieved.

getAllSchemasClause

Retrieve names of all schemas within the transportable module.

getSourceLocationClause

Retrieve name of the source location.

getTargetLocationClause

Retrieve name of the target location.

getReferenceIconSetClause

Retrieve name of the icon set.

propertyNameList

The list of unquoted property names.

See Also

OMBRETRIEVE

OMBCREATE TRANSPORTABLE_MODULE

OMBALTER TRANSPORTABLE_MODULE

OMBRETRIEVE UNQUOTED_STRING

Purpose

Retrieve details of the module.

Prerequisites

Should be in the context of project.

Syntax

parseRetrieveCommand =  OMBRETRIEVE ( "UNQUOTED_STRING" "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

Basic properties for module:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of the module

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the module

See Also

OMBCREATE

OMBRETRIEVE USER

Purpose

To retrieve properties of a Warehouse Builder user.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

retrieveUserCommand =  OMBRETRIEVE USER "QUOTED_STRING" ( GET
          "getPropertiesClause" )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveUserCommand

This clause retrieves properties of a Warehouse Builder user.

getPropertiesClause

Retrieve specified properties.

getPropertiesClause

Basic properties for USER:

getPropertiesClause

Name: PROMPT_FOR_COMMIT
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: PROMPT_FOR_JOB_NAME
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: PROMPT_FOR_EXECUTION_PARAMS
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_MONITOR
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_DEPLOYMENT_COMPLETION
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_DEPLOYMENT_DEPENDENCIES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_MONITOR_RESULTS
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_MONITOR_LOGFILE
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: PERSONALITY
Type: STRING
Valid Values: Any valid character string in supported character set.
Default:  Default

Name: SHOW_GUIDED_ASSISTANCE
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: HIDE_WIZARD_WELCOME_PAGES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_DELETE_CONFIRMATION
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: RECYCLE_DELETED_OBJECTS
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: EMPTY_RECYCLE_BIN
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: CLEAR_CLIPBOARD
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_GENERATION_PROJECT
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_GENERATION_MODULE
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: SHOW_GENERATION_LOCATION
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_GENERATION_ACTION
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: SHOW_GENERATION_TYPE
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: LOG_FILE_PATH
Type: STRING(1000)
Valid Values: Any valid character string in supported character set.
Default: Empty string

Name: LOG_FILE_NAME
Type: STRING(1000)
Valid Values: Any valid character string in supported character set.
Default:  log

Name: LOG_FILE_MAX_SIZE
Type: STRING
Valid Values: 1-10000000
Default:  100

Name: LOG_ERROR_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: LOG_WARNING_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: LOG_INFORMATION_MESSAGES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: NAMING_MODE
Type: STRING
Valid Values: PHYSICAL_NAMING_MODE, BUSINESS_NAMING_MODE
Default:  PHYSICAL_NAMING_MODE

Name: PROPAGATE_NAME_CHANGES
Type: BOOLEAN
Valid Values: true, false
Default:  false

Name: DESIGNREPOS_PWD_PERSIST
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: RUNTIMEREPOS_PWD_SHARE
Type: BOOLEAN
Valid Values: true, false
Default:  true

Name: DEFAULT_SEC_POLICY
Type: STRING
Valid Values: MINIMUM_SECURITY, MAXIMUM_SECURITY
Default:  MINIMUM_SECURITY

propertyNameList

A list of valid properties are shown in section of Basic properties for USER.

See Also

OMBUNREGISTER USER

OMBALTER USER

OMBREGISTER USER

OMBRETRIEVE VARYING_ARRAY

Purpose

Retrieve details of the Varying Array.

Prerequisites

Should be in the context of an Oracle Module.

Syntax

retrieveVaryingArrayCommand =  OMBRETRIEVE VARYING_ARRAY "QUOTED_STRING" (
          GET ( "getPropertiesClause" | "getReferenceIconSetClause" ) )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveVaryingArrayCommand

Retrieves the details of the Varying Array with the given name.

getPropertiesClause

This clause retrieves all the properties.

getPropertiesClause

Basic properties for VARYING_ARRAY:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Varying Array

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Varying Array

Name: DATATYPE
Type: STRING(20)
Valid Values: BINARY_DOUBLE, BINARY_FLOAT, BLOB, CHAR, CLOB, DATE, FLOAT, INTEGER, INTERVAL DAY TO SECOND, INTERVAL YEAR TO MONTH, NCHAR, NCLOB, NUMBER, NVARCHAR2, RAW, SYS.ANYDATA, SYS.LCR$_ROW_RECORD, XMLFORMAT, TIMESTAMP, TIMESTAMP WITH LOCAL TIME ZONE, TIMESTAMP WITH TIME ZONE, VARHCAR, VARCHAR2, XMLTYPE
Default: Empty string
Datatype of the Base Element of the Varying Array

getReferenceIconSetClause

Gets reference icon set.

propertyNameList

The list of properties.

VARYING_ARRAY Object

Table 21-13 VARYING_ARRAY Object

Property
Type
Choices
Min
Max
Default
Description

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

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

See Also

OMBRETRIEVE

OMBRETRIEVE VIEW

Purpose

To retrieve properties of a view.

Prerequisites

In the context of an Oracle Module

Syntax

retrieveViewCommand =  OMBRETRIEVE VIEW "QUOTED_STRING" (
          "retrieveViewClause" | "retrieveColumnClause" | "retrieveUkPkClause" |
           "retrieveFkClause" | "retrieveDataRuleUsageClause" )
     retrieveViewClause =  GET ( "getPropertiesClause" |
          "getReferenceIconSetClause" | "getViewSCOorDependentsClause" )
     retrieveColumnClause =  COLUMN "QUOTED_STRING" GET "getPropertiesClause"
     retrieveUkPkClause =  ( UNIQUE_KEY | PRIMARY_KEY ) "QUOTED_STRING" GET (
          "getPropertiesClause" | COLUMNS )
     retrieveFkClause =  FOREIGN_KEY "QUOTED_STRING" GET ( "getPropertiesClause"
           | COLUMNS | UNIQUE_KEY | PRIMARY_KEY | REFERENCED_KEY )
     retrieveDataRuleUsageClause =  DATA_RULE_USAGE "QUOTED_STRING" ( GET (
          "getPropertiesClause" | GROUPS ) | GROUP "QUOTED_STRING" ( GET (
          "getPropertiesClause" | ATTRIBUTES | REF ( TABLE | VIEW |
          MATERIALIZED_VIEW | EXTERNAL_TABLE ) ) | ATTRIBUTE "QUOTED_STRING" (
          GET ( "getPropertiesClause" | REF COLUMN ) ) ) )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferenceIconSetClause =  ( REF | REFERENCE ) ICONSET
     getViewSCOorDependentsClause =  COLUMNS | UNIQUE_KEYS | PRIMARY_KEY |
          FOREIGN_KEYS | COLUMN AT POSITION "INTEGER_LITERAL" | DATA_RULE_USAGES
           | ATTRIBUTE_SETS | ( REF | REFERENCE ) ( TABLES | VIEWS |
          MATERIALIZED_VIEWS )
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveViewCommand

This clause retrieves a view.

QUOTED_STRING

name of the view.

retrieveViewClause

This clause will retrieve a view.

retrieveColumnClause

This clause will retrieve columns.

QUOTED_STRING

Name of the column.

retrieveUkPkClause

This clause will retrieve a unique key or primary key.

QUOTED_STRING

Name of the unique key or the primary key.

retrieveFkClause

This clause will retrieve a key referenced by a foreign key, either a unique key or primary key. Use REFERENCED_KEY to retrieve the referenced key for a foreign key regardless of the type of referenced key (unique or primary).

QUOTED_STRING

Name of the foreign key.

retrieveDataRuleUsageClause

This clause retrieves the data rule usages.

QUOTED_STRING

Name of data rule usage, group or attribute.

GROUPS

Retrieve the names of all relation groups in the data rule usage.

ATTRIBUTES

Retrieve the names of all attributes in a data rule usage group.

TABLE

Table name associated withthe data rule usage group.

VIEW

View name associated withthe data rule usage group.

MATERIALIZED_VIEW

Materialized view name associated with the data rule usage group.

EXTERNAL_TABLE

External table name associated with the data rule usage group.

COLUMN

Column name associated with the data rule usage group attribute.

getPropertiesClause

This clause retrieves all the properties.

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.

getViewSCOorDependentsClause

This clause will retrieves view components like columns, keys, etc. or relational objects that this view hav referential dependency on.

propertyNameList

The list of properties.

VIEW Object

Table 21-14 VIEW Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

false

Warehouse Builder generates a set of scripts to create an object only for those object marked as Deployable = true

ERROR_TABLESPACE

STRING(30)

none

none

none

empty string

Use the Tablespace parameter to specify the name of tablespace.

ERROR_TABLE_NAME

STRING(30)

none

none

none

empty string

Use the error table name to specify the name of Error Table.

GENERATE_ERROR_TABLE_ONLY

BOOLEAN

true, false

none

none

false

Create, drop, replace or upgrade only the error table.

GENERATION_COMMENTS

STRING

none

none

none

empty string

Enter additional comments for the generated code.

COLUMN Object

Table 21-15 COLUMN Object

Property
Type
Choices
Min
Max
Default
Description

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 21-16 UNIQUE_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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 21-17 FOREIGN_KEY Object

Property
Type
Choices
Min
Max
Default
Description

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.

See Also

OMBRETRIEVE

OMBCREATE VIEW

OMBALTER VIEW

OMBDROP VIEW

OMBRETRIEVE WEB_SERVICE

Purpose

Retrieves the details of the Web Service.

Prerequisites

Should be in the context of a Web Service Package or an Application Server Module, public web service should be in the context of public Application Server Module.

Syntax

retrieveWebServiceCommand =  OMBRETRIEVE WEB_SERVICE "QUOTED_STRING" GET (
          "getPropertiesClause" | ( REF "getReferencedObjectClauses" ) )
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     getReferencedObjectClauses =  [ WEBSERVICE_OBJECT ]
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveWebServiceCommand

Retrieve the detail of the web service.

getPropertiesClause

Used to get properties (core, user-defined) for Web service. Valid properties are shown below:

getPropertiesClause

Base properties for WEB_SERVICE:
Basic properties for Web Service:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Web Service

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Web Service :

Name: WSDLURL
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
WSDL url of the public Web Service :

Name: SPEC
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
SPECIFICATION of the Web Service :

getReferencedObjectClauses

Retrieve the detail of the referenced object of the non-public web service.

propertyNameList

A list of property names.

WEB_SERVICE Object

Table 21-18 WEB_SERVICE Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

The Web service is deployable or not

See Also

OMBRETRIEVE

OMBCREATE WEB_SERVICE

OMBALTER WEB_SERVICE

OMBDROP WEB_SERVICE

OMBRETRIEVE WEB_SERVICE_PACKAGE

Purpose

Retrieve details of the Web Service Package.

Prerequisites

Should be in the context of a Web Service Module.

Syntax

retrieveWebServicePackageCommand =  OMBRETRIEVE WEB_SERVICE_PACKAGE
          "QUOTED_STRING" GET "getPropertiesClause"
     getPropertiesClause =  PROPERTIES "(" "propertyNameList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveWebServicePackageCommand

Retrieve the detail of the web service package.

getPropertiesClause

Used to get properties (core, user-defined) for Web Service packages. Valid properties are shown below:

getPropertiesClause

Basic properties for WEB_SERVICE_PACKAGE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the Web Service Package

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the Web Service Package

propertyNameList

A list of property names.

WEB_SERVICE_PACKAGE Object

Table 21-19 WEB_SERVICE_PACKAGE Object

Property
Type
Choices
Min
Max
Default
Description

DEPLOYABLE

BOOLEAN

true, false

none

none

true

The Web service package is deployable or not

See Also

OMBRETRIEVE

OMBCREATE WEB_SERVICE_PACKAGE

OMBALTER WEB_SERVICE_PACKAGE

OMBDROP WEB_SERVICE_PACKAGE

OMBREVERT

Purpose

Perform revert action on the repository (all objects are reverted to the last saved state).

Prerequisites

Must be connected to a OWB workspace of the repository.

Syntax

parseRevertCommand =  OMBREVERT

Parameters

parseRevertCommand

Specify revert command.

See Also

OMBSAVE

OMBREVOKE DEFAULT_OBJ_PRIV

Purpose

To change the default object privilege setting property of a user, basically it will revoke a list of default object privileges from a list of users or roles. These object privileges will not be granted to the specified user or role on the new objects whenever the owner creates them.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseRevokeDefObjPrivCommand =  OMBREVOKE DEFAULT ( OBJ_PRIV |
          OBJECT_PRIVILEGE ) "objPrivNameList" FROM ( USER "userOrRoleNameList"
          | ROLE "userOrRoleNameList" ) [ FOR USER "QUOTED_STRING" ]
     objPrivNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     userOrRoleNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }

Parameters

parseRevokeDefObjPrivCommand

This clause changes the default object privilege setting property of a user through revoking a list of default object privileges from a list of users or roles.

objPrivNameList

Object privileges. Valid object privileges are: READ, COMPILE, EDIT, FULL_CONTROL.

userOrRoleNameList

List of valid OWB user names or OWB role names.

See Also

OMBREVOKE J2EE_ROLE

Purpose

To revoke a list of J2EE runtime roles from a list of J2EE runtime users.

Prerequisites

J2EE runtime must be up and running.

Syntax

parseRevokeJ2EERoleCommand =  OMBREVOKE J2EE_ROLE "userOrRoleNameList" FROM
           J2EE_USER "userOrRoleNameList" "J2eePropertiesClause"
     userOrRoleNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }
     J2eePropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")" VALUES
          "(" "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseRevokeJ2EERoleCommand

This clause revokes a list of J2EE runtime roles from a list of J2EE runtime users.

userOrRoleNameList

List of valid OWB user names or OWB role names.

J2eePropertiesClause

Properties for making J2EE connection.

propertyNameList

Connection property names : USER, PASSWORD, HOST, PORT, JSR88TYPE, ROOT, INSTANCE, PROTOCOL

propertyValueList

List of connection property value for the property name. See the example for detail.

propertyValue

The value for the connection property. See example for detail.

See Also

OMBGRANT J2EE_ROLE

OMBREVOKE OBJ_PRIV

Purpose

To revoke a list of object privileges on the specified objects from a list of users or roles.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseRevokeObjPrivCommand =  OMBREVOKE ( OBJ_PRIV | OBJECT_PRIVILEGE )
          "objPrivNameList" ON "UNQUOTED_STRING" "QUOTED_STRING" [ CASCADE ]
          FROM ( USER "userOrRoleNameList" | ROLE "userOrRoleNameList" )
     objPrivNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     userOrRoleNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }

Parameters

parseRevokeObjPrivCommand

This clause revokes a list of object privileges on the specified objects from a list of users or roles.

UNQUOTED_STRING

The type of the objects to be listed.Valid object types are: PROJECT, ORACLE_MODULE, FLAT_FILE_MODULE, PROCESS_FLOW_MODULE, SAP_MODULE, BUSINESS_DEFINITION_MODULE, OBIEE_BUSINESS_DEFINITION_MODULE, BUSINESS_PRESENTATION_MODULE, TRANSFORMATION_MODULE, PACKAGE, ADVANCED_QUEUE, BUSINESS_AREA, COLLECTION, CONNECTOR, CUBE, DIMENSION, EXTERNAL_TABLE, FLAT_FILE, FUNCTION, REGISTERED_FUNCTION, MAPPING, MATERIALIZED_VIEW, OBJECT_TYPE, PROCEDURE, ITEM_FOLDER, DRILL_PATH, DRILLS_TO_DETAIL, ALTERNATIVE_SORT_ORDER, LISTS_OF_VALUE, PRESENTATION_TEMPLATE, SEQUENCE, TABLE, PROCESS_FLOW, PROCESS_FLOW_PACKAGE, LOCATION, CONTROL_CENTER, CONFIGURATION, DEPLOYMENT, VIEW.

objPrivNameList

Object privileges. Valid object privileges are: READ, COMPILE, EDIT, FULL_CONTROL.

userOrRoleNameList

List of valid OWB user names or OWB role names.

See Also

OMBGRANT OBJ_PRIV

OMBLIST OBJ_PRIVS

OMBREVOKE ROLE

Purpose

To revoke a list of Warehouse Builder roles from a list of Warehouse Builder users.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseRevokeRoleCommand =  OMBREVOKE ROLE "userOrRoleNameList" FROM USER
          "userOrRoleNameList"
     userOrRoleNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }

Parameters

parseRevokeRoleCommand

This clause revokes a list of Warehouse Builder roles from a list of Warehouse Builder users.

userOrRoleNameList

List of valid OWB user names or OWB role names.

See Also

OMBGRANT ROLE

OMBLIST ROLES

OMBREVOKE SYS_PRIV

Purpose

To revoke a list of system privileges from a list of users or roles.

Prerequisites

Must be connected to a workspace on OWB repository.

Syntax

parseRevokeSysPrivCommand =  OMBREVOKE ( SYS_PRIV | SYSTEM_PRIVILEGE )
          "sysPrivNameList" FROM ( USER "userOrRoleNameList" | ROLE
          "userOrRoleNameList" )
     sysPrivNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     userOrRoleNameList =  "QUOTED_STRING" { "," "QUOTED_STRING" }

Parameters

parseRevokeSysPrivCommand

This clause revokes a list of system privileges from a list of users or roles.

sysPrivNameList

List of system privileges. Valid system privileges are:ACCESS_PUBLICVIEW_BROWSER, CONTROL_CENTER_DEPLOYMENT, CONTROL_CENTER_EXECUTION,CONTROL_CENTER_VIEW,CREATE_EXTENSIONMODEL,CREATE_PROJECT, CREATE_SNAPSHOT

userOrRoleNameList

List of valid OWB user names or OWB role names.

See Also

OMBGRANT SYS_PRIV

OMBLIST SYS_PRIVS

22 OMBROLLBACK to OMUCOMPILE

OMBROLLBACK

OMBSAVE

OMBSEED

OMBSHOW

OMBSTART

OMBSTATS

OMBSTOP

OMBSWITCHMODE

OMBSYNCHRONIZE

OMBUNDEFINE ASSOCIATION_DEFINITION

OMBUNDEFINE CLASS_DEFINITION

OMBUNLOCK

OMBUNREGISTER CONTROL_CENTER

OMBUNREGISTER LOCATION

OMBUNREGISTER USER

OMBUPGRADEREPOS

OMBUPGRADEREPOSITORY

OMBVALIDATE

OMBWORKSPACEMODE ZDT

OMUALTER

OMUCOMPILE

OMBROLLBACK

Purpose

Perform rollback action on the repository.

Prerequisites

Must be connected to a OWB workspace of the repository.

Syntax

parseRollbackCommand =  OMBROLLBACK

Parameters

parseRollbackCommand

Specify rollback command.

See Also

OMBCOMMIT

OMBSAVE

Purpose

Perform save action on the repository (all objects are saved).

Prerequisites

Must be connected to a OWB workspace of the repository.

Syntax

parseSaveCommand =  OMBSAVE

Parameters

parseSaveCommand

Specify save command.

See Also

OMBREVERT

OMBSEED

Purpose

Seed OWB repository schema OWBSYS.

Prerequisites

To seed OWB repository schema OWBSYS, within the same OMBPlus session, no other OMB commands should be issued before or after the OMBSEED command. Also, before issuing this command, OWBSYS user schema needs to be created either through 11g database installation or by executing script 'cat_owb.sql' manually. The value of OWB_SERVER_HOME_CHECK_FLAG can be set to either TRUE or FALSE. If OWB_SERVER_HOME_CHECK_FLAG is set to TRUE, OWB_SERVER_ORACLE_HOME must be provided as a valid path which OWB software is installed. The value of USING CREDENTIAL must be OWBSYS' database user credential.

Syntax

parseSeedWBRepositoryCommand =  OMBSEED [ DATA_TABLESPACE "QUOTED_STRING" ]
           [ INDEX_TABLESPACE "QUOTED_STRING" ] [ TEMPORARY_TABLESPACE
          "QUOTED_STRING" ] [ SNAPSHOT_TABLESPACE "QUOTED_STRING" ] [
          BASE_LANGUAGE "QUOTED_STRING" ] [ SUPPORTED_LANGUAGES "("
          "QUOTED_STRING" { "," "QUOTED_STRING" } ")" ] [ OWB_SERVER_ORACLE_HOME
           "QUOTED_STRING" ] [ OWB_SERVER_HOME_CHECK_FLAG "UNQUOTED_STRING" ]
          USING CREDENTIAL "UNQUOTED_STRING" [ NET_SERVICE_NAME "QUOTED_STRING"
          ]

Parameters

parseSeedWBRepositoryCommand

Specify an OMBSEED command.

QUOTED_STRING

Specify the tablespace name, language name, OWB Oracle Home, or NET SERVICE NAME. For example: DATA_TABLESPACE 'USERS'

UNQUOTED_STRING

Specify the connection string to the database using this format: OWBSYS/OWBSYS_PASSWORD@HOST:PORT:SERVICE_NAME

OMBSHOW

Purpose

To show the session or system parameter information.

Prerequisites

Need to connect to a workspace on the repository.

Syntax

parseShowCommand =  ( OMBSHOW "UNQUOTED_STRING" )

Parameters

parseShowCommand

Show the session or system parameters.The Valid session or system parameter names are: USER, REPOSITORY, CONNECTION, REPOSITORY_VERSION, CLIENT_VERSION, WORKSPACE, LICENSED_OPTIONS.

UNQUOTED_STRING

Specify the session or system parameter name.

The Valid session or system parameter names are: USER, REPOSITORY,WORKSPACE, CONNECTION, REPOSITORY_VERSION, CLIENT_VERSION, LICENSED_OPTIONS.

OMBSTART

Purpose

To execute objects from the Control Center. If the ASYNCHRONOUS keyword is specified then this command will return the Execution Job Identifier. Note, this can then be passed to the OMBSTOP command.

The 'Best Practice' usage of this command is within the context of a Design Repository connection. However, advanced users may use this command with a 'Control Center Only' usage. Note, the MAPPING keyword can not be used in this mode and you must specify the deployed Mapping type.

If it is required to fully specify the Deployed Mapping type then the possible values are ABAPFILE, DATAAUDITOR, DATAPROFILE, PLSQLMAP, PROCESSFLOW, SQLLOADERCONTROLFILE and SCHEDULEDJOB.

The Deployment Location of the object is optional if the name of the executable object is unique in the Control Center. However, please specify the 'CONTROL_CENTER' location for types that are deployed to the Control Center (SQL Loader and SAP Mappings).

The System Parameters that can be overriden are

PLSQL Mapping - BULK_SIZE COMMIT_FREQUENCY DEFAULT_AUDIT_LEVEL DEFAULT_OPERATING_MODE DEFAULT_PURGE_GROUP MAXIMUM_NUMBER_OF_ERRORS

SQL Loader Mapping - AUDIT BIND_SIZE CONTROL_FILE_LOCATION CONTROL_FILE_NAME DEFAULT_PURGE_GROUP DIRECT_MODE DISCARD_MAX ERRORS_ALLOWED LOG_FILE_LOCATION LOG_FILE_NAME PERFORM_PARALLEL_LOAD READ_SIZE RECORDS_TO_LOAD RECORDS_TO_SKIP ROWS_PER_COMMIT SKIP_INDEX_MAINTENANCE SKIP_UNUSABLE_INDEXES

SAP Mapping - BACKGROUND CONTROL_FILE_NAME DATA_FILE_NAME FILE_DELIMITER_FOR_STAGING_FILE LOG_FILE_NAME NESTED_LOOP PRIMARY_FOREIGN_KEY_FOR_JOIN SAP_LOCATION SQL_JOIN_COLLAPSING STAGING_FILE_DIRECTORY USE_SELECT_SINGLE

Data Auditor - BULK_SIZE COMMIT_FREQUENCY DEFAULT_AUDIT_LEVEL DEFAULT_OPERATING_MODE DEFAULT_PURGE_GROUP MAXIMUM_NUMBER_OF_ERRORS

Data Profile and Web Service - There are no System Parameters defined.

If a web service has only one operation then, as for other object types, only the ObjectName needs be specified. However if it defines more than one operation then the ObjectName must be qualified with the operation name i.e. ObjectName.operation. e.g.

MY_WEB_SERVICE.run

or

MY_WEB_SERVICE.runWithParams

Multiple operations are created for OWB object types such as PL/SQL mapping and Processflow that are published as web services. These will be:

run : "run without passing any parameters"

runWithCustomParam - "run passing Custom parameters"

runWithSystemParam - "run passing System parameters"

runWithParams - "run passing both System and Custom parameters"

The exact interface required is dependent of the interface of the object being published and therefore you are required to use the Control Center Manager or the OWB Browser to view the deployed WSDL file to determine the required parameters.

Prerequisites

'Best Practice' usage requires a Design Repository connection and the context to be set to that of executable object. The 'Control Center Only' usage does not require a Design Repository connection and therefore no context.

Syntax

parseExecuteCommand =  ( OMBSTART | OMBEXECUTE ) ( ( MAPPING | DATA_AUDITOR
           | PROCESS_FLOW | SCHEDULABLE | REAL_TIME_MAPPING | WEB_SERVICE |
          "UNQUOTED_STRING" ) "QUOTED_STRING" [ AS "QUOTED_STRING" ] [ IN
          "QUOTED_STRING" ] ) [ OVERRIDE SYSTEM_PARAMETER "overideParameters" ]
          [ OVERRIDE CUSTOM_PARAMETER "overideParameters" ] [ ASYNCHRONOUS ]
     overideParameters =  "(" "stringList" ")" VALUES "(" "stringList" ")"
     stringList =  "stringListValue" { "," "stringListValue" }
     stringListValue =  ( "QUOTED_STRING" )

Parameters

parseExecuteCommand

Specify Execute command.

QUOTED_STRING

The name of the object to be executed or the execution's Audit Name.

AS

The execution's Audit Name.

IN

The deployed object's location.

OVERRIDE

Override an Execution Parameter.

SYSTEM_PARAMETER

Specify to override a System Parameter.

CUSTOM_PARAMETER

Specify to override a Custom Parameter.

ASYNCHRONOUS

Execute in an asynchronous mode.

overideParameters

Specify parameters to override.

stringList

Comma seperated list of quoted parameter names to override.

stringListValue

Comma seperated list of quoted parameter values.

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.

OMBSTOP

Purpose

To stop jobs running in the Control Center.

Prerequisites

A Control Center connection. Note, a Design Repository connection is not required.

Syntax

parseStopCommand =  OMBSTOP ( "INTEGER_LITERAL" )

Parameters

parseStopCommand

Specify Stop command.

INTEGER_LITERAL

The job id.

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.

See Also

OMBDISPLAYCURRENTMODE

OMBCONNECT

OMBSAVE

OMBREVERT

OMBSYNCHRONIZE

Purpose

Synchronize the target metadata definition with the source metadata definition.

Prerequisites

1. The current context of scripting must be a project at least.

2. The target and/or source objects should exist in the current project.

3. No concurrent user is operating on the target.

Valid synchronize source types for MAPPING:

MAPPING_ACTIVITY

Valid synchronize source types for CONSTRUCT_OBJECT_OPERATOR:

OBJECT_TYPE PLSQL_RECORD_TYPE PLSQL_REF_CURSOR_TYPE

Valid synchronize source types for CUBE_OPERATOR:

CUBE

Valid synchronize source types for DATA_AUDITOR_ACTIVITY:

DATA_AUDITOR

Valid synchronize source types for DIMENSION_OPERATOR:

DIMENSION

Valid synchronize source types for EXPAND_OBJECT_OPERATOR:

OBJECT_TYPE PLSQL_RECORD_TYPE

Valid synchronize source types for EXTERNAL_TABLE:

EXTERNAL_TABLE_OPERATOR RECORD

Valid synchronize source types for EXTERNAL_TABLE_OPERATOR:

EXTERNAL_TABLE FLAT_FILE

Valid synchronize source types for FLAT_FILE:

FLAT_FILE_OPERATOR

Valid synchronize source types for FLAT_FILE_OPERATOR:

FLAT_FILE MATERIALIZED_VIEW TABLE VIEW

Valid synchronize source types for FUNCTION:

TRANSFORMATION_ACTIVITY

Valid synchronize source types for ITERATOR_OPERATOR:

NESTED_TABLE VARYING_ARRAY

Valid synchronize source types for KEY_LOOKUP_OPERATOR:

DIMENSION LEVEL MATERIALIZED_VIEW TABLE VIEW

Valid synchronize source types for LCRCAST_OPERATOR:

TABLE

Valid synchronize source types for MAPPING_ACTIVITY:

MAPPING

Valid synchronize source types for MATERIALIZED_VIEW:

MATERIALIZED_VIEW_OPERATOR

Valid synchronize source types for MATERIALIZED_VIEW_OPERATOR:

FLAT_FILE MATERIALIZED_VIEW TABLE VIEW

Valid synchronize source types for PLUGGABLE_MAPPING:

PLUGGABLE_MAPPING_OPERATOR

Valid synchronize source types for PLUGGABLE_MAPPING_OPERATOR:

PLUGGABLE_MAPPING

Valid synchronize source types for POSTMAPPING_PROCESS_OPERATOR:

FUNCTION PROCEDURE

Valid synchronize source types for PREMAPPING_PROCESS_OPERATOR:

FUNCTION PROCEDURE

Valid synchronize source types for PROCEDURE:

TRANSFORMATION_ACTIVITY

Valid synchronize source types for PROCESS_FLOW:

SUBPROCESS_ACTIVITY

Valid synchronize source types for REGISTERED_FUNCTION:

TRANSFORMATION_ACTIVITY

Valid synchronize source types for SEQUENCE_OPERATOR:

SEQUENCE

Valid synchronize source types for SUBPROCESS_ACTIVITY:

PROCESS_FLOW

Valid synchronize source types for TABLE:

CUBE DIMENSION LEVEL TABLE_OPERATOR

Valid synchronize source types for TABLE_FUNCTION:

TRANSFORMATION_ACTIVITY

Valid synchronize source types for TABLE_OPERATOR:

FLAT_FILE MATERIALIZED_VIEW PROFILE_REFERENCE TABLE VIEW

Valid synchronize source types for TRANSFORMATION_ACTIVITY:

FUNCTION

Valid synchronize source types for TRANSFORMATION_OPERATOR:

FUNCTION PROCEDURE

Valid synchronize source types for VIEW:

VIEW_OPERATOR

Valid synchronize source types for VIEW_OPERATOR:

FLAT_FILE MATERIALIZED_VIEW TABLE VIEW

Syntax

ReconcileCommand =  ( OMBRECONCILE | OMBSYNCHRONIZE ) ( "parseIOObject" |
          "parseSourceFCOSCO" TO "parseTargetFCOSCO" USE "(" "setStrategyClause"
           "," "setStrategyClause" ")" )
     parseIOObject =  ITEM_FOLDER "QUOTED_STRING" | LOGICAL_TABLE
          "QUOTED_STRING"
     parseSourceFCOSCO =  ( ( DATA_AUDITOR "QUOTED_STRING" [ OPERATOR
          "QUOTED_STRING" ] ) ) | ( ( MAPPING "QUOTED_STRING" [ OPERATOR
          "QUOTED_STRING" ] ) ) | ( ( PLUGGABLE_MAPPING "QUOTED_STRING" [
          OPERATOR "QUOTED_STRING" ] ) ) | ( ( REAL_TIME_MAPPING "QUOTED_STRING"
           [ OPERATOR "QUOTED_STRING" ] ) ) | ( ( FLAT_FILE "QUOTED_STRING" [
          RECORD "QUOTED_STRING" ] ) ) | ( PROCESS_FLOW "QUOTED_STRING" [
          ACTIVITY "QUOTED_STRING" ] ) | ( DIMENSION "QUOTED_STRING" [ LEVEL
          "QUOTED_STRING" ] ) | ( TABLE | EXTERNAL_TABLE | VIEW |
          MATERIALIZED_VIEW | SEQUENCE | CUBE | ADVANCED_QUEUE | OBJECT_TYPE |
          VARYING_ARRAY | NESTED_TABLE | ACTIVITY_TEMPLATE | PACKAGE | FUNCTION
          | TABLE_FUNCTION | WEB_SERVICE | PROCEDURE ) "QUOTED_STRING"
     parseTargetFCOSCO =  ( ( DATA_AUDITOR "QUOTED_STRING" [ OPERATOR
          "QUOTED_STRING" ] ) ) | ( ( MAPPING "QUOTED_STRING" [ OPERATOR
          "QUOTED_STRING" [ GROUP "QUOTED_STRING" ] ] ) ) | ( (
          PLUGGABLE_MAPPING "QUOTED_STRING" [ OPERATOR "QUOTED_STRING" ] ) ) | (
           ( REAL_TIME_MAPPING "QUOTED_STRING" [ OPERATOR "QUOTED_STRING" ] ) )
          | ( ( FLAT_FILE "QUOTED_STRING" [ RECORD "QUOTED_STRING" ] ) ) | ( (
          PROCESS_FLOW "QUOTED_STRING" [ ACTIVITY "QUOTED_STRING" ] ) ) | (
          TABLE | EXTERNAL_TABLE | VIEW | MATERIALIZED_VIEW | SEQUENCE |
          ADVANCED_QUEUE | VARYING_ARRAY | NESTED_TABLE | OBJECT_TYPE |
          ACTIVITY_TEMPLATE | WEB_SERVICE | FUNCTION | PROCEDURE )
          "QUOTED_STRING"
     setStrategyClause =  ( RECONCILE_STRATEGY | SYNCHRONIZE_STRATEGY )
          "retrieveReconcileStrategyClause" | MATCHING_STRATEGY
          "retrieveMatchingStrategyClause"
     retrieveReconcileStrategyClause =  "QUOTED_STRING"
     retrieveMatchingStrategyClause =  "QUOTED_STRING"

Parameters

ReconcileCommand

Synchronizes the target metadata definition with the source metadata definition.

parseIOObject

The source object for synchronization.

parseSourceFCOSCO

The source object for synchronization.

parseTargetFCOSCO

The target object for synchronization.

setStrategyClause

The strategy to be used for synchronization. Must be one of SYNCHRONIZE_STRATEGY OR MATCHING_STRATEGY

SYNCHRONIZE_STRATEGY

MERGE or REPLACE.

MERGE : Updates the matching objects in the target with the metadata definition in the source object and creates new objects in the target for source objects that do not match.

REPLACE : Updates the matching objects in the target with the metadata definition in the source object, creates a new object in the target for source objects that do not match, and deletes objects in the target that have no match in the source.

MATCHING_STRATEGY

Indicates the matching strategy to be used between the object types in source and target. Currently, the list of available matching strategies for a source and target combination are listed below. For synchronization between RECORD and EXTERNAL_TABLE, the valid matching strategies are MATCH_BY_OBJECT_ID, MATCH_BY_OBJECT_NAME, MATCH_BY_OBJECT_POSITION. For synchronization involving OPERATOR of MAP, the available matching strategies are MATCH_BY_OBJECT_ID, MATCH_BY_OBJECT_NAME, MATCH_BY_OBJECT_POSITION, MATCH_BY_OBJECT_ID_AND_NAME, MATCH_BY_OBJECT_ID_AND_POSITION, MATCH_BY_OBJECT_NAME_AND_POSITION, MATCH_BY_OBJECT_ID_AND_NAME_AND_POSITION. Note that the source map might be modified during outbound synchronization of maps, which would require locking both the source and the target before synchronization invocation.

retrieveReconcileStrategyClause

Must of one of 'MERGE' or 'REPLACE'

retrieveMatchingStrategyClause

String representing the matching paradigm between the source and the target object. The list varies for every source and target object type.

OMBUNDEFINE ASSOCIATION_DEFINITION

Purpose

To undefine an association between two classes (types).

Prerequisites

Association definition to be undefined should already exist. This command can be executed for any association definition regardless of current context. Only user defined associations can be undefined. User must have CREATE_EXTENSIONMODEL system privilege and has to be connected in single user mode to run this command.

Syntax

parseUndefineAssociationCommand =  OMBUNDEFINE ASSOCIATION_DEFINITION
          "QUOTED_STRING" [ ( ON | OF ) "modelClause" ]
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" |
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM
          "QUOTED_STRING" )

Parameters

parseUndefineAssociationCommand

Undefine an association.

See Also

OMBDEFINE ASSOCIATION_DEFINITION

OMBDESCRIBE ASSOCIATION_DEFINITION

OMBUNDEFINE CLASS_DEFINITION

Purpose

To undefine a class.

Prerequisites

Class definition to be undefined should already exist. This command can be executed for any class definition regardless of current context. Only user defined classes can be undefined. User must have CREATE_EXTENSIONMODEL system privilege and has to be connected in single user mode to run this command.

Syntax

parseUndefineClassCommand =  OMBUNDEFINE CLASS_DEFINITION "QUOTED_STRING" [
           ( ON | OF ) "modelClause" ] [ CASCADE ]
     modelClause =  ( MODEL "QUOTED_STRING" | PLATFORM "QUOTED_STRING" |
          CONFIGURATION_TEMPLATE "QUOTED_STRING" ( ON | OF ) PLATFORM
          "QUOTED_STRING" )

Parameters

parseUndefineClassCommand

Undefine a class.

See Also

OMBDEFINE CLASS_DEFINITION

OMBDESCRIBE CLASS_DEFINITION

OMBUNLOCK

Purpose

Unlock one or more objects, previously locked by OMBLOCK command. Note that if the object(s) have been modified, save or revert is also required in order for the lock(s) to be released.

Prerequisites

The object(s) should have been locked previously using OMBLOCK command.

Syntax

parseUnLockCommand =  OMBUNLOCK "parseTypeNameList"
     parseTypeNameList =  "objectType" "QUOTED_STRING" { "," "objectType"
          "QUOTED_STRING" }
     objectType =  ( ADVANCED_QUEUE | BUSINESS_AREA | CATALOG_FOLDER |
          COLLECTION | CONNECTOR | CONFIGURATION | DEPLOYMENT | CUBE | DIMENSION
           | EXPERT | EXPERT_MODULE | CT | CT_FOLDER | EXTERNAL_TABLE |
          FLAT_FILE_MODULE | FLAT_FILE | FUNCTION | TABLE_FUNCTION |
          GATEWAY_MODULE | BUSINESS_DEFINITION_MODULE |
          OBIEE_BUSINESS_DEFINITION_MODULE | REGISTERED_FUNCTION | LOCATION |
          LOGICAL_TABLE | MAPPING | MATERIALIZED_VIEW | OBJECT_TYPE |
          VARYING_ARRAY | NESTED_TABLE | ORACLE_MODULE | PACKAGE | PROCEDURE |
          PROCESS_FLOW | PROCESS_FLOW_MODULE | PROCESS_FLOW_PACKAGE |
          WEB_SERVICE | WEB_SERVICE_PACKAGE | APPLICATION_SERVER_MODULE |
          PROJECT | ITEM_FOLDER | DRILL_PATH | LIST_OF_VALUES | DRILL_TO_DETAIL
          | ALTERNATIVE_SORT_ORDER | CONTROL_CENTER | MODULE | SAP_MODULE |
          CMI_MODULE | SEQUENCE | TABLE | VIEW | CMI_DEFINITION |
          PLSQL_RECORD_TYPE | "UNQUOTED_STRING" )

Parameters

parseUnLockCommand

Specify unlock command.

parseTypeNameList

Specify the object or the list of objects to be unlocked.

QUOTED_STRING

Name of the object to be unlocked. Can be specified as an absolute path or as a path relative to the current context. However, there is the restriction that all objects to be unlocked must be in the current project.

objectType

Type of the object to be unlocked.

See Also

OMBLOCK

OMBUNREGISTER CONTROL_CENTER

Purpose

Un-register a control center.

Prerequisites

Must be logged on as the owner of the workspace and connected in a single user mode.

Syntax

unRegisterControlCenterCommand =  OMBUNREGISTER CONTROL_CENTER
          "QUOTED_STRING"

Parameters

unRegisterControlCenterCommand

Unregister the specified control center

OMBUNREGISTER LOCATION

Purpose

Un-register a location with a Control Center.

Prerequisites

Must be in the context of a project and connected to a Control Center.

Syntax

unRegisterLocationCommand =  OMBUNREGISTER LOCATION "QUOTED_STRING"

Parameters

unRegisterLocationCommand

Un-register a location.

QUOTED_STRING

The name of the location to un-register.

OMBUNREGISTER USER

Purpose

To unregister a specified Warehouse Builder user. When you issue this command, the operation is implicitly committed. This will not drop the user from database.

Prerequisites

A Warehouse Builder user can be unregistered from any context.

Syntax

parseUnregisterUserCommand =  ( OMBUNREGISTER USER "QUOTED_STRING" )

Parameters

parseUnregisterUserCommand

This clause unregister a specified Warehouse user.

See Also

OMBREGISTER USER

OMBALTER USER

OMBRETRIEVE USER

OMBUPGRADEREPOS

Purpose

Upgrade Oracle Warehouse Builder repository to the current release.

Prerequisites

Upgrade the Oracle Warehouse Builder repository from 10g Release 2 or 11g Release 1 to the current release of Oracle Warehouse Builder. An OWBSYS schema must exist prior to upgrading the Oracle Warehouse Builder repository. The USING CREDENTIAL value must be from an OWBSYS database user. If upgrading from Oracle Warehouse Builder 10g Release 2, you must also specify the REPOSITORY_OWNER credential.

Syntax

parseUpgradeRepositoryCommand =  ( OMBUPGRADEREPOSITORY | OMBUPGRADEREPOS )
           [ [ TO ] MDL_FILE "QUOTED_STRING" ] [ OUTPUT LOG [ TO ]
          "QUOTED_STRING" ] USING CREDENTIAL "UNQUOTED_STRING" [
          NET_SERVICE_NAME "QUOTED_STRING" ] [ USING REPOSITORY_OWNER CREDENTIAL
           "UNQUOTED_STRING" ]

Parameters

parseUpgradeRepositoryCommand

Upgrade an Oracle Warehouse Builder repository from a previous release to the current release.

UNQUOTED_STRING

Specify the credential in the format: USERNAME/PASSWORD@HOST:PORT:SERVICE_NAME

OMBUPGRADEREPOSITORY

Purpose

Upgrade Oracle Warehouse Builder repository to the current release.

Prerequisites

Upgrade the Oracle Warehouse Builder repository from 10g Release 2 or 11g Release 1 to the current release of Oracle Warehouse Builder. An OWBSYS schema must exist prior to upgrading the Oracle Warehouse Builder repository. The USING CREDENTIAL value must be from an OWBSYS database user. If upgrading from Oracle Warehouse Builder 10g Release 2, you must also specify the REPOSITORY_OWNER credential.

Syntax

parseUpgradeRepositoryCommand =  ( OMBUPGRADEREPOSITORY | OMBUPGRADEREPOS )
           [ [ TO ] MDL_FILE "QUOTED_STRING" ] [ OUTPUT LOG [ TO ]
          "QUOTED_STRING" ] USING CREDENTIAL "UNQUOTED_STRING" [
          NET_SERVICE_NAME "QUOTED_STRING" ] [ USING REPOSITORY_OWNER CREDENTIAL
           "UNQUOTED_STRING" ]

Parameters

parseUpgradeRepositoryCommand

Upgrade an Oracle Warehouse Builder repository from a previous release to the current release.

UNQUOTED_STRING

Specify the credential in the format: USERNAME/PASSWORD@HOST:PORT:SERVICE_NAME

OMBVALIDATE

Purpose

This command validates an repository object. The results are generated in a file in a user defined directory.

Prerequisites

In the context of a Oracle Module except when validating Project and Oracle Module. To validate a Project the user needs to be in the Root context. To validate Oracle Module the user needs to be in Project context.

Syntax

parseValidateCommand =  OMBVALIDATE ( ( EXPERT | EXPERT_MODULE | CT |
          CT_FOLDER | TABLE | VIEW | SEQUENCE | ORACLE_MODULE | COLLECTION |
          MATERIALIZED_VIEW | TRANSPORTABLE_MODULE | BUSINESS_DEFINITION_MODULE
          | OBIEE_BUSINESS_DEFINITION_MODULE | DIMENSION | CUBE | DATA_AUDITOR |
           MAPPING | REAL_TIME_MAPPING | PROJECT | OBJECT_TYPE | VARYING_ARRAY |
           NESTED_TABLE | PACKAGE | FUNCTION | PROCEDURE | TABLE_FUNCTION |
          EXTERNAL_TABLE | FLAT_FILE | FLAT_FILE_MODULE | ALTERNATIVE_SORT_ORDER
           | LIST_OF_VALUES | DRILL_TO_DETAIL | BUSINESS_AREA | DRILL_PATH |
          CATALOG_FOLDER | ITEM_FOLDER | REGISTERED_FUNCTION | LOGICAL_TABLE |
          LOCATION | CONNECTOR | CONTROL_CENTER | CONFIGURATION | DEPLOYMENT |
          PROCESS_FLOW_MODULE | PROCESS_FLOW | PROCESS_FLOW_PACKAGE |
          ADVANCED_QUEUE | QUEUE_TABLE | QUEUE_PROPAGATION | PLSQL_RECORD_TYPE |
           PLSQL_TABLE_TYPE | PLSQL_REF_CURSOR_TYPE | CALENDAR | CALENDAR_MODULE
           | FOLDER | WEB_SERVICE | APPLICATION_SERVER_MODULE |
          WEB_SERVICE_PACKAGE ) "QUOTED_STRING" [ "getOutputValidationResults" ]
           )
     getOutputValidationResults =  OUTPUT [ VALIDATION_RESULT ] TO (
          "QUOTED_STRING" | ( FILE "QUOTED_STRING" ) ) WRITE ( ( "(" ( ( SUCCESS
           | WARNING | ERROR ) [ "," ] )+ ")" ) | ALL | SUCCESS | WARNING |
          ERROR )

Parameters

parseValidateCommand

This command validates a repository object.

QUOTED_STRING

The name of the object.

getOutputValidationResults

This clause outputs the validation results to one or more files in the specified folder.

QUOTED_STRING

A directory where validation results are stored.

See Also

OMBCOMPILE

OMBWORKSPACEMODE ZDT

Purpose

Set the Workspace Mode to enable custom extensions

Prerequisites

Should be in the top level context

Syntax

parseWorkspaceModeOWBRepositoryCommand =  OMBWORKSPACEMODE "QUOTED_STRING"

Parameters

OMUALTER

Purpose

Invoke the editing GUI from OWB for the specified object.

Prerequisites

Must be in the parent context of the object.

Syntax

parseAlterCommand =  OMUALTER "objectType" "QUOTED_STRING"
     objectType =  "UNQUOTED_STRING"

Parameters

parseAlterCommand

Invoke the corresponding editing GUI for the object. This command returns the type and name of the object being altered, or empty string if the GUI is cancelled.

objectType

The type of object to be edited. This can be any component or folder type. For example, TABLE, VIEW, or MAPPING.

See Also

OMUCREATE

OMUCOMPILE

Purpose

Invoke the generation GUI from OWB for the specified object.

Prerequisites

Must be in the parent context of the object.

Syntax

parseCompileCommand =  OMUCOMPILE "objectType" "QUOTED_STRING"
     objectType =  "UNQUOTED_STRING"

Parameters

parseCompileCommand

Invoke the generation GUI for the specified object.

QUOTED_STRING

The object name.

objectType

The type of object to be compiled. For example, TABLE, VIEW, or MAPPING.

23 OMUCONFIGURE to OMUSTART EXPERT

OMUCONFIGURE

OMUCONNECT

OMUCONTROLCENTERJOBS

OMUCREATE

OMUDATAVIEWER

OMUDEPLOY

OMUDERIVE

OMUEXPORT MDL_FILE

OMUIMPACT

OMUIMPORT

OMUIMPORT MDL_FILE

OMULINEAGE

OMULIST

OMUNAVIGATE

OMUPROMPT

OMUPROPERTIES

OMUSELECTSOURCE

OMUSELECTTARGET

OMUSHOWCHANGECONSOLE

OMUSTART

OMUSTART EXPERT

OMUCONFIGURE

Purpose

To launch the graphical version of the configuration inspector.

Prerequisites

The object specified must be configurable within the current project.

Syntax

parseConfigureCommand =  OMUCONFIGURE "objectType" "QUOTED_STRING"
     objectType =  "UNQUOTED_STRING"

Parameters

parseConfigureCommand

Launch the graphical configuration editor.

objectType

Type of the object being configured.

OMUCONNECT

Purpose

To connect to repository using a graphical interface.

Prerequisites

Must not be connected to a repository.

Syntax

parseConnectCommand =  OMUCONNECT

Parameters

parseConnectCommand

Provides a graphical interface to connect to repository.

OMUCONTROLCENTERJOBS

Purpose

To show jobs running in the Control Center.

Prerequisites

A Control Center connection. Note, a Design Repository connection is not required.

Syntax

parseControlCenterJobsCommand =  OMUCONTROLCENTERJOBS [ "QUOTED_STRING" ]

Parameters

parseControlCenterJobsCommand

Display the Control Center list of running jobs.

See Also

OMUALTER

OMUCREATE

Purpose

Invoke the creation GUI from OWB for the specified object type.

Prerequisites

Must be in the parent context for the object type.

Syntax

parseCreateCommand =  OMUCREATE "objectType" [ SET "setPropertiesClause" ]
     objectType =  "UNQUOTED_STRING"
     setPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "("
          "propertyValueList" ")"
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parseCreateCommand

Invoke the corresponding creation GUI for the object type. This command returns the type and name of the object(s) being created, or empty string if the GUI is cancelled.

objectType

The type of object to be created. This can be any component or folder. For examples, TABLE, VIEW, MAPPING, etc.

setPropertiesClause

This clause sets the properties needed for launching the GUI.

propertyNameList

The list of property names to set.

Properties for LOCATION:

Name: TYPE

Type: STRING

Valid Values: See OMBCREATE LOCATION for valid values.

Default: 'ORACLE_DATABASE'

The type of system the location represents.

Properties for CONNECTOR:

Name: TYPE

Type: STRING

Valid Values: 'DB_CONNECTOR', 'DIRECTORY'

Default: 'DB_CONNECTOR'

The type of connector to create.

Properties for GATEWAY_MODULE:

Name: GATEWAY_TYPE

Type: STRING

Valid Values: See OMBCREATE GATEWAY_MODULE for valid values.

Default: N/A

The type of gateway module to create.

propertyValueList

The list of property values.

propertyValue

The value of a property.

See Also

OMUALTER

OMUDATAVIEWER

Purpose

To display Dataviewer for relational and dimensional objects to business definition objects.

Prerequisites

A relational object or dimensional object must exist.

Syntax

parseDataviewerCommand =  OMUDATAVIEWER ( DIMENSION | CUBE | TABLE | VIEW )
           "QUOTED_STRING"

Parameters

parseDataviewerCommand

For data viewing of relational and dimensional objects.

OMUDEPLOY

Purpose

To Deploy Action Plans to Control Centers.

Prerequisites

A Control Center connection and a named Deployment Action Plan are required. Also, the current Context must be either an Oracle Module, a Process Flow Module or a Location.

Syntax

parseDeployCommand =  OMUDEPLOY "objectType" "QUOTED_STRING"
     objectType =  "UNQUOTED_STRING"

Parameters

parseDeployCommand

Deploy the specified action plan

objectType

Type of the speciifed object to deploy (DEPLOYMENT_ACTION_PLAN)

See Also

OMUALTER

OMUDERIVE

Purpose

To derive relational and dimensional objects to business definition objects.

Prerequisites

A relational object or dimensional object must exist.

Syntax

parseDeriveCommand =  OMUDERIVE ( ORACLE_MODULE | "UNQUOTED_STRING" |
          MATERIALIZED_VIEW | PACKAGE | DIMENSION | CUBE | TABLE | VIEW |
          EXTERNAL_TABLE | FUNCTION | COLLECTION ) "QUOTED_STRING"

Parameters

parseDeriveCommand

To derive relational and dimensional objects to business definition objects.

OMUEXPORT MDL_FILE

Purpose

Exports the metadata from the repository based on the metadata loader action plan.

Prerequisites

Connection must be established to workspace to be exported from.

Syntax

parseMDLExportCommand =  OMUEXPORT MDL_FILE [ "QUOTED_STRING" ]
          MDL_ACTION_PLAN "QUOTED_STRING"

Parameters

parseMDLExportCommand

Exports the metadata from the repository

QUOTED_STRING

Enclose the name of the export metadata file in single quotes.

MDL_ACTION_PLAN

Specify the MDL_ACTION_PLAN to be used by the export. Enclose the metadataloader action plan in single quotes.

See Also

OMBCREATE MDL_ACTION_PLAN

OMBALTER MDL_ACTION_PLAN

OMBDROP MDL_ACTION_PLAN

OMBRETRIEVE MDL_ACTION_PLAN

OMUIMPORT MDL_FILE

OMUIMPACT

Purpose

To perform impact analysis on the specified object. Metadata Dependency Manager will show up with an impact graph of the specified object.

Prerequisites

The object specified can be source or target object.

Syntax

parseShowImpactCommand =  OMUIMPACT "objectType" "QUOTED_STRING"
     objectType =  "UNQUOTED_STRING"

Parameters

parseShowImpactCommand

Shows the impact of an object.

objectType

Type of the object whose impact graph needs to be shown.

OMUIMPORT

Purpose

To launch the graphical version of the import wizard.

Prerequisites

Must be in the context of a module.

Syntax

parseDatabaseImportCommand =  METADATA_LOCATION [ "objectType" [ (
          MINIMAL_MODE | FULL_MODE ) ] ]
     objectType =  "UNQUOTED_STRING"

Parameters

OMUIMPORT MDL_FILE

Purpose

Imports the metadata from a file into the workspace

Prerequisites

Must be connected to the workspace where the import is to be performed.

Syntax

parseMDLImportCommand =  MDL_FILE [ "QUOTED_STRING" ]

Parameters

parseMDLImportCommand

Import metadata from a file.

QUOTED_STRING

Enclose the name of the import metadata file in single quotes.

See Also

OMUEXPORT MDL_FILE

OMULINEAGE

Purpose

To perform lineage analysis on the specified object. Metadata Dependency Manager will show up with a lineage graph of the specified object.

Prerequisites

The object specified can be source or target object.

Syntax

parseShowLineageCommand =  OMULINEAGE "objectType" "QUOTED_STRING"
     objectType =  "UNQUOTED_STRING"

Parameters

parseShowLineageCommand

Shows the linage of an object.

objectType

Type of the object whose lineage graph needs to be shown.

OMULIST

Purpose

Run the object selector dialog for selecting some objects.

Prerequisites

Connect to the workspace and in the parent context.

Syntax

parseListCommand =  OMULIST "objectType"
     objectType =  "UNQUOTED_STRING"

Parameters

parseListCommand

Show an object selector dialog for choosing the specified object type.

objectType

Specify the object type that the object selector dialog should show. This object type can be any component or folder object type name in plural. For example, TABLES, VIEWS, MAPPINGS, etc.

OMUNAVIGATE

Purpose

Quickly navigate to an object by highlighting it on the console tree, given the object's type and path to object from the current context. OMUNAVIGATE does not change the current context, and can not navigate outside of the current project.

Prerequisites

Connect to the workspace. OMUNAVIGATE can not navigate to objects outside of current project, except for object in the PUBLIC_PROJECT (Locations, PUBLIC_EXPERTs, and etc), which can be reached regardless of the current context.

Syntax

parseNavigateCommand =  OMUNAVIGATE "objectType" "QUOTED_STRING"
     objectType =  "UNQUOTED_STRING"

Parameters

parseNavigateCommand

Highlight an object on the console tree given the object's type and path to the object from the current context. Does not change the current context.

QUOTED_STRING

The path to the object including object's name from the current context. The path must be within the current project or PUBLIC_PROJECT.

objectType

The type of the object being navigated to.

OMUPROMPT

Purpose

To construct a custom UI in order to prompt for some information from the end user.

Prerequisites

None.

Syntax

parsePromptCommand =  OMUPROMPT "type" "name" [ "setPropertiesClause" ] {
          "addComponentClause" }
     type =  "UNQUOTED_STRING"
     name =  "QUOTED_STRING"
     setPropertiesClause =  SET PROPERTIES "(" "propertyNameList" ")" VALUES "("
           "propertyValueList" ")"
     addComponentClause =  ADD "type" "name" [ "setPropertiesClause" ]
     propertyNameList =  PROPERTY_NAME { "," PROPERTY_NAME }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     propertyValue =  ( "QUOTED_STRING" | "INTEGER_LITERAL" |
          "FLOATING_POINT_LITERAL" )

Parameters

parsePromptCommand

Construct a custom UI to prompt for information. This clause specifies the name of the dialog and the properties for the dialog.

type

The type of custom dialog or its component.  Currently only DIALOG is valid custom UI type.  For the type of a component UI, the valid types include CHECK_BOX, CHOICE_BOX, COMBO_BOX, FILE_CHOOSER, HYPERLINK, LABEL, LIST_BOX, PASSWORD_FIELD, RADIO_BUTTONS, SEPARATOR, TEXT_FIELD.

name

The name of the custom UI or UI component.

setPropertiesClause

This clause sets the properties for the custom UI or the UI component.

Basic properties for CHECK_BOX :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The text to be displayed by the side of the check box.

Name: SELECTION
Type: BOOLEAN
Valid Values: true, false
Default: false
Whether the check box should be selected by default.

Basic properties for CHOICE_BOX :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed by the side of the choice box that describes what the selection is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The different choices shown in the choice box.  Needs to be a comma-separated list.

Name: SELECTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default selection of the choices.

Basic properties for COMBO_BOX :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed by the side of the combo box that describes what the selection is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The different choices shown in the combo box.  Needs to be a comma-separated list.

Name: SELECTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default selection of the choices.

Basic properties for DIALOG :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: TITLE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
Title of the custom dialog.

Name: WIDTH
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: Empty string
The width of the custom dialog.  If either the height or the width is unspecified or set to 0, then the dialog will be auto-sized.

Name: HEIGHT
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: Empty string
The height of the custom dialog.  If either the height or the width is unspecified or set to 0, then the dialog will be auto-sized.

Name: LINE_WRAP
Type: NUMBER
Valid Values: Any valid character string in supported character set.
Default: 2
CUSTOMUI_DIALOG_LINE_WRAP_DESC??

Name: OPTIONS
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The options for the dialog.  These translate into buttons at the bottom of the dialog.  A comma-separated list of values is expected here.  For example, a dialog with a YES and No button will need an OPTION of 'YES,NO'.

Name: DEFAULT_OPTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default option of the dialog.  This means the default button that will be pressed when the ENTER key is pressed.

Name: CANCEL_OPTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The option that represents cancellation of the dialog.

Basic properties for FILE_CHOOSER :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: .
The default directory to be shown in the file chooser.

Name: SELECTION
Type: STRING
Valid Values: DIRECTORIES_ONLY, FILES_ONLY, FILES_AND_DIRECTORIES
Default: FILES_AND_DIRECTORIES
Tells whether the file chooser should allow selection of files only, directories only, or both files and directories.

Basic properties for HYPERLINK :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed as text for the link.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The URL of the link target location.

Basic properties for LABEL :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The content of the label.  This can be HTML-formatted text.

Basic properties for LIST_BOX :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed on top of the list box that describes what the selection is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The different choices shown in the list box.  Needs to be a comma-separated list.

Name: SELECTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default selection of the choices.

Basic properties for PASSWORD_FIELD :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed by the side of the password field that describes what the field is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default content of the password field.

Basic properties for RADIO_BUTTONS :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed on top of the radio buttons that describes what the selection is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The different choices shown for the radio buttons.  Needs to be a comma-separated list.

Name: SELECTION
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default selection of the choices.

Basic properties for SEPARATOR :

Basic properties for TEXT_FIELD :

Name: RETURN_VALUE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The return value for this component.

Name: MESSAGE_TEXT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The message text to be displayed by the side of the text field that describes what the field is about.

Name: CONTENT
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: Empty string
The default content of the text field.

addComponentClause

Add a UI component to the custom UI.

propertyNameList

The list of property names.

propertyValueList

The list of property values to set.

propertyValue

The value of the property.

OMUPROPERTIES

Purpose

To launch the graphical version of the object property inspector.

Prerequisites

The object specified must be within the current project.

Syntax

parsePropertiesCommand =  OMUPROPERTIES "objectType" "QUOTED_STRING"
     objectType =  "UNQUOTED_STRING"

Parameters

parsePropertiesCommand

Launch the graphical object property inspector.

objectType

Type of the object whose properties are being examined.

OMUSELECTSOURCE

Purpose

To select the source where data is going to move from: type (oracle, gateway or file) and location.

Prerequisites

Must be in the context of a project.

Syntax

parseSelectSrcCommand =  OMUSELECTSOURCE

Parameters

OMUSELECTTARGET

Purpose

To select the target where data is going to move to: type (oracle only) and location.

Prerequisites

Must be in the context of a project.

Syntax

parseSelectTgtCommand =  OMUSELECTTARGET

Parameters

OMUSHOWCHANGECONSOLE

Purpose

To show the console containing all snapshots.

Prerequisites

Must be connected to the repository.

Syntax

parseShowChangeConsoleCommand =  OMUSHOWCHANGECONSOLE

Parameters

parseShowChangeConsoleCommand

Shows the console containing all snapshots.

OMUSTART

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.

See Also

OMBCREATE EXPERT

OMBALTER EXPERT

OMUCREATE

OMUALTER

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.

See Also

OMBCREATE EXPERT

OMBALTER EXPERT

OMUCREATE

OMUALTER

24 OMUSTARTJOB to OMUVALIDATE

OMUSTARTJOB

OMUVALIDATE

OMUSTARTJOB

Purpose

To launch the graphical version of object execution .

Prerequisites

'Best Practice' usage requires a Design Repository workspace connection and the context to be set to that of executable object. The 'Control Center Only' usage does not require a Design Repository workspace connection and therefore no context.

Syntax

parseStartJobCommand =  OMUSTARTJOB "objectType" "QUOTED_STRING"
     objectType =  "UNQUOTED_STRING"

Parameters

parseStartJobCommand

Start execution of the specified object.

objectType

Type of the object to start.

OMUVALIDATE

Purpose

Invoke the validation GUI from OWB for the specified object.

Prerequisites

Must be in the parent context of the object.

Syntax

parseValidateCommand =  OMUVALIDATE "objectType" "QUOTED_STRING"
     objectType =  "UNQUOTED_STRING"

Parameters

parseValidateCommand

Invoke the validation GUI for the specified object.

QUOTED_STRING

The object name.

objectType

The type of object to be validated. For example, TABLE, VIEW, or MAPPING.

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2012, Oracle and/or its affiliates. All rights reserved.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Alpha and Beta Draft Documentation Notice

If this document is in prerelease status:

This documentation is in prerelease status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.