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
Mobi · ePub

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

Go to previous page
Previous		 Go to next page
Next
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