Skip to content

RLSMAREA HST LIST

The RLSMAREA HST LIST message lists the history residing in the ERO component history table. A comprehensive list may be obtained for all components in a release, or a selective list may be obtained by requesting specific fields.

The XML service/scope/message tags and attributes for this message are:

<service name="RLSMAREA">
<scope name="HST">
<message name="LIST">

These tags appear in both requests and replies.

RLSMAREA HST LIST — Request

The following example shows how you might code a request to list all of the component history for a release. Data structure details for the <request> tag follow the example.

Example XML — RLSMAREA HST LIST Request

<?xml version="1.0"?>
<service name="RLSMAREA">
    <scope name="HST">
        <message name="LIST">
            <header>
                <subsys>4</subsys>
                <test> </test>
                <product>CMN</product>
            </header>
            <request>
                <release>S4712COM</release>
            </request>
        </message>
    </scope>
</service>

RLSMAREA HST LIST <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 0 - 1 String (4), variable Release application name.
<buildProc> Optional 0 - 1 String (8), variable Component build procedure.
<checkinDescription> Optional 0 - 1 String (120), variable Checkin description.
<component> Optional 0 - 1 String (256), variable Release area component name.
<componentFromChangeDate> Optional 0 - 1 Date, yyyymmdd Component change "from" date.
<componentFromChangeTime> Optional 0 - 1 Time, hhmmss Component change "from" time.
<componentHistoryStatus> Optional 0 - 1 String (3) Status of action on component. Values:
BAS = Component was baselined.
CKI = Component was checked in.
CKO = Component was checked out.
DEL = Component was deleted.
DEM = Component was demoted.
MDL = Component was memo-deleted.
PRM = Component was promoted.
RTV = Component was retrieved.
STG = Component was staged.
<componentToChangeDate> Optional 0 - 1 Date, yyyymmdd Component change "to" date.
<componentToChangeTime> Optional 0 - 1 Time, hhmmss Component change "to" time.
<componentType> Optional 0 - 1 String (3) Component library type.
<language> Optional 0 - 1 String (8), variable Component source code language.
<lastHistory> Optional 0 - 1 String (1) Y = List last history record only.
N = List all history records.
<package> Optional 0 - 1 String (10), variable Package name.
NOTE: May be masked using asterisk (*) wildcard.
<packageId> Optional 0 - 1 Integer (6) Package number.
<release> Required 1 String (8), variable Release name.
<releaseArea> Optional 0 - 1 String (8), variable Release area name.
<releaseAreaFromCheckinDate> Optional 0 - 1 Date, yyyymmdd Release area checkin "from" date.
<releaseAreaFromRetrieveDate> Optional 0 - 1 Date, yyyymmdd Release area retrieve "from" date.
<releaseAreaToCheckinDate> Optional 0 - 1 Date, yyyymmdd Release area checkin "to" date.
<releaseAreaToRetrieveDate> Optional 0 - 1 Date, yyyymmdd Release area retrieve "to" date.
<updater> Optional 0 - 1 String (8), variable Component checkin user ID.

...

RLSMAREA HST LIST — Reply

The XML reply to a RLSMAREA HST LIST request returns zero to many <result> data elements. Each result lists a record of history data for a component.

The standard <response> data element follows any <result> tags in the reply and indicates 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. Because it is the final data element in the XML reply message, the <response> tag serves as an end-of-list marker.

The following example shows what the reply message might look like. Data structure details for the <result> tag follow the example.

Example XML — RLSMAREA HST LIST Reply

<?xml version="1.0"?>
<service name="RLSMAREA">
    <scope name="HST">
        <message name="LIST">
            <result>
                <release>S4712COM</release>
                <releaseArea>ACCTPAY</releaseArea>
                <package>ACTP000076</package>
                <applName>ACTP</applName>
                <packageId>000076</packageId> <componentHistoryType>RLS</componentHistoryType>
                <componentType>CPY</componentType>
                <component>ACPCPYCE</component>
                <updater>KCAMPBE</updater>
                <componentChangeDate>20120827</componentChangeDate>
                <componentChangeTime>135951</componentChangeTime>
                <componentPriorChangeDate>20120827</componentPriorChangeDate>
                <componentPriorChangeTime>135835</componentPriorChangeTime>
                <setssi>630B28C0</setssi>
                <version>01</version>
                <modLevel>02</modLevel>
                <componentHistoryStatus>CKI</componentHistoryStatus>
                <componentPriorHistoryStatus>RTV</componentPriorHistoryStatus>
                <useDb2PreCompileOption>N</useDb2PreCompileOption>
                <forceAssignedBuildProc>N</forceAssignedBuildProc>
                <size>00000003</size>
                <checkinReleaseArea>PACKAGE</checkinReleaseArea>
                <checkinUser>KCAMPBE</checkinUser>
                <releaseAreaCheckinDate>20120827</releaseAreaCheckinDate>
                <releaseAreaCheckinTime>135951</releaseAreaCheckinTime>
                <retrieveReleaseArea>ACCTPAY</retrieveReleaseArea>
                <retrieveUser>KCAMPBE</retrieveUser>
                <releaseAreaRetrieveDate>20120827</releaseAreaRetrieveDate>
                <releaseAreaRetrieveTime>135835</releaseAreaRetrieveTime>
                <promotionDate>20121231</promotionDate>

...

                <promotionTime>000000</promotionTime>
                <componentCheckoutSetssi>630B28C0</componentCheckoutSetssi>
                <componentCheckoutDate>20120827</componentCheckoutDate>
                <componentCheckoutTime>135951</componentCheckoutTime>
                <userOption7205>CMNTP HRAPL &a\#xFF00;&\#xFF00;&\#xFF00;&\#xFF00;/cmntp</userOption7205>
            </result> 
.
.
.
            <response>
                <statusMessage>CMR8700I - Release HST Table service completed </statusMessage>
                <statusReturnCode>00</statusReturnCode>
                <statusReasonCode>8700</statusReasonCode>
            </response>
        </message>
    </scope>
</service>

RLSMAREA HST LIST <result> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<applName> Optional 0 - 1 String (4), variable Release application name.
<buildProc> Optional 0 - 1 String (8), variable Component build procedure.
<builder> Optional 0 - 1 String (8), variable Component build user ID.
<checkinDescription> Optional 0 - 1 String (120), variable Component checkin description.
<checkinReleaseArea> Optional 0 - 1 String (8), variable Component checkin release area name.
<checkinUser> Optional 0 - 1 String (8), variable Component checkin user ID.
<checkoutAssocPkg> Optional 0 - 1 String (10) Component checkout associated package name.
<checkoutHashToken> Optional 0 - 1 String (16) Component checkout hash token.
<checkoutRelease> Optional 0 - 1 String (8), variable Component checkout release name.
<checkoutReleaseArea> Optional 0 - 1 String (8), variable Component checkout release area name.
<checkoutUser> Optional 0 - 1 String (8), variable Component checkout user ID.
<compileOptions> Optional 0 - 1 String (34), variable Compile options.
<component> Optional 0 - 1 String (256), variable Component name.
<componentBuildNumber> Optional 0 - 1 String (10) Component build number.
<componentChangeDate> Optional 0 - 1 Date, yyyymmdd Component changed date.
<componentChangeTime> Optional 0 - 1 Time, hhmmss Component changed time.
<componentCheckoutDate> Optional 0 - 1 Date, yyyymmdd Component checkout date.
Optional 0 - 1 String (8) Component checkout SETSSI.
<componentCheckoutTime> Optional 0 - 1 Time, hhmmss Component checkout time.
<componentHistoryStatus> Optional 0 - 1 String (3) Status of action on component. Values:
BAS = Component was baselined.
CKI = Component was checked in.
CKO = Component was checked out.
DEL = Component was deleted.
DEM = Component was demoted.
MDL = Component was memo-deleted.
PRM = Component was promoted.
RTV = Component was retrieved.
STG = Component was staged.
<componentHistoryType> Optional 0 - 1 String (3) Type of component history record. Values:
GEN = Component general record.
RLS = Component release record.
<componentLastBaselineDate> Optional 0 - 1 Date, yyyymmdd Component last baseline date.
<componentLastBaselineTime> Optional 0 - 1 Time, hhmmss Component last baseline time.
<componentLastBuildDate> Optional 0 - 1 Date, yyyymmdd Component last build date.
<componentLastBuildTime> Optional 0 - 1 Time, hhmmss Component last build time.
<componentLastCheckoutDate> Optional 0 - 1 Date, yyyymmdd Component last checkout date.
<componentLastCheckoutTime> Optional 0 - 1 Time, hhmmss Component last checkout time.
<componentPriorChangeDate> Optional 0 - 1 Date, yyyymmdd Component prior change date.
<componentPriorChangeTime> Optional 0 - 1 Time, hhmmss Component prior change time.
<componentPriorHistoryStatus> Optional 0 - 1 String (3) Status of prior action on component. Values:
BAS = Component was baselined.
CKI = Component was checked in.
CKO = Component was checked out.
DEL = Component was deleted.
DEM = Component was demoted.
MDL = Component was memo-deleted.
PRM = Component was promoted.
RTV = Component was retrieved.
STG = Component was staged.
<componentType> Optional 0 - 1 String (3) Component library type.
<forceAssignedBuildProc> Optional 0 - 1 String (1) Compile "force" option. Values:
1 = Allow users to compile this component with alternate procedures prior to freezing the package. The last compile prior to freezing the package must be done with the designated procedure.
2 = Force users to use the designated procedure for all compiles.
<language> Optional 0 - 1 String (8), variable Name of source code language for component.
<linkOptions> Optional 0 - 1 String (34), variable Link options.
<loadModuleSize> Optional 0 - 1 String (8) Load module size.
<modLevel> Optional 0 - 1 String (2) Component modification level.
<package> Optional 0 - 1 String (10) Release package name.
<packageId> Optional 0 - 1 Integer (6) Release package number.
<promoter> Optional 0 - 1 String (8), variable Promoter TSO ID/job name.
<promotionDate> Optional 0 - 1 Date, yyyymmdd Component promotion date.
<promotionLevel> Optional 0 - 1 String (2) Promotion level number.
<promotionName> Optional 0 - 1 String (8), variable Promotion nick name.
<promotionSite> Optional 0 - 1 String (8), variable Promotion site name.
<promotionTime> Optional 0 - 1 Time, hhmmss Component promotion time.
<release> Optiona 0 - 1 String (8), variable Release name.
<releaseArea> Optiona 0 - 1 String (8), variable Release area name.
<releaseAreaCheckinDate> Optional 0 - 1 Date, yyyymmdd Release area checkin date.
<releaseAreaCheckinTime> Optional 0 - 1 Time, hhmmss Release area checkin time.
<releaseAreaRetrieveDate> Optional 0 - 1 Date, yyyymmdd Release area retrieve date.
<releaseAreaRetrieveTime> Optional 0 - 1 Time, hhmmss Release area retrieve time.
<requestorDept> Optiona 0 - 1 String (4), variable Requestor department.
<retrievePackage> Optiona 0 - 1 String (10) Release retrieve package name.
<retrieveReleaseArea> Optiona 0 - 1 String (8), variable Component retrieve release area name.
<retrieveUser> Optiona 0 - 1 String (8), variable Component retrieve user ID.
<setssi> Optional 0 - 1 String (8) Component SETSSI date.
<size> Optional 0 - 1 String (8) Size of component in lines of code.
<targetLoadLibType> Optional 0 - 1 String (3) Target load library type.
<updater> Optional 0 - 1 String (8), variable User ID of user who last updated component.
<useDb2PreCompileOption> Optional 0 - 1 String (1) Y = Use Db2 pre-processing step.
N = Do not use Db2 pre-processing step.
<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) 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.
<version> Optional 0 - 1 String (2) Component version number.