RLSMRLSE SERVICE SEARCH

The RLSMRLSE SERVICE SEARCH message provides the means to do a comprehensive search for releases and list status flags and other information for selected releases.

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

<service name="RLSMRLSE">
<scope name="SERVICE">
<message name="SEARCH">

These tags appear in both requests and replies.

RLSMRLSE SERVICE SEARCH — Request

The only required tag for this service is <releaseCreators>, which requires the entry of one or more user IDs.

This service provides several yes/no flags for release status filtering, for example, <searchForApprovedStatus>, <searchForBackedOutStatus>, and so on. These flags 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".

For more information about yes/no flags, see Yes/No Flag Tags.

The following tags allow multiple values to be entered in a semicolon-delimited list:

<releaseCreators>
<releaseList>
<searchForRlseApplNames>
<searchForRlseApprovalEntities>
<searchForRlseSites>

The following example shows how you might code a request to list release information for a named release-creator. Data structure details for the <request> tag follow the example.

Example XML — RLSMRLSE SERVICE SEARCH Request

<?xml version="1.0"?>
<service name="RLSMRLSE">
    <scope name="SERVICE">
        <message name="SEARCH">
            <header>
                <subsys>4</subsys>
                <test> </test>
                <product>CMN</product>
            </header>
            <request>
                <releaseCreators>WSER99</releaseCreators>
            </request>
        </message>
    </scope>
</service>

...

RLSMRLSE SERVICE SEARCH `<request>` Data Structure

Subtag	Use	Occurs	Data Type & Length	Values & Dependencies
<releaseAuditReturnCode>	Optional	0 - 1	String (2)	Release audit return code.
<releaseCreators>	Optional	1	String (255), variable	User IDs of release creators. Multiple entries are allowed, delimited by semicolons. Asterisk (*) wildcard may be used.
<releaseDesc>	Optional	0 - 1	String (72), variable	Release description.
<releaseList>	Optional	0 - 1	String (255), variable	Release name list. Multiple release names are allowed, delimited by semicolons. Asterisk (*) wildcard may be used.
<releaseRequestorDept>	Optional	0 - 1	String (8), variable	Release requester department.
<releaseRequestorName>	Optional	0 - 1	String (25), variable	Release requester name.
<releaseRequestorPhone>	Optional	0 - 1	String (15), variable	Release requester phone number.
<releaseSearchParms>	Optional	0 - 1	String (1)	Release parameters. Values: A = ADMIN list. List all releases regardless of the release status. blank = List only those releases that have fully configured release areas.
<releaseWorkChangeRequest>	Optional	0 - 1	String (16), variable	Release work change request. Asterisk (*) wildcard may be used.
<searchForApprovedStatus>	Optional	0 - 1	String (1)	Y = Include approved releases. N = Exclude approved releases. Part of release 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.
<searchForBackedOutStatus>	Optional	0 - 1	String (1)	Y = Include backed out releases. N = Exclude backed out releases. Part of release 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.
<searchForBaselineStatus>	Optional	0 - 1	String (1)	Y = Include baseline releases. N = Exclude baseline releases. Part of release 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.
<searchForBlockedStatus>	Optional	0 - 1	String (1)	Y = Include blocked releases. N = Exclude blocked releases. Part of release 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.
<searchForCmnScheduler>	Optional	0 - 1	String (1)	Y = Include releases with a scheduler type of CMN. N = Exclude releases with a scheduler type of CMN.
<searchForDeletedStatus>	Optional	0 - 1	String (1)	Y = Include deleted releases. N = Exclude deleted releases. Part of release 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.
<searchForDeliveredStatus>	Optional	0 - 1	String (1)	Y = Include delivered releases. N = Exclude delivered releases. Part of release 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.
<searchForDevelopmentStatus>	Optional	0 - 1	String (1)	Y = Include releases in development. N = Exclude releases in development. Part of release 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.
<searchForInstalledStatus>	Optional	0 - 1	String (1)	Y = Include installed releases. N = Exclude installed releases. Part of release 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.
<searchForManualScheduler>	Optional	0 - 1	String (1)	Y = Include releases with a scheduler type of MANUAL. N = Exclude releases with a scheduler type of MANUAL.
<searchForOtherScheduler>	Optional	0 - 1	String (1)	Y = Include releases with a scheduler type of OTHER. N = Exclude releases with a scheduler type of OTHER.
<searchForRejectedStatus>	Optional	0 - 1	String (1)	Y = Include rejected releases. N = Exclude rejected releases. Part of release 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.
<searchForReleaseApplNames>	Optional	0 - 1	String (255), variable	Release application name. Multiple entries are allowed, delimited by semicolons. Asterisk (*) wildcard may be used.
<searchForReleaseApprovalEntities>	Optional	0 - 1	String (255), variable	Release approval entity. Multiple entries are allowed, delimited by semicolons. Asterisk (*) wildcard may be used.
<searchForReleaseSites>	Optional	0 - 1	String (255), variable	Release site. Multiple entries are allowed, delimited by semicolons. Asterisk (*) wildcard may be used.
<searchFromDateApproved>	Optional	0 - 1	Date, yyyymmdd	Start date for searching on release approve date.
<searchFromDateBackedOut>	Optional	0 - 1	Date, yyyymmdd	Start date for searching on release backout date.
<searchFromDateBaselined>	Optional	0 - 1	Date, yyyymmdd	Start date for searching on release baseline date.
<searchFromDateBlocked>	Optional	0 - 1	Date, yyyymmdd	Start date for searching on release block date.
<searchFromDateCreated>	Optional	0 - 1	Date, yyyymmdd	Start date for searching on release create date.
<searchFromDateInstalled>	Optional	0 - 1	Date, yyyymmdd	Start date for searching on release install date.
<searchFromDateRejected>	Optional	0 - 1	Date, yyyymmdd	Start date for searching on release reject date.
<searchFromDateReverted>	Optional	0 - 1	Date, yyyymmdd	Start date for searching on release revert date.
<searchFromInstallDate>	Optional	0 - 1	Date, yyyymmdd	Start date for searching on release install date.
<searchToDateApproved>	Optional	0 - 1	Date, yyyymmdd	End date for searching on release approve date.
<searchToDateBackedOut>	Optional	0 - 1	Date, yyyymmdd	End date for searching on release back-out date.
<searchToDateBaselined>	Optional	0 - 1	Date, yyyymmdd	End date for searching on release baseline date.
<searchToDateBlocked>	Optional	0 - 1	Date, yyyymmdd	End date for searching on release block date.
<searchToDateCreated>	Optional	0 - 1	Date, yyyymmdd	End date for searching on release create date.
<searchToDateInstalled>	Optional	0 - 1	Date, yyyymmdd	End date for searching on release install date.
<searchToDateRejected>	Optional	0 - 1	Date, yyyymmdd	End date for searching on release reject date.
<searchToDateReverted>	Optional	0 - 1	Date, yyyymmdd	End date for searching on release revert date.
<searchToInstallDate>	Optional	0 - 1	Date, yyyymmdd	End date for searching on release install date.

...

RLSMRLSE SERVICE SEARCH — Reply

The XML reply to a RLSMRLSE SERVICE SEARCH request returns zero to many <result> data elements. Each result lists status flags and other information for a release.

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 — RLSMRLSE SERVICE SEARCH Reply

<?xml version="1.0"?>
<service name="RLSMRLSE">
    <scope name="SERVICE">
        <message name="SEARCH">
            <result>
                <release>DEMOREL1</release>
                <releaseDesc>general testing</releaseDesc>
                <releaseStatus>DEV</releaseStatus>
                <releaseRequestorName>DAVE BRADY</releaseRequestorName>
                <releaseRequestorPhone>763-416-9999</releaseRequestorPhone>
                <releaseWorkChangeRequest>ERO</releaseWorkChangeRequest>
                <releaseRequestorDept>DEVL</releaseRequestorDept>
                <addReleaseInterfacingApprovers>N</addReleaseInterfacingApprovers>
                <isReleaseAreasConfigured>Y</isReleaseAreasConfigured>
                <releaseSyslibOrder>A</releaseSyslibOrder>
                <auditEnforceIHASetting>Y</auditEnforceIHASetting>
                <auditIgnoreHigherAreas>N</auditIgnoreHigherAreas>
                <isReleaseLinked>N</isReleaseLinked>
                <isAutoFixDevPackages>Y</isAutoFixDevPackages>
                <isAutoFixFrzPackages>Y</isAutoFixFrzPackages>
                <isAutoFixAprPackages>Y</isAutoFixAprPackages>
                <isAllReleaseSitesInstalled>N</isAllReleaseSitesInstalled> <isReleaseSiteBackedOut>N</isReleaseSiteBackedOut>
                <isReleaseInstallBuildJclPending>N</isReleaseInstallBuildJclPending>
                <isReleaseInstallPending>N</isReleaseInstallPending>
                <isReleaseRevertPending>N</isReleaseRevertPending>
                <isReleaseBackoutPending>N</isReleaseBackoutPending>
                <isReleaseApprovalPending>N</isReleaseApprovalPending>
                <isReleaseBlockPending>N</isReleaseBlockPending>
                <releaseSchedulerCmn>Y</releaseSchedulerCmn>
                <releaseSchedulerManual>Y</releaseSchedulerManual>
                <releaseSchedulerOther>N</releaseSchedulerOther>
                <releaseSchedulerType>CMN</releaseSchedulerType>
                <releaseProblemActionCode>1</releaseProblemActionCode>
                <releaseAuditMinRule>0</releaseAuditMinRule>
                <releaseCheckinMinRule>0</releaseCheckinMinRule>
                <releaseBlockingMinRule>0</releaseBlockingMinRule>
                <releaseRetrieveMinRule>0</releaseRetrieveMinRule>
                <releaseApproveMinRule>0</releaseApproveMinRule>
                <releaseFromInstallDate>20081230</releaseFromInstallDate>
                <releaseFromInstallTime>120000</releaseFromInstallTime>
                <releaseToInstallDate>20080125</releaseToInstallDate>
                <releaseToInstallTime>190000</releaseToInstallTime>
                <releaseDateCreated>20080125</releaseDateCreated>
                <releaseTimeCreated>142124</releaseTimeCreated>
                <releaseCreator>WSER99</releaseCreator>
                <releaseImplInst>Implementation Instructions</releaseImplInst>
                <totalReleasePackages>00000</totalReleasePackages>
                <releaseHighLevelName>CMNDEV.A</releaseHighLevelName>
                <releaseDsnPattern>HRAL</releaseDsnPattern>
            </result>

...

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

...

RLSMRLSE SERVICE SEARCH `<result>` Data Structure

Subtag	Use	Occurs	Data Type & Length	Values & Dependencies
<addReleaseInterfacingApprovers>	Optional	0 - 1	String (1)	Y = Add related approvers. N = Do not add related approvers.
<auditEnforceIHASetting>	Optional	0 - 1	String (1)	Y = Enforce IHA setting. N = Do not enforce IHA settings.
<auditIgnoreHigherAreas>	Optional	0 - 1	String (1)	Y = Ignore higher areas. N = Do not ignore higher areas. C = If the current release has only a single path through it, process as if "Y" had been specified. If the current release has multiple paths through it, process as if "N" had been specified.
<isAllReleaseSitesInstalled>	Optional	0 - 1	String (1)	Y = All release sites are installed. N = All release sites are not installed.
<isAutoFixAprPackages>	Optional	0 - 1	String (1)	Y = Automatically cleanup APR packages. N = Do not automatically cleanup APR packages.
<isAutoFixDevPackages>	Optional	0 - 1	String (1)	Y = Automatically cleanup DEV packages. N = Do not automatically cleanup DEV packages.
<isAutoFixFrzPackages>	Optional	0 - 1	String (1)	Y = Automatically cleanup FRZ packages. N = Do not automatically cleanup FRZ packages.
<isReleaseApprovalPending>	Optional	0 - 1	String (1)	Y = Release approval is pending. N = Release approval is not pending.
<isReleaseAreasConfigured>	Optional	0 - 1	String (1)	Y = Release areas are configured. N = Release areas are not configured.
<isReleaseBackoutPending>	Optional	0 - 1	String (1)	Y = Release backout is pending. N = Release backout is not pending.
<isReleaseBlockPending>	Optional	0 - 1	String (1)	Y = Release block is pending. N = Release block is not pending.
<isReleaseInstallBuildJclPending>	Optional	0 - 1	String (1)	Y = Release install JCL builds are pending. N = Release install JCL builds are not pending.
<isReleaseInstallPending>	Optional	0 - 1	String (1)	Y = Release install is pending. N = Release install is not pending.
<isReleaseLinked>	Optional	0 - 1	String (1)	Y = Release is linked. N = Release is not linked.
<isReleaseRevertPending>	Optional	0 - 1	String (1)	Y = Release revert is pending. N = Release revert is not pending.
<isReleaseSiteBackedOut>	Optional	0 - 1	String (1)	Y = Release site is backed out. N = Release site is not backed out.
<release>	Optional	0 - 1	String (8), variable	Release name.
<releaseApplName>	Optional	0 - 1	String (4), variable	Release application name.
<releaseApprovalEntity>	Optional	0 - 1	String (8), variable	Release approval entity.
<releaseApproveMinRule>	Optional	0 - 1	Integer (1)	Release minimum 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.
<releaseAuditMinRule>	Optional	0 - 1	Integer (1)	Release area minimum 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).
<releaseAuditReturnCode>	Optional	0 - 1	String (2)	Release audit return code.
<releaseBackoutUserid>	Optional	0 - 1	String (8), variable	User ID of user who backed out release.
<releaseBlockUserid>	Optional	0 - 1	String (8), variable	User ID of user who blocked release.
<releaseBlockingMinRule>	Optional	0 - 1	Integer (1)	Release minimum blocking rule. Values: = Wide open. = Audit required. = User must pass entity check (and rule 0). = Rule 1 and rule 2.
<releaseBuildNumber>	Optional	0 - 1	String (10), variable	Release build number.
<releaseCheckinMinRule>	Optional	0 - 1	Integer (1)	Release minimum 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, rule2, and rule 3.
<releaseCreator>	Optional	0 - 1	String (8), variable	User ID of user who created release.
<releaseDateApproved>	Optional	0 - 1	Date, yyyymmdd	Date that release was approved.
<releaseDateBackedOut>	Optional	0 - 1	Date, yyyymmdd	Date that release was backed out.
<releaseDateBaselined>	Optional	0 - 1	Date, yyyymmdd	Date that release was baselined.
<releaseDateBlocked>	Optional	0 - 1	Date, yyyymmdd	Date that release was blocked.
<releaseDateCreated>	Optional	0 - 1	Date, yyyymmdd	Date that release was created.
<releaseDateDisReceived>	Optional	0 - 1	Date, yyyymmdd	Date that DEV site received all notifications that release was successfully distributed to all remote sites.
<releaseDateDistributed>	Optional	0 - 1	Date, yyyymmdd	Date that release was distributed.
<releaseDateInstalled>	Optional	0 - 1	Date, yyyymmdd	Date that release was installed.
<releaseDateMemoDeleted>	Optional	0 - 1	Date, yyyymmdd	Date that release was memo-deleted.
<releaseDateRejected>	Optional	0 - 1	Date, yyyymmdd	Date that release was rejected.
<releaseDateReverted>	Optional	0 - 1	Date, yyyymmdd	Date that release was reverted.
<releaseDesc>	Optional	0 - 1	String (72), variable	Release description.
<releaseDsnPattern>	Optional	0 - 1	String (5), variable	Release dataset name pattern.
<releaseFromInstallDate>	Optional	0 - 1	Date, yyyymmdd	Install start date.
<releaseFromInstallTime>	Optional	0 - 1	Time, hhmmss	Install start time.
<releaseGenerateMinRule>	Optional	0 - 1	Integer (1)	Release area minimum generate rule. Values: 0 = Wide open. 1 = User must pass entity check.
<releaseHighLevelName>	Optional	0 - 1	String (8), variable	Release high-level qualifier.
<releaseHighLevelPath>	Optional	0 - 1	String (1024), variable	Release high-level HFS path.
<releaseImplInst>	Optional	0 - 1	String (72), variable	Release implementation instructions.
<releaseLibsAged>	Optional	0 - 1	String (1)	Release libraries aged. Values (Y/N)/
<releaseMemoDeleteUserid>	Optional	0 - 1	String (8), variable	User ID of user who memo-deleted release.
<releaseOtherProblemAction>	Optional	0 - 1	String (72)	Release other problem description.
<releaseProblemActionCode>	Optional	0 - 1	String (1)	Action to be taken if a problem occurs when a package is installed. Values: 1 = Hold production and contact analyst. 2 = Back out change and continue production. 3 = Other
<releaseRejectUserid>	Optional	0 - 1	String (8), variable	User ID of user who rejected release.
<releaseRemoteSite>	Optional	0 - 1	String (8), variable	Release site name.
<releaseRequestorDept>	Optional	0 - 1	String (8), variable	Release requester department.
<releaseRequestorName>	Optional	0 - 1	String (25), variable	Release requester name.
<releaseRequestorPhone>	Optional	0 - 1	String (15), variable	Release requester phone number.
<releaseRetrieveMinRule>	Optional	0 - 1	Integer (1)	Release minimum retrieve rule. Values: 0 = Retrieve allowed from any area (blocked or unblocked). 1 = Retrieve allowed only from unblocked areas. 2 = Must pass entity check (and rule 0). 3 = Rule 1 and rule 2.
<releaseRevertUserid>	Optional	0 - 1	String (8), variable	User ID of user who reverted release.
<releaseSchedulerCmn>	Optional	0 - 1	String (1)	Y = Allow CMN internal release scheduler. N = Do not allow CMN internal release scheduler.
<releaseSchedulerManual>	Optional	0 - 1	String (1)	Y = Allow manual release scheduler. N = Do not allow manual release scheduler.
<releaseSchedulerOther>	Optional	0 - 1	String (1)	Y = Allow other release scheduler. N = Do not allow other release scheduler.
<releaseReleaseSchedulerType>	Optional	0 - 1	String (8), variable	Release scheduler type. Values: CMN = ChangeMan ZMF. The installation jobs are submitted by the ZMF started task at the scheduled install date and time. MANUAL = Manual. The installation jobs are submitted as soon as the package approvals are completed. OTHER = Other. The installation jobs are inserted into a third-party scheduler via a batch job.
<releaseStatus>	Optional	0 - 1	String (3), variable	Release status. Values: APR = Approved BAK = Backed out BAS = Baselined BLK = Blocked DEL = Deleted DEV = In development DIS = Distributed INS = Installed REJ = Rejected
<releaseSyslibOrder>	Optional	0 - 1	String (1)	Release SYSLIB sort order. Values: A = Ascending D = Descending
<releaseTimeApproved>	Optional	0 - 1	Time, hhmmss	Time that release was approved.
<releaseTimeBackedOut>	Optional	0 - 1	Time, hhmmss	Time that release was backed out.
<releaseTimeBaselined>	Optional	0 - 1	Time, hhmmss	Time that release was baselined.
<releaseTimeBlocked>	Optional	0 - 1	Time, hhmmss	Time that release was blocked.
<releaseTimeCreated>	Optional	0 - 1	Time, hhmmss	Time that release was created.
<releaseTimeDisReceived>	Optional	0 - 1	Time, hhmmss	Time that DEV site received all notifications that release was successfully distributed to all remote sites.
<releaseTimeDistributed>	Optional	0 - 1	Time, hhmmss	Time that release was distributed.
<releaseTimeInstalled>	Optional	0 - 1	Time, hhmmss	Time that release was installed.
<releaseTimeMemoDeleted>	Optional	0 - 1	Time, hhmmss	Time that release was memo-deleted.
<releaseTimeRejected>	Optional	0 - 1	Time, hhmmss	Time that release was rejected.
<releaseTimeReverted>	Optional	0 - 1	Time, hhmmss	Time that release was reverted.
<releaseToInstallDate>	Optional	0 - 1	Date, yyyymmdd	Install end date.
<releaseToInstallTime>	Optional	0 - 1	Time, hhmmss	Install end time.
<releaseWorkChangeRequest>	Optional	0 - 1	String (16), variable	Release work change request.
<revertReasons>	Optional	0 - 1	String (72), variable	Release revert reasons.
<totalReleasePackages>	Optional	0 - 1	Integer (5)	Total number of packages in release.

...