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