Skip to content

Component Information Management Tasks

Component information management tasks retrieve or manage control information and descriptive metadata about one or more components. Such tasks include:
*• List Component Change Description - CMPONENT CHG_DESC LIST • List Short Component History - *CMPONENT HISTORY LISTSHRT
• Find Component Description - *CMPONENT APL_CDSC FIND • List Current Component History - *CMPONENT HISTORY LISTCURR
• List Component Description - *CMPONENT APL_CDSC LIST • List Concurrent Comp. History - *CMPONENT HISTORY LISTCONC
• List Global Component Description - *CMPONENT GBL_CDSC LIST • List Baselined Component History - *CMPONENT HISTORY LISTBASE
*• List Component Promotion History - CMPONENT PRM_HIST LIST • List Comp. Standard Language – *CMPONENT HISTORY LISTLANG
*• Component History List - CMPONENT HISTORY LIST • List Comp. User Worklist Records - *CMPONENT PKG_WRKL LIST

Note that some component information management functions, such as listing all the components in a package, are described with package-level component tasks. See Package-Level Component Change Management, for those functions.

List Component Change Description - CMPONENT CHG_DESC LIST

The Serena XML service/scope/message tags and attributes for messages that list change descriptions for one or more components are:

<service name="CMPONENT">
<scope name="CHG_DESC">
<message name="LIST">

These tags appear in both requests and replies.

CMPONENT CHG_DESC LIST — Request

The following example below shows how you might code a Serena XML request to list the change description for a single component in a package. Data structure details for the list <request> tag appear in Exhibit 5-23.

Example XML — CMPONENT CHG_DESC LIST Request

<?xml version="1.0"?>
<service name="CMPONENT">
    <scope name="CHG_DESC">
        <message name="LIST">
            <header>
                <subsys>8</subsys>
                <product>CMN</product>
            </header>
            <request>
                <package>ACTP000007</package>
            </request>
        </message>
    </scope>
</service>

Exhibit 5-29 CMPONENT CHG_DESC LIST <request> Data Structure

Subtag Use Instances Data Type & Length Instances
<applName> Optional 0 - 1 String (4), variable ZMF application name. Same as first 4 bytes of package name.
<component> Optional 1 String (256), variable ZMF name of component. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
NOTE: May be masked using the following wildcard characters:

? = Any one alphanumeric character.

* = Any number of alphanumeric characters. Used alone, it matches all values.
<componentType> Optional 1 String (3), fixed ZMF library type of component.
NOTE: May be masked using the asterisk (*) wildcard character.
<package> Required 1 String (10), fixed Fixed-format ZMF package name.
<packageId> Optional 0 - 1 Integer (6), fixed ZMF package ID number. Same as last 6 bytes of package name.

CMPONENT CHG_DESC LIST — Reply

The Serena XML reply message for the component change description list function returns zero to many <result> tags for the requested component(s). Each result contains a component change description for the component name and library type in the reply.

The standard <response> data structure follows the final <result> tag and indicates the success or failure of the list request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. As the final data structure in the reply, the <response> tag also serves as an end-of-list marker.

An example reply to a component change description list request follows. Data structure details for the list <result> tag appear in Exhibit 5-24.

Example XML — CMPONENT CHG_DESC LIST Reply

<?xml version="1.0"?>
<service name="CMPONENT">
    <scope name="CHG_DESC">
        <message name="LIST">
            <result>
                <package>ACTP000007</package>
                <applName>ACTP</applName>
                <packageId>000007</packageId>
                <component>ACPCPY00</component>
                <componentType>CPY</componentType>
                <changeDesc>SER5904E</changeDesc>
            </result>
            <result>
                <package>ACTP000007</package>
                <applName>ACTP</applName>
                <packageId>000007</packageId>
                <component>ACPCPY1A</component>
                <componentType>CPY</componentType>
                <changeDesc>SER5904E</changeDesc>
            </result>
            .
            .
            .
            <response>
                <statusMessage>CMN8700I - LIST service completed</statusMessage>
                <statusReturnCode>00</statusReturnCode> <statusReasonCode>8700</statusReasonCode>
            </response>
        </message>
    </scope> 
</service>

Exhibit 5-30 CMPONENT CHG_DESC LIST <result> Data Structure

Subtag Use Instances Data Type & Length Instances
<applName> Optional 0 - 1 String (4), variable ZMF application name. Same as first 4 bytes of package name.
<changeDesc> Optional 0 - 1 String (35), variable Text description of change to component.
<component> Optional 1 String (256), variable ZMF component name. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
<componentType> Optional 1 String (3), fixed ZMF library type of component.
<package> Optional 1 String (10), variable Fixed-format ZMF package name.
<packageId> Optional 0 - 1 Integer (6), fixed ZMF package ID number. Same as last 6 bytes of package name.

Find Component Description - CMPONENT APL_CDSC FIND

The Serena XML service/scope/message tags and attributes for messages that find the application-level description for a specific component are:

<service name="CMPONENT">
<scope name="APL_CDSC"> 
<message name="FIND">

These tags appear in both requests and replies.

CMPONENT APL_CDSC FIND — Request

This function first tries to find the application-level description for a specific component. If no description is found at the application level, the global records are searched.

Data structure details for the component description find <request> tag appear in Exhibit 5-25.

Exhibit 5-31 CMPONENT APL_CDSC FIND <request> Data Structure

Subtag Use Instances Data Type & Length Instances
<applName> Required 1 String (4), variable ZMF application name. Same as first 4 bytes of package name.
<component> Required 1 String (256), variable ZMF name of component. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
<componentType> Required 1 String (3), fixed ZMF library type of component.

CMPONENT APL_CDSC FIND— Reply

The Serena XML reply message for the component description find function returns one <result> tag for the requested component. It contains the component description and library type in the reply.

The standard <response> data structure follows the <result> tag and indicates the success or failure of the list request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher.

Data structure details for the list <result> tag appear in Exhibit 5-26.

Exhibit 5-32 CMPONENT APL_CDSC FIND <result> Data Structure

Subtag Use Instances Data Type & Length Instances
<applName> Optional 0 - 1 String (4), variable ZMF application name. Same as first 4 bytes of package name.
<component> Optional 0 - 1 String (256), variable ZMF component name. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
<componentDesc> Optional 0 - 48 String (72), variable Text description of component.
<componentType> Optional 0 - 1 String (3), fixed ZMF library type of component.

List Component Description - CMPONENT APL_CDSC LIST

The Serena XML service/scope/message tags and attributes for messages that list the application-level description for one or more components are:

<service name="CMPONENT">
<scope name="APL_CDSC"> 
<message name="LIST">

These tags appear in both requests and replies.

CMPONENT APL_CDSC LIST — Request

Data structure details for the component description list <request> tag appear in Exhibit 5-27.

Exhibit 5-33 CMPONENT APL_CDSC LIST <request> Data Structure

Subtag Use Instances Data Type & Length Instances
<applName> Required 1 String (4), variable ZMF application name. Same as first 4 bytes of package name.
<component> Required 1 String (256), variable ZMF name of component. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.

NOTE: May be masked using the following wildcard characters:

? = Any one alphanumeric character.

* = Any number of alphanumeric characters. Used alone, it matches all values.
<componentType> Required 1 String (3), fixed ZMF library type of component.
NOTE: May be masked using the asterisk (*) wildcard character.

CMPONENT APL_CDSC LIST — Reply

The Serena XML reply message for the component description list function returns zero to many <result> tags for the requested component(s). Each result contains the component description and library type in the reply.

The standard <response> data structure follows the <result> tags and indicates the success or failure of the list request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. As the final data structure in the reply, the <response> tag also serves as an end-of-list marker.

Data structure details for the list <result> tag are identical to those of CMPONENT APL_CDSC FIND; refer to Exhibit 5-26.

List Global Component Description - CMPONENT GBL_CDSC LIST

The Serena XML service/scope/message tags and attributes for messages that list the global description for a component are:

<service name="CMPONENT">
<scope name="GBL_CDSC"> 
<message name="LIST">

These tags appear in both requests and replies.

CMPONENT GBL_CDSC LIST — Request

Data structure details for the component global description list <request> tag appear in Exhibit 5-28.

Exhibit 5-34 CMPONENT GBL_CDSC LIST <request> Data Structure

Subtag Use Instances Data Type & Length Instances
<component> Required 1 String (256), variable ZMF name of component. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.

NOTE: May be masked using the following wildcard characters:

? = Any one alphanumeric character.

* = Any number of alphanumeric characters. Used alone, it matches all values.
<componentType> Required 1 String (3), fixed ZMF library type of component.
NOTE: May be masked using the asterisk (*) wildcard character.

CMPONENT GBL_CDSC LIST — Reply

The Serena XML reply message for the component global description list function returns zero to many <result> tags for the requested component(s). Each result contains the component global description and library type in the reply.

The standard <response> data structure follows the <result> tags and indicates the success or failure of the list request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. As the final data structure in the reply, the <response> tag also serves as an end-of-list marker.

Data structure details for the list <result> tag are similar to those of CMPONENT APL_CDSC FIND; the only difference is that the subtag is omitted. Refer to Exhibit 5-26.

List Component Promotion History - CMPONENT PRM_HIST LIST

A Serena XML message to list component promotion history has the following service/scope/message names:

<service name="CMPONENT">
<scope name="PRM_HIST"> 
<message name="LIST">

These tags appear in both request and reply messages.

CMPONENT PRM_HIST LIST — Requests

Serena XML provides component promotion history for selected components in a named package. Component name, component type, and promotion site name may be masked using a wildcard pattern.

Data structure details for the <request> tag of this message appear in Exhibit 5-29.

Exhibit 5-35 CMPONENT PRM_HIST LIST <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 0 - 1 String (4), variable ZMF application name. Same as first 4 bytes of package name.
NOTE: OK to omit trailing blanks.
<component> Optional 0 - 1 String (256), variable One ZMF component name. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
NOTE: May be masked using asterisk (*) wildcard character.
<componentType> Optional 0 - 1 String (3), variable ZMF component library type.
NOTE: May be masked using asterisk (*) wildcard character.
<package> Required 1 String (10), variable Fixed-format ZMF package name.
<packageId> Optional 0 - 1 Integer (6), fixed ZMF package ID number. Same as last 6 bytes of package name.
NOTE: Leading zeroes required.
<promotionSiteName> Optional 0 - 1 String (8), variable Site where promotion library of interest resides.
NOTE: May be masked using asterisk (*) wildcard character.

CMPONENT PRM_HIST LIST — Replies

The Serena XML reply message for a component promotion history list contains zero to many <result> tag, each of which provides promotion history and status information for one component that matches your request criteria.

The standard <response> data structure follows the final <result> tag and indicates the success or failure of the list request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. As the final data structure in the reply, the <response> tag also serves as an end-of-list marker.

Data structure details for the <request> tag of this message appear in Exhibit 5-30.

Exhibit 5-36 CMPONENT PRM_HIST LIST <result> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 0 - 1 String (4), variable ZMF application name. Same as first 4 bytes of package name.
<cleanupComponent> Optional 0 - 1 String (1) Y = Yes, clean up component
N = No, don’t clean up component
<component> Optional 1 String (256), variable ZMF component name. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
<componentType> Optional 1 String (3), fixed ZMF component library type.
<isComponentDeleted> Optional 0 - 1 String (1) Y = Yes, component deleted
N = No, not deleted
<isComponentOverlaid> Optional 0 - 1 String (1) Y = Yes, component overlaid
N = No, not overlaid
<isComponentRestaged> Optional 0 - 1 String (1) Y = Yes, component restaged
N = No, component not restaged
<package> Optional 1 String (10), variable Fixed-format ZMF package name.
<packageId> Optional 0 - 1 Integer (6), fixed ZMF package ID number. Same as last 6 bytes of package name.
<priorPromoter> Optional 0 - 1 String (8), variable TSO ID of prior promoter.
<priorPromotionDate> Optional 0 - 1 Date, yyyymmdd Prior promotion/demotion date.
<priorPromotionLevel> Optional 0 - 1 Integer (2), fixed Numeric promotion level for prior component promotion library.
<priorPromotionName> Optional 0 - 1 String (8), variable Name of library corresponding to hierarchical level number in <priorPromotionLevel> tag.
<priorPromotionTime> Optional 0 - 1 Time, hhmmss Prior promotion/demotion time.
<promoter> Optional 0 - 1 String (8), variable TSO ID of most recent promoter.
<promotionDate> Optional 0 - 1 Date, yyyymmdd Date component was last promoted.
<promotionJobStatus> Optional 0 - 1 String (1) Code for status of promotion job. Values:
1 = Submitted
2 = Succeeded
3 = Failed
<promotionLevel> Optional 0 - 1 Integer (2), fixed Numeric promotion level for current component promotion library.
<promotionName> Optional 0 - 1 String (8), variable Name of library corresponding to hierarchical level number in <promotionLevel> tag.
<promotionSiteName> Optional 0 - 1 String (8), variable Promotion/demotion site.
<promotionTime> Optional 0 - 1 Time, hhmmss Time component was last promoted, in 24-hour format.

...

Component History List - CMPONENT HISTORY LIST

A Serena XML message to retrieve and list a comprehensive history of selected components has the following service/scope/message names:

<service name="CMPONENT">
<scope name="HISTORY"> 
<message name="LIST">

These tags appear in both request and reply messages.

CMPONENT HISTORY LIST — Request

Requests may be filtered by the following component status tags:

<baselinedStatus>
<checkedOutStatus>
<delArchStatus>
<deletedStatus>
<demotedStatus>
<promotedStatus>

Yes/no flags for component status filtering take default values as a group. The default changes based on whether or not you enter explicit values in these tags, as follows:

  • If no status flag has an explicitly typed value, the default for all tags is "Y".
  • If any status flag has an explicitly typed value, the default for the remaining tags is "N".

The following example shows how you might code a Serena XML request for a comprehensive component history list. Data structure details follow the example in Exhibit 5-31.

Example XML — CMPONENT HISTORY LIST Request

<?xml version="1.0"?>
<service name="CMPONENT">
    <scope name="HISTORY">
        <message name="LIST">
            <header>
                <subsys>8</subsys>
                <product>CMN</product>
            </header>
            <request>
                <component>ACPSRS00</component>
                <componentType>SRS</componentType>
            </request>
        </message>
    </scope>
</service>

...

Exhibit 5-37 CMPONENT HISTORY LIST <request>

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 0 - 1 String (4), variable ZMF application name.
<baselinedStatus> Optional 0 - 1 String (1) Y = Include baselined components
N = Omit baselined components
NOTE: Part of component status flag group. If no tag in group has explicit value, default is Y. If any tag in group has explicit value, default is N.
<buildProc> Optional 0 - 1 String (8), variable 8-byte ZMF name for designated build procedure.
<checkedOutStatus> Optional 0 - 1 String (1) Y = Include checked-out components
N = Omit checked-out components
NOTE: Part of component status flag group. If no tag in group has explicit value, default is Y. If any tag in group has explicit value, default is N.
<component> Required 1 String (256), variable ZMF component name. If component is a PDS member, this is the member name (max 8 bytes, no qualifiers). If component is an HFS file, this is the Unix-style long file name, optionally prefixed by path from installation root, max 256 bytes.
NOTE: Component name may be masked using standard wildcards.
<componentType> Required 1 String (3) 3-byte component library type to include in results.
NOTE: Component type may be masked using standard wildcards.
<delArchStatus> Optional 0 - 1 String (1) Y = Include del-archived components
N = Omit del-archived components
NOTE: Part of component status flag group. If no tag in group has explicit value, default is Y. If any tag in group has explicit value, default is N.
<deletedStatus> Optional 0 - 1 String (1) Y = Include deleted components
N = Omit deleted components
NOTE: Part of component status flag group. If no tag in group has explicit value, default is Y. If any tag in group has explicit value, default is N.
<demotedStatus> Optional 0 - 1 String (1) Y = Include demoted components
N = Omit demoted components
NOTE: Part of component status flag group. If no tag in group has explicit value, default is Y. If any tag in group has explicit value, default is N.
<fromBaselinePkgDate> Optional 0 - 1 Date, yyyymmdd Baseline package date.
<fromDateLastModified> Optional 0 - 1 Date, yyyymmdd Start of range for desired component modification dates.
<language> Optional 0 - 1 String (8), variable Source language of component(s) to be compiled. If omitted, ZMF retrieves from component history.
<package> Optional 0 - 1 String (10), variable ZMF package name.
NOTE: May be masked using standard wildcards.
<packageId> Optional 0 - 1 Integer (6), fixed ZMF package ID number. Same as last 6 bytes of package name.
<promotedStatus> Optional 0 - 1 String (1) Y = Include promoted components
N = Omit promoted components
NOTE: Part of component status flag group. If no tag in group has explicit value, default is Y. If any tag in group has explicit value, default is N.
<toBaselinePkgDate> Optional 0 - 1 Date, yyyymmdd To baseline package date.
<toDateLastModified> Optional 0 - 1 Date, yyyymmdd End of range desired component modification dates.
<updater> Optional 0 - 1 String (8), variable TSO ID of last user to update component.

...

CMPONENT HISTORY LIST — Reply

The reply to a Serena XML component history list request returns zero to many <result> tags. Each <result> tag contains change history information about one component that meets the search criteria in your request. If one component appears in multiple packages, a <result> tag will appear for each instance of each component in each package.

A standard <response> data structure follows the <result> tags, if any, to indicate the success or failure of the request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. As the last data element returned in a Serena XML reply message, the <response> tag serves as an end-of-list marker.

An example Serena XML reply message for a component history list request appears below. Data structure details for the <result> tag follow in Exhibit 5-32.

Example XML — CMPONENT HISTORY LIST Reply

<?xml version="1.0"?>
<service name="CMPONENT">
    <scope name="HISTORY">
        <message name="LIST">
            <result>
                <component>ACPSRS00</component>
                <componentType>SRS</componentType>
                <package>ACTP000002</package>
                <applName>ACTP</applName> <packageId>000002</packageId>
                <updater>SERT</updater>
                <dateLastModified>20081019</dateLastModified>
                <timeLastModified>204620</timeLastModified>
                <versionModLevel>0101</versionModLevel>
                <version>01</version>
                <modLevel>01</modLevel>
                <hashToken>E1C3A019000001FD</hashToken>
                <checkedOutStatus>N</checkedOutStatus>
                <deletedStatus>N</deletedStatus>
                <promotedStatus>N</promotedStatus>
                <demotedStatus>N</demotedStatus>
                <baselinedStatus>N</baselinedStatus>
                <delArchStatus>N</delArchStatus>
                <baselinePkgDate>20081019</baselinePkgDate>
                <baselinePkgTime>204620</baselinePkgTime>
                <language>COBOL2</language>
                <buildProc>CMNCOB2</buildProc>
                <linkOptions>NCAL</linkOptions>
                <useDb2PreCompileOption>N</useDb2PreCompileOption>
                <size>00000020</size>
                <setssi>5BCB7948</setssi>
            </result>
            .
            .
            .
            <response>
                <statusMessage>CMN8700I - LIST service completed</statusMessage>
                <statusReturnCode>00</statusReturnCode>
                <statusReasonCode>8700</statusReasonCode>
            </response>
        </message>
    </scope> 
</service>

...

Exhibit 5-38 CMPONENT HISTORY LIST <result>

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 0 - 1 String (4), variable ZMF application name.
<baselinePkgDate> Optional 0 - 1 Date, yyyymmdd Baseline package date.
<baseLinePkgTime> Optional 0 - 1 Time, hhmmss Time component was last baselined, in 24-hour format.
<baselinedStatus> Optional 0 - 1 String (1) Y = Yes, component baselined
N = No, component not baselined
<buildProc> Optional 0 - 1 String (8), variable 8-byte ZMF name for designated build procedure.
<checkedOutStatus> Optional 0 - 1 String (1) Y = Yes, component checked out
N = No, not checked out
<compileOptions> Optional 0 - 1 String (34) Compile options for component not stored elsewhere.
<component> Required 1 String (256), variable ZMF component name. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
<componentBuildNumber> Optional 1 String (10), variable Component build number
<componentType> Required 1 String (3) ZMF component library type.
<dateLastModified> Optional 0 - 1 Date, yyyymmdd Date component was last changed.
<delArchStatus> Optional 0 - 1 String (1) Y = Yes, component del-archived.
N = No, component not del-archived
<deletedStatus> Optional 0 - 1 String (1) Y = Yes, component deleted.
N = No, component not deleted.
<demotedStatus> Optional 0 - 1 String (1) Y = Yes, component demoted.
N = No, component not demoted.
<hashToken> Optional 0 - 1 String (16), variable **Hash Token
<language> Optional 0 - 1 String (8) Name of source code language for component.
<linkOptions> Optional 0 - 1 String (34) Link options for component not stored elsewhere.
<modLevel> Optional 0 - 1 Integer Modification level
<package> Optional 1 String (10) ZMF name of package that includes this component.
NOTE: If a component appears in multiple packages, a tag for each package is returned with packagespecific component change information.
<packageId> Optional 0 - 1 Integer (6) ZMF package ID number. Same as last 6 bytes of package name.
<processingtype> Optional 0 - 1 String (1) **Processing type.
<promotedStatus> Optional 0 - 1 String (1) Y = Yes, component promoted
N = No, not promoted
<promoter> Optional 0 - 1 String (8) TSO ID of most recent promoter.
<promotionDate> Optional 0 - 1 Date, yyyymmdd Date component was last promoted.
<promotionLevel> Optional 0 - 1 Integer Numeric promotion level for current component promotion library.
<promotionName> Optional 0 - 1 String (8) Name of library corresponding to hierarchical level number in <promotionLevel> tag.
<promotionSite> Optional 0 - 1 String (8), variable Promotion site
<promotionTime> Optional 0 - 1 Time, hhmmss Time component was last promoted, in 24-hour format.
<renameFrom> Optional 0 - 1 String (256), variable Rename FROM component name.
<renameTo> Optional 0 - 1 String (256), variable Rename TO component name.
<setssi> Optional 0 - 1 String (8) Component SETSII date (seconds since 1/1/1960)
<size> Optional 0 - 1 Integer(8) Number of lines of code.
<timeLastModified> Optional 0 - 1 Time, hhmmss Time component was last changed, in 24-hour format.
<updater> Optional 0 - 1 String (8), variable TSO ID of last user to update component.
<useDb2PreCompileOption> Optional 0 - 1 String (1) Y = Yes, use DB2 precompile
N = No, don’t precompile for DB2
<userOption01> . . . <userOption20> Optional 0 - 1 String (1) Set of up to 20 one-byte, custom, administrator-defined variables. Values:
Y = Yes
N = No
<userOption0101> . . . <userOption0105> Optional 0 - 1 each String (1), variable Administrator-defined build options assigned to component. Each tag corresponds to User Option 0101 to 0105 on the ISPF user options panel for component build.
<userOption0201> . . . <userOption0203> Optional 0 - 1 each String (2), variable Administrator-defined build options assigned to component. Each tag corresponds to User Option 0201 to 0203 on the ISPF user options panel for component build.
<userOption0301> . . . <userOption0303> Optional 0 - 1 each String (3), variable Administrator-defined build options assigned to component. Each tag corresponds to User Option 0301 to 0303 on the ISPF user options panel for component build.
<userOption0401> . . . <userOption0403> Optional 0 - 1 each String (4), variable Administrator-defined build options assigned to component. Each tag corresponds to User Option 0401 to 0403 on the ISPF user options panel for component build.
<userOption0801> . . . <userOption0805> Optional 0 - 1 each String (8), variable Administrator-defined build options assigned to component. Each tag corresponds to User Option 0801 to 0805 on the ISPF user options panel for component build.
<userOption1001> . . . <userOption1002> Optional 0 - 1 each String (10), variable Administrator-defined build options assigned to component. Each tag corresponds to User Option 1001 to 1002 on the ISPF user options panel for component build.
<userOption1601> . . . <userOption1602> Optional 0 - 1 each String (16), variable Administrator-defined build options assigned to component. Each tag corresponds to User Option 1601 to 1603 on the ISPF user options panel for component build.
<userOption3401> . . . <userOption3402> Optional 0 - 1 each String (34), variable Administrator-defined build options assigned to component. Each tag corresponds to User Option 3401 to 3402 on the ISPF user options panel for component build.
<userOption4401> . . . <userOption4402> Optional 0 - 1 each String (44), variable Administrator-defined build options assigned to component. Each tag corresponds to User Option 4401 to 4402 on the ISPF user options panel for component build.
<userOption6401> . . . <userOption6405> Optional 0 - 1 each String (64), variable Administrator-defined build options assigned to component. Each tag corresponds to User Option 6401 to 6405 on the ISPF user options panel for component build.
<userOption7201> . . . <userOption7205> Optional 0 - 1 each String (72), variable Administrator-defined build options assigned to component. Each tag corresponds to User Option 7201 to 7205 on the ISPF user options panel for component build.
<userOptionsPart1> Optional 0 - 10 String (10) Set of up to 10 one-byte, custom, administrator-defined variables. User options 01-10. Values:
Y = Yes
N = No
<userOptionsPart2> Optional 0 - 10 String (10) Set of up to 10 one-byte, custom, administrator-defined variables. User options 11 - 20. Values:
Y = Yes
N = No
<version> Optional 0 - 1 Integer ISPF version of component.
<versionModLevel> Optional 0 - 1 Integer ISPF modification level for component.

...

Tip

Tags: <userOption01> to <userOption20>, <userOptionsPart1>, <userOptionsPart2>, <userOption0101> to <userOption7205>. See topic "Staging User Options" in the ChangeMan ZMF Customization Guide.

List Short Component History - CMPONENT HISTORY LISTSHRT

The Serena XML service/scope/message names in messages to retrieve and list the short version of selected component history records are:

<service name="CMPONENT"> 
<scope name="HISTORY">
<message name="LISTSHRT">

These tags appear in both request and reply messages.

CMPONENT HISTORY LISTSHRT — Requests

The short form of the component history list request is similar to the comprehensive component history list function (CMPONENT HISTORY LIST). The differences for the short form are:

  • The name attribute of the <message> tag is "LISTSHRT".

  • The <component> and <componentType> tag values may not be masked using wildcard patterns; you must enter a single component name and component type.

  • The <package> and <packageId> tags are omitted.

Data structure details for the <request> tag of the CMPONENT HISTORY LIST message appeared previously in Exhibit 5-31.

CMPONENT HISTORY LISTSHRT — Replies

Other than the name attribute of the <message> tag, replies to a short component history list are identical in syntax to a comprehensive component history list. Data structure details for the <result> tag of this message appeared previously in Exhibit 5-32.

List Current Component History - CMPONENT HISTORY LISTCURR

The Serena XML service/scope/message names in messages to retrieve and list component history for the current, active version of a selected component are:

<service name="CMPONENT"> 
<scope name="HISTORY">
<message name="LISTCURR">

These tags appear in both request and reply messages.

CMPONENT HISTORY LISTCURR — Requests

Data structure details for this request message appear in Exhibit 5-33.

Exhibit 5-39 CMPONENT HISTORY LISTCURR <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 0 - 1 String (4), variable ZMF application name.
<component> Required 1 String (256), variable ZMF component name. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
<componentType> Required 1 String (3), fixed ZMF component library type.
<package> Optional 0 - 1 String (10), variable ZMF package name.
<packageId> Optional 0 - 1 Integer (6), fixed ZMF package ID number. Same as last 6 bytes of package name.

...

CMPONENT HISTORY LISTCURR — Replies

Other than the name attribute of the <message> tag, reply messages for a current component history list are identical to those for a comprehensive component history list. Data structure details for the <result> tag of this message appeared previously in Exhibit 5-32.

List Concurrent Comp. History - CMPONENT HISTORY LISTCONC

The Serena XML service/scope/message names in messages to retrieve and list history records for components in concurrent development are:

<service name="CMPONENT"> 
<scope name="HISTORY">
<message name="LISTCONC">

These tags appear in both request and reply messages.

CMPONENT HISTORY LISTCONC — Requests

Data structure details for this request message appear in Exhibit 5-34.

Exhibit 5-40 CMPONENT HISTORY LISTCONC <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Required 1 String (4), variable ZMF application name.
<component> Required 1 String (256), variable ZMF component name. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
<componentType> Required 1 String (3), fixed ZMF component library type.

...

CMPONENT HISTORY LISTCONC — Replies

Other than the name attribute of the <message> tag, and the additional tag <packageType>, the reply messages for a concurrent component history list are identical to those for a comprehensive component history list. Data structure details for the <result> tag of this message appeared previously in Exhibit 5-32.

The <packageType> tag is a one-byte string and may contain a value of 1, 2, 3, or 4:

1 = Planned Permanent
2 = Planned Temporary
3 = Unplanned Permanent
4 = Unplanned Temporary

List Baselined Component History - CMPONENT HISTORY LISTBASE

The Serena XML service/scope/message names in messages to retrieve and list component history for the baselined version of a selected component are:

<service name="CMPONENT"> 
<scope name="HISTORY">
<message name="LISTBASE">

These tags appear in both request and reply messages.

CMPONENT HISTORY LISTBASE — Requests

Data structure details for this request message appear in Exhibit 5-35.

Exhibit 5-41 CMPONENT HISTORY LISTBASE <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Required 1 String (4), variable ZMF application name.
<component> Required 1 String (256), variable ZMF component name. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
<componentType> Required 1 String (3), fixed ZMF component library type.

CMPONENT HISTORY LISTBASE — Replies

Other than the name attribute of the <message> tag, reply messages for a baselined component history list are identical to those for a comprehensive component history list. Data structure details for the <result> tag of this message appeared previously in Exhibit 5-32.

List Comp. Standard Language – CMPONENT HISTORY LISTLANG

The Serena XML service/scope/message names in messages to list a standardized language identifier for a component are:

<service name="CMPONENT">
<scope name="HISTORY">
<message name="LISTLANG">

These tags appear in both request and reply messages.

CMPONENT HISTORY LISTLANG - Request

Data structure details for the <request> tag appear in Exhibit 5-36.

Exhibit 5-42 CMPONENT HISTORY LISTLANG <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Required 1 String (4), variable ZMF application name.
<component> Required 1 String (256), variable ZMF component name. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
<componentType> Required 1 String (3), fixed ZMF component library type.
<packageId> Optional 0 - 1 Integer (6), fixed ZMF package ID number. Same as last 6 bytes of package name. Required when <location> = S.
<promotionLevel> Optional 0 - 1 Integer (2) Numeric promotion level for current component promotion library. Required (or <promotionName>) as well as <promotionSite> when <location> = P.
<promotionName> Optional 0 - 1 String (8), variable Name of library corresponding to hierarchical level number in <promotionLevel> tag. Required (or <promotionLevel>) as well as <promotionSite> when <location> = P.
<promotionSite> Optional 0 - 1 String (8), variable Promotion site. Required (as well as <promotionLevel> or <promotionName>) when <location> = P.
<location> Required 1 String (1), fixed The possible values for location are as follows:

S Staging

B Baseline

P Promotion

R Release
<release> Optional 0 - 1 String (8), variable Name of ZMF release (ERO Option only). Required when <location> = R.
<releaseArea> Optional 0 - 1 String (8), variable Name of the ZMF release area (ERO Option only). Required when <location> = R.

...

CMPONENT HISTORY LISTLANG - Reply

The reply to a Serena XML component history list language request returns a single <result> tag. The <result> tag contains a tag that indicates the component’s language and can take one of the following values:

  • ASM

  • C

  • COBOL

  • FORTRAN

  • JAVA

  • JCL

  • PLI

  • REXX

  • TEXT

Example XML — CMPONENT HISTORY LISTLANG Reply

<?xml version="1.0"?>
<service name="CMPONENT">
  <scope name="HISTORY">
    <message name="LISTLANG">
      <result>
        <language>ASM</language>
      </result>
      <response>
        <statusMessage>CMN8700I - LIST service completed</statusMessage>
        <statusReturnCode>00</statusReturnCode>
        <statusReasonCode>8700</statusReasonCode>
       </response>
    </message>
  </scope>
</service>

The process for calculating the return value involves determining the component’s language then using that language to set the return value. The following list describes an outline of the process:

  1. Call exit CMNEX038, if it is active, and use the language returned if it is specified.

  2. Call HLL exit SYSL00XL and use the language returned if it is specified.

  3. If steps 1 or 2 return a language, jump to step 5.

  4. Establish the language using different methods depending on the component’s library type.

    If the library type is not like-SRC, set the language based on the value of libtype:

    If libtype begins with: Set language to:
    H C
    C COBOL
    J or P JCL
    I PLI
    R REXX

    If the library type does not match any pattern in the above list, the default language setting, TEXT, is used. If the library type is like-SRC, set the language based on the specified value of language and other required values:

    If the location is: Set language by:
    S Staging Using the package specified by packageId to look up the component’s history and take the language from that record.
    B Baseline Using the LISTBASE component history lookup to get the relevant record, and take the language from that.
    P Promotion Using a general list history, filtered on promoted=Y, then match the results against the specified values for promotionSite and promotionLevel or promotionName. If there is more than one match, the record with the latest timestamp is used. The language is then taken from the relevant record.
    R Release Looking up the component in the ERO CIM table (using the specified values for release and releaseArea) and use the language defined there.

  5. Use the discovered language to set the return value as follows:

    Pattern of Discovered Language Returned value
    AS*, BAL, CICS*, DB*, MF*, MSMASM*, PS* ASM
    C , CP*, C+* C
    CO*, CB*, VSC* COBOL
    FORT* FORTRAN
    J* JAVA
    PL* PLI

  6. Call HLL exit SYSL01XL, giving you the opportunity to change the value that was returned. You can change the default processing in the following three exit points:

    • CMNEX038 - traditional assembler exit which enables you to predetermine the language of a component.
    • SYSL00XL - HLL exit point to provide the same functionality as CMNEX038. It is taken after CMNEX038 and overrides anything set by CMNEX038.
    • SYSL01XL - HLL exit point to enable you to change the standard language determined by the service immediately before sending back the result.

The two HLL exits have been created under the SYSL functional area (Package SYSLIB).

List Comp. User Worklist Records - CMPONENT PKG_WRKL LIST

The Serena XML service/scope/message names in messages to list user work records for developers who have worked on a component are:

<service name="CMPONENT">
<scope name="PKG_WRKL">
<message name="LIST">

These tags appear in both request and reply messages.

CMPONENT PKG_WRKL LIST — Requests

Requests for a list of user work records concerning a component in a package — the socalled ICWK records in the package master — consist almost entirely of required tags. You must supply the package name, component name, component type, and the TSO ID of the component updater whose work records you want to list. No wildcard patterns for these values are supported in Serena XML.

Example XML — CMPONENT PKG_WRKL LIST Request

<?xml version="1.0"?>
<service name="CMPONENT">
  <scope name="PKG_WRKL">
    <message name="LIST">
        <header>
            <subsys>8</subsys>
            <product>CMN</product>
        </header>
        <request>
            <package>ACTP000007</package>
            <component>ACPCPY00</component>
            <componentType>CPY</componentType>
            <updater>USER24</updater>
        </request>
    </message>
  </scope>
</service>

Data structure details for the <request> tag of this request appear in Exhibit 5-37.

Exhibit 5-43 CMPONENT PKG_WRKL LIST <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 0 - 1 String (4), variable ZMF application name. Same as first 4 bytes of package name.
NOTE: OK to omit trailing blanks.
<component> Required 1 String (256), variable ZMF component name. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
<componentType> Required 1 String (3), fixed ZMF component library type.
<package> Required 1 String (10), variable Fixed-format ZMF package name.
<packageId> Optional 0 - 1 Integer (6), fixed ZMF package ID number. Same as last 6 bytes of package name.
NOTE: Leading zeroes required.
<updater> Required 1 String (8), variable TSO ID of component updater.

List Component User Worklist Records — Replies

The Serena XML reply for a component user work record list request returns zero to many <result> tags. Each <result> tag contains information about the last action taken by the user on the component in question, the date and time of that action, a flag identifying this user as the last user to modify the component (if applicable), and the last action performed on the component by any user. Other control information, if any, related to the user audit trail also appears in the <result>.

A standard <response> data structure follows the <result> tags, if any, to indicate the success or failure of the request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher. As the last data element returned in a Serena XML reply message, the <response> tag serves as an end-of-list marker.

...

Example XML — CMPONENT PKG_WRKL LIST Reply

<?xml version="1.0"?>
<service name="CMPONENT">
    <scope name="PKG_WRKL">
        <message name="LIST">
            <result>
                <package>ACTP000007</package>
                <applName>ACTP</applName>
                <packageId>000007</packageId>
                <component>ACPCPY00</component>
                <componentType>CPY</componentType>
                <updater>USER24</updater>
                <lastAction>9</lastAction>
                <setssi>5C4EBCC3</setssi>
                <updateDate>20090127</updateDate>
                <updateTime>082643</updateTime>
                <useCount>0001</useCount>
                <isComponentDeleted>N</isComponentDeleted>
                <mostRecentUpdate>Y</mostRecentUpdate>
            </result>
            <response>
                <statusMessage>CMN8700I - LIST service completed</statusMessage>
                statusReturnCode>00</statusReturnCode>
                statusReasonCode>8700</statusReasonCode>
            </response>
        </message>
    </scope>  
</service>
Data structure details for the <result> tag follow in Exhibit 5-38.

Exhibit 5-44 CMPONENT PKG_WRKL LIST <result> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 0 - 1 String (4), variable ZMF application name. Same as first 4 bytes of package name.
<component> Optional 1 String (256), variable ZMF component name. If component is PDS member, this is member name (max 8 bytes, no qualifiers). If component is HFS file, this is Unix-style long file name, optionally prefixed by path from installation root.
<componentType> Optional 1 String (3), fixed ZMF component library type.
<isComponentDeleted> Optional 0 - 1 String (1) Y = Yes, component deleted
N = No, component not deleted
<lastAction> Optional 0 - 1 Integer (1) Code for user function performed by last component updater. Values:
1 = Browse
2 = Check Out
3 = Create
4 = Delete
5 = Edit
6 = Edit & Stage
7 = Recompile
8 = Relink
9 = Stage
A = Update
B = Checkin
C = Build
<mostRecentUpdate> Optional 0 - 1 String (1) Y = this is the most recent update
N = this is not the most recent update
<package> Optional 1 String (10), variable Fixed-format ZMF package name.
<packageId> Optional 0 - 1 Integer (6), fixed ZMF package ID number. Same as last 6 bytes of package name.
<setssi> Optional 0 - 1 String (8), variable setssi.
<updateDate> Optional 0 - 1 Date, yyyymmdd Update date.
<updateTime> Optional 0 - 1 Time, hhmmss Update time
<updater> Optional 0 - 1 String (8), variable Userid of updater.
<usecount> Optional 0 - 1 Integer(4) Use count

...