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