Definitions for z/OS® Customization variables are
covered in this article.
This article lists definitions for the terms you see in the WebSphere® Application Server for z/OS Customization
tool.
The panels corresponding to the following tables set up the names,
network configuration, start procedures, and user IDs for a stand-alone
server.
Recommendation: Use the IBM® default
names the first time you install WebSphere Application
Server for z/OS to make the installation instructions easier
to follow.
System Locations
This section identifies the
target z/OS system on which you will configure the
new stand-alone application server, along with system data set names.
- System name
- The system name for the target z/OS system
on which you will configure WebSphere Application Server
for z/OS.
- Sysplex name
- The sysplex name for the target z/OS system
on which you will configure WebSphere Application Server
for z/OS.
Tip: If you are not sure what
the system name (&SYSNAME) and sysplex name (&SYSPLEX) are,
use the console command D SYMBOLS on the target z/OS system
to display them.
For the following, specify the fully qualified data
set names without quotes.
Rule: You can specify up to
44 characters for the data set names.
- PROCLIB
- An existing procedure library where the WebSphere Application
Server for z/OS cataloged procedures are added.
- PARMLIB
- An existing parameter library for system definitions to support WebSphere Application Server for z/OS.
This data set must be in the parmlib concatenation for the target z/OS system.
- SYSEXEC
- A variable-block (RECFM=VB, LRECL=255) data set into which the
customization process places REXX EXECs to be called from TSO, such
as the WebSphere Application Server for z/OS error
log browser, BBORBLOG. You must allocate this data set and concatenate
it as part of the SYSEXEC DD allocation in your installation-wide
TSO logon PROC or allocation exec.
If your existing SYSEXEC DD data
set concatenation consists of fixed-blocked (RECFM=FB) data sets,
you must make a copy of the hlq.DATA data set (produced by the Customization
Dialog) after the customization process is complete, and place the
copy in the SYSEXEC concatenation.
If you do not specify a data
set name, the customization process does not place any REXX EXECs
in any data set.
WebSphere Application Server for z/OS product
data sets
Specify the following WebSphere Application
Server for z/OS libraries so they can be accessed by the
customized jobstreams the tool produces. These data sets must be cataloged.
See
Product data sets for more information.
- Run WebSphere Application Server from STEPLIB
(Y/N)?
- Specifies whether to load WebSphere Application Server
for z/OS load modules from STEPLIB ("Y") or from
the link pack area and link list ("N"). See Link pack area, link list, and STEPLIB for more information.
Note: Specify
"Y" if you have another instance of WebSphere Application
Server for z/OS (Version 4 or later) in the system link
pack area or link list.
- SBBOLPA
- WebSphere Application Server for z/OS load
module library. It has modules that should go into LPA or the location
service daemon STEPLIB.
- SBBOLOAD
- WebSphere Application Server for z/OS 31-bit
load module library. It has members that should go into the link list
or LPA, or into STEPLIB.
- SBBOLD2
- WebSphere Application Server for z/OS load
module library that you installed through SMP/E. It has members that
should go into the link list, or into STEPLIB. DO NOT place
them in LPA.
- SBBOEXEC
- WebSphere Application Server for z/OS CLIST
library.
- SBBOMSG
- SBBOMSG WebSphere Application Server for z/OS message
skeletons for language translation.
Additional system data sets
Specify
the following Language Environment
® and WebSphere Application Server for z/OS data
sets and whether they should ("Y") or should not ("N") load from STEPLIB.
"N" indicates the generated JCL will contain STEPLIB statements for
these data sets. Refer to your z/OS SMP/E
installation for the location of these data sets listed by their DD
Name.
- SCEERUN
- Language Environment runtime
load module library.
- SCEERUN2
- Language Environment runtime
load module library.
- SGSKLOAD
- System SSL load module library. This data set does not exist in z/OS Version
1 Release 6 or later. See Link pack area, link list, and STEPLIB for the effects of this change. Leave the data
set name blank if ALL z/OS target systems are at z/OS Version
1 Release 6 or later.
WebSphere Application
Server for z/OS product directory
- WebSphere Application Server product directory
- The name of the directory where WebSphere Application
Server for z/OS files reside after installation. See Product file system for
more information.
WebSphere configuration file system
This
section defines the WebSphere configuration file
system that you will use for the stand-alone application server. See
Configuration file system for
more information.
- Mount point
- Read/write file system directory mount point where application
data and environment files are written. The customization process
creates this mount point if it does not already exist.
- Name
- File System data set you will create and mount at the above mount
point.
Rule: You can specify up to 44 characters for the
data set name.
- Volume, or '*' for SMS
- Specify either the DASD volume serial number to contain the above
data set or "*" to let SMS select a volume. Using "*" requires that
SMS automatic class selection (ACS) routines be in place to select
the volume. If you do not have SMS set up to handle data set allocation
automatically, list the volume explicitly.
- Primary allocation in cylinders
- Initial size allocation in cylinders for the above data set.
Recommendation:
The minimum suggested size is 250 cylinders (3390).
- Secondary allocation in cylinders
- Size of each secondary extent in cylinders.
Recommendation:
The minimum suggested size is 100 cylinders.
WebSphere error
log stream
This section defines the System Logger log stream
that you will use for WebSphere Application Server
for z/OS error logging if TRACEBUFFLOC=BUFFER. Having
the error log in the log stream is optional. By default, the error
log is written to JES SYSOUT.
- Name
- Name of the WebSphere error log stream you will create.
Rules:
- The name must be 26 or fewer characters.
- Do NOT put quotes around the name.
- Data class
- An existing DFSMS data class for the log stream data set allocation.
Applicable only if you use SMS.
- Storage class
- An existing DFSMS storage class for allocation of the DASD staging
data set for this log stream. Applicable only if you use SMS.
- HLQ for data sets
- The high-level qualifier for the log stream data set name and
staging data set name that you will create.
- Is log stream CF resident (Y|N)
- If you want the log stream to be created on a coupling facility,
specify "Y". If on DASD, specify "N".
- If yes, specify structure name
- If using the coupling facility, specify the coupling facility
structure to be used for the log stream.
Rule: The name can
be 1 to 16 characters, including alphanumeric characters, national
characters, and an underscore, where the first character is uppercase
alphabetic.
- If no, specify: log stream size
- Specifies the size, in 4K blocks, of the log stream DASD data
sets for the log stream being defined.
- If no, specify: staging size
- Specifies the size, in 4K blocks, of the DASD staging data set
for the log stream being defined.
RRS setup (if not done previously)
Note: RRS setup was removed from the
Customization Dialog in WebSphere Application Server
for z/OS Version 6.0.2.
If you do not have the
RRS log streams set up, the Customization tool will create the jobs
you can use to set up the log streams. See
Preparing Resource Recovery Services for more information.
- Group name
- Specify the XCF group name.
Recommendation: Use your
sysplex name.
- Data class
- Specify an existing DFSMS Data Class for the log stream data set
allocation. Applicable only if you use SMS.
- Storage class
- An existing DFSMS storage class for allocation of the DASD staging
data set for this log stream. Applicable only if you use SMS.
- HLQ for data sets
- The high-level qualifier for your log stream data set name and
staging data set name.
- Is log stream CF resident (Y|N)
- If the log stream is to be created on a coupling facility, specify
"Y". If on DASD, specify "N".
- Create RRS PROC (Y|N)
- If you specify "Y", the tool copies the ATRRRS cataloged procedure
into SYS1.PROCLIB so that RRS can be started.
If you already have
RRS set up, specify "N".
Component Trace
Note: Except for specifying the Trace
Parmlib member suffix, component-trace setup was removed from the
Customization tool in WebSphere Application Server
for z/OS Version 6.0.2.
WebSphere Application
Server for z/OS uses component trace (CTRACE) to capture
and to display trace data in trace data sets. WebSphere Application
Server for z/OS identifies itself to CTRACE with the short
cell name.
- Procedure name
- This is the CTRACE external writer start procedure to be created.
It is identified in the WebSphere Application Server
for z/OS CTRACE member (CTIBBOxx) in PARMLIB.
Rule: The
name must be one to seven characters.
- User ID
- RACF® user ID to be created and associated with
the CTRACE external writer start procedure.
- Group
- The name of an existing RACF group you will associate with
this user.
Recommendation: Use the "default started task" RACF group
for your target z/OS system.
- Name
- Specify a fully qualified data set name, such as WAS390.CTRACE1,
for the data set to be created. The default includes the system name
of the system on which the Customization tool is running.
Rules:
- You can specify up to 44 characters for the data set name.
- Do not use quotes.
- Volume, or "*" for SMS
- Specify either the DASD volume serial number containing the above
data set or "*" to let DFSMShsm™ select a volume. Using
"*" requires SMS. Using "*" requires that SMS automatic class selection
(ACS) routines be in place to select the volume. If you do not have
SMS set up to handle data set allocation automatically, list the volume
explicitly.
- Primary space in cylinders
- The primary space for the trace data set.
- Secondary space in cylinders
- The secondary space for the trace data set.
- Trace Parmlib member suffix
- Value that is appended to CTIBBO to form the member name for the
Trace Parmlib member.
WebSphere transaction
XA partner log
This section specifies whether the transaction
XA partner log resides in the configuration HFS or in a log stream.
This log is used for recovery of XA resources.
- Use Log stream (Y|N)
- Indicates whether the XA partner log is located in the file system
or in a log stream. Choose "N" to put the partner log in the file
system.
Note: If you choose "Y" to use logger, you must
continue with the rest of the variables on this panel. If you choose
"N" to put the partner log in the file system, however, no further
modification is required on this panel, and the XA logs will be written
to the file system at the default location (WAS_HOME/recoveryLogs),
or at the value of $TRANLOG_ROOT.
- Name HLQ
- Name that becomes the first qualifier in the name of the log stream.
The
remainder of the log stream name consists of the server short name,
followed by an M or D (short for Main and Delayed streams). If the
HLQ is HLQ and server name is BBOS001,
however, the stream names would be HLQ.BBOS001.M and HLQ.BBOS001.D.
As stated above, it is important that you select the HLQ carefully
to ensure that two servers are not using the same stream. If you have
two servers named BBOS001 in two cells, the
streams will overlap if they both use the same HLQ.
Note: No two
servers can have the same log stream name. If you plan for your installation
to have more than one server with the same short name, you must choose
a different HLQ for each server.
Rule: The name can be
one to eight characters.
- Data class
- An existing DFSMS data class for the log stream data set allocation.
Specify this if your installation requires you to allocate log streams
in a particular data class. Applicable only if you use SMS.
- Storage class
- An existing DFSMS storage class for allocation of the DASD staging
data set for this log stream. Specify this if your installation requires
you to allocate log streams in a particular storage class. Applicable
only if you use SMS.
- HLQ for data sets
- High-level qualifier that becomes both the HLQ for the DASD offload
data sets produced when the log stream becomes full and the HLQ for
the log stream data sets themselves if they are using a DASD-only
log stream.
Rule: The HLQ can be one to eight characters.
- Is log stream CF resident (Y|N)
- If you want to create the log stream on a coupling facility, specify
"Y". If on DASD, specify "N".
- If yes, specify structure name
- If using the coupling facility (CF), specify the coupling facility
structure to be used for the log stream.
Rule: The name can
be 1 to 16 characters, including alphanumeric characters, national
characters, and an underscore, where the first character is uppercase
alphabetic.
- If no, specify: log stream size
- Specifies the size, in 4K blocks, of the log stream DASD data
sets for the log stream being defined. Specifying "1" indicates
4096 bytes of storage. It is recommended that you make the DASD log
stream the same size as your RRS (Resource Recovery Services) main
and delayed log streams.
- If no, specify: staging size
- Specifies the size, in 4K blocks, of the DASD staging data set
for the log stream being defined. Specifying "1" indicates 4096
bytes of storage.
Server customization
- WebSphere Application Server home directory
- Directory in which the application server configuration resides.
See HFS configuration strategy for
more information.
Note: You can alter only the portion
after the configuration file system mount point.
- Cell name (short)
- Name that identifies the cell to z/OS facilities
such as SAF.
Rules:
- Name must be eight or fewer characters and all uppercase.
- Name must be unique among all other cells in the sysplex.
- Cell name (long)
- Primary external identification of this WebSphere Application
Server for z/OS cell. This name identifies the cell as
displayed through the administrative console.
Note: If
you intend to ever add this stand-alone server node to a Network Deployment
cell, ensure that the stand-alone server cell name is different from
the Network Deployment cell name.
Rules:
- Name must be 50 or fewer characters and can be of mixed case.
- Name must be unique among all other cells in the sysplex.
- Node name (short)
- Name that identifies the node to z/OS facilities
such as SAF.
Rules:
- Name must be eight or fewer characters and all uppercase.
- Name must be unique within the cell.
- Node name (long)
- Primary external identification of this WebSphere Application
Server for z/OS node. This name identifies the node as
displayed through the administrative console.
Note: If
you intend to ever add this stand-alone server node to a deployment
manager cell, ensure that the stand-alone server node name is not
the same as that of any existing node in the Network Deployment cell.
Rules:
- Name must be 50 or fewer characters and can be of mixed case.
- Name must be unique within the cell.
- The application server must be defined on its own node; no other
server can exist on the same node as the application server.
- Server name (short)
- This value identifies the server to z/OS facilities
such as SAF.
Note: The server short name is also used
as the server JOBNAME.
Rule: Name must usually contain
seven or fewer all-uppercase characters. If you want to instead specify
eight characters, you must follow the steps outlined in the "Converting
a 7-character server short name to 8 characters" article in the information
center.
- Server name (long)
- Name of the application server and the primary external identification
of this WebSphere Application Server for z/OS server.
This name identifies the server as displayed through the administrative
console.
Rule: Name must be 50 or fewer characters and can
be of mixed case.
- Cluster transition name
- WLM APPLENV (WLM application environment) name for this server.
Note: If this server is converted into a clustered server, this
name becomes the cluster short name. The cluster short name is the
WLM APPLENV name for all servers that are part of the same cluster.
See Cataloged procedures for
more information.
Rule: Name must be eight or
fewer characters and all uppercase.
- Admin asynch operations procedure name
- Specifies the JCL procedure name of a started task that is launched
by way of the START command by node agents or application servers
to perform certain asynchronous administrative operations (such as
node synchronization) and add and remove a node.
See Cataloged procedures for
more information.
- Install samples? (Y/N)
- Specify whether you do ("Y") or do not ("N") want to install the WebSphere Application Server for z/OS sample
applications (the Samples Gallery).
Note: These applications are not
supported in a Network Deployment cell.
Server address space information
This section
defines the cataloged procedures and associated user IDs for the server
regions.
See Cataloged procedures for more information.
Rule: In the following,
unless specified otherwise, names must be eight or fewer characters.
Note: If
you want to specify job names with eight instead of seven characters,
you must follow the steps outlined in the "Converting a 7-character
server short name to 8 characters" article in the information center.
Controller
Information
- Jobname
- The jobname, specified in the MVS™ START
command JOBNAME parameter, associated with the application server
controller. This is the same as the server short name and it cannot
be changed through the Customization tool.
- Procedure name
- Name of member in your procedure library to start the application
server controller.
Rule: Name must be seven or fewer characters.
- User ID
- The user ID associated with the application server controller.
Note: If you are using a non-IBM security system, the user ID
might have to match the procedure name. Please refer to your security
system's documentation.
- UID
- The user identifier associated with this user ID.
Rule: UIDs
must be unique numbers, between 1 and 2,147,483,647, within the system.
Servant Information
- Jobname
- The jobname used by WLM to start the application server servant.
This is set to the server short name, followed by the letter "S",
and it cannot be changed through the Customization tool.
- Procedure name
- Name of member in your procedure library to start the application
server servant.
Rule: Name must be seven or fewer characters.
- User ID
- The user ID associated with the application server servant.
Note: If you are using a non-IBM security system, the user ID
might have to match the procedure name. Please refer to your security
system's documentation.
- UID
- The user identifier associated with this user ID.
Rule: UIDs
must be unique numbers between 1 and 2,147,483,647 within the system.
Control Region Adjunct
- Jobname
- The jobname used by WLM to start the application server control
region adjunct. This is set to the server short name followed by the
letter "A", and it cannot be changed through the Customization tool.
- Procedure name
- Name of the member in your procedure library that starts the control
region adjunct.
Rule: Name must be seven or fewer characters.
- User ID
- The user ID associated with the control region adjunct.
Note: If
you use a non-IBM security system, the user ID might have to match
the procedure name. Please refer to your security system's documentation
for more information.
- UID
- The user identifier associated with this user ID.
Rule: UIDs
must be unique numbers, between 1 and 2,147,483,647, within the system.
Server TCP/IP information
Note: Do
not choose port values already in use.
- Node host name
- IP name or address of the system on which the server is configured.
This value is used by other WebSphere Application Server
for z/OS functions to connect to this server.
Note: The node host name must always resolve to an IP stack
on the system where the application server runs. The node host name
cannot be a DVIPA or a DNS name that, in any other way, causes the
direction of requests to more than one system.
- SOAP JMX Connector port
- Port number for the JMX HTTP connection to this server based on
the SOAP protocol. JMX is used for remote administrative functions,
such as invoking scripts through wsadmin.sh.
Rule: Value
cannot be 0.
- ORB Listener host name
- IP address on which the server's ORB listens for incoming IIOP
requests. The default is "*", which instructs the ORB to listen on
all available IP addresses.
- ORB port
- Port for IIOP requests that acts as the bootstrap port for this
server and also as the port through which the ORB accepts IIOP requests.
Rule: Value
cannot be 0.
- ORB SSL port
- Port for secure IIOP requests. The default is "0", which allows
the system to choose this port.
- HTTP transport host name
- IP address on which the server's Web container should listen for
incoming HTTP requests. The default is "*", which instructs the Web
container to listen on all available IP addresses.
Note: The
"transport host name" becomes the "hostname" in the virtualhosts.xml
file, which makes setting a specific IP address here less than ideal
because, if you do so, you are restricting yourself to that IP address
until you go into the administrative console and add another virtual
host.
- HTTP port
- Port for HTTP requests.
Rule: Value cannot be 0.
- HTTP SSL port
- Port for secure HTTP requests.
Rule: Value cannot be
0.
- High Availability Manager Host
- Host name for the High Availability Manager. This host name must
resolve to a single IP address--it cannot be a multihomed host.
Note: This field was removed from the
Customization tool in WebSphere Application Server
for z/OS Version 6.0.2.
- High Availability Manager Communication Port
- Port on which the High Availability Manager listens.
Rule: Value
cannot be 0.
- Service Integration port
- Port for service-integration requests.
Rule: Value cannot
be 0.
- Service Integration Secure port
- Port for secure service-integration requests.
Rule: Value
cannot be 0.
- Service Integration MQ Interoperability port
- Port for service-integration MQ interoperability requests.
Rule: Value
cannot be 0.
- Service Integration MQ Interoperability Secure port
- Port for secure service-integration MQ interoperability requests.
Rule: Value
cannot be 0.
Location service daemon
The location service
daemon is the initial point of client contact in WebSphere Application
Server for z/OS. The server contains the CORBA-based location
service agent, which places sessions in a cell. All RMI/IIOP IORs
(for example, for enterprise beans) establish connections to the location
service daemon first, then forward them to the target application
server.
- Daemon home directory
- Directory in which the location service daemon resides. This is
set to the configuration file system mount point/Daemon and cannot
be changed.
- Daemon jobname
- Specifies the jobname of the location service daemon, specified
in the JOBNAME parameter of the MVS start
command used to start the location service daemon.
Caution: When
configuring a new cell, be sure to choose a new daemon jobname value.
Note: A server automatically starts the location service daemon
if it is not already running.
- Procedure name
- Name of the member in your procedure library to start the location
service daemon.
Rule: Name must be seven or fewer characters.
- User ID
- The user ID associated with the location service daemon.
- UID
- The user identifier associated with this user ID.
Rule: UIDs
must be unique numbers, between 1 and 2,147,483,647, within the system.
- IP Name
- The fully qualified IP name, registered with the Domain Name Server
(DNS), that the location service daemon uses. The default is your
node host name.
Note:
- In a sysplex, you should consider using a virtual IP address (VIPA)
for the location service daemon IP name.
- Select the IP name for the location service daemon carefully.
Once you have chosen a name, it is difficult to change, even in the
middle of customization. This name must not be a numeric, such as,
3.7.2543.
- Port
- The port number on which the location service daemon listens.
Note: Select the port number for the location service daemon
carefully. You can choose any value you want, but, once chosen, it
is difficult to change, even in the middle of customization.
- SSL Port
- The port number on which the location service daemon listens for
SSL connections.
- Register daemon with WLM DNS
- If you use the WLM DNS (connection optimization), you must select
"Y" to register your location service daemon with it. Otherwise, select
"N."
Note: Only one location service daemon per LPAR can
register its domain name with WLM DNS. If you have multiple cells
in the same LPAR and register one location service daemon and then
a second, the second will fail to start.
Schedule database
This
section defines an (optional) DB2
® database that the scheduler
daemon can use.
- SBPXEXEC
- The data set name of the UNIX® System
Services SBPXEXEC data set on your z/OS system.
- DB2 RUNLIB Location
- The data set name of the DB2 RUNLIB data set.
- DB2 Subsystem Name
- The subsystem name (1-4 characters) of the DB2 region
to be used for creating the scheduler database.
- Plan Name
- The plan name to be used in creating the scheduler database.
- Scheduler Database Name
- The DB2 database name for the scheduler database.
- Storage Group Name
- The DB2 storage group name to be used for creating
scheduler database tables.
- Tablespace Name
- The DB2 table-space name to be created for the schedule
database.
- Table Prefix
- The table prefix to be used for the scheduler database tables.
Security customization - WebSphere-managed security
For
this security option, you must choose an administrator user ID and
password.
- Administrator user ID
- Enter an alphanumeric user ID which you will use to log on to
the administrative console and perform administrative tasks. This
user ID and its password will initially be the only entry in the file-based
user registry.
- Administrator password
- This password must not be blank.
Web Server Configuration
If
you are running IBM HTTP Server for z/OS on
a local or remote z/OS system and want to have WebSphere Application Server for z/OS manage
the
plugin-cfg.xml file, fill in the following
values.
- Web Server Name
- Name used to define the Web server in the administrative console.
- Host
- IP name or address of the z/OS system on which the Web server
is located.
- Port
- HTTP port on which the Web server listens.
- Application Mapping
- Determines whether you want to map all applications (A), none
of the applications (N), or the default application (D) to the Web
server.
Security Domain Configuration
These
panels display values that you previously set in the "Configure security
domain" option--you cannot change any of the values here. If you do
want to make changes, you must go back to the main dialog panel and
run through the "Configure security domain" option again.