WebSphere Enterprise Service Bus for z/OS, Version 6.2.0 Operating Systems: z/OS


Response file values

When you have run the installation jobs which install the WebSphere® ESB for z/OS® product definitions, sample response files are installed into the installation file system. Copy and edit these response files according to the configuration that you want to achieve, and pass in the response file when you run the augment script.

Purpose

Response files contain keywords that you can use to configure WebSphere ESB. Take a copy of the response file and make the file writeable before you start tailoring it to match the needs of the configuration you are creating. Once you have finished, save your changes.

Use the following rules and guidelines when you are working with response files:
  • Do not leave any extra unreadable characters at the end of the keywords.
  • Use TSO oedit or vi to edit the response file.
  • Start comments on a new line. Do not start the comments to the right of the keyword.
  • Start comments with a number sign (#) in column 1.
  • The response file must be in EBCDIC format. If you prefer to edit the file using your workstation, use the text format during the FTP download and upload.

There are global variables at the beginning of the response file that are referenced by other variables in the file with the dollar sign ($). The serverName variable is an example of a variable that references a global variable.

The following table lists the names of the four sample response files that you can use to create different WebSphere ESB for z/OS configurations.

Table 1.
standAloneProfile.rsp Use this file to create a stand-alone configuration using a Derby™ database. A stand-alone configuration has a single node running an application server and one daemon server in a single z/OS® system or LPAR. Use a Derby database only for a test system.
standAloneProfileDB2.rsp Use this file to create a stand-alone configuration using a DB2® database. A stand-alone configuration has a single node running an application server and one daemon server in a single z/OS® system or LPAR. Use a DB2® database for a production system.
DmgrDB2.rsp Use this file to create a deployment manager server with a network deployment configuration using a DB2® database. A basic network deployment configuration contains a deployment manager server in one node, and an application server in another node. The application server is then federated into the deployment manager cell which allows the application server to be managed by the deployment manager. In a network deployment configuration, both nodes are augmented with WebSphere ESB functions.
ManagedDB2.rsp Use this file to create a node with a network deployment configuration using a DB2 database. A basic network deployment configuration contains a deployment manager server in one node, and an application server in another node. The application server is then federated into the deployment manager cell which allows the application server to be managed by the deployment manager. In a network deployment configuration, both nodes are augmented with WebSphere ESB functions.
The following table alphabetically lists the default response file keywords that you can use to create a WebSphere ESB for z/OS configuration. Many of these keywords default to appropriate values if not set by a response file, and you do not need include all of these keywords in a response file to produce a working installation of WebSphere ESB for z/OS.
Table 2. Alphabetical list of keywords in WebSphere ESB for z/OS response files
-adminPassword The password for the administrative security user ID specified with the -adminUserName keyword. This keyword is required when augmenting an existing profile that has administrative security enabled.
-adminUserName The user ID that is used for administrative security. This keyword is required when augmenting an existing profile that has administrative security enabled.
-augment The augment parameter uses an augmentation template to configure a node with WebSphere ESB for z/OS functions.
-ceiBufferPool4k The name of the 4K buffer pool for the Comment Event Infrastructure. This buffer pool must be active before the database DDL scripts can be run.
-ceiBufferPool8k The name of the 8K buffer pool for the Comment Event Infrastructure. This buffer pool must be active before the database DDL scripts can be run.
-ceiBufferPool16k The name of the 16K buffer pool for the Comment Event Infrastructure. This buffer pool must be active before the database DDL scripts can be run.
-ceiCacheSizeInMB The size of the cache in MB that will be used for transaction logs.
-ceiCreateLogin An optional parameter, which if set totrue results in the creation of the login user ID that will own the Event Service Sybase tables for the Common Event Infrastructure.
-ceiDbAlreadyConfigured A boolean keyword used to specify if the Common Event Infrastructure has already been configured for the profile.
-ceiDbInstallDir The directory where the database is installed for the Common Event Infrastructure.
-ceiDbName The DB2 name for the Comment Event Infrastructure.
-ceiDiskSizeInMB The database size in MB to be created for the Event Service. For DB2 for z/OS, the default value is 10. If you want to specify another value it must be greater than or equal to 10.
-ceiEventCatalogDBName The name of the event catalog database.
-ceiInstancePrefix The prefix used for the cei instance.
-ceiFindDeviceNumber The event database creates six devices for the Comment Event Infrastructure. This keyword identifies the value of the first device number that should be assigned to the new devices. The default value is 10 if not specified.
-ceiOverrideDataSource The keyword that indicates whether or not to remove any existing Common Event Infrastructure service data source at the specified scope before creating a new one. When this keyword is set to true, the command removes any existing Common Event Infrastructure service data source at the specified scope before creating a new one. When this keyword is set to false, the command does not create an event service data source at the specified scope if another event service data source is found at the same scope. The default value is false if not specified.
-ceiOracleHome (Deprecated) The directory of the ORACLE_HOME.
-ceiSaUser The Microsoft SQL Server ID that has privileges to create tables, devices, and caches for the Common Event Infrastructure.
-ceiSaPassword The password for the Microsoft SQL Server ID that has privileges to create tables, devices, and caches for the Common Event Infrastructure. This keyword is required if you specify a value for the ceiSaUser keyword, unless the sa user ID does not have a password.
-cellName The cell name of the profile. This must match the cell name of the WebSphere Application Server profile that you want to augment. The value for this keyword must not contain spaces, commas or any characters that are not valid such as the following: /, \, *, :, ;, =, +, ?, |, <, >, &, %, ', ", ]]&gt, #, $, ^, {, or }. A period (.) is not valid if it is the first character."
-configureBSpace The keyword that determines whether or not to configure the Business Space. The default value is false.
-dbAlreadyConfigured A boolean keyword used to specify if the database has already been configured.
-dbAppMeUserId The user ID required for authentication if messaging engines use the common DB.
-dbAppMePassword The password required for authentication if messaging engines use the common DB.
-dbCeiMeUserId The user ID required for authentication if the CEI messaging engines use the common DB.
-dbCeiMePassword The password required for authentication if CEI messaging engines use the common DB.
-dbCommonForME The keyword that indicates whether to use the common database for the messaging engine tables. The default value is false. If you set this keyword to true the common database is used for the messaging engine tables which must be manually created in the common database. See Creating the messaging engine data stores for more information.
-dbConnectionLocation The location of DB2 for z/OS database.
-dbCeiUserId The user ID required for authentication of the CEI database.
-dbCommonUserId The user ID required for authentication of the common database.
-dbCeiPassword The password required for authentication of the cei database.
-dbCommonPassword The password required for authentication of the common database.
-dbCreateNew A boolean flag to indicate whether to create a new database in which to store the Common DB, or whether to use an existing database.
-dbDelayConfig The keyword that indicates whether to postpone table creation until after the profile is created. Valid values are true or false. This keyword is set to false by default. Whether you set this keyword to true or false depends on your configuration. If you have all the necessary databases set up and ready you can set -dbDelayConfig to true. If you do not have all the necessary databases set up and ready you can set -dbDelayConfig to false and set up the databases after augment.
-dbDriverType The database driver type. For Oracle databases, valid values are THIN or OCI. For DB2 databases, valid values are 2 or 4.
-dbHostName The database server host name or IP address. The default value is localhost.
-dbJDBCClasspath The JDBC class path required for the common DB.
-dbInstance The database instance name for Informix databases.
-dbLocation The location of the database server (database product installation root).
-dbName The name of the WebSphere ESB database. The value is set to WPRCSDB by default.
-dbOutputScriptDir The directory location of the output script.
-dbPassword The password required for database authentication. This keyword is required for all databases except Derby embedded.
-dbSchemaName The name of the database schema.
-dbServerPort The database server port number. Depending on the database you are using, you can specify a different port number instead of the default port number which is 446.
-dbStorageGroup The name of the storage group for the DB2 for z/OS databases.
-dbSysMeUserId The database system messaging engine user ID.
-dbSysMePassword The database system messaging engine password.
-dbSysUserId The user ID to gain access to the database.
-dbSysPassword The password to gain access to the database.
-dbType The database type. Set one of the following values for the type of database product you are using with the WebSphere ESB database:
  • DERBY_EMBEDDED for a Derby Embedded database
  • DB2UDBOS390_V8_1 for a DB2 for z/OS v8 database
  • DB2UDBOS390_V9_1 for a DB2 for z/OS v9 database
-dbUserId The user ID that is required for database authentication. This keyword is required for all databases except Derby embedded.
-dmgrAdminPassword The password that gains the user administration access rights to the system in which the deployment manager is running.
-dmgrAdminUserName The user name that gains the user administration access rights to the system in which the deployment manager is running.
-dmgrHost

The keyword that identifies the system in which the deployment manager is running. Specify this keyword with the dmgrPort keyword to federate an empty node when it is created. The host name can be the long or short DNS name or the IP address of the deployment manager system. Specifying this optional keyword directs the configuration process to attempt to federate the empty node into the deployment manager cell when it creates the empty node.

This keyword is ignored when creating a deployment manager or an application server. If you federate an empty node when the deployment manager is not running or is not available because of security being enabled or for other reasons, the installation indicator in the logs is INSTCONFFAIL to indicate a complete failure. The resulting empty node is unusable. You must move the empty node's profile directory out of the profile repository (the profiles installation root directory) before creating another empty node with the same name.

If you have enabled security or changed the default JMX connector type, you cannot federate during the configuration process. Use the addNode command instead. The default value for this keyword is localhost. The value for this keyword must be a properly formed host name and must not contain spaces or characters that are not valid such as the following: *, ?, ", V, < , >, , , /, \, |, A connection to the deployment manager must also be available in conjunction with the dmgrPort keyword. For example dmgr_host_name.

-dmgrPort The keyword that identifies the SOAP port of the deployment manager. Specify this keyword with the dmgrHost keyword to federate an empty node when it is created. The deployment manager must be running and accessible. If you have enabled security or changed the default JMX connector type, you cannot federate during the configuration process. Use the addNode command instead. The default value for this keyword is 8879. The port that you indicate must be a positive integer and a connection to the deployment manager must be available in conjunction with the dmgrHost keyword. For example dmgr_port_number.
-enableAdminSecurity The keyword that enables administrative security. Possible values are:
  • True - when enableAdminSecurity is set to true you must also specify the keywords -adminUserName and -adminPassword along with the values for these keywords.
  • False - when enableAdminSecurity is set to false, you do not have to set any keywords.
The default value is false.
-federateLater The keyword that indicates if the managed node will be federated during profile creation or if you will federate it later using the addNode command. If the dmgrHost,dmgrPort,dmgrAdminUserName and dmgrAdminPassword keywords have values, the default value for this keyword is true. Valid values are true or false.
-federateLaterBPC The keyword that indicates if the managed node will be federated during profile creation or if you will federate it later during BPC configuration. Valid values are true or false.
-federateLaterSOACore The keyword that indicates if the managed node will be federated during profile creation or if you will federate it later during SOA core configuration. Valid values are true or false.
-federateLaterWESB The keyword that indicates if the managed node will be federated during profile creation or if you will federate it later using the managed.esbserver template. Valid values are true or false.
-fileStoreForME The location of the file store for messaging engines. This keyword applies to stand-alone server configurations only. Default value is false, cannot be set to true when -dbCommonForME is also set to true.
-isDeveloperServer Specifies whether the server is intended for development purposes only.
-portsFile An optional keyword that specifies the path to a file that defines port settings for the new profile.
-profileName The keyword used to augment a profile. The profile is always named default in each of the configurations. The profile must not have already been federated. When augmenting the profile the server must not be running.
-profilePath The default profile root directory for WebSphere Application Server for z/OS. This keyword is mandatory. The server configuration for WebSphere Application Server for z/OS resides in a directory structure under a profiles directory. The profile path contains the files that define the runtime environment, such as commands, configuration files, and log files. Specify the full path to avoid an Apache Ant scripting limitation which can cause a failure when federating the profile into a cell. If not specified, the augment procedure looks up the path where the profile resides in the WebSphere Application Server for z/OS configuration, for example:
  • Stand-alone Derby=/WebSphere/V6R2/AppServer/profiles/default
  • Stand-alone DB2=/WebSphere/V6R2/AppServer/profiles/default
  • Network Deployment=/WebSphere/V6R2/DeploymentManager/profiles/default
  • Managed node in Network Deployment=/WebSphere/V6R2/AppServer/profiles/default.
-serverNameplatform The name of the platform in which the server is running.
-soaCoreAugmentType The keyword that specifies the type of SOA core augment information.
-topologyPattern The keyword that determines the topology patterns for your deployment manager: none (default value), CondensedSync, CondensedAsync or Reference.
-topologyRole The keyword that indicates the function the profile will play in the deployment environment, when you are federating a profile that has been created. Valid values are ADT for a deployment target, Messaging for host messaging or Support for supporting services. You can indicate one value or more than one value, each separated by a space, for example ADT Messaging Support or Messaging or ADT Support.

Using response files

  • Be careful when you add comments to a response file.
    If you put comments in the response file, and that comment resides on the same line as a property value, even if you precede the comment with a cross hatch character (#), the Ant script attempts to read the comment as part of the keyword value, causing unpredictable results. For example, do not enter comments as shown in this example:
    ################################################################################
    # DB2 Properties
    ################################################################################
    dbJDBCClasspath=/shared/db2810/jcc/classes    # DB2 ClassPath Location
    dbJDBCProperties=/u/hutch/wpswork/            # DB2JccConfiguration.properties 
    The correct way to add comments shown in the sample above would be as follows:
    ################################################################################
    # DB2 Properties
    ################################################################################
    # DB2 ClassPath Location
    dbJDBCClasspath=/shared/db2810/jcc/classes  
    # DB2JccConfiguration.properties   
    dbJDBCProperties=/u/hutch/wpswork/  

Global properties

The start of the response file contains a section named GLOBAL Properties. Here is an example:
################################################################################
# GLOBAL Properties
################################################################################
JMSUSER=ibmuser
JMSPASS=ibmuser
DBUSER=wsadmin	
DBPASS=wsadmin
CONFIGSERVER=server1
DBLOCATION=LOC1

################################################################################

The GLOBAL Properties section provides a central location for common values. Common values are displayed in multiple places in the response file because they are used by multiple components. The GLOBAL Properties section provides a central location for these common values to help you editing these values. For example, you can use a global property to set all the server property instances to server1 instead of searching the response file for all instances of the property that you want to change.

Use the GLOBAL property by specifying the global keyword prefixed with the $ symbol as the value for the subsequent property. For example, serverName=$CONFIGSERVER.

Global properties must physically appear in the response file before they are referenced by the $ symbol.

When a global property is used, it must constitute the whole value of a property. The following example is NOT allowed:
templatePath=/usr/$USERPATH/dir

Global properties simplify the use of the override argument (-Z ) in the product configuration command by reducing the amount of syntax on the command line.

Comments for a property display above the property, the property name and the default value are displayed in bold text. The following is an example of a property:
################################################################################
#
# Profile name
#
# On z/OS, there is always one and only one profile and that profile is named
# default in each of the configurations.
#
# The profile referred to here is the default profile installed and 
# and configured during the WebSphere Application Server for z/OS install.
#
profileName=default

reference Reference topic

Terms of use | Feedback


Timestamp icon Last updated: 21 June 2010


http://publib.boulder.ibm.com/infocenter/dmndhelp/v6r2mx/topic//com.ibm.websphere.wesb620.zseries.doc/doc/rins_zos_sampresp.html
Copyright IBM Corporation 2005, 2010. All Rights Reserved.
This information center is powered by Eclipse technology (http://www.eclipse.org).