Skip to content

Logon Service

The SERNET logon service takes as input a valid TSO user ID and password for the user of the Web client application. It also requires an IP address for the desired host system where the ChangeMan ZMF subsystem resides and a port ID where SERNET is listening for requests to this subsystem. The subsystem ID for the desired ChangeMan ZMF instance is not required, as it is redundant with the IP address and port.

The logon service returns status information stating whether or not logon was successful.

Logon Request

<logon> Service Tag

A SERNET logon request contains the <logon> service tag as the top-level tag in the SOAP envelope body. The <logon> service tag encloses a <request> method tag, which in turn encloses a set of parameter tags.

Syntax Example

The following example logon request shows fully qualified ZMF Web Services tag names with values, wrapped in a SOAP envelope. Deprecated parameter tags are omitted.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/ envelope/" xmlns:ser="http://wsdl.zmf.serena.com/services/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:logon>
         <ser:request>
            <ser:host>111.222.333.444</ser:host>
            <ser:portid>9999</ser:portid>
            <ser:user>USER01</ser:user>
            <ser:password>OLDPASS</ser:password>
            <ser:newpassword>NEWPASS</ser:newpassword>
            <ser:version>6.1.0</ser:version>
         </ser:request>
      </ser:logon>
   </soapenv:Body>
</soapenv:Envelope>

<request> Parameter Tags

The following parameter tags are supported within the logon <request> tag:

Parameter Tag Use Occurs Data Type & Length Values & Dependencies
<host> Required 1 String (255) TCP/IP address of LPAR where desired ZMF subsystem resides.
<newpassword> Optional 0 - 1 String (8) New password for <user>.
<password> Required 1 String (8) Current password for <user>.
<portid> Required 1 String (4) TCP/IP port ID for desired ZMF subsystem.
<subsystemid> Deprecated 1 String (1) ZMF subsystem ID. Blank subsystem ID not supported.
<user> Required 1 String (8) TSO user ID for Web client
<version> Optional 0 - 1 String (10) ZMF API version supported by Web client. Example value for ZMF 6.1.0 patch 01: 6.1.0.01

Logon Response

A SERNET logon response contains the <logon> service tag as the top-level tag in the SOAP envelope body. Within this service tag, the status of the logon action is reported in the <response> method tag, which in turn encloses a set of parameter tags.

Syntax Example

The logon <response> method tag returns a host-originated status message, return code, and reason code describing the host status of the logon request. The same syntax is used by all SERNET Web Services <response> methods.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/ envelope/" xmlns:ser="http://wsdl.zmf.serena.com/services/"/>
   <soapenv:Header/>
   <soapenv:Body>
      <ser:logon>
      <ser:response>
         <ser:statusMessage>Logon successful</ser:statusMessage>
         <ser:statusReturnCode>00</ser:statusReturnCode>
         <ser:statusReasonCode>0000</ser:statusReasonCode>
      </ser:response>
      </ser:logon>
   </soapenv:Body>
</soapenv:Envelope>

<response> Parameter Tags

The following parameter tags are supported within the logon <response> tag:

Parameter Tag Use Occurs Data Type & Length Values & Dependencies
<statusMessage> Required 1 String (255) Free-format status message returned by host or ZMF
<statusReasonCode> Required 1 String (4) Diagnostic reason code
<statusReturnCode> Required 1 String (4) Status severity code. Typical values:
00 - Normal completion
04 - Completed using default overrides for minor error conditions
08 - Some job steps failed
12 or higher - Severe error

...