OMBALTER FLAT_FILE_MODULE

Purpose

Alter the flat file module by renaming it, and/or reseting its properties.

Prerequisites

Should be in the context of a project.

Syntax

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

alterFlatFileModuleCommand

Alter a flat file module.

QUOTED_STRING

The name of the flat file module to alter.

renameClause

Rename the flat file module.

QUOTED_STRING

The new name for the flat file module.

alterPropertiesOrReferenceOrJCTClauseForDataMetadataModule

Set properties and/or metadata location and/or icon set and/or journal code template for the flat file module.

alterPropertiesOrReferenceClauseForDataMetadataModule

Set properties and/or metadata location for the flat file module.

alterPropertiesClause

Set the properties for the flat file module.

setReferenceClauseForDataMetadataModule

Set data location and/or icon set for the flat file module.

unsetReferenceClauseForDataMetadataModule

Unset location and/or icon set for the flat file module.

addOrRemoveOrModifyModuleReferenceLocationClause

Add/remove/modify data location for the flat file module.

propertyValueList

The values for the named properties.

propertyNameList

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

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.

setReferenceLocationClause

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

setReferenceMetadataLocationOrIconSetOrJCTClause

Set metadata location and/or icon set and/or journal code template for the flat file module.

unsetReferenceLocationClause

Unset a data location to the existing flat file module.

unsetReferenceMetadataLocationOrIconSetOrJCTClause

Unset metadata location and/or icon set and/or journal code template for the flat file module.

addReferenceLocationClause

Add a data location to the flat file module.

removeReferenceLocationClause

Remove a data location from the flat file module.

modifyReferenceLocationClause

Modify a data location of the flat file module.

propertyValue

A property value.

setReferenceMetadataLocationOrIconSetClause

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

unsetReferenceMetadataLocationOrIconSetClause

Unset metadata location and/or icon set for the flat file module.

setReferenceMetadataLocationClause

Set metadata location for the flat file module.

setReferenceIconSetClause

Set icon set for the flat file module.

unsetReferenceMetadataLocationClause

Unset metadata location for the flat file module.

unsetReferenceIconSetClause

Unset icon set for the flat file module.

See Also

OMBALTER

OMBCREATE FLAT_FILE_MODULE

OMBDROP FLAT_FILE_MODULE