CSLOMI XML output examples

Each of the command syntax examples contain a sample of CSLOMI XML output. The examples present different scenarios that generate XML output based on the commands that are used in the example.

CSLOMI XML output

One or more of the sets of tags in the following output example is returned on each CSLOMI request.

<imsout> 
   <ctl> 
       <omname> </omname>
       <omvsn> </omvsn>
       <xmlvsn> </xmlvsn>
       <statime> </statime>
       <stotime> </stotime>
       <staseq> </staseq>
       <stoseq> </stoseq>
       <rqsttkn1> </rqsttkn1>
       <rqsttkn2> </rqsttkn2>
       <rc> </rc>
       <rsn> </rsn>
			<rsnmsg> </rsnmsg>
  </ctl>
  <cmdclients> 
    <mbr name="membername"> 
      <typ> </typ>
      <styp> </styp>
      <vsn> </vsn>
      <jobname> </jobname>
   </mbr>
  </cmdclients>
  <cmdsyntax> </cmdsyntax>
  <cmddtd> </cmddtd>
  <cmdtext> </cmdtext>
  <cmderr> 
    <mbr name="membername"> 
      <typ> </typ>
      <styp> </styp>
      <rc> </rc>
      <rsn> </rsn>
   </mbr>
  </cmderr>
  <cmdsecerr> 
    <exit> 
       <rc> </rc>
       <userdata> </userdata>
    </exit> 
    <saf> 
       <rc> </rc>
       <racfrc> </racfrc>
       <racfrsn> </racfrsn>
    </saf>
 </cmdsecerr>
 <cmd> 
    <master> </master>
    <userid> </userid>
    <verb> </verb>
    <kwd> </kwd>
    <input> </input>
 </cmd>
 <cmdrsphdr>
    <hdr ... />
 </cmdrsphdr>
 <cmdrspdata> 
    <rsp> </rsp>
 </cmdrspdata>
 <msgdata> 
   <mbr name="membername"> 
     <msg> </msg>
   </mbr>
 </msgdata>
</imsout>

Issue IMS command example

The following examples are CSLOMI XML output. In the following command example, the QUERY TRAN command was routed to IMSA with a timeout value of 10 seconds.

OM API Input:
CMD(QUERY TRAN) NAME(SKS*)) ROUTE(IMSA) TIMEOUT(10) RQSTTKN2(QTRANCMD)

OM API Output:
<imsout>
  <ctl>
    <omname>OM1</omname>
    <omvsn>1.1.0</omvsn>
    <xmlvsn>1</xmlvsn>
    <statime>1999.341 12:52:44.46</statime>
    <stotime>1999.341 12:52:44.46</stotime>
    <staseq>B342BCC72A34D206</staseq>
    <stoseq>B342BCC75CD52208</stoseq>
    <rqsttkn2>QTRANCMD</rqsttkn2>
    <rc>0</rc> <rsn>0</rsn>
  </ctl>
  <cmd>
    <master>IMS1</master>
    <verb>QRY</verb>
    <kwd>TRAN</kwd>
    <input>QUERY TRAN</input>
  </cmd>
  <cmdrsphdr>
    <hdr slbl="TRAN" llbl="TranCode" scope="LCL" sort="a" key="1" scroll="no"     
     len="8" dtype="CHAR" align="left" />
    <hdr slbl="MBR" llbl="MbrName" scope="LCL" sort="a" key="4" scroll="no" 
     len="8" dtype="CHAR" align="left" />
    <hdr slbl="CC" llbl="CC" scope="LCL" key="0" scroll="YES" len="4" dtype="INT" 
     align="right" />
  </cmdrsphdr>
  <cmdrspdata>
    <rsp> TRAN(SKS1) MBR(IMSA) CC(0) </rsp>
    <rsp> TRAN(SKS2) MBR(IMSA) CC(0) </rsp>
    <rsp> TRAN(SKS3) MBR(IMSA) CC(0) </rsp>
    <rsp> TRAN(SKS4) MBR(IMSA) CC(0) </rsp>
    <rsp> TRAN(SKS5) MBR(IMSA) CC(0) </rsp>
  </cmdrspdata>
</imsout>

Query client list example

In the following client list example, the Operations Manager (OM) returns a list of client names that are currently registered for command processing.

OM API Input:
QUERY(CMDCLIENTS) RQSTTKN2(CLIENTLIST)
OM API Output:
<imsout>
  <ctl>
    <omname>OM1</omname>
    <omvsn>1.1.0</omvsn>
    <xmlvsn>1</xmlvsn>
    <statime>1999.341 12:52:44.46</statime>
    <stotime>1999.341 12:52:44.46</stotime>
    <staseq>B342BCC72A34D206</staseq>
    <stoseq>B342BCC75CD52208</stoseq>
    <rqsttkn2>CLIENTLIST</rqsttkn2>
    <rc>0</rc> <rsn>0</rsn>
  </ctl>
  <cmdclients>
    <mbr name=IMSA>
      <typ>DBDC</typ>
      <vsn>0800</vsn>
      <jobname>IMSJOB01</jobname>
    </mbr>
    <mbr name=IMSB>
      <typ>DBDC</typ>
      <vsn>0800</vsn>
      <jobname>IMSJOB02</jobname>
    </mbr>
  </cmdclients>
</imsout>

Query command syntax example

The following command syntax example returns the command syntax for currently registered commands. In this example, the QUERY TRAN command is the only command that is registered to OM, and the keyword NAME is associated with it.

OM API Input:
QUERY(CMDSYNTAX) RQSTTKN2(CMDLIST)
OM API Output:
<imsout>
  <ctl>
    <omname>OM1</omname>
    <omvsn>1.1.0</omvsn>
    <xmlvsn>1</xmlvsn>
    <statime>1999.341 12:52:44.46</statime>
    <stotime>1999.341 12:52:44.46</stotime>
    <staseq>B342BCC72A34D206</staseq>
    <stoseq>B342BCC75CD52208</stoseq>
    <rqsttkn2>CMDLIST</rqsttkn2>
    <rc>0</rc> <rsn>0</rsn>
  </ctl>

  <cmdsyntax>
    <root>
      <resource name="TRAN">
        <verb name="QUERY">
          <keyword name="NAME">
            <var name="tranname*"/>
          </keyword>
        </verb>
      </resource>
    </root>
  </cmdsyntax>

  <cmdtext>
    NEXT "Next"
    BACK "Back"
    FINISH "Finish"
    CANCEL "Cancel"
    SUMMARY "Summary"
    TRAN_NAME "Transaction"
    TRAN_QUERY_NAME "Query"
    TRAN_QUERY_NAME_NAME "Name"
    TRAN_QUERY_NAME_TEXT "Name of transaction."
    TRAN_QUERY_NAME_VAR "tranname*"
  </cmdtext>
</imsout>