The Web User Interface interacts with other web-based tools as follows:
The Web User Interface can access other web-based tools by:
See Customizing the Web User Interface for more information.
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
The prefix may be one of the following depending on the server configuration:
The path may be one of the following:
This takes you to the Welcome panel that contains a Begin Signon button.
This takes you to the Welcome panel that contains a Begin Signon button. The codepage that you specify here overrides the codepage specified on the INITPARM system initialization parameter in the start-up JCL of the Web User Interface server.
You can specify the default codepage by leaving codepage blank. For example:
//hostname:port/CICSPlexSM//
This takes you directly to your home menu (which is the menu specified on the DEFAULTMENU system initialization parameter), if you are already signed on in the current browser session.
If you are not signed on in the current browser session you will be taken through the signon process described in Signing on.
This takes you directly to the menu called menuname, if you are already signed on in the current browser session.
If you are not signed on in the current browser session you will be taken through the signon process described in Signing on, before the menu specified in the URL is displayed.
This takes you directly to the default view within the view set called viewsetname, if you are already signed on in the current browser session.
If you are not signed on in the current browser session, you will be taken through the signon process described in Signing on, before the default view within the viewset specified in the URL is displayed.
This takes you directly to the view called viewname contained within the view set called viewsetname, if you are already signed on in the current browser session.
If you are not signed on in the current browser session you will be taken through the signon process described in Signing on, before the view specified in the URL is displayed.
This takes you directly to the default view set for object objectname, if you are already signed on in the current browser session.
If you are not signed on in the current browser session you will be taken through the signon process described in Signing on, before the default view for the object specified in the URL is displayed.
Any object name may be specified for object, and the default view set will be EYUSTARTobjectname, where objectname is the value of the URL. Note however that not all CICSPlex® SM objects have starter set view sets.
The default view set for a subset of CPSM objects may be changed by using the following Web User Interface Server system parameters:
WUI Server system parameter | Objectname |
---|---|
DEFAULTCICSPLEX | CICSPLEX |
DEFAULTCICSRGN | CICSRGN |
DEFAULTCONNECT | CONNECT |
DEFAULTCSYSGRP | CSYSGRP |
DEFAULTDB2SS | DB2SS |
DEFAULTEJCOBEAN | EJCOBEAN |
DEFAULTEJDJBEAN | EJDJBEAN |
DEFAULTEVENT | EVENT |
DEFAULTLOCFILE | LOCFILE |
DEFAULTLOCTRAN | LOCTRAN |
DEFAULTPROGRAM | PROGRAM |
DEFAULTREMFILE | REMFILE |
DEFAULTREMTRAN | REMTRAN |
DEFAULTTASK | TASK |
See CICS® Transaction Server for z/OS® Installation Guide for the list of parameters used to specify default view sets.
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:
The following query variables can be used for both menus and views:
This is the CICSplex name.
This is the CMAS name.
This is the CICSplex, CICS group, MAS or logical scope name.
These additional query variables can be used for views only:
This is an attribute filter. You can specify any number of attributes on a URL. You can specify characters, numbers, CVDA or EYUDA values. The default operator for an attribute filter is equality (=). If you wish to use a different operator you can specify the operator value on the O_attrname query variable. See Table 9 for a list of operators and their values.
For information about attributes see the CICSPlex SM Resource Tables Reference.
If FILTERC is not present, or is not set to 1, filter confirmation might still occur depending on the GLOBALPREFILTER Web User Interface system parameter or the user group option Force filter confirmation.
This is a parameter filter, as used for a CICSPlex SM API GET command.
For information about parameters see the CICSPlex SM Resource Tables Reference.
This is specified with the A_attrname query variable to change the equality (=) default operator. For a list of operator values that you can specify on the O_attrname query variable see Table 9.
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 |
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.
The following examples show valid URL formats:
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.
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.
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.
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.
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.
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.