Optional parameters for the WUI

You can specify a number of optional initialization parameters when setting up your Web User Interface server. Certain parameters are required in certain circumstances. For example, if you want to use the CICS management client interface (CMCI) with CICSPlex SM, you must set the CMCIPORT parameter.

TCP/IP options

You can specify additional TCP/IP parameters to configure your TCP/IP connections. The Web User Interface supports names up to 44 characters in length for all options:
TCPIPADDRESS(name | INADDR_ANY)
Specifies the dotted decimal or colon hexadecimal IP address on which the Web User Interface listens for incoming requests. If INADDR_ANY is specified (the default), the Web User Interface listens on any of the addresses known to the TCP/IP for z/OS® host.

You do not normally have to specify the TCPIPADDRESS parameter unless the z/OS host has multiple TCP/IP addresses.

TCPIPHTTPHOST(NO|YES)
DEPRECATED: The value, if specified, is ignored. This parameter is retrained for compatibility and will be removed in a later release.
TCPIPSSL(NO|YES|ATTLSBASIC)
Indicates whether you require data encryption between the Web User Interface server and the web browser.
NO
No data encryption between the Web User Interface server and the web browser is required, or data encryption is to be performed by AT-TLS.
To use AT-TLS, the TCPIPPORT parameter must be set to a port that is configured to run as an AT-TLS port by the z/OS Communications Server. For more information about AT-TLS, see z/OS Communications Server: Application Transparent Transport Layer Security (AT-TLS).
YES
If you select YES, specify the appropriate system initialization parameters to enable SSL support in the CICS® Web Interface. For information, see SSL with CICS web support.

In addition, the TCPIPSSLCERT and TCPIPSSLCIPHERS settings will always apply, unless the optional CMCISSL parameter is set with the NO or ATTLSAWARE value.

ATTLSBASIC
DEPRECATED: This option is retrained for compatibility and will be removed in a later release.
TCPIPSSL(ATTLSBASIC) implies CMCISSL(ATTLSAWARE). In all other regards, TCPIPSSL(ATTLSBASIC), if specified, behaves as TCPIPSSL(NO).
TCPIPSSLCERT(name)
Specifies the label for the SSL certificate that is to be used for the connection between the Web User Interface and the web browser. If you specify an explicit certificate, the label must be no longer than 44 characters.

The default is the default certificate in the key ring. This field is case-sensitive and is not converted to uppercase.

TCPIPSSLCIPHERS(cipher_list)
The TCPIPSSLCIPHERS attribute can be specified in either of two ways:
  • A string of up to 44 hexadecimal digits that is interpreted as a list of up to 22 2-digit cipher suite codes.
  • The name of the SSL cipher suite specification file, which is a z/OS UNIX file in the security/ciphers subdirectory of the directory that is specified by the USSCONFIG system initialization parameter. For example if USSCONFIG is set to /var/cicsts/dfhconfig and TCPIPSSLCIPHERS is set to strongciphers.xml, the fully qualified file name is /var/cicsts/dfhconfig/security/ciphers/strongciphers.xml.

The cipher suite codes are used to describe the set of algorithms that are supported by the Web User Interface server for SSL communications. If the TCPIPSSLCIPHERS parameter is not specified, the cipher suite is set using the ENCRYPTION system initialization option that the Web User Interface server is using.

For details, see Cipher suites and cipher suite specification files.

CMCI options

You can specify additional parameters to enable the use of CMCI with CICSPlex SM. The defaults for CMCI are derived from the SEC CICS system initialization parameter and the TCPIPSSL WUI server initialization parameter. If TCPIPSSL is set to YES, CMCI will use the TCPIPSSLCERT and TCPIPSSLCIPHERS parameters.

If the optional CMCIAUTH and CMCISSL parameters are specified then the CMCI will use these parameters to define the level of security. If CMCISSL is set to YES or CLIENTAUTH, CMCI will use the TCPIPSSLCERT and TCPIPSSLCIPHERS parameters. For more information on the TCPIPSERVICE attributes affected by CMCIAUTH and CMCISSL, see TCPIPSERVICE attributes.

CMCIPORT(value)
Specifies the TCP/IP port number allocated to the CICS management client interface (CMCI). This parameter is required so that you can use CMCI in a CICSPlex SM environment. Specify a number in the range 1 - 65535 but do not use the same port number as specified for the WUI in the TCPIPPORT parameter. When you set this parameter, TCPIPSERVICE and URIMAP definitions are autoinstalled to support CMCI.
CMCIAUTH(NO | BASIC | CERTIFICATE | AUTOREGISTER | AUTOMATIC)
Specifies the settings for the CMCI TCPIPSERVICE AUTHENTICATE attribute. If CMCIAUTH is specified then CMCISSL must also be specified.
CMCISSL(NO | YES | CLIENTAUTH | ATTLSAWARE)
Specifies the settings for the CMCI TCPIPSERVICE SSL attribute. If CMCISSL is specified then CMCIAUTH must also be specified.
Note: TCPIPSSLCERT and TCPIPSSLCIPHERS settings are ignored when this parameter is set with the NO or ATTLSAWARE value.

Import options

The import options allow you to automatically import WUI data repository definitions from the Web User Interface. The WUI data repository includes view sets and menus, WUI map objects, user objects, and user group profiles. Definitions can be imported from a specified transient data queue or a data set, or both.

Auto-import is an alternative to the import function of the COVC transaction. When you use auto-import, you can use all three parameters to specify a transient data queue and a data set. When using COVC, you are restricted to specifying either a transient data queue or a data set in one import operation.

AUTOIMPORTDSN(dsn_name)
Specifies the name of the data set containing IBM-supplied view and menu definitions. Currently, the supplied set of WUI view and menu definitions is in the SEYUVIEW data set. If you specify an AUTOIMPORTDSN name, you must specify the name of a data set member using the AUTOIMPORTMEM parameter.

Use the AUTOIMPORTDSN and AUTOIMPORTMEM parameters when you want to import specific IBM-supplied view set and menu definitions as a result of service (by a PTF).

AUTOIMPORTMEM(member_name)
Specifies the name of the data set member containing the specific IBM-supplied view and menu definitions that you want to import. You can use an asterisk at the end of the name to specify a group of data set members that begin with the same characters. For example, specifying AUTOIMPORTMEM(EYUEA*) with the IBM-supplied SEYUVIEW data set in AUTOIMPORTDSN imports all of the members beginning with the characters EYUEA.

Use the AUTOIMPORTDSN and AUTOIMPORTMEM parameters when you want to import specific IBM-supplied view set and menu definitions as a result of service (by a PTF).

AUTOIMPORTTDQ(tdq_name)
Specifies the name of the CICS extrapartition transient data queue from which you want the server to import a complete set of WUI data repository definitions during server initialization. To use this option, you enter a value explicitly. There is no automatic default; however, queue name COVI (DD name EYUCOVI) is defined as shown in sample EYU£WDEF.

You use the AUTOIMPORTTDQ parameter when starting a WUI server for the first time or if you are already a CICSPlex® SM user and want to import other data repository definitions, including your own customized definitions, into an existing data set. Avoid using this parameter at other times because of the resources required to perform the import operation.

Data formatting options

These options determine how data appears on Web User Interface displays.
CVDASTYLE(MIXED | UPPER)
Indicates whether the CVDAs and EYUDAs are displayed in uppercase or mixed case characters.
MIXED
Mixed case text, that is, the first character uppercase and the rest lowercase, for example, 'Enabled'.
UPPER
Text is displayed in uppercase only.
DATEFORMAT (format | MMDDYY)
Specifies the format to be used to display the date on Web User Interface displays:
  • YYMMDD
  • DDMMYY
  • MMDDYY
  • YYYYMMDD
  • DDMMYYYY
  • MMDDYYYY

where:

DD
is the day.
MM
is the month.
YY
is the year in two-digit format.
YYYY
is the year in four-digit format.
DATESEPARATOR(character | / )
Specifies the character to be used to separate the date elements on Web User Interface displays.
DECIMALSEPARATOR(character | . )
Specifies the character to be used to denote the decimal point on Web User Interface displays.
GMMTEXTMSG( NO | YES | BEFORE | AFTER)
Specifies how the CICS "good morning" message is handled.
NO
The message is not issued
YES
The message is issued before and after sign-on.
BEFORE
The message is issued before sign-on only.
AFTER
The message is issued after sign-on only.
MSGCASE (MIXED | UPPER)
Indicate whether messages destined for the operator or EYULOGs should be displayed in mixed case or uppercase characters.
MIXED
Mixed case text is displayed, that is, the first character uppercase and the rest lowercase, for example, 'Enabled'.

If you specify MIXED, output may be displayed incorrectly on Katakana display terminals, where lowercase characters are displayed as Katakana symbols.

UPPER
Text is displayed in uppercase only.

Note that while MSGCASE(MIXED) is the default, it takes effect after all the EYUWUI parameters have been read. Certain EYUWUI parameters such as TCPIPSSLCERT may contain values that are in mixed case. They will be echoed back in the EYULOG in uppercase unless MSGCASE(MIXED) is the first parameter in the EYUWUI input stream.

THOUSNDSEPARATOR(character | , )
Specifies the character to be used to separate thousands on Web User Interface displays, when required. For example, 100 000 is displayed as 100,000 if the default is used.
  1. The space character (hex 40) is a valid THOUSNDSEPARATOR value, allowing digits to be grouped by a space.
  2. Use 0 (zero) to suppress the THOUSNDSEPARATOR value.
  3. The THOUSNDSEPARATOR value is used only when required by the individual view definition.
TIMESEPARATOR(character | : )
Specifies the character to be used to separate hours, minutes, and seconds on Web User Interface displays.

Environment options

These options specify the context and scope values, the home menu and navigation frame, default map objects, and the appearance of newly opened maps.

AUTOREFRESH(YES | NO)
Disables the automatic refresh option for a WUI server. The default setting, YES, displays automatic refresh control, based on the view definition. When NO is specified, automatic refresh control is not displayed, even if automatic refresh control is set on the view definition. For more information about the automatic refresh option, see Refreshing views.
DEFAULTCMASCTXT(name | EYUCMS1A)
Specifies the CMAS context that is set when the user signs on to the Web User Interface.
DEFAULTCONTEXT(name | EYUPLX01)
Specifies the context that is set when the user signs on to the Web User Interface.
DEFAULTMAPBAS(name | EYUSTARTMAPBAS)
Specifies the name of the map object used to generate maps of business application services definitions.
DEFAULTMAPCOLL(value | 0)
Specifies the number of rows in a generated map below which a map opens in the expanded state. If the number of rows to be displayed is above this number, the map opens in a fully collapsed state. The default value of 0 means that in every generated map all of the rows are visible when opened.
DEFAULTMAPMON(name | EYUSTARTMAPMON)
Specifies the name of the map object used to generate maps of monitoring definitions.
DEFAULTMAPRTA(name | EYUSTARTMAPRTA)
Specifies the name of the map object used to generate maps of real-time-analysis definitions.
DEFAULTMAPWLM(name | EYUSTARTMAPWLM)
Specifies the name of the map object used to generate maps of workload management definitions.
DEFAULTMENU(name | EYUSTARTMENU)
Specifies the name of the menu that is presented to users after sign-on to the Web User Interface.
DEFAULTNAVIGATE(name | EYUSTARTNAVIGATE)
Specifies the name of the navigation frame that is presented to users after sign-on to the Web User Interface.
DEFAULTSCOPE(name | EYUPLX01)
Specifies the scope that is set when the user signs on to the Web User Interface.
DEFAULTWARNCNT(value)
Specifies the number of records required to trigger the record count warning mechanism. This integer value is in the range of 0 to 99999999, the default value is 0 meaning that no warnings are issued. This option affects the behavior of both the WUI and the CICS management client interface (CMCI).

For the WUI only, you can also set a record count warning value applying to a group of users when setting up a WUI user group; setting DEFAULTWARNCNT in a user group applies to the WUI only if the WUI is running with security switched on. A value set in a user group takes precedence over a value set in the DEFAULTWARNCNT parameter for the users in that group.

GLOBALPREFILTER(YES | NO)
Specifies filter parameters the first time that a view is displayed; that is, before data is collected. You can also specify this parameter when setting up a WUI user group if the WUI is running with security enabled. A value set in a user group takes precedence, for users in that group, over the value set in the GLOBALPREFILTER parameter.
RESOURCELIMIT(WARNING | FAIL)
Specifies whether a warning or failure is issued when the resource limit is reached.
WARNING
For the WUI only, the default setting, WARNING, issues message EYUVC1258W, and the user can select OK to bypass the warning threshold.
For the CMCI only, the CMCI responds with an HTTP 403 response including message DFHWU4302. The user can bypass the warning threshold by using the CMCI request URI option OVERRIDEWARNINGCOUNT.
FAIL
For the WUI only, specify FAIL to issue message EYUVC1267E and deny the new resource request.
For the CMCI only, the CMCI responds with an HTTP 403 response including message DFHWU4302 denying the new resource request.

Operation options

These options name the default view set to be used if the Web User Interface receives an external request that does not specify a view set name but specifies an object name. The view sets that you name in these options must represent the objects that can be specified. For more information, see Providing access to WUI views and menus.

You can ignore these parameters if you do not intend to launch Web User Interface displays in this manner.

DEFAULTCICSPLEX(name | EYUSTARTCICSPLEX)
Specifies the name of the default CICSplex view set.
DEFAULTCICSRGN(name | EYUSTARTCICSRGN)
Specifies the name of the default CICS region view set.
DEFAULTCONNECT(name | EYUSTARTCONNECT)
Specifies the name of the default connection view set.
DEFAULTCSYSGRP(name | EYUSTARTCSYSGRP)
Specifies the name of the default CICS system group view set.
DEFAULTDB2SS(name | EYUSTARTDB2SS)
Specifies the name of the default DB2® subsystem view set.
DEFAULTEJCOBEAN(name | EYUSTARTEJCOBEAN)
Specifies the name of the default enterprise bean in a CorbaServer view set.
DEFAULTEJDJBEAN(name | EYUSTARTEJDJBEAN)
Specifies the name of the default enterprise bean in a CICS-deployed JAR file view set.
DEFAULTEVENT(name | EYUSTARTEVENT)
Specifies the name of the default event view set.
DEFAULTLOCFILE(name | EYUSTARTLOCFILE)
Specifies the name of the default local file view set.
DEFAULTLOCTRAN(name | EYUSTARTLOCTRAN)
Specifies the name of the default local transaction view set.
DEFAULTPROGRAM(name | EYUSTARTPROGRAM)
Specifies the name of the default program view set.
DEFAULTREMFILE(name | EYUSTARTREMFILE)
Specifies the name of the default remote file view set.
DEFAULTREMTRAN(name | EYUSTARTREMTRAN)
Specifies the name of the default remote transaction view set.
DEFAULTTASK(name | EYUSTARTTASK)
Specifies the name of the default task view set.

User options

These options specify user settings that you can configure.
INACTIVETIMEOUT(value | 30)
Specifies the period, in minutes, after which inactive user sessions are ended. The maximum period allowed is 10080 minutes (7 days).
MAXUSERS(value | 20)
Specifies the maximum number of concurrent users of the Web User Interface. The maximum number of concurrent users allowed is 50.
SIGNONPANEL(BASIC | ENHANCED)
Specifies, if the Web user Interface server has CICS security active (SEC=YES in the system initialization parameter), whether the Web User Interface sign on panel takes one of the following actions:
  • Displays a GROUP option
  • Saves previously used USER and GROUP values
  • Positions the cursor in the sign-on field requiring input
When the default value, ENHANCED, is specified, the GROUP option is displayed on the sign-on screen and the following events occur:
  • If the user enters a value, sign on proceeds and if:
    • The user ID is connected to the specified group, the group is used for the WUI user group profile
    • The user ID is not connected to the specified group or the group name is not valid, sign on continues, but the WUI group profile is set to the default group of the user, and message EYUVC1227W is issued to the WUI user after sign on is complete. Message EYUVS0024W is written to the WUI server's EYULOG.
  • If the user does not enter a value, the user group profile is set to the default group of the user
The GROUP option does not change the current connect group of the user being signed on. The security environment built by the WUI is always based on the default group of the user. The group option on the WUI sign-on screen specifies which WUI user group profile the user should be associated with and does not change any security decisions that might be made by the External Security Manager.
When the SIGNONPANEL(ENHANCED) option is set and JavaScript is enabled in the web browser, the sign-on process performs the following actions:
  • Saves the user ID and group values in a cookie, so that when the sign-on process next runs, the form is filled with previously entered values
  • Positions the cursor to the sign-on field requiring input

When the value, BASIC, is specified, the GROUP option is not displayed on the sign on screen, and the user group profile is set to the default group of the user. Values are not saved and the cursor is not positioned on the sign-on panel.

Whether the Web User Interface user group profile is set based on the default group, or specified on the GROUP option, if no matching Web User Interface group profile is found, the values usually set using a user group profile are set to the system default.

The SIGNONPANEL option is ignored if the Web User Interface server is running with CICS Security inactive (SEC=NO in the system initialization parameter).

Accessibility options

These options specify the default colors for the Web User Interface displays.

The accessibility options are not normally changed as they affect all users of the Web User Interface server. If you want to change these options for reasons of accessibility, take care to ensure that the Web User Interface displays do not become unreadable.

Each option specifies a color as six hexadecimal digits. The first 2 digits describe the red component. The second 2 digits describe the green component. The last 2 digits describe the blue component. For example, FFFFFF represents white, 000000 represents black, FF0000 represents bright red, 00FF00 represents bright green, and 0000FF represents bright blue.

COLORPAPER(color)
Main work frame background color.
COLORPAPERHEAVY(color)
Navigation and assistance frame background color.
COLORPAPERLIGHT(color)
Background color used for many interface items; for example, information messages, table column headings, detail view labels, view selection and refresh area.
COLORPAPERWARN(color)
Background color for warning messages.
COLORPAPERERROR(color)
Background color for error messages.
COLORPAPERALT(color)
Background color for alternate rows on tabular displays.
COLORPAPERRULE(color)
Background color for assistance frame bar containing the navigation and help icons.
COLORINK(color)
Main work frame text color.
COLORINKBANNER(color)
Navigation and assistance frame text color.
COLORINKLINK(color)
Unvisited link text color.
COLORINKVLINK(color)
Visited link text color.

Problem determination option

This option allows you to specify the level of tracing you require for the Web User Interface server.
Attention: Only activate trace at the request of IBM® Support Center personnel.
WUITRACE(trace levels)
Specifies the level of tracing for the Web User Interface server.
The trace levels that you specify must be separated by a comma, as shown in this example: 
WUITRACE(8,11,13,15,18)
You can define a range of trace levels as shown in these examples: 
WUITRACE(1:5) 
    activates trace levels 1 through 5

WUITRACE(1:5,13,28:31) 
     activates trace levels 1 through 5, 13, and 28 through 31