Skip Headers
Oracle® Warehouse Builder OMB*Plus Command Reference
11g Release 2 (11.2)

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

Go to previous page
Previous
Go to next page
Next
 

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