Define variables to configure base Application Server node - definitions

This article lists definitions for the terms you will come across in the WebSphere Application Server for z/OS Customization Dialog.

Note: Some term definitions--those that you cannot set in the related panel--are not displayed. To see the definition, you must to go to the Information Center article for the panel on which you can change that particular term.

The WebSphere Application Server for z/OS run-time requires four base cell servers: Application Server, deployment manager, node agent, location service daemon. The panels corresponding to the following tables set up the names, network configuration, start procedures, and user IDs for a base 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.

For identification, each controller and servant start procedure must have a user ID and will be defined in the STARTED class.

1 System locations (directories, HLQs, etc)

System Locations (1 of 2)

System name
The system name for the target z/OS system on which WebSphere Application Server for z/OS is installed.
Sysplex name
The sysplex name for the target z/OS system on which WebSphere Application Server for z/OS is installed.

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 42 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.

Specify the following Language Environment and WebSphere Application Server for z/OS data sets and whether they are ("Y") or are not ("N") in the link list or the link pack area (LPA). "N" indicates the generated JCL will contain STEPLIB statements for these data sets. Refer to your SMP/E installation for the location of these data sets listed by their DD Name.

Note: If you run multiple versions of WebSphere Application Server for z/OS on your system, specify "N" for each of the following in order to generate the proper //STEPLIB DD cards for all the appropriate jobs and procs.

SCEERUN
A Language Environment run-time load module library. Access is required. If it is not in your link list, concatenate it in the STEPLIB DD statement. You need to stop and restart your queue manager to do this.
SBBOLOAD
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 LPA.
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. DO NOT place them in LPA.
SBBOMIG
WebSphere Application Server for z/OS IPCS data set that you installed through SMP/E. It is not used during normal operations, but for dump formatting in IPCS only. DO NOT place them in LPA.
SBBOLPA
WebSphere Application Server for z/OS data set that you installed through SMP/E.
System SSL
DLLs that are stored in a partitioned dataset (PDS) when System SSL is SMP/E-installed. The DLLS are not automatically added to the link list or LPA, so contact your system programmer to determine whether or not the System SSL DLLs are in link list or LPA and, if they are not, the high level qualifier of the PDS that contains the System SSL DLLs.

In z/OS Version 1 Release 6, the contents of the System SSL data set SGSKLOAD were merged into the SIEALNKE system data set..

  • If you chose to place SGSKLOAD in the link list or link pack area on your pre-z/OS Version 1 Release 6 systems, then place SIEALNKE in the link list or link pack area on your z/OS systems at Version 1 Release 6 and above. This will allow you to share WebSphere Application Server cataloged procedures across your z/OS systems.
  • If you chose not to place SGSKLOAD in the link list or link pack area on your pre-z/OS Version 1 Release 6 systems, you will need to make separate copies of the WebSphere Application Server cataloged procedures to use on your z/OS systems at Version 1 Release 6 and above.

Select one of the following options.

  • If SIEALNKE is in the link list or link pack area on your z/OS systems at Version 1 Release 6 and above, remove SGSKLOAD from the STEPLIB concatenation in each cataloged procedure, and remove SGSKLOAD from the STEPLIB variable in each <WAS_home>/bin/setupCmdLine.sh script for those nodes running on z/OS Version 1 Release 6 (or above) systems.
  • If SIEALNKE is not in the link list or link pack area on your z/OS systems at Version 1 Release 6 and above, change the SGSKLOAD reference in the STEPLIB concatenation in each cataloged procedure to SIEALNKE, and change the SGSKLOAD reference in the STEPLIB variable in each <WAS_home>/bin/setupCmdLine.sh script to SIEALNKE, for those nodes running on z/OS Version 1 Release 6 (or above) systems.

Note: Do not modify setupCmdLine.sh except as directed by product documentation or by service personnel. In particular, do not move lines around or comment them out. This might cause problems with post-installer scripts that update setupCmdLine.sh and other files as needed. If you need to remove data set names from the STEPLIB variable, be sure to leave at least one STEPLIB= line in the OS/390 section: STEPLIB=$STEPLIB

Specify the following WebSphere Application Server for z/OS libraries so they can be accessed by the customized job streams the Dialog produces. These data sets must be cataloged.

SBBOEXEC
WebSphere Application Server for z/OS variable length file distribution PDS you installed through SMP/E.
SBBOMSG
SBBOMSG WebSphere Application Server for z/OS message skeletons for language translation you installed through SMP/E.

System Locations (2 of 2)

Locations of HFS Resident Components:

WebSphere Application Server SMP/E home directory
The name of the directory where WebSphere Application Server for z/OS files reside after SMP/E installation.
WebSphere JMS Client Java Feature SMP/E home directory
The name of the directory where the JMS client Java feature files reside after SMP/E installation.
Java home directory
The name of the directory where the Java SDK files reside after SMP/E installation.

2 System Environment Customization

System Environment Customization (1 of 4)

WebSphere Application Server Configuration HFS Information

Mount point
Read/write HFS directory mount point where application data and environment files are written. The customization process creates this mount point, if it did not already exist.
Name
Hierarchical File System data set mounted at the above mount point.

Rule: You can specify up to 42 characters for the data set name.

Volume, or '*' for SMS
Specify either the DASD volume serial number containing 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.

System Environment Customization (2 of 4)

WebSphere Error Log Stream Information

Note: Having the error log in the log stream is optional. By default, the error log is written to JES SYSOUT.

Name
Name of your WebSphere error log stream that is created.

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 your log stream data set name and staging data set name that is created.
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 Log Stream Information

If you do not have the RRS log streams set up, the Customization Dialog will create the jobs you can use to set up the log streams.

Group name
Specify the XCF group name.

Recommendation: Use your cell 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 answer " Y", the Dialog copies the ATRRRS cataloged procedure into SYS1.PROCLIB so that RRS can be started.

If you already have RRS set up, specify " N".

System Environment Customization (3 of 4)

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 "cell short name."

CTRACE Writer Definitions

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 1 to 7 characters.

User ID
RACF user ID to be created and associated with the CTRACE external writer start procedure.
Group
RACF group name to be created and associated with this user.

Trace Data Set Information

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 Dialog is running.

Rules:

  • You can specify up to 42 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.

System Environment Customization (4 of 4)

Logging Details for Transaction XA Partner Log

Use Log stream (Y|N)
Indicates whether the XA partner log is located in the file system or in a logstream. 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. However, if you choose "N" to put the partner log in the file system, no further modification is required on this panel, and the XA logs will be written to the file system at the default location (/install root/AppServer/recoveryLogs), or at the value of $TRANLOG_ROOT.

Log Stream Information

Name HLQ
Name that becomes the first qualifier in the name of the log stream.

Note: No two servers may 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.

The remainder of the logstream name consists of the server short name, followed by an M or D (short for Main and Delayed streams). For example, if the HLQ is HLQ and server name is BBOS001, 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.

Rule: The name can be 1 to 8 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 1 to 8 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: logstream 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 logstream the same size as your RRS (Resource Recovery Services) main and delayed logstreams.
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.

3 Server Customization

Server Customization (1 of 4)

Application Server Definitions

Rule: In the following, unless specified otherwise, names must be 8 or fewer characters.

WebSphere Application Server home directory
Directory in which the Application Server configuration resides.

Note: You can alter only the portion after "/WebSphere/V5R0M0."

Cell name (short)
Parameter passed to the server's start procedures that specifies the location of the cell's configuration files and identifies the cell to certain WebSphere Application Server for z/OS-exploited z/OS facilities (for example, SAF).

Note: If WebSphere Application Server 5.0 is already installed and you are installing WebSphere Application Server 5.1, the cell short name should be unique.

Rules:

  • Name must be 8 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 and also appears as part of the directory path under the WebSphere Application Server for z/OS home's configuration directory.

Note: If you intend to ever add this base server node to a deployment manager cell, ensure that the base server cell name is different than the deployment manager cell name.

Rules:

  • Name must be 60 or fewer characters and can be of mixed case.
  • Name must be unique among all other cells in the sysplex.

Node name (short)
Parameter passed to the server's start procedures that specifies the location of the node's configuration files and identifies the node to certain WebSphere Application Server for z/OS-exploited z/OS facilities (for example, SAF).

Rules:

  • Name must be 8 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 and also appears as part of the directory path under the WebSphere Application Server for z/OS home's configuration directory.

Note: If you intend to ever add this base server node to a deployment manager cell, ensure that all the nodes in the deployment manager cell are unique.

Rules:

  • Name must be 60 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 may exist on the same node as the Application Server.

Server name (short)
Name of the Application Server. This is the server's job name, as specified in the MVS START command JOBNAME parameter. This value is also passed as a parameter to the server's start procedures to specify the location of the server's configuration files and identify the server to certain WebSphere Application Server for z/OS- exploited z/OS facilities (for example, SAF).

Note: The server short name is used as the server JOBNAME.

Rule: Name must usually contain 7 or fewer all-uppercase characters. If you wish to instead specify 8 characters, you must follow the steps outlined in the Information Center article "Converting a 7-character jobname to 8 characters."

Note: When you define a server, its server short name receives a default prefix of BBO* and a corresponding RACF BBO* profile is created. During installation, if you change the server short name to use a prefix other than BBO*, you must create your own non-default RACF profile using the non-default prefix. See RACF server class profiles for information on creating your own RACF profile and Understanding System Authorization Facility profile names generated by the Customization Dialog for information on how the Customization Dialog manages SAF profiles.

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 and also appears as part of the directory path under the WebSphere Application Server for z/OS home's configuration directory.

Rule: Name must be 60 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.

Rule: Name must be 8 or fewer characters and all uppercase.

Admin asynch operations procedure name
Specifies the JCL procedure name of a started task that is launched via the START command by node agents and/or Application Servers to perform certain asynchronous administrative operations (such as node synchronization) and add and remove a node.

Server Customization (2 of 4)

Application Server Definitions

Rule: In the following, unless specified otherwise, names must be 8 or fewer characters.

Note: If you wish to specify jobnames with 8 instead of 7 characters, you must follow the steps outlined in the Information Center article "Converting a 7-character jobname to 8 characters."

Controller Information

Jobname
The jobname, specified in the MVS START command JOBNAME parameter, associated with the Application Server controller.
Procedure name
Name of member in your procedure library to start the Application Server controller.

Rule: Name must be 7 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 may 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 job name specified in the IWMSSNM parameter of the WLM Application Environment for the server.
Procedure name
Name of member in your procedure library to start the Application Server servant.

Rule: Name must be 7 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 may 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.

Server Customization (3 of 4)

Application Server Definitions

Rule: In the following, unless specified otherwise, names must be 8 or fewer characters.

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.

DRS Client Address port
Port address for access to the server's data replication service. This is important for configurations that define replication groups.

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 which 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.

Server Customization (4 of 4)

Location Service Daemon Definitions

Rule: In the following, unless specified otherwise, names must be 8 or fewer characters.

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.
Daemon job name
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 second cell, ensure you change the daemon job name from the default or value you used for the first cell.

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 7 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.

Port
The port number on which the location service daemon listens.
SSL Port
The port number on which the location service daemon listens for SSL connections.

Note: Select the IP name and port number for the location service daemon carefully. You can choose any name you want, but, once chosen, it is difficult to change, even in the middle of customization.

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.

4 View Security Domain Configuration Panels

This panel displays values you previously set in the "Configure security domain" option--you can not change any of the values here. If you do wish to make changes, you must go back to the main Dialog panel and run through the "Configure security domain" option again.


Related concepts
Setting up WebSphere Application Server for z/OS security
Related tasks
Warning: no string named [tins_dialogdefvarsteps] found.
Related reference
Define variables to configure base Application Server node - worksheets



Searchable topic ID:   rinsdefvar2def
Last updated: Jun 21, 2007 9:56:50 PM CDT    WebSphere Application Server for z/OS, Version 5.0.2
http://publib.boulder.ibm.com/infocenter/wasinfo/index.jsp?topic=/com.ibm.websphere.zseries.doc/info/zseries/ae/rins_defvar2def.html

Library | Support | Terms of Use | Feedback