Commands Reference, Volume 3

mkodmextract Command

Purpose

Reads each stanza from the input stanza file and writes an odmdelete command, with appropriate parameters, to standard output.

Syntax

mkodmextract -d ObjectClassDB -f StanzaFile

Description

The mkodmextract command is invoked by the mkodmupdt command in the 4.1 build environment. For each stanza in the input stanza file, it reads the object classdatabase file, extracts the keys associated with the object descriptor, and writes an odmdelete command with appropriate parameters to standard output. The command also verifies the object class, keys, and fields from the stanza file.

Flags

-d ObjectClassDB	Specifies the database file containing object class descriptors, keys, and fields.
-f StanzaFile	Specifies the stanza file that is being processed, for example .add.

Note

Both flags are required.

Fatal Errors

If a fatal error is detected, processing is terminated and mkodmextract exits with a non-zero return code. Possible errors include:

An object class descriptor should not be modified during an install or update. This situation is indicated in the object class database file by listing a 99 in the object class key data.
The descriptor could not be identified in a stanza.
An object class name from the stanza file could not be found in the object class database file.
An invalid key or field appears in a stanza.

Input Files

object description (.add) file

This file contains one or more object class definitions in stanza format. The format of a stanza is:

object_class_name: 
key = value
...
attribute = value
...

object class database file

This is the internal database file the mkodmupdt command uses to verify the object classes from the stanza files and generate the appropriate odm commands for the output odm scripts. This database file contains one entry for each object class where the entries are described as follows:

object class:List of keys:list of fields including keys

The list of keys is separated by %. The keys are the set of fields whose combination of values can uniquely identify a stanza. The list of fields is comma separated.

Example:       
GAI:Adapter_Id%Module_Key%Module_Path:Adapter_Id,Module_Key,Module_Path

To indicate that an object class cannot be updated, use the following syntax in the object class database file:

CDiagDev:99

Output Files

The mkodmextract command writes the odmdelete commands to stdout. The mkodmupdt command redirects the output of mkodmextract into the option*.odmdel and the option*.unodmadd scripts.

Related Information

The mkodmupdt command, odmdelete command.