Data interface command reference

This topic describes each data interface command and its options. There are seven data interface commands:

DATA/CONNECT
DATA/DISCONNECT
You use these commands to establish a connection with a Web User Interface server, and then terminate the connection when it is no longer needed.
DATA/GET
DATA/FETCH
DATA/DISCARD
DATA/GETDEF
You use these commands to obtain information about the resources managed by CICSPlex® SM. These commands enable a client application: (1) to request the creation (GET) of a result set of records matching a particular query; (2) to download pages of records (FETCH) from the result set; and (3) to release (DISCARD) the result set when the application has finished with it. The DATA/GETDEF command is similar to the DATA/EGT command except that it retrieves CICSPlex SM metadata.
DATA/PASSTICKET
You use this command to obtain a PassTicket, which you need to enable the client application to launch a Web browser window that connects to the same CICSPlex SM Web User Interface server as the client application.

Each of these data interface commands is described in detail in the following sections.

DATA/CONNECT

Establish a session between a client application and a CICSPlex SM Web User Interface server.

Read syntax diagramSkip visual syntax diagramDATA/CONNECT
 
>>-DATA/CONNECT--USERID=userid---------------------------------->
 
>--+---------------------------------------------------+-------->
   '-PASSWORD=value-+--------------------------------+-'
                    '-NEWPASS1=value--NEWPASS2=value-'
 
>--+--------------+--------------------------------------------><
   '-RECONN=value-'
 

Description

The DATA/CONNECT command enables you obtain a Web User Interface user session from a client application. If the Web User Interface server is running with security enabled, a connection command must include the correct password. You can also specify a new password. Because the DATA/CONNECT command can contain password details, the server accepts connection request using only the HTTP POST method.

A user ID can have only one session with a specific Web User Interface server. Thus a user ID signed on directly to the CICSPlex SM Web User Interface cannot also sign on from a client application using the data interface. However, an existing session can be taken over using the RECONN option.

When the user session has been established, the response to the DATA/CONNECT command includes an HTTP cookie, which acts as a ticket to the session. The client application must retrieve the cookie from the response and include it in all subsequent requests to the Web User Interface server for the user session.

Note:
The cookie name and value are a "black box" to the client application, which should return the cookie to the server unaltered. The client application should also assume that the cookie name and value are variable length to protect against change in a future release of the data interface

Although it does not contain any password information, the cookie represents access to the Web User Interface user session and should be protected accordingly. The client must honor the restrictions set out in the HTTP cookie response header. Do not send the cookie to any other host name or path and do not write the cookie to a file.

A data interface client is permitted to create multiple connections (either to different servers for the same user ID, or for different user IDs on the same server), provided that the correct cookie is sent for each request. However, normal Web User Interface server restrictions apply:

When a user session is no longer required, you can terminate it using the DATA/DISCONNECT command. As this terminates the user session, any browser sessions that have been launched by the client application are also disconnected. Similarly, if the user issues a signoff command in a launched browser window, the client application session is also disconnected.

If the DATA/CONNECT command completes with STATUS OK, the DATA/CONNECT command can also return the following additional header fields:

Table 14. Data returned on DATA/CONNECT command response header
Header field Description
DATEFORMAT= Identifies the format being used by this session to represent dates on Web User Interface displays. The data interface client must use this format for date filters when launching an HTML view. Possible values are:
YYMMDD
DDMMYY
MMDDYY
YYYYMMDD
DDMMYYYY
MMDDYYYY
Note:
The format used for data interface requests and responses is always YYYYMMDD.
DATESEPARATOR= Identifies the character being used by this session to separate date elements on Web User Interface displays. The data interface client must use this character for date filters when launching an HTML view.
Note:
The character used for data interface requests and responses is always / (slash).
DECIMALSEPARATOR= Identifies the character being used by this session to denote the decimal point on Web User Interface displays. The data interface client must use this character for numerical filters when launching an HTML view.
Note:
The character used for data interface requests and responses is always . (period).
DAYSLEFT= Gives the number of days until the user's password expires. This header field is present only if security is enabled in the Web User Interface server.
INTERFACELEVEL= Indicates the support level of the client application data interface implemented by the Web User Interface server, as a decimal integer. The requirement of a specific INTERFACELEVEL value is documented within the descriptions of the appropriate data interface commands and options. To use these options, the client should examine the INTERFACELEVEL value to ensure it is greater than or equal to the support level required.

If the INTERFACELEVEL header is not present, the client must assume the value, 0.

LASTUSETIME= Gives the date and time the user ID was last used, in the form yyyy/mm/dd hh:mm:ss. This header field is present only if security is enabled in the Web User Interface server.
TCPIPHOSTNAME= This returns the fully-qualified host name of the Web User Interface server as specified on the Web User Interface TCPIPHOSTNAME initialization parameter.
TIMESEPARATOR= Identifies the character being used by this session to separate hours, minutes and seconds on Web User Interface displays. The data interface client must use this character for time filters when launching an HTML view.
Note:
The character used for data interface requests and responses is always : (colon).

Data: The DATA/CONNECT command does not return any data records after the response header fields.

Note:
If the client application does not issue a request on a user session for a period longer than the time specified by the Web User Interface INACTIVETIMEOUT parameter, all browser windows and client applications are automatically disconnected. Whenever the server receives a request, either from a client application or a browser window it has launched, the server resets the "clock" measuring the inactive time on a user session.

Options

NEWPASS1=value
Specifies a new password if you want to change the user's current password. This can be omitted.
NEWPASS2=value
Specifies the new password again to validate that it is the same as the value on NEWPASS1. This can be omitted.
PASSWORD=value
Specifies the user's password, for signon to a Web User Interface server. This is not required for connection to Web User Interface servers that are running with security inactive (that is SEC=NO is specified as a CICS® system initialization parameter).
RECONN={N|J|Y}
Specifies the reconnection action required if the user session is already active:
N
Do not reconnect by destroying the existing user session and connecting the user of the client application on a new session.
J
Join the existing user session
Y
Destroy the existing user session and create a new session for the specified user ID.
USERID=value
Specifies the user ID for which a session is to be created. This must match the user ID specified in the base part of the DATA/CONNECT command in the URL.

STATUS values

BADCOMMAND
The command passed to the data interface is not recognized.
CONNECTIONFAILURE
The attempt to connect to the CICSPlex SM application programming interface (API) for the new user session has failed.
MAXUSERS
The maximum number of users permitted to be signed on to the Web User Interface server has been reached. The maximum number of users is defined by the server initialization parameter MAXUSERS (see CICS Transaction Server for z/OS® Installation Guide).
NEWPASSWORDINVALID
The new password does not satisfy the rules for passwords, as defined by the host system external security manager (ESM).
NEWPASSWORDMISMATCH
The values specified on NEWPASS1 and NEWPASS2 are different, and these values must be the same to change successfully an existing password.
PASSWORDEXPIRED
The specified password is out-of-date. Specify a new password using NEWPASS1 and NEWPASS2.
PASSWORDINVALID
The password entered for the specified user ID has failed authentication by the external security manager (ESM).
PASSWORDREQUIRED
The password is missing from the DATA/CONNECT request. The Web User Interface server is running with signon security enabled, and therefore a password is required.
RECONNECTREQUIRED
The user is already signed on but the RECONN option did specify Y or J.
USERIDREQUIRED
The DATA/CONNECT command requires a user ID to establish a session with the Web User interface.
USERIDREVOKED
The Web User Interface server is running with signon security enabled, but the external security manager has revoked the user ID.
USERIDUNKNOWN
The Web User Interface server is running with signon security enabled, and the user ID specified is not known to the ESM.

DATA/DISCARD

Release a result set created by a DATA/GET command.

Read syntax diagramSkip visual syntax diagramDATA/DISCARD
 
>>-DATA/DISCARD--STUB=value------------------------------------><
 

Description

This command requests the Web User Interface server to release all the resources for the result set associated with the specified stub. Although the server sends a response to the client application (that is, it does not make the request wait), it does not immediately discard the resources used by result set. The result set is marked as discarded and can no longer be accessed by the client. Instead of using a DATA/DISCARD and DATA/GET sequence for a new query, consider using a DATA/GET request that specifies an old stub that is no longer required.

The delay in discarding a result set means that the number of windows shown in the user sessions view (see Figure 17) can be higher than the number of windows actually active.

Data: The DATA/DISCARD command does not return any data records after the response header fields.

Options

STUB=value
Specifies the identifier of the result set that you want to discard.

STATUS values

BADCOMMAND
The command passed to the data interface by the Web User Interface is not recognized.
CMASGONE
The Web User Interface has lost its connection with the CMAS. As a result, the client application's user session is terminated.
BADSTUB
The stub value is not valid for the request. This could be for one of the following reasons:
  • You have have specified a stub value that does not belong to the user session on which you have issued the command.
  • The stub value is out of sequence.
BUSYSTUB
The Web User Interface server is still processing a previous request for this stub.

DATA/DISCONNECT

Disconnect a client application from a CICSPlex SM Web User Interface server.

Read syntax diagramSkip visual syntax diagramDATA/DISCONNECT
 
>>-DATA/DISCONNECT---------------------------------------------><
 

Description

This command enables the client application to initiate the termination of the user session established by a DATA/CONNECT data interface command.

All Web User Interface server sessions, including sessions started by the client application data interface, are subject to automatic signoff after a period of inactivity. This period is determined by the Web User Interface server initialization parameter, INACTIVETIMEOUT. When the original user session is terminated or replaced, the EYUTICKET value becomes invalid and is ignored by the Web User Interface server.

Data: The DATA/DISCONNECT command does not return any data records after the response header fields.

Options

None.

STATUS values

BADCOMMAND
The command passed to the data interface by the Web User Interface is not recognized.

DATA/FETCH

Retrieve the records created in a result set by a previous DATA/GET command.

Read syntax diagramSkip visual syntax diagramDATA/FETCH
 
>>-DATA/FETCH--STUB=value--+-------------+---------------------->
                           '-COUNT=value-'
 
>--+----------------+--+--------------+------------------------><
   '-POSITION=value-'  '-FIELDS=value-'
 

Description

This command retrieves records from the result set identified by the stub value returned to your client application in response to a DATA/GET or DATA/FETCH command.

Table 15. DATA/FETCH command header response fields
Header field Description
COUNT= The number of records returned in this response, which can be zero.
OBJECT= The name of the CICSPlex SM resource.
REASON= The CICSPlex SM reason code for the FETCH (the EYUDA value).
RESPONSE= The CICSPlex SM API response code for the FETCH (the EYUDA value).
STUB= The STUB header for use on subsequent requests against the result set.
USERID= The user ID of the session.

The contents of the records selected from result set are contained in additional records in the data interface response, following the response header record (see Figure 41 for an illustration of an HTTP response package). Each data record encodes a single result set record, in the order that they appeared in the result set, starting from the record specified by the POSITION= option in the DATA/FETCH request.

Each result set record is described as a series for attribute-value pairs. The attribute name corresponds to the attribute name in the CICSPlex System Manager Resource Tables Reference and the value is represented as described above. The order that theses attributes appear in a particular result set record is undefined and the client application has to search for specific attributes by attribute name. If the FIELDS= option is specified, the DATA/FETCH command returns only the attributes named by the FIELDS= option, in the order specified by the client. If the FIELDS= option is not specified, all attributes of the resource will be returned and the order that these attributes appear in a particular result set record is undefined. In this case, the client application must search for specific attributes in each record by attribute name.

If a requested attribute on a DATA/GET request is not valid for the release of CICS from which the result set is created, the attribute is not included in the data interface record.

When your client application is finished with a result set, it can use the DATA/DISCARD command with the correct STUB value to discard it.

Options

COUNT=value
Specifies the number of records you want the server to return to your client application from the results set. If you omit this option, the server returns all the records, which could have an adverse affect on performance if the results set is large. The number of records for the result set is in the COUNT header field returned from the DATA/GET command.
FIELDS=attribute list
Specifies one or more attributes of the resource type that are to be retrieved by this DATA/FETCH request. Each record in the response contains only the attributes required and those attributes appear in the order specified by the FIELDS= option.

The list of attributes must be separated by a comma and terminated with a period. You can specify any attribute listed in the CICSPlex System Manager Resource Tables Reference for the resource type, including EYU_CICSNAME. There must be no white space characters between the attribute names and the separating commas or period. Any characters in the FIELDS= value that appear after the period will be ignored.

For example, to request that only the originating CICS name, the transaction ID, and enable status attributes be retrieved for each local transaction (LOCTRAN) record, specify:

FIELDS=EYU_CICSNAME,TRANID,STATUS.

If an attribute name is repeated in the list, the attribute will be repeated in the response records. However, the total number of attributes specified in the attribute list must not exceed the number of attributes defined by the CICSPlex System Manager Resource Tables Reference for the resource type.

If the attribute list is not formatted correctly, contains too many attributes, or contains an unknown attribute name, the DATA/FETCH command RESPONSE header will contain INVALIDPARM and the REASON header will contain FIELDS. No data records will be returned.

If the FIELDS= option is not specified, the response will contain all the attributes of each record in an undefined order.

Note:
The FIELDS= option is only supported when the INTERFACELEVEL header returned on the DATA/CONNECT command is greater than or equal to 1. If a client attempts to use the FIELDS= option on an earlier support level of the data interface, the option is ignored.
POSITION={1|value}
Specifies the record number in the result set of the first record to be retrieved by this fetch command. The default number is 1, which indexes the first record in the result set.
STUB=value
Specifies the result set from which you want the server to return records. The value you specify must be obtained from the result of one of the the following commands:
  • The stub value returned from the GET command that created the result set
  • The stub value returned from a previous FETCH command.
Note:
Your client application can use a stub value received from Web User Interface server once only. Once you specify a stub value on a request to a Web User Interface server, you cannot use the same value again, but must use the next stub returned for the result set. For example, when you specify a stub value on a DATA/FETCH command, the response from the server includes a new stub to enable you to retrieve more records from the set.

STATUS values

BADCOMMAND
The command passed to the data interface by the Web User Interface is not recognized.
BADSTUB
The stub value is not valid for the request. This could be for one of the following reasons:
  • You have have specified a stub value that does not belong to the user session on which you have issued the command.
  • The stub value is out of sequence.
BUSYSTUB
The Web User Interface server is still processing a previous request for this stub.
CMASGONE
The Web User Interface has lost its connection with the CMAS. As a result, the client application's user session is terminated.

DATA/GET

Request the CICSPlex SM Web User Interface server to create a result set of records that satisfy a query.

Read syntax diagramSkip visual syntax diagramDATA/GET
 
>>-DATA/GET--OBJECT=resource_name------------------------------->
 
   .-----------------------------------------------------------------.
   V                                                                 |
>----+-------------------------------------------------------------+-+-->
     '-A_attributeName=character_string-+------------------------+-'
                                        '-O_attributeName=number-'
 
>--+-----------------------------------------------------+------>
   +-CMASCONTEXT=character_string------------------------+
   '-CONTEXT=character-string-+------------------------+-'
                              '-SCOPE=character-string-'
 
>--+----------------------------------+------------------------->
   '-P_parameterName=character-string-'
 
>--+-----------------------+-----------------------------------><
   '-STUB=character_string-'
 

Description

Initially, you issue a DATA/GET request for a new result set of records without specifying a STUB option on the command. The response from the server includes a STUB header identifying the result set.

You can reuse a results set by issuing a another DATA/GET command that specifies a previous stub value. This has the effect of discarding the old results and reusing the resources to hold the results of the new DATA/GET request.

The result of a DATA/GET command for STATUS OK is shown in Table 16.

Table 16. Data returned on DATA/GET command response header
Header field Description
COUNT= The number of records in the results set that match the query. This can be a zero value.
OBJECT= The CICSPlex SM resource name, as specified on the DATA/GET command.
REASON= The CICSPlex SM API reason code, where applicable.
RESPONSE= The CICSPlex SM API response code.
STUB= The stub value to be used for the next request relating to this query. This can be another GET, or a FETCH or DISCARD command.
USERID= The user ID signed on to the Web User Interface Server session used for this request.

The CICSPlex SM Web User Interface server manages each active data interface result set as a single-user session window. Each user session can have at anyone time a maximum of 64 active windows, which are shared between the client application data interface and the HTML interface.

Data: The DATA/GET command does not return any data records after the response header fields. The command creates a result set from which a subsequent DATA/FETCH command can retrieve records.

Note:
Attribute and parameter filters specified on the DATA/GET command are always grouped by a logical AND operator. It is not possible to use any filter with an OR operator.

Options

A_attributeName=value
Specifies the value of a known attribute name from one of the CICSPlex SM resource tables. For example, if your query is to find all the disabled files using the LOCFILE resource table, the keyword A_attributeName becomes A_ENABLESTATUS and the operand is DISABLED.

The following attribute datatypes can be used as filters:

  • AVG
  • AVG3
  • BIN
  • CHAR
  • CODEBIN
  • CVDAS
  • CVDAT
  • DEC
  • EYUDA
  • HEX
  • INTVSTCK
  • PCT
  • PCT3
  • RATE
  • RATE3
  • SCLOCK
  • SUM
  • SUM3

See the CICSPlex System Manager Resource Tables Reference for details of all the CICSPlex SM resource tables.

See also Access to the Web User Interface for a discussion about selection criteria and Data representation for information about data representation.
CONTEXT=value
Specifies the context for resources that use the CICSplex name. The context must be the 1- to 8-character name of a CICSplex.

If you omit this option, the server uses the last CONTEXT for the specified STUB, or the server default if you do not specify a STUB on the command.

CMASCONTEXT=value
Specifies the context for resources that use the CMAS name.

If you omit this option, the server uses the last CMASCONTEXT for the specified STUB, or the server default if you do not specify a STUB on the command.

O_attributeName=value
Specifies the filter operator to be used with a known attribute name from one of the CICSPlex SM resource tables. For a list of the operator values and their meanings, see Table 9. For example, if your GET query is about the enable status of files in the LOCFILE resource table, the result of A_ENABLESTATUS=DISABLED with O_ENABLESTATUS=NE is all the files that are in ENABLED, UNENABLED, and DISABLING state (that is, all those that that are not DISABLED).

See the CICSPlex System Manager Resource Tables Reference for details of all the CICSPlex SM resource tables.

OBJECT=value
Specifies the name of the CICSPlex SM resource table in which A_attributeName is a valid attribute. This option is required, and must specify the 1- to 8-character name of either a valid resource table or a valid view.
P_parameterName=value
Specifies a parameter filter for the resources. For example, P_WORKLOAD=name in the WLMAWAOR resource table, where name is the name of an active workload..

Not all resources have parameters associated with them. See the CICSPlex System Manager Resource Tables Reference for details of all the CICSPlex SM resources and information about their parameters, if any. See also Data representation for information about data representation.

SCOPE=value
Specifies the scope for those resources that require a scope.
STUB=value
Specifies the result set stub value returned by the server in response to an earlier request. This is optional, and has the following effect:
  • If you omit the STUB option, the server creates a new result set. If the server has created one or more result sets from previous requests, these are preserved and unaffected by this request.
  • If you specify the STUB option, the server reuses the old result set storage for the new query. In effect, issuing a DATA/GET request with a stub value is the equivalent of issuing a DATA/DISCARD followed by a DATA/GET, and avoids tying up system resources that are no longer needed.
Note:
Your client application can use a stub value received from Web User Interface server once only. Once you specify a stub value on a request to a Web User Interface server, you cannot use the same value again.

STATUS values

BADATTR
An A_attribueName keyword is invalid. If the DATA/GET command specified a stub value, the implied DISCARD is honored and the associated result set is discarded.
BADCOMMAND
The command passed to the data interface by the Web User Interface is not recognized.
BADOBJECT
The value specified on the OBJECT option is invalid. If the DATA/GET command specified a stub value, the implied DISCARD is honored and the associated result set is discarded.
BADPARM
A P_parameterName keyword is invalid. If the DATA/GET command specified a stub value, the implied DISCARD is honored and the associated result set is discarded.
BADSTUB
The stub value is not valid for the request. This could be for one of the following reasons:
  • You have have specified a stub value that does not belong to the user session on which you have issued the command.
  • The stub value is out of sequence.
BUSYSTUB
The Web User Interface server is still processing a previous request for this stub.
CMASGONE
The Web User Interface has lost its connection with the CMAS. As a result, the client application's user session is terminated.
MAXWIN
The maximum number of windows (64) for the user session has been reached.

DATA/GETDEF

Request the CICSPlex SM Web User Interface server to create a result set containing selected descriptive records (metadata) for a resource table

Read syntax diagramSkip visual syntax diagramDATA/GETDEF
 
>>-DATA/GETDEF-------------------------------------------------->
 
>--+-----------------------------------------------+------------>
   +-ATTRIBUTE=attribute_name----------------------+
   '-ACTION(data-value)-+------------------------+-'
                        '-ACTIONPARM(data-value)-'
 
>--OBJECT=resource_name--+---------------------------+---------->
                         '-RESOURCE=character-string-'
 
>--+-----------------------+-----------------------------------><
   '-STUB=character_string-'
 

Description

Initially, you issue a DATA/GETDEF request for a new result set of metadata records without specifying a STUB option on the command. The response from the server includes a STUB header identifying the metadata result set.

You can reuse a result set by issuing another DATA/GETDEF or DATA/GET command that specifies a previous stub value. This has the effect of discarding the old results and reusing the resources to hold the results of the new DATA/GETDEF or DATA/GET request.

The result of a DATA/GETDEF command for STATUS OK is shown in Table 16.

Table 17. Data returned on DATA/GETDEF command response header
Header field Description
COUNT= The number of records in the results set that match the query. This can be a zero value.
OBJECT= The type of metadata to be retrieved for the resource table specified on the RESOURCE option.
REASON= The CICSPlex SM API reason code, where applicable.
RESPONSE= The CICSPlex SM API response code.
STUB= The stub value to be used for the next request relating to this query. This can be another GETDEF, a GET, a FETCH, or a DISCARD command.
USERID= The user ID signed on to the Web User Interface Server session used for this request.

The CICSPlex SM Web User Interface server manages each active data interface result set as a single-user session window. Each user session can have at anyone time a maximum of 64 active windows, which are shared between the client application data interface and the HTML interface.

Data: The DATA/GETDEF command does not return any data records after the response header fields. The command creates a result set from which a subsequent DATA/FETCH command can retrieve records.

Options

ACTION(data-value)
The 12-character name of an action against the resource table for which CPSM MetaData records are to be retrieved.
ACTIONPARM(data-value)
The 12-character name of a parameter to an action against the resource table for which CPSM MetaData records are to be retrieved, as it appears in the API parameter string.
ATTRIBUTE=value
Specifies, optionally, the value of one or more known attribute names from one of the CICSPlex SM resource tables.

Depending on which CPSM metadata table is named on the OBJECT parameter, this value can be the 1- to 12-character name of a specific attribute or an asterisk (*), for all attributes in the resource table. If you do not specify the ATTRIBUTE option for an OBJECT that does not require it, data is retrieved for all attributes in the resource table.

See the CICSPlex System Manager Resource Tables Reference for details of all the CICSPlex SM resource table attribute names.
OBJECT=value
Identifies the type of metadata to be retrieved for the resource table specified on the RESOURCE option. This option is required, and must specify one of the following CPSM metadata resource table names:
OBJECT
OBJACT
METADESC
ATTR
ATTRAVA
METANAME
METAPARM
PARMAVA
RESOURCE=value
Specifies the resource table for which CPSM metadata records are to be retrieved.

If you specify the ATTRIBUTE parameter, the resource value must be the 1- to 8-character name of a specific CICSPlex SM resource table. Otherwise, you can specify a value of asterisk (*) to retrieve data for all resource tables.

STUB=value
Specifies the result set stub value returned by the server in response to an earlier request. This is optional, and has the following effect:
  • If you omit the STUB option, the server creates a new result set. If the server has created one or more result sets from previous requests, these are preserved and unaffected by this request.
  • If you specify the STUB option, the server reuses the old result set storage for the new query. In effect, issuing a DATA/GETDEF request with a stub value is the equivalent of issuing a DATA/DISCARD followed by a DATA/GETDEF, and avoids tying up system resources that are no longer needed.
Note:
Your client application can use a stub value received from Web User Interface server once only. Once you specify a stub value on a request to a Web User Interface server, you cannot use the same value again.

STATUS values

BADCOMMAND
The command passed to the data interface by the Web User Interface is not recognized.
BADOBJECT
The value specified on the OBJECT option is invalid. If the DATA/GETDEF command specified a stub value, the implied DISCARD is honored and the associated result set is discarded.
BADSTUB
The stub value is not valid for the request. This could be for one of the following reasons:
  • You have have specified a stub value that does not belong to the user session on which you have issued the command.
  • The stub value is out of sequence.
CMASGONE
The Web User Interface has lost its connection with the CMAS. As a result, the client application's user session is terminated.
MAXWIN
The maximum number of windows (64) for the user session has been reached.

DATA/PASSTICKET

Requests a RACF®, or other external security manager (ESM), PassTicket from the CICSPlex SM Web User Interface server.

Read syntax diagramSkip visual syntax diagramDATA/PASSTICKET
 
>>-DATA/PASTICKET----------------------------------------------><
 

Description

Access to the Web User Interface explains how you can access the Web User Interface through a Web browser. For example, a client application using the data interface might want to launch a Web browser window to allow the user to carry out some activities not supported directly by the client application. However, because the Web browser is a separate application it does have the client's cookie, which means the user of the client application would have to sign on separately to the Web User Interface server through the browser.

The DATA/PASSTICKET command provides a mechanism by which a client application can achieve an authenticated browser launch without requiring the user to perform another signon. This mechanism is in two parts:

When the client application receives a PassTicket, it can start a Web browser using the HTTP POST method to send the signon details for the user. The POST request includes the variables matching the options of the DATA/CONNECT command, including USERID=value, RECONN=J, and PASSWORD=. However, on the PASSWORD= option, you specify the PassTicket value in place of the password. You can specify the required menu, view, or object on the URL path of the browser start request. Include in the POST request body any additional query variables for the launch request; for example, CONTEXT.

If the DATA/PASSTICKET command completes with STATUS OK, the command response returns the following additional header field:

Table 18. Data returned on DATA/PASSTICKET command response header
Header field Description
PASSTICKET= The PassTicket generated by the ESM. This PassTicket is for the current application and user ID, and must be protected..

Options

None.

STATUS values

BADCOMMAND
The command passed to the data interface by the Web User Interface is not recognized.
[[ Contents Previous Page | Next Page Index ]]