Integrating the Web User Interface with other web-based tools

The Web User Interface interacts with other web-based tools as follows:

Access from the Web User Interface to an external server

The Web User Interface can access other web-based tools by:

See Customizing the Web User Interface for more information.

Access to the Web User Interface

The Web User Interface is accessed using standard web browser software. Every time you access the Web User Interface, a new window is opened showing a new instance of the data. The different instances of the data are independent of each other. See Opening a new window for information about the maximum number of windows you can have open at any one time.

You can link to the Web User Interface from any location that can launch a web browser by supplying a valid URL. The URL must be correctly formatted for a HTTP or HTTPS request using escaping for reserved and unsafe characters with standard HTTP '%nn' notation, where nn is the hexadecimal representation of a character from the ISO-8859-1 codepage. For example, '%7E' represents the tilda ('~') character. Except for the 'http' or 'https' prefix, the URL, in general, is not case sensitive unless the value of any query variables is case sensitive.

For information about the HTTP standard refer to RFC2068 - Hypertext Transfer Protocol - HTTP/1.1.

The URL is constructed as follows:

prefix:path?selection criteria
Note:
The path and the selection criteria, which are specified as HTTP query variables, are separated by a question mark (?). If selection criteria are not present, the '?' should not be specified.

Prefix

The prefix may be one of the following depending on the server configuration:

Path

The path may be one of the following:

Notes:
  1. The hostname and port represent the IP address of the CICS Web Interface listener or the secure server, and are specified on the TCPIPHOSTNAME and TCPIPPORT Web User Interface server initialization parameters, respectively. See CICS Transaction Server for z/OS Installation Guide for information about these parameters.
  2. You need to specify codepage only if you wish to override the codepage specified on the INITPARM system initialization parameter.

Selection criteria

In URLs, the selection criteria are specified as HTTP query variables. Each query variable is specified as a variable name followed by '=' then a value. The variable names and values must be escaped using the HTTP standard notation, where necessary. Multiple query variables should be separated by an ampersand (&) character.

The Web User Interface supports query variables as follows:

Query variables that can be used for menus and views

The following query variables can be used for both menus and views:

Query variables that can be used for views only

These additional query variables can be used for views only:

Table 9. Operator values for the O_attrname query variable
Operator value Meaning
Mnemonic form Numeric form
EQ 1 Equal to
NE 2 Not equal to
GT 3 Greater than
LT 4 Less than
GE 5 Greater than or equal to
LE 6 Less than or equal to

Specifying object names

If you do not specify a view set name but specify an object name, the view set named on the Web User Interface server initialization operation options parameter, that represents the specified object, is opened.

If a view set has not been named to represent the specified object, the default view set, EYUSTARTobjectname is opened.

For a list of Web User Interface server initialization operation options parameters see CICS Transaction Server for z/OS Installation Guide.

Examples

The following examples show valid URL formats:

  1. http://MVSXX.COMPANY.COM:04445/CICSPLEXSM//JSMITH/MENU/OURHOME?
           CONTEXT=FRED&SCOPE=FRED

    This is a request for a user to be directly presented with a home menu called OURHOME using context FRED and scope FRED.

  2. http://MVSXX.COMPANY.COM:04445/CICSPLEXSM//JSMITH/VIEW/OURLOCTRAN?
           CONTEXT=FRED&SCOPE=FRED&A_TRANID=PAY*

    This is a request for a user to be directly presented with the default view, in view set OURLOCTRAN, displaying all the local transactions with a TRANID beginning with the characters PAY, using context FRED and scope FRED.

  3. http://MVSXX.COMPANY.COM:04445/CICSPLEXSM//JSMITH/VIEW/OURWLMAWAOR.TABLE1?
           P_WORKLOAD=WLDPAY01

    This is a request for a user to be directly presented with the TABLE1 view, in view set OURWLMAWAOR, displaying active workload information about workload WLDPAY01, using the default context as specified in the DEFAULTCONTEXT Web User Interface server initialization parameter.

  4. http://MVSXX.COMPANY.COM:04445/CICSPLEXSM//JSMITH/VIEW/OURLOCTRAN?
           A_TRANID=P*&O_TRANID=NE

    This is a request for a user to be directly presented with the default view, in view set OURLOCTRAN, displaying all the local transactions with a TRANID that does not begin with the character P.

  5. http://MVSXX.COMPANY.COM:04445/CICSPLEXSM//JSMITH/VIEW/OURTASK?
           A_PRIORITY=200&O_PRIORITY=GT

    This is a request for a user to be directly presented with the default view, in view set OURTASK, displaying all the tasks with a PRIORITY greater than 200.

  6. Start of change
    http://MVSXX.COMPANY.COM:44455/CICSPLEXSM//TOXTETH/VIEW/EYUSTARTPROGRAM.TABULAR?FILTERC=1 

    This is a request for a user to be presented with the filter confirmation screen of the EYUSTARTPROGRAM TABULAR view.

    End of change
[[ Contents Previous Page | Next Page Index ]]