Skip to content

ChangeMan ZMF Environment Parameters - ENVIRON SERVICE LIST

This function returns the values of ChangeMan ZMF environment parameters for the current started task and the current user. (For batch jobs, the "current" started task is the ChangeMan ZMF instance identified in the <subsys> tag in the <header> data element of the request.) Returned values include the environment type, the started task job name and subsystem ID, the ChangeMan ZMF options licensed, and the product features (such as administrator access) available to the current user.

The Serena XML service/scope/message tags and attributes for a ChangeMan ZMF environment parameter list message are:

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

These tags appear in both requests and replies.

ENVIRON SERVICE LIST — Requests

Because this function accepts no input data, the Serena XML request message includes an empty <request> tag. The <request> tag itself is required, however, to identify the message as a request rather than a reply.

Note

XML syntax allows both a long form and a short form for empty tags. An empty <request> tag can therefore be coded in one of two ways.

Long form:

<request>
</request>

Equivalent short form:

<request\>

...

The example shows how to code a ChangeMan ZMF environment parameter list request with an empty <request> tag.

Example XML — ENVIRON SERVICE LIST Request

...

<?xml version="1.0"?>
<service name="ENVIRON">
    <scope name="SERVICE">
        <message name="LIST">
            <header>
                <subsys>8</subsys>
                <product>CMN</product>
            </header>
            <request>
            </request>
        </message>
    </scope>
</service>

...

ENVIRON SERVICE LIST — Replies

This function returns one <result> data element containing the ChangeMan ZMF environment parameter values for the started task responding to the request. Following the <result> data structure is the standard <response> data structure, which indicates the success or failure of the XML request. Successful requests have a return code of 00. Unsuccessful requests have a return code of 04 or higher.

Example XML — ENVIRON SERVICE LIST Reply

<?xml version="1.0"?>
<service name="ENVIRON">
    <scope name="SERVICE">
        <message name="LIST">
            <result>
                <startedTaskJobName>SERT8</startedTaskJobName>
                <startedTaskUser>SERT</startedTaskUser>
                <subSystemId>8</subSystemId>
                <cmnEnvironmentType>3</cmnEnvironmentType>
                <hasGlobalAccess>Y</hasGlobalAccess>
                <hasAdminAccess>Y</hasAdminAccess>
                <hasMonitorAccess>Y</hasMonitorAccess>
                <hasBackoutAccess>Y</hasBackoutAccess>
                <hasRevertAccess>Y</hasRevertAccess>
                <hasReleaseManAccess>Y</hasReleaseManAccess>
                <db2SubSystemId>DSN</db2SubSystemId>
                <imsSubSystemId>C113</imsSubSystemId>
                <cmnResourceClass>$CMNTP</cmnResourceClass>
                <enableTestMode>Y</enableTestMode>
                <enableNetTrace>N</enableNetTrace>
                <printTraceConsole>Y</printTraceConsole>

...

                <shutdownInProgress>N</shutdownInProgress>
                <disableCmnScheduling>N</disableCmnScheduling>
                <reinitParm>Y</reinitParm>
                <isPanPresent>N</isPanPresent>
                <isLibrPresent>N</isLibrPresent>
                <isRlsSupported>N</isRlsSupported>
                <isSmsVsamPresent>N</isSmsVsamPresent>
                <isDb2Licensed>Y</isDb2Licensed>
                <isInfoSystemInstalled>Y</isInfoSystemInstalled>
                <isImsLicensed>Y</isImsLicensed>
                <isCdfLicensed>Y</isCdfLicensed>
                <isOfmLicensed>Y</isOfmLicensed>
                <isLoadBalancingLicensed>Y</isLoadBalancingLicensed>
                <isEroLicensed>Y</isEroLicensed>
                <maximumSiteCount>00255</maximumSiteCount>
            </result>
            <response>
                <statusMessage>CMN8700I - Environment service completed</statusMessage>
                <statusReturnCode>00</statusReturnCode>
                <statusReasonCode>8700</statusReasonCode>
            </response>
        </message> 
    </scope>
</service>

Data structure details for the <result> data element appear in Exhibit 12-6.

Exhibit 12-6 ChangeMan ZMF Environment Parameter List <result>

Subtag Use Occurs Data Type & Length Values & Dependencies
<cmnEnvironmentType> Optional 0 - 1 String (1) Code for ZMF environment type. Values:
1 = All development & production handled by same ZMF instance; no remote production sites
2 = Development ZMF instance only
3 = Development & production handled by same ZMF instance; remote production sites also supported
4 = Production ZMF instance only
<cmnResourceClass> Optional 0 - 1 String (8), variable Security resource class for ZMF.
<db2SubSystemId> Optional 0 - 1 String (4), variable DB2 subsystem ID used by ZMF.
<disableCmnScheduling> Optional 0 - 1 String (1) Y = Yes, disable ZMF scheduling
N = No, don’t disable ZMF scheduling
<enableNetTrace> Optional 0 - 1 String (1) Y = Yes, net trace on
N = No, net trace off
<enableTestMode> Optional 0 - 1 String (1) Y = Yes, test mode on
N = No, test mode off
<hasAdminAccess> Optional 0 - 1 String (1) Y = Yes, user has administrator authority
N = No administrator authority
<hasBackoutAccess> Optional 0 - 1 String (1) Y = Yes, user has backout authority
N = No backout authority
<hasGlobalAccess> Optional 0 - 1 String (1) Y = Yes, user has global authority
N = No global authority
<hasMonitorAccess> Optional 0 - 1 String (1) Y = Yes, user has monitor authority
N = No monitor authority
<hasReleaseManAccess> Optional 0 - 1 String (1) Y = Yes, user has release mgr authority
N = No release manager authority
<hasRevertAccess> Optional 0 - 1 String (1) Y = Yes, user has revert authority
N = No revert authority
<imsSubSystemId> Optional 0 - 1 String (4), variable IMS subsystem ID used by ZMF.
<isApsLicensed> Optional 0 - 1 String (1) Y = Yes, APS licensed
N = No, APS not licensed
<isCdfLicensed> Optional 0 - 1 String (1) Y = Yes, Merge+Reconcile licensed
N = No, Merge+Reconcile not licensed
<isDb2Licensed> Optional 0 - 1 String (1) Y = Yes, DB2 licensed
N = No, DB2 not licensed
<isEroLicensed> Optional 0 - 1 String (1) Y = Yes, ERO licensed
N = No, ERO not licensed
<isImsLicensed> Optional 0 - 1 String (1) Y = Yes, IMS licensed
N = No, IMS not licensed
<isInfoSystemInstalled> Optional 0 - 1 String (1) Y = Yes, INFO installed
N = No, INFO not installed
<isLibrPresent> Optional 0 - 1 String (1) Y = Yes, CA Librarian present
N = No, CA Librarian not present
<isLoadBalancingLicensed> Optional 0 - 1 String (1) Y = Yes, Load Balancing Option licensed
N = No, Load Balancing not licensed
<isOfmLicensed> Optional 0 - 1 String (1) Y = Yes, Online Forms Option licensed
N = No, Online Forms Option not licensed
<isPanPresent> Optional 0 - 1 String (1) Y = Yes, CA Panvalet present
N = No, CA Panvalet not present
<isRlsSupported> Optional 0 - 1 String (1) Y = Yes, record-level sharing (RLS) active
N = No, record-level sharing not active
<isSmsVsamPresent> Optional 0 - 1 String (1) Y = Yes, SMS/VSAM (RLS) present
N = No, SMS/VSAM (RLS) not present
<licensedLine1> Optional 0 - 1 String (56), variable Licensed to line 1.
<licensedLine2> Optional 0 - 1 String (56), variable Licensed to line 2.
<maximumSiteCount> Optional 0 - 1 String (1) Maximum number remote sites supported.
<printTraceConsole> Optional 0 - 1 String (1) Y = Yes, trace to SERPRINT/WTO
N = No, don’t trace to SERPRINT/WTO
<printTraceOnly> Optional 0 - 1 String (1) Y = Yes, trace to SERPRINT only
N = No, don’t trace to SERPRINT only
<reinitParm> Optional 0 - 1 String (1) Y = Yes, PARM=REINIT
N = No, reinitialization parameter not set
<shutdownInProgress> Optional 0 - 1 String (1) Y = Yes, shutdown in progress
N = No, not shutting down
<startedTaskJobName> Optional 0 - 1 String (8), variable ZMF started task job name.
<startedTaskUser> Optional 0 - 1 String (8), variable TSO user ID of current started task user.
<subsystemId> Optional 0 - 1 String (1) ZMF subsystem ID.