Skip to content

RLSMAREA SERVICE LIST

The RLSMAREA SERVICE LIST message lists release area definitions.

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

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

These tags appear in both requests and replies.

RLSMAREA SERVICE LIST — Request

The following example shows how you might code a request to list the release area definitions for all areas in a named release. Data structure details for the <request> tag follow the example.

Example XML — RLSMAREA SERVICE LIST Request

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

...

RLSMAREA SERVICE LIST <request> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<release> Required 1 String (8), variable Release name.
<releaseArea> Optional 0 - 1 String (8), variable Release area name.
<releaseParms> Optional 0 - 1 String (1), variable Release parms S or blank.

...

RLSMAREA SERVICE LIST — Reply

The XML reply to a RLSMAREA SERVICE LIST request returns zero to many <result> data elements. Each <result> contains information for a release area.

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 SERVICE LIST Reply

<?xml version="1.0"?>
<service name="RLSMAREA">
    <scope name="SERVICE">
        <message name="LIST">
            <result>
                <release>S4711010</release>
                <releaseArea>ACCTPAY</releaseArea>
                <releaseAreaDesc>Starting area for Accounts Payable components </releaseAreaDesc>
                <releaseAreaType>0</releaseAreaType>
                <releaseAreaStepNumber>0001</releaseAreaStepNumber> <releaseNextReleaseArea>FINANCE</releaseNextReleaseArea>
                <isReleaseAreaBlocked>N</isReleaseAreaBlocked>
                <isReleaseAreaApprovedForCheckin>Y</isReleaseAreaApprovedForCheckin>
                <isReleaseAreaApprovedForCheckoff>N</isReleaseAreaApprovedForCheckoff> <isReleaseAreaRejectedForCheckin>N</isReleaseAreaRejectedForCheckin>
                <isReleaseAreaRejectedForCheckoff>N</isReleaseAreaRejectedForCheckoff>
                <releaseAreaAuditRule>0</releaseAreaAuditRule>
                <releaseAreaBlockingRule>0</releaseAreaBlockingRule>
                <releaseAreaCheckinRule>0</releaseAreaCheckinRule>
                <releaseAreaRetrieveRule>0</releaseAreaRetrieveRule>
                <releaseAreaApproveRule>0</releaseAreaApproveRule>
                <isReleaseAreaAuditPending>N</isReleaseAreaAuditPending>
                <isReleaseAreaCheckinPending>N</isReleaseAreaCheckinPending>
                <isReleaseAreaApprovalPending>N</isReleaseAreaApprovalPending>
                <isReleaseAreaBlockPending>N</isReleaseAreaBlockPending>
                <addRelatedApprovers>Y</addRelatedApprovers>
                <allowComponentCheckout>Y</allowComponentCheckout>
                <excludeAreaFromConcatenation>N</excludeAreaFromConcatenation>
                <overrideOverlaidComponent>N</overrideOverlaidComponent>
                <bypassAreaTestDevPkg>N</bypassAreaTestDevPkg>
                <bypassAreaTestFrzPkg>N</bypassAreaTestFrzPkg>
                <bypassAreaTestAprPkg>N</bypassAreaTestAprPkg>
                <bypassAreaTestEmptyPkg>N</bypassAreaTestEmptyPkg>
                <bypassAreaTestPkgIntg>N</bypassAreaTestPkgIntg>
            </result>

...

            .
            .
            .
            <response>
                <statusMessage>CMR8700I - Area information service completed </statusMessage>
                <statusReturnCode>00</statusReturnCode>
                <statusReasonCode>8700</statusReasonCode>
            </response>
        </message>
    </scope>
</service>

...

RLSMAREA SERVICE LIST <result> Data Structure

Subtag Use Occurs Data Type & Length Values & Dependencies
<addRelatedApprovers> Optional 0 - 1 String (1) Y = Add related release area approvers.
N = Do not add related release area approvers.
<allowComponentCheckout> Optional 0 - 1 String (1) Y = Allow component checkout from release area.
N = Do not allow component checkout from release area.
<bypassAreaTestAprPkg> Optional 0 - 1 String (1) Y = Bypass test area packages in APR status.
N = Do not bypass test area packages in APR status.
<bypassAreaTestDevPkg> Optional 0 - 1 String (1) Y = Bypass test area packages in DEV status.
N = Do not bypass test area packages in DEV status.
<bypassAreaTestEmptyPkg> Optional 0 - 1 String (1) Y = Bypass test area packages that are empty.
N = Do not bypass test area packages that are empty.
<bypassAreaTestFrzPkg> Optional 0 - 1 String (1) Y = Bypass test area packages in FRZ status.
N = Do not bypass test area packages in FRZ status.
<bypassAreaTestPkgIntg> Optional 0 - 1 String (1) Y = Bypass test area package integrity.
N = Do not bypass test area package integrity.
<excludeAreaFromConcatenation> Optional 0 - 1 String (1) Y = Exclude release area from SYSLIB concatenation.
N = Do not exclude release area from SYSLIB concatenation.
<isReleaseAreaApprovalPending> Optional 0 - 1 String (1) Y = Release area approval is pending.
N = Release area approval is not pending.
<isReleaseAreaApprovedForCheckin> Optional 0 - 1 String (1) Y = Release area is approved for checkin.
N = Release area is not approved for checkin.
<isReleaseAreaApprovedForCheckoff> Optional 0 - 1 String (1) Y = Release area is approved for checkoff.
N = Release area is not approved for checkoff.
<isReleaseAreaAuditPending> Optional 0 - 1 String (1) Y = Release area audit is pending.
N = Release area audit is not pending.
Optional 0 - 1 String (1) Y = Release area block is pending.
N = Release area block is not pending.
<isReleaseAreaBlocked> Optional 0 - 1 String (1) Y = Release area is blocked.
N = Release area is not blocked.
<isReleaseAreaCheckinPending> Optional 0 - 1 String (1) Y = Release area checkin is pending.
N = Release area checkin is not pending.
<isReleaseAreaRejectedForCheckin> Optional 0 - 1 String (1) Y = Release area is rejected for checkin.
N = Release area is not rejected for checkin.
<isReleaseAreaRejectedForCheckoff> Optional 0 - 1 String (1) Y = Release area is rejected for checkoff.
N = Release area is not rejected for checkoff.
<overrideOverlaidComponent> Optional 0 - 1 String (1) Y = Override overlaid components.
N = Do not override overlaid components.
<release> Optional 0 - 1 String (8), variable Release name.
<releaseArea> Optional 0 - 1 String (8), variable Release area name.
Optional 0 - 1 Integer (1) Release area approval rule. Values:
0 = No approvals required.
1 = Approvals required before checkin.
2 = Approvals required before advancing to the next area (check-off).
3 = Rule 1 and rule 2.
<releaseAreaAuditReturnCode> Optional 0 - 1 String (2) Release area audit return code.
<releaseAreaAuditRule> Optional 0 - 1 Integer (1) Release area audit rule. Values:
0 = Audit optional.
1 = Audit required, RC<20 (audit failure).
2 = Audit required, RC<=12 (out-of-sync errors within audited area).
3 = Audit required, RC<=8 (out-of-sync errors with respect to next areas/final areas in prior releases/baseline).
4 = Audit required, RC<=4 (no out-of- sync errors but some duplicates exist).
5 = Audit required, RC=0 (no out-of-sync errors and no warnings).
<releaseAreaBlockingRule> Optional 0 - 1 Integer (1) Release area blocking rule. Values:
0 = Wide open.
1 = Audit required.
2 = User must pass entity check (and rule 0).
3 = Rule 1 and rule 2.
<releaseAreaBlockingRuleEntity> Optional 0 - 1 String (8), variable Release area blocking rule entity.
<releaseAreaCheckinRule> Optional 0 - 1 Integer (1) Release area checkin rule. Values:
0 = Wide open.
1 = Area or package audit required before moving to next area.
2 = Area must be blocked (or package frozen) before moving to next area.
3 = User must pass entity check (and rule 0).
4 = Rule 1 and rule 2.
5 = Rule 1 and rule 3.
6 = Rule 2 and rule 3.
7 = Rule 1, rule 2, and rule 3.
<releaseAreaCheckinRuleEntity> Optional 0 - 1 String (8), variable Release area checkin rule entity.
<releaseAreaDesc> Optional 0 - 1 String (72), variable Release area description.
<releaseAreaRetrieveRule> Optional 0 - 1 Integer (1) Release area retrieve rule. Values:
0 = Retrieve wide open for any area, blocked or unblocked.
1 = Retrieve only from unblocked areas.
2 = Must pass entity check (and rule 0).
3 = Rule 1 and rule 2.
<releaseAreaRetrieveRuleEntity> Optional 0 - 1 String (8), variable Release area retrieve rule entity.
<releaseAreaStepNumber> Optional 0 - 1 String (4) Release area step number.
<releaseAreaType> Optional 0 - 1 String (1) Release area type. Values:
0 = Subsystem
1 = System
<releaseBuildNumber> Optional 0 - 1 String (10), variable Release area build number.
<releaseNextReleaseArea> Optional 0 - 1 String (8), variable Next release area name in this release.
<releasePriorReleaseArea> Optional 0 - 1 String (8), variable Prior release area name in this release.

...