../E14406-01.epub /> ../E14406-01.mobi />

OMBRETRIEVE FLAT_FILE_MODULE

Purpose

Retrieve details from a flat file module.

Prerequisites

Should be in the context of a project.

Syntax

retrieveFlatFileModuleCommand =  OMBRETRIEVE FLAT_FILE_MODULE 
          "QUOTED_STRING" ( "getPropertiesClause" | "getReferenceLocationClause"
           | "getReferenceDefaultLocationClause" | 
          "getReferenceMetadataLocationClause" | "getReferenceIconSetClause" | 
          "getReferenceLocationsClause" | "getJournalCodeTemplateClause" )
     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
     getJournalCodeTemplateClause =  GET ( REF | REFERENCE ) CDC_CT OPTIONS | 
          GET ( REF | REFERENCE ) CDC_CT OPTION "QUOTED_STRING" | GET ( REF | 
          REFERENCE ) CDC_CT
     propertyNameList =  "UNQUOTED_STRING" { "," "UNQUOTED_STRING" }

Parameters

retrieveFlatFileModuleCommand

Retrieve details from a flat file module.

QUOTED_STRING

The name of the flat file module to retrieve details from.

getPropertiesClause

Retrieve specified property values from the flat file 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 flat file module.

getReferenceIconSetClause

Retrieve the icon set referenced by this flat file module.

getReferenceLocationsClause

Retrieve all of the data locations referenced by this module.

propertyNameList

The names of the properties whose values you want to retrieve.

propertyNameList

Basic properties for FLAT_FILE_MODULE:

Name: BUSINESS_NAME
Type: STRING(200)
Valid Values: Any valid character string in supported character set.
Default: NAME
Business name of the flat file module.

Name: DESCRIPTION
Type: STRING(4000)
Valid Values: Any valid character string in supported character set.
Default: Empty string
Description of the flat file module.

See Also

OMBRETRIEVE