OMBALTER GATEWAY_MODULE

Purpose

Alter the Gateway module by renaming it, and/or reset its properties.

Prerequisites

Should be in the context of project.

Syntax

alterGatewayModuleCommand =  OMBALTER ( GATEWAY_MODULE "QUOTED_STRING" ( 
          "renameClause" [ 
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ] | 
          "alterPropertiesOrReferenceClauseForDataMetadataModule" ) )
     renameClause =  RENAME TO "QUOTED_STRING"
     alterPropertiesOrReferenceClauseForDataMetadataModule =  ( ( SET ( ( 
          "alterPropertiesClause" [ ( SET 
          "setReferenceClauseForDataMetadataModule" [ UNSET 
          "unsetReferenceClauseForDataMetadataModule" ] ) | ( UNSET 
          "unsetReferenceClauseForDataMetadataModule" [ SET 
          "setReferenceClauseForDataMetadataModule" ] ) ] ) | ( 
          "setReferenceClauseForDataMetadataModule" [ UNSET 
          "unsetReferenceClauseForDataMetadataModule" ] ) ) ) | ( UNSET 
          "unsetReferenceClauseForDataMetadataModule" [ SET 
          "setReferenceClauseForDataMetadataModule" ] ) ) [ 
          "addOrRemoveOrModifyModuleReferenceLocationClause" ]
     alterPropertiesClause =  PROPERTIES "(" "propertyNameList" ")" VALUES "(" 
          "propertyValueList" ")"
     setReferenceClauseForDataMetadataModule =  ( "setReferenceLocationClause" [
           SET "setReferenceMetadataLocationOrIconSetOrJCTClause" ] | 
          "setReferenceMetadataLocationOrIconSetOrJCTClause" )
     unsetReferenceClauseForDataMetadataModule =  ( 
          "unsetReferenceLocationClause" [ UNSET 
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" ] | 
          "unsetReferenceMetadataLocationOrIconSetOrJCTClause" )
     addOrRemoveOrModifyModuleReferenceLocationClause =  ( 
          "addReferenceLocationClause" | "removeReferenceLocationClause" | 
          "modifyReferenceLocationClause" ) { "addReferenceLocationClause" | 
          "removeReferenceLocationClause" | "modifyReferenceLocationClause" }
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }
     propertyValueList =  "propertyValue" { "," "propertyValue" }
     setReferenceLocationClause =  ( REFERENCE | REF ) LOCATION "QUOTED_STRING"
     setReferenceMetadataLocationOrIconSetOrJCTClause =  ( 
          "setJournalCodeTemplateClause" [ SET 
          "setReferenceMetadataLocationOrIconSetClause" ] | 
          "setReferenceMetadataLocationOrIconSetClause" )
     unsetReferenceLocationClause =  ( REFERENCE | REF ) LOCATION 
          "QUOTED_STRING"
     unsetReferenceMetadataLocationOrIconSetOrJCTClause =  ( 
          "unsetJournalCodeTemplateClause" [ UNSET 
          "unsetReferenceMetadataLocationOrIconSetClause" ] | 
          "unsetReferenceMetadataLocationOrIconSetClause" )
     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
     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" )
     unsetJournalCodeTemplateClause =  ( REFERENCE | REF ) CDC_CT
     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

alterGatewayModuleCommand

This command modifies an existing Gateway module.

QUOTED_STRING

Name of the existing Gateway module in single quotes.

renameClause

Rename the Gateway module.

alterPropertiesOrReferenceClauseForDataMetadataModule

Alter existing Gateway module's properties and/or locations and/or icon sets.

alterPropertiesClause

Associate a set of properties with the existing Oracle module.

alterPropertiesClause

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 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

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.

addOrRemoveOrModifyModuleReferenceLocationClause

Add/remove/modify data location for the Gateway module.

setReferenceLocationClause

Set a data location to the existing Gateway module as the new configuration default.

unsetReferenceLocationClause

Unset a location to the existing Gateway module.

addReferenceLocationClause

Add a data location to the gateway module.

removeReferenceLocationClause

Remove a data location from the gateway module.

setReferenceMetadataLocationOrIconSetClause

Set metadata location and/or icon set for the gateway module.

unsetReferenceMetadataLocationOrIconSetClause

Unset 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.

unsetReferenceMetadataLocationClause

Unset metadata location for the gateway module.

unsetReferenceIconSetClause

Unset icon set for the gateway module.

GATEWAY_MODULE Object

Table 2-15 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

OMBALTER

OMBCREATE GATEWAY_MODULE

OMBDROP GATEWAY_MODULE