Syntax
retrieveGatewayModuleCommand = OMBRETRIEVE GATEWAY_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
retrieveGatewayModuleCommand
Specify the gateway module from which to retrieve details.
getPropertiesClause
Retrieve the properties of a gateway module.
getPropertiesClause
Basic properties for GATEWAY_MODULE:
Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Business name of the gateway module
Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the gateway module
Name: GATEWAY_TYPE
Type: STRING
Valid Values: Any valid character string in supported character set.
Default: N/A
Type of gateway 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 gateway module.
getReferenceLocationsClause
Retrieve all of the data locations referenced by this module.
propertyNameList
A list of property names.
HTML