You can specify the Web User Interface server initialization parameters
in the start-up job or in a fixed block 80 data set. See Specify the JCL DD statements for the DDname. All of these parameters are subject
to the following conditions unless otherwise stated:
- Lines with an asterisk in column 1 are comments and are ignored.
- Values must not contain lower case characters.
- Values must be specified in parenthesis immediately following
the parameter.
- Values must not be greater than 32 characters.
For example:
* An EYUWUI parameter data set
DEFAULTMENU(OURHOME)
TCPIPHOSTNAME(MVSXX.COMPANY.COM)
TCPIPPORT(4445)
A description of the Web User Interface server initialization parameters
follows with default values for the parameters underlined.
The Web User Interface server has some required initialization
parameters. If you do not specify a required parameter the Web User
Interface server initialization fails. The Web User Interface server
initialization also fails if any of the specified parameters are invalid.
The required Web User Interface server initialization parameters
are:
- TCPIPHOSTNAME(name)
Specify the TCP/IP host name of
this Web User Interface server. This is normally the host name and
domain name of the MVS™ system (that is, a fully-qualified
name). This host name is normally used by the Web User Interface to
construct URLs, depending on the client's HTTP version and the value
of the TCPIPHTTPHOST Web User Interface server parameter.
This
value is always returned in the TCPIPHOSTNAME header of a DATA/CONNECT
Web User Interface Data Interface request.
The Web User Interface
does not support names longer than 32 characters. If required, you
may use the address of the server using the dotted decimal notation.
For example, '127.0.0.1'.
- TCPIPPORT(value)
- Specify the TCP/IP port number of the port that you have allocated
for the Web User Interface to run on.
The
value specified in this parameter must correspond to the port number
given on the CWBC transaction, if you are using a pre-CICS Transaction
for OS/390® version 1.3 CICS® system.
You might also want to consider the following Web User Interface
server initialization parameters:
AUTOREFRESH(YES|NO)
Disable the automatic refresh option for a WUI server. When
YES is specified (the default), the automatic refresh control is displayed,
based on the view definition. When NO is specified, the automatic
refresh control is not displayed, even if automatic refresh is set
on the view definition. For additional information on the automatic
refresh option, see the CICSPlex SM Web User Interface Guide (SC34-6841).
RESOURCELIMIT(WARNING|FAIL)
Specifies the action when the default warning count threshold
is reached. When WARNING is specified (the default), message EYUVC1258W
is issued and the user can select OK to ignore the warning threshold.
When FAIL is specified, message EYUVC1267E is issued and the resource
request is denied. The filter can be changed, but users of the WUI
server will not be able to click OK to bypass a warning count.
Additional TCP/IP parameters
You can specify the following TCP/IP parameters only if you are
using a CICS Transaction Server for OS/390 version
1.3 or later CICS system.
- TCPIPADDRESS(name | INADDR_ANY)
- Specify the dotted decimal IP address on which the Web User
Interface will listen for incoming requests. If name is specified,
it must be of the form nnn.nnn.nnn.nnn where nnn is 0 through 255.
If INADDR_ANY is specified (the default), the Web User Interface
will listen on any of the addresses known to the TCP/IP for OS/390 host.
You
do not normally need to specify the TCPIPADDRESS option unless the OS/390 host
has multiple TCP/IP addresses.
TCPIPHTTPHOST(NO|YES)
Indicate whether you require the TCP/IP host name used to construct
URLs to be generated based on the incoming HTTP request for HTTP version
1.1 requests or later.
This option has no effect on pre HTTP 1.1
requests sent to the Web User Interface server. The Web User Inter
face server will always construct URLs using the host name specified
in the TCPIPHOSTNAME Web User Interface server parameter for HTTP
1.0 (and earlier) requests.
- NO
- For HTTP 1.1 (or later) requests, the host name used in URLs
constructed by the Web User Interface server is based on the value
specified in the TCPIPHOSTNAME Web User Interface server parameter.
- YES
- For HTTP 1.1 (or later) requests, the host name used in URLs
constructed by the Web User Interface server is based on the incoming
URI or HTTP 'Host' header according to the HTTP 1.1 specification.
When HTTP 1.1 clients are used with a Web User Interface server
running TCPIPHTTPHOST(YES), the IP address or name used on the server,
does not need to be the same as that used by the HTTP 1.1 client.
This can allow the Web User Interface to be used when name address
translation (NAT) is performed (for example due to a firewall).
If TCPIPSSL(YES) is used with TCPIPHTTPHOST(YES) and
HTTP 1.1 clients are used along with different IP address names, you
may receive SSL certficate warnings due to host name mismatches.
- TCPIPSSL(YES | NO)
- Indicate whether you require data encryption between your Web
User Interface server and web browser. If you select YES, you must
have specified the appropriate system initialization parameters to
enable SSL support in the CICS Web Interface. For information
see the CICS Internet Guide.
- TCPIPSSLCERT(name)
- Specify (in upper case characters) 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 32 characters.
The default is the default
certificate in the key database or key ring. as applicable.
Note:
The names of all SSL certificates to be used with the WUI
server must be upper case.
Import option
You can specify the following parameter if you want the Web User
Interface server to import automatically menus and view sets from
a specified TD queue. This is an alternative to using to import function
of the COVC transaction.
- AUTOIMPORTTDQ(tdq_name)
- Specifies the name of the CICS extrapartition
transient data queue from which you want the server to import menu
and view sets automatically during server initialization. In order
to use this option, you need to enter a value explicitly. There is
no automatic default, however, queue name COVI (DD name EYUCOVI) is
defined in the CICSPlex® SM CSD group EYUnnnGW.
Note:
Include this parameter
in the Web User Interface initialization parameters for the following
occasions only:
- When starting the Web User Interface server for the first time.
- When starting the Web User Interface server after the view sets
have been replaced or modified as a result of service (by a PTF).
- If you are already a CICSPlex SM
user and want to import other view sets into your existing EYUWREP
data set.
Avoid using this parameter at other times because of the overhead
involved in performing the import operation.
Data formatting options
These options determine how data will appear on Web User Interface
displays.
- CVDASTYLE(MIXED | UPPER)
- Indicate whether the CVDAs, EYUDAs, and so on should be displayed
in upper case or mixed case characters.
- MIXED
- Mixed case text, that is, the first character upper case and
the rest lower case, for example, 'Enabled'.
- UPPER
- Text is displayed in upper case only.
- DATEFORMAT (format)
- Specify the format to be used to display the date on Web User
Interface displays as follows:
- YYMMDD
-
- DDMMYY
-
- MMDDYY
-
- YYYYMMDD
-
- DDMMYYYY
-
- MMDDYYYY
-
where:
- DD
- is the day.
- MM
- is the month.
- YY and YYYY
- are the year in two-digit or four-digit format, respectively.
- DATESEPARATOR(character | / )
- Specify the character to be used to separate the date elements
on Web User Interface displays.
- DECIMALSEPARATOR(character | . )
- Specify the character to be used to denote the decimal point
on Web User Interface displays.
- GMMTEXTMSG( NO | YES |
BEFORE | AFTER)
- Specify how the CICS "good morning" message is handled.
- NO
- The message is not issued
- YES
- The message is issued before and after signon.
- BEFORE
- The message is issued before signon only.
- AFTER
- The message is issued after signon only.
- MSGCASE (MIXED | UPPER)
- Indicate whether messages destined for the operator or EYULOGs
should be displayed in mixed case or upper case characters.
- MIXED
- Mixed case text is displayed.
If you specify MIXED, output
may be displayed incorrectly on Katakana display terminals, where
lower case characters are displayed as Katakana symbols.
- UPPER
- Text is displayed in upper case only.
- THOUSNDSEPARATOR(character | , )
- Specify the character to be used to separate thousands on Web
User Interface displays, when required. For example, 100000 is displayed
as 100,000 if the default is used.
Notes:
- The space character (hex 40) is a valid THOUSNDSEPARATOR value,
allowing digits to be grouped by a space.
- Use 0 (zero) to suppress the THOUSNDSEPARATOR value.
- The THOUSNDSEPARATOR value is used only when required by the individual
view definition.
- TIMESEPARATOR(character | : )
- Specify the character to be used to separate hours, minutes,
and seconds on Web User Interface displays.
Environment options
These specify the context and scope values, and the home menu and
navigation frame, used by the Web User Interface unless overridden.
AUTOREFRESH(YES | NO)
Disable 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.
See the CICSPlex SM Web User Interface Guide for more information
on the automatic refresh option.
- DEFAULTCMASCTXT(name | EYUCMS1A)
- Specify the CMAS context that is set when the user signs onto
the Web User Interface.
- DEFAULTCONTEXT(name | EYUPLX01)
- Specify the context that is set when the user signs onto the
Web User Interface.
DEFAULTMAPCOLL(value | 0)
Specify 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.
- DEFAULTMENU(name | EYUSTARTMENU)
- Specify the name of the menu that is be presented to users after
sign onto the Web User Interface.
- DEFAULTNAVIGATE(name | EYUSTARTNAVIGATE)
- Specify the name of the navigation frame that is presented to
users after sign onto the Web User Interface.
- DEFAULTSCOPE(name | EYUPLX01)
- Specify the scope that is set when the user signs onto the Web
User Interface.
DEFAULTWARNCNT(value)
Specify the number of records required to trigger the record
count warning mechanism before opening a view. This can take an integer
value in the range of 0 to 99999999. The default value is 0 meaning
no warnings are issued.
Note:
You can also set a record count
warning value applying to a group of users when setting up a WUI user
group (this applies 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)
- Specify whether to filter parameters the first time a view is
displayed (before data is collected).
Note:
You can also
specify this parameter when setting up a WUI user group (this applies
only if the WUI is running with security switched on). 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)
Specify whether a warning or failure is issued when the resource
limit is reached. The default setting, WARNING, issues message EYUVC1258W
and the user can select OK to bypass the warning threshold. Specify
FAIL to issue message EYUVC1267E and to deny the new resource request.
The WUI server can be used to change the RESOURCELIMIT filter, however
the WUI server cannot be used to bypass the warning threshold.
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 may be specified.
For more information see the CICSPlex System Manager Web User Interface Guide.
These parameters can be ignored if you do not intend to launch
Web User Interface displays in this manner.
- DEFAULTCICSPLEX(name | EYUSTARTCICSPLEX)
- Specify the name of the default CICSplex view set.
- DEFAULTCICSRGN(name | EYUSTARTCICSRGN)
- Specify the name of the default CICS region
view set.
- DEFAULTCONNECT(name | EYUSTARTCONNECT)
- Specify the name of the default connection view set.
- DEFAULTCSYSGRP(name | EYUSTARTCSYSGRP)
- Specify the name of the default CICS system
group view set.
- DEFAULTDB2SS(name | EYUSTARTDB2SS)
- Specify the name of the default DB2® subsystem
view set.
- DEFAULTEJCOBEAN(name | EYUSTARTEJCOBEAN)
- Specify the name of the default Enterprise Bean in a CorbaServer
view set.
- DEFAULTEJDJBEAN(name | EYUSTARTEJDJBEAN)
- Specify the name of the default Enterprise Bean in a CICS-deployed
JAR file view set.
- DEFAULTEVENT(name | EYUSTARTEVENT)
- Specify the name of the default event view set.
- DEFAULTLOCFILE(name | EYUSTARTLOCFILE)
- Specify the name of the default local file view set.
- DEFAULTLOCTRAN(name | EYUSTARTLOCTRAN)
- Specify the name of the default local transaction view set.
- DEFAULTPROGRAM(name | EYUSTARTPROGRAM)
- Specify the name of the default program view set.
- DEFAULTREMFILE(name | EYUSTARTREMFILE)
- Specify the name of the default remote file view set.
- DEFAULTREMTRAN(name | EYUSTARTREMTRAN)
- Specify the name of the default remote transaction view set.
- DEFAULTTASK(name | EYUSTARTTASK)
- Specify the name of the default task view set.
User options
- INACTIVETIMEOUT(value | 30)
- Specify the period, in minutes, after which inactive user sessions
are terminated. The maximum period allowed is 10080 minutes (7 days).
- MAXUSERS(value | 20)
- Specify 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, 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.
When the
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 signon 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
signon process next runs, the form is filled with previously entered
values
- Positions the cursor to the sign on field requiring input
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 parameters specify the default colors for the Web User Interface
displays.
These parameters should not normally be changed as they effect
all users of the Web User Interface server. If you want to change
these parameters for reasons of accessibility, take care to ensure
that the Web User Interface displays do not become unreadable.
Each parameter specifies a color as six hexadecimal digits. Each
pair of digits describes the red, green and blue components of the
color, respectively. 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
- 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. For example:
WUITRACE(8,11,13,15,18)
You
can define a range of trace levels, for example:
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
Attention: It is recommended that you only activate trace at the
request of IBM® Support Center personnel.
[[ Contents Previous Page | Next Page Index ]]