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

OMBRETRIEVE ORACLE_MODULE

Purpose

Prerequisites

Syntax

Parameters

retrieveOracleModuleCommand

QUOTED_STRING

getPropertiesClause

getPropertiesClause

getReferenceLocationClause

getReferenceDefaultLocationClause

getReferenceIconSetClause

getReferenceLocationsClause

propertyNameList

ORACLE_MODULE Object

See Also