Scripting Tool for WebSphere Application Server

Building the WebSphere Application Server Cell on Another Machine

Some sites separate the administration of SAS applications and the administration of Web application servers. For sites that do not permit running the SAS Deployment Wizard on the Web application server machine, the configuration scripting tool can be used to configure WebSphere Application Server.. The configuration scripting tool is archived from the machine where the SAS Deployment Wizard was run and provided to the Web application server administrator. The configuration scripting tool can configure a cell, deployment manager, profiles, and servers, identically to what is created with an automated deployment with SAS Deployment Wizard. The configuration scripting tool is located in SAS-config-dir\Lev1\Web\Scripts\WebSphere\Scripts. The name of the command is WASDriver.bat. For UNIX deployments, the command is named WASDriver.sh.

The configuration scripting tool reads the commands listed in the SAS-config-dir\Lev1\Web\Scripts\WebSphere\tasks\websphere.configure.tasks file and then performs the tasks. Each command in the websphere.configure.tasks file, such as create JDBCProvider, uses the properties files that are stored in SAS-config-dir\Lev1\Web\Scripts\WebSphere\props to determine how to configure the resource.

If the Cache Credentials check box was not selected on the Web Application Server: Scripting Configuration page in the SAS Deployment Wizard, then you are prompted for credentials when you run the WASDriver.bat command.

On the Web application server machine, create the directory structure that was used on the machine where the SAS Deployment Wizard was run. The following commands are examples for a Windows environment:
```
mkdir c:\SAS\Config\Lev1\Web\Staging
mkdir c:\SAS\Config\Lev1\Web\Scripts
mkdir c:\SAS\Config\Lev1\Web\Common
mkdir c:\SAS\Config\Lev1\AppData
```
Note: These directory paths must be archived from the machine where the SAS Deployment Wizard was run. The archive must be transferred to the Web application server machine.
Extract the archive into the directories that were created in the previous step.
Open the Scripts\WebSphere\props\global.properties file in a text editor. Review the properties to make sure that values for the JDK path, WebSphere Application Server installation path, host names, and ports are accurate.
Begin the configuration by running Scripts\WASDriver.bat.

If the Cache Credentials check box was not selected on the Web Application Server: Scripting Configuration page in the SAS Deployment Wizard, monitor the progress because the tool prompts you for credentials. The following code is an example:
```
[12/19/11 12:28:28:181 EST] - WASDriver-prepareTask: Task(s) to be 
executed  indicate operations on resourceType(s) require userIds and passwords
for authentication...

*=*=*=*=*=*=*  BEGIN Prompting for credentials *=*=*=*=*=*=*

----------------------------------------------------------------------------
Please enter credentials for: Data Source "SASServer1-SharedServices" 
database Connection
Enter username:
```

When the configuration scripting tool is used to create the WebSphere Application Server cell, after the script completes, the environment is configured with all the resources that are needed for the SAS Web applications. The configuration scripting tool deploys the applications, but it does not start the servers.

After the configuration scripting tool runs and WebSphere Application Server is configured, some additional tasks must be performed manually on the machine where the SAS Deployment Wizard was run. (For a multiple-machine deployment, this is the machine where the middle-tier configuration was performed.) These tasks are recorded in the Instructions.html file that is generated by the SAS Deployment Wizard. Before you perform those tasks, confirm or correct the JDK_HOME environment variable that is identified in SAS-config-dir\Lev1\level_env.bat. For UNIX deployments, the file is named level_env.sh. Open the file in an editor and make sure that the value for JDK_HOME identifies the path to a JDK or JRE.

Rebuilding the WebSphere Application Server Configuration

You can rebuild the WebSphere Application Server configuration by running the configuration scripting tool. The tool can re-create the entire WebSphere Application Server configuration and restore it to the originally configured state. The tool reads the commands in the task files and configures the resources according to the settings in the properties files.

Adding, Updating, and Upgrading SAS Software

If the SAS Deployment Wizard runs to add, update, or upgrade SAS software that affects WebSphere Application Server, a backup of the configuration scripting tool is made. For example, the contents of SAS-config-dir\Lev1\Web\Scripts\WebSphere are backed up to directory like SAS-config-dir\Lev1\Web\Scripts\WebSphere_2011-05-20-14.21.56_bak. The original directory is then re-created, and configuration scripting tasks and properties are set for the additional software, update, or upgrade.

Executing an Alternative Batch Script

The WASDriver.bat command is configured to execute the commands in the websphere.configure.tasks file. You can override this behavior and supply the name of a file that contains the commands that you want to execute. The following steps describe how run in batch mode with the commands in the cmds.txt file:

Create a text file that is named SAS-config-dir\Lev1\Web\Scripts\WebSphere\tasks\cmds.txt. Include commands that are similar to the following example:
```
undeploy Application SASThemes9.3 SERVER
deploy Application SASThemes9.3 SERVER
```
Tip
Put the commands file in the tasks directory. The WASDriver.bat file does not accept the fully qualified pathname to the commands file. It accepts the name of the commands file that must be in the tasks directory.
Invoke the command with the following command line options:
```
WASDriver.bat -e FILE -m AUTO -t cmds.txt
```

If you are creating a resource that requires credentials, such as a data source, remember to create property keys in the Credentials.CELL.credentials.properties file.

Executing a Single Task

You can use the configuration scripting tool to perform a single task. The following command demonstrates how to undeploy SAS Themes for Web Applications:

WASDriver.bat -e RUN -m AUTO -p TEXT -o undeploy -r Application 
-n SASThemes9.3 -s SERVER

Before this operation can run and succeed, a properties file that is named Application.SERVER.SASThemes9.3.properties must exist. This properties file is used by the configuration scripting tool to determine how to undeploy the application.

Tip

The case for the resource type (-r), name (-n), and scope (-s) matter. These arguments are used to locate properties files in the props directory as well as to look up keys within the properties files.

Command Syntax

Four Parts of the Command Syntax

The command syntax in a task file has four parts:

<operation> <resourceType> <resourceName> <scope>

The following example shows the commands for creating a deployment manager profile and a node profile:

create DmgrProfile SASDmgr01 CELL
create NodeProfile SAShostnameNode NODE

Executing a single task uses the same four parts for the command syntax. However, variables are used to indicate the operation, resource type, and so on.

Command Options

The command options for the WASDriver.bat file are provided in the following table:

WASDriver.bat Command Options
Short Option Name	Full Option Name	Required	Values	Description
-h	-help	No	None	Use this option to see the command help.
-e	-execType	Yes	FILE or RUN	Use FILE to execute the tasks that are listed in a task file. Use RUN to execute a single task. FILE is the default value.
-m	-execMode	Yes	AUTO or NOAUTO	Use NOAUTO to check the task syntax and not perform any configuration tasks. Use AUTO to perform the configuration tasks. AUTO is the default value.
-d	-directory	Yes		Provide the fully qualified path to the configuration scripting tool directory. The `props`, `scripts`, and `tasks` directories are subdirectories of the configuration scripting tool directory.
-t	-taskFile	No		Provide the name of the task file to use when the execution mode is FILE. The default value is websphere.configuration.tasks.
-o	-operation	No	create, delete, start, stop, deploy, undeploy, checkAppStatus, syncNode	Provide the operation to perform when the execution mode is RUN.
-r	-resourceType	No		Provide the resource to use when the execution mode is RUN. See the resources in Resource Types, Operations, and Scopes.
-n	-resourceName	No	SASServer1, SAS_Messaging_Bus, and so on	Provide the name of the resource to use when the execution mode is RUN.
-s	-scope	No	SERVER, NODE, or CELL	Provide the scope for the resource to configure when the execution mode is RUN.
-p	-promptMode	No	TEXT or GRAPHIC	Use TEXT to provide a command line prompt for credentials when credentials are not stored in the credentials file. Use GRAPHIC to provide a dialog box for credentials when credentials are not stored in the credentials file.

Resource Types

The following table provides a list of resource types and identifies the operations and scope that apply to the resource type.

Resource Types, Operations, and Scopes
Resource Type	Operations	Scopes
ActivationSpec	create, delete	SERVER, NODE, CELL
Application	deploy, undeploy	SERVER
DataSource	create, delete	SERVER, NODE, CELL
DmgrProfile	create	CELL
JDBCProvider	create, delete	SERVER
JmsConnectionFactory	create, delete	SERVER, NODE, CELL
JmsQueue	create, delete	SERVER, NODE, CELL
JmsTopic	create, delete	SERVER, NODE, CELL
LoginModule	create, delete	CELL
MailSession	create, delete	SERVER, NODE, CELL
NodeProfile	create	NODE
ObjectCache	create, delete	SERVER, NODE, CELL
Server	create, delete	SERVER
SIBus	create, delete	SERVER

Resource Properties Files

Each resource requires a set of properties that define how the configuration scripting tool should configure it. The default location for the properties files is SAS-config-dir\Lev1\Web\Scripts\WebSphere\props. The properties files are named according to the following pattern:

<resourceType>.<scope>.<resourceName>.properties

For example, the Server.SERVER.SASServer1.properties file describes settings for the SASServer1 application server instance. You could change a property such as WC_defaulthost or jvmOptions in the file and then re-create the server by executing only the server creation task. The following command is an example:

WASDriver.bat -e RUN -m AUTO -p TEXT -o create -n SASServer1 -t SERVER

Note: Many properties, such as the Web application server port number, are also stored in the SAS Metadata Server. The configuration scripting tool does not modify values in SAS metadata. Be careful that you do not create an inconsistency with SAS metadata.

Managing Credentials

Credentials are required to configure resources within a CELL, NODE, or SERVER. The following list identifies some of the credentials that might be needed:

WebSphere Application Server console credentials
the SAS trusted user password for SAS Web applications that connect to SAS servers
database credentials for JDBC connections
SMTP mail server credentials, if the SMTP mail server is secured

By default, the SAS Deployment Wizard does not persist any of these credentials. When you run the configuration scripting tool, you are prompted for all credentials that are required to configure the resources. The credentials are temporarily stored in the Credentials.CELL.credentials.properties file. The credentials are removed from the file when the configuration scripting tool exits unless you enabled the Cache Credentials check box on the Web Application Server: Scripting Configuration page in the SAS Deployment Wizard. By default, prompts appear on the command line as each credential is needed. An option is available to display a dialog box that prompts for credentials. To display the dialog box for credential prompts, add the following command option to the WASDriver.bat script:

-p GRAPHIC

If the option to cache credentials was enabled when the SAS Deployment Wizard was run, then the credentials are stored in the Credentials.CELL.credentials.properties file. In this case, the configuration scripting tool reads the credentials from the file rather than prompting for them. When the Update passwords feature of the SAS Deployment Manager is used, the passwords for the login modules and mail sessions are updated in the credentials file. Passwords for data source definitions are not updated.

Log File

Details for the command execution are stored in the SAS-config-dir\Lev1\Web\Scripts\WebSphere\logs\WASDriver.log file. The SAS Deployment Wizard invokes the configuration scripting tool, so this already contains messages for an installed system. This file can be useful for troubleshooting middle-tier configuration tasks performed with the SAS Deployment Wizard and the SAS Deployment Manager.

Properties Reference

Modifying Properties

Be careful when editing properties files. If you make a change to a property in one file, be sure to apply the same change to all occurrences of the property in all properties files.
Do not change the value of properties that are not identified in this document. Some undocumented properties are used for the creation of the Instructions.html file.
An asterisk (^*) beside the property name indicates that the property value is stored in SAS metadata. If you change the property, then you create a difference with the information that is stored in SAS metadata.

Global Properties

The following list defines the properties that are used in the websphere.global.properties file.

appsrvnodename ^*

is the name of the node that contains the WebSphere Application Servers.

appsrvnodermiport ^*

is the RMI port number for the WebSphere Application Server node agent.

appsrvnodesoapport ^*

is the SOAP port number for the WebSphere Application Server node agent.

cellname ^*

is the name of the WebSphere Application Server cell.

config.lev.web.staging.dir ^*

identifies the fully qualified path to the SAS Web application EAR files. This path is SAS-config–dir/Lev1/Web/Staging.

defaultsibusname ^*

is the name for the service integration bus. The default value is SAS_Messaging_Bus.

dmgrhttpport ^*

identifies the port to use for HTTP communication with the deployment manager server. The default value is 9060.

dmgrhttpsport ^*

identifies the port to use for HTTPS communication with the deployment manager server. The default value is 9043.

dmgrnodename ^*

is the name of the node that contains the deployment manager server. The default value is SASDmgr01Node.

dmgrport ^*

identifies the port to use for communication with the deployment manager server. The default value is 9060.

dmgrprofilename ^*

identifies the profile name for the deployment manager server. The default value is SASDmgr01.

dmgrprotocol ^*

identifies the default protocol to use for communication with the deployment manager server. Values are SOAP or RMI. The default value is SOAP.

dmgrrmiport ^*

identifies the RMI port number for the deployment manager server. The default value is 9809.

dmgrrmiprops ^*

identifies the fully qualified path to the sas.client.props file in the deployment manager profile. This file is used to set the RMI properties for the deployment manager server.

dmgrrmitimeout ^*

is the time-out value in seconds for RMI communication from the deployment manager server to the node agent. The default value is 900.

dmgrsoapport ^*

identifies the port to use for SOAP communication with the deployment manager server. The default value is 8879.

dmgrsoapprops ^*

identifies the fully qualified path to the soap.client.props file in the deployment manager profile. This file is used to set the SOAP properties for the deployment manager server.

dmgrsoaptimeout ^*

is the time-out value in seconds for SOAP communication from the deployment manager server to the node agent. The default value is 900.

globalPropsFileName

identifies the fully qualified path to the websphere.global.properties file.

mustCreateDmgrProfile

is a Boolean value. If set to true, then the configuration scripting tool creates the deployment manager profile.

nodermiprops ^*

identifies the fully qualified path to the sas.client.props file in the node profile. This file is used to set the RMI properties for the node.

nodesoapprops ^*

identifies the fully qualified path to the soap.client.props file in the node profile. This file is used to set the SOAP properties for the node.

os.localhost.host.name ^*

is the short host name for the machine where the configuration scripting tool runs.

profilename ^*

is the profile name for the node.

scriptingDirectory

identifies the fully qualified path to the configuration scripting tool for WebSphere Application Server.

webapp.auto_deploy ^*

is a Boolean value. If set to true, then the SAS Web applications are automatically deployed to WebSphere Application Server. If set to false, then you must deploy the SAS Web applications manually.

webappsrv.admin.host ^*

is the fully qualified domain name for the machine that is running the WebSphere Application Server administration server.

webappsrv.admin.security.is_enabled ^*

is a Boolean value. If set to true, then WebSphere Application Server administration security is enabled for the cell.

webappsrv.admin.url ^*

is the URL for the WebSphere Application Server administration console.

webappsrv.auto_configure ^*

is a Boolean value. If set to true, then the configuration scripting tool performs an automatic configuration of an application server instance. If set to false, then you must configure the application server instance manually.

webappsrv.host ^*

is the fully qualified domain name of the machine to configure with the configuration scripting tool.

webappsrv.policy.use_restrictive ^*

is a Boolean value. If set to true, then Java 2 security is enabled for application deployments.

webappsrv.scripting.cache_credentials ^*

is a Boolean value. If set to true, then the credentials that are required for configuring resources are saved in a file.

webappsrv.server.admin.http.port ^*

identifies the port to use for HTTP communication with the deployment manager server. The default value is 9060.

webappsrv.server.admin.https.port ^*

identifies the port to use for HTTPS communication with the deployment manager server. The default value is 9043.

websphere.appsrv.logs ^*

identifies the fully qualified path to the directory for WebSphere Application Server logs.

websphere.dmgr.logs ^*

identifies the fully qualified path to the directory for the deployment manager server logs.

websphere.install.dir ^*

identifies the fully qualified path to the directory where WebSphere Application Server is installed. Set this property to the same value that is used for the WAS_INSTALL_ROOT variable.

websphere.profile.dir ^*

identifies the fully qualified path to the directory where the WebSphere Application Server profiles are stored.

websphere.scripting.classpath

is the class path to use for the configuration scripting tool.

websphere.scripting.credentials

identifies the fully qualified path to the file that contains the credentials (user IDs and passwords) that are required to configure resources.

websphere.scripting.dir

identifies the fully qualified path to the configuration scripting tool for WebSphere Application Server.

websphere.scripting.jython

identifies the fully qualified path to the directory for the Jython procedures.

websphere.scripting.lib

identifies the fully qualified path for directory that contains the JAR file for the configuration scripting tool.

websphere.scripting.logs

identifies the fully qualified path to the directory for the configuration scripting tool logs.

websphere.scripting.props

identifies the fully qualified path to the directory for the configuration scripting tool properties files.

websphere.scripting.scripts

identifies the fully qualified path to the directory for the configuration scripting tool, WASDriver.sh or WASDriver.bat.

websphere.scripting.src

identifies the fully qualified path to the directory for the configuration scripting tool Groovy source modules.

websphere.scripting.tasks

identifies the fully qualified path to the configuration scripting tool tasks directory.

websphere.scripting.tasks.file

identifies the fully qualified path to the configuration scripting tool tasks file.

websphere.temp.dir ^*

identifies the fully qualified path to the temporary directory for the configuration scripting tool.

websphere.wsadmin.classpath

is the class path to use for the WebSphere Application Server wsadmin client application.

websphere.wsadmin.jython

identifies the fully qualified path to the directory for the WebSphere Application Server wsadmin client application Jython procedures.

webspherend.is_installed ^*

is a Boolean value. Set to true if WebSphere Application Server is installed on this machine. Set to false, if it is installed on a remote machine.

wsadminProps

is a string that identifies common command-line options that are used to run the wsadmin client application.

Credentials Properties

The following list defines the properties that are used in the Credentials.CELL.credentials.properties file.

DataSource.create_scope_resource-identifier_passwd

is the data source user password.

DataSource.create_scope_resource-identifier_userid

is the data source user ID.

LoginModule.create_CELL_SAS-Trusted-user_passwd

is the password for the SAS trusted user identity. It is used for creating the JAAS login module.

LoginModule.create_CELL_SAS-Trusted-user_userid

is the user ID for the SAS trusted user identity. It is used for creating the JAAS login module.

MailSession.create_scope_SMTP-Mail-Server_passwd

is password for the user ID that is used to communicate with the SMTP mail server.

MailSession.create_scope_SMTP-Mail-Server_userid

is the user ID that is used to communicate with the SMTP mail server.

Application Properties

This section defines the properties that are needed to deploy a SAS Web application. The properties files are named in the pattern Application.SERVER.applicationName.properties.

appname

is the Web application name.

classloaderMode

identifies the class loader mode. Values are PARENT_LAST or PARENT_FIRST. The default value is PARENT_LAST.

classloaderPolicy

identifies the class loader policy. Values are MULTIPLE or SINGLE. The default value is MULTIPLE.

deployejb

is a Boolean value. If set to true, then Enterprise Java Bean (EJB) support is requested for the installation.

deployws

is a Boolean value. If set to true, then Web services support is requested for the installation.

loadorder

is an integer value that identifies the load order. The default value is 100.

pathtoear

is the fully qualified path to the EAR file for the Web application.

servername

is the name of the target WebSphere Application Server instance where the Web application is installed.

Data Source Properties

This section defines the properties that are needed to configure a data source. The properties files are named in the pattern DataSource.scope.dataSourceIdentifier.properties. For more information about connection pool properties, see the WebSphere Application Server product documentation.

dataSourceIdentifier

is the unique identifier for this datasource.

pCpAgedTimeout

is the value in seconds for the database connection pool aged time-out.

pCpConnectionTimeout

is the value in seconds for the database connection pool time-out.

pCpMaxConnections

is the maximum number of connections for the database connection pool.

pCpMinConnections

is the minimum number of connections for the database connection pool.

pCpPurgePolicy

identifies the database connection pool purge policy.

pCpReapTime

is the value for the database connection pool reap time-out.

pCpTestConnection

is a Boolean value. If set to true, then the database connection pool is tested when it is configured.

pCpTestConnectionInterval

is the value in seconds for the database connection pool testing interval.

pCpUnusedTimeout

is the value in seconds for the time-out that controls when unused connections are returned to the connection pool.

pDsClassName

is the class name for the JDBC provider.

pDsClassPath

is the fully qualified path to each of the JAR files that are required for the JDBC provider.

pDsConnectionUrl

is the JDBC connection URL.

pDsDataSourceName

is the name of the data source.

pDsDatabase

is the database product name.

pDsHelperClass

is the WebSphere Application Server helper class name for the JDBC provider.

pDsHost

is the host name for the machine with the database.

pDsJaasAliasName

is the name that is used to construct a JAAS alias entry. The entry contains the user ID and password for the database connection.

pDsJdbcProviderName

is the name of the JDBC provider that is associated with this data source.

pDsJdbcProviderReuse

is a Boolean value. If set to true, then an existing JDBC provider definition with the same name is reused. If set to false, then the existing definition is deleted and all data sources associated with it, and a new JDBC provider is created.

pDsJdbcProviderType

identifies the JDBC provider type. It is a unique description for the JDBC provider, such as "DB2 Universal JDBC Driver Provider."

pDsJndiName

is the JNDI name for this data source.

pDsOptions

is a comma-separated list of data source options for the data source.

pDsPort

is the port number for the database.

pDsPropEnableMultithreadedAccessDetection

is a Boolean value that controls whether to enable multi-threaded access detection to the database using this data source.

pDsPropPreTestSQLString

is an SQL command that is used to test the database connection.

pDsPropValidateNewConnection

is a Boolean value. If set to true, then the configuration scripting tool attempts to validate the new database connection.

pDsPropValidateNewConnectionRetryCount

identifies the number attempts to perform for validating a new connection.

pDsPropValidateNewConnectionRetryInterval

identifies the number of seconds to wait between attempts to validate a new connection.

pDsStatementCacheSize

identifies the SQL statement cache size.

pDsXADataSource

is a Boolean value. Set to true if the data source supports JDBC XA.

scope

identifies the cope of the data source. Values are CELL, NODE, or SERVER.

servername

is the name of the server configuration where the data source is configured, such as SASServer1, SASServer2, and so on.

Deployment Manager Profile Properties

This section defines the properties that are used with the global properties to configure a WebSphere Application Server deployment manager profile. The properties files are named in the pattern DmgrProfile.CELL.dmgrProfileName.properties. Along with the global properties that are related to the deployment manager, these properties contain information that is needed to configure a WebSphere Application Server deployment manager profile.

BOOTSTRAP_ADDRESS

is the RMI bootstrap address for the deployment manager server.

SOAP_CONNECTOR_ADDRESS

is the SOAP port for the deployment manager server.

WC_adminhost

is the port number for the deployment manager server administrative console.

WC_adminhost_secure

is the port number for secure access to the deployment manager server administrative console.

WC_defaulthost

is the HTTP transport port for the deployment manager server.

WC_defaulthost_secure

is the HTTPS transport port for the deployment manager server.

create.dmgrprofile.response.file

identifies the fully qualified path for the file that contains all the responses that are needed to create a deployment manager profile (dmgr) with the manageprofiles command. For more information, see the description of the create.DmgrProfile.CELL.responsedmgrProfileName.properties file in the next section.

jvmOptions

is the list of JVM options for the deployment manager server.

Deployment Manager manageprofiles Command Response File Properties

The WebSphere Application Server manageprofiles command uses properties from three sources to create the deployment manager server profile:

global properties
deployment manager profile properties
properties in the create.DmgrProfile.CELL.response.dmgrProfileName.properties file

This section defines the properties in the create.DmgrProfile.CELL.response.dmgrProfileName.properties file.

create

must have a null value so that the manageprofiles command creates the deployment manager server profile.

cellName

use the value for cellname from the websphere.global.properties file.

defaultPorts

must have a null value so that the manageprofiles command configures the deployment manager server profile to use the default ports.

isDefault

must have a null value so that the deployment manager server profile becomes the default profile.

nodeName

use the value for dmgrnodename from the websphere.global.properties file.

profileName

use the value for dmgrprofilename from the websphere.global.properties file.

profilePath

concatenate the values for websphere.profile.dir and dmgrprofilename from the websphere.global.properites file. Here is an example:C\:\\Program Files\\IBM\\WebSphere\\AppServer\\profiles\\SASDmgr01.

templatePath

concatenate the values for websphere.install.dir from the websphere.global.properties file with the "profileTemplates\\management." Here is an example:

C\:\\Program
                                    Files\\IBM\\WebSphere\\AppServer\\profileTemplates\\management

winserviceCheck

set to true when the deployment manager server profile is being created on Windows.

winserviceStartupType

set to automatic when the deployment manager server profile is being created on Windows.

JMS Connection Factory Properties

This section defines the properties that are needed to configure a JMS connection factory resource. The properties files are named in the pattern JMSConnectionFactory.scope.jmsConnectionFactoryIdentifier.properties.

SIBusname

is the name of the service integration bus. This property is required if a data source must be constructed as a message data store.

connectionFactoryId

is a unique identifier for this JMS connection factory.

pagedTimeout

is the value in seconds for the JMS connection pool aged time-out.

pconnectionFactoryName

is the JMS connection factory name.

pconnectionFactoryType

is the JMS connection factory type. Values are Queue or Topic.

pconnectionTimeout

is the value in seconds for the JMS connection pool time-out.

pdataSource

is the name of a data source that has already been created. This data source is used as a messaging data store.

pjaasAliasName

is the name of the JAAS alias definition that contains the user ID and password for the data source when a messaging data store is used.

pjndiName

is the JNDI name for this JMS connection factory.

pmaxConnections

is the maximum number of JMS connection pool connections.

pminConnections

is the minimum number of JMS connection pool connections.

pproviderEndPoints

is the JMS provider endpoints string that is used for remote connections.

ppurgePolicy

is the JMS connection pool purge policy.

preapTime

is the value for the JMS connection pool reap time.

pschemaName

is the schema name for the data store when a messaging data source is used.

punusedTimeout

is the JMS connection pool unused connection time-out.

scope

is the scope for this JMS connection factory. Values are SERVER, NODE or CELL.

servername

is the name of the server configuration where the JMS connection factory is configured, such as SASServer1, SASServer2, and so on.

JMS Queue Properties

This section defines the properties that are needed to configure a JMS queue resource. The properties files are named in the pattern JMSQueue.scope.jmsQueueIdentifier.properties.

SIBusname

is the name of the service integration bus to which this JMS queue is associated.

pdeliveryMode

is the type of message delivery for this JMS queue destination. Values are Application, Nonpersistent, or Persistent. The default value is Application.

pjndiName

is the JNDI name for this JMS queue.

ppriority

is an integer between 0 and 9. If a value is not provided, then the priority must be assigned by the producing application.

pqueueName

is the name of the JMS queue.

preadAhead

identifies the read ahead optimization. Values are AsConnection, Enabled, or Disabled. The default value is AsConnection.

psibusdestname

is the service integration bus destination name for this JMS queue.

psibusdesttype

identifies the service integration bus destination type. Set this property to Queue for this resource.

ptimeToLive

is the time that a message has to live.

scope

identifies the scope for this JMS queue. Values are SERVER, NODE, or CELL.

servername

is the name of the server configuration where the JMS queue is configured, such as SASServer1, SASServer2, and so on.

JMS Topic Properties

This section defines the properties that are needed to configure a JMS topic resource. The properties files are named in the pattern JMSTopic.scope.jmsTopicIdentifier.properties.

SIBusname

is the name of the service integration bus to which this JMS topic is associated.

pdeliveryMode

is the type of message delivery for this JMS topic destination. Values are Application, Nonpersistent, or Persistent. The default value is Application.

pjndiName

is the JNDI name for this JMS topic.

ppriority

is an integer between 0 and 9. If a value is not provided, then the priority must be assigned by the producing application.

preadAhead

identifies the read ahead optimization. Values are AsConnection, Enabled, or Disabled. The default value is AsConnection.

psibusdestname

is the service integration bus destination name for this JMS topic.

psibusdesttype

identifies the service integration bus destination type. Set this property to TopicSpace for this resource.

ptimeToLive

is the time that a message has to live.

ptopicSpace

is the name for this topic space. This value is typically the same as the ptopicname value.

ptopicname

is the name of for this topic definition.

scope

identifies the scope for this JMS topic. Values are SERVER, NODE, or CELL.

servername

is the name of the server configuration where the JMS topic is configured, such as SASServer1, SASServer2, and so on.

Login Module Properties

This section defines the properties that are needed to configure a JAAS login module. The properties files are named in the pattern LoginModule.CELL.loginModuleIdentifier.properties.

JaasAlias

is the JAAS alias name for this login module.

JaasAliasDomain

identifies an additional domain to which this login module responds. This property is used when this login module is running in a remote JVM and receives generated credentials from an environment using the trusted authentication module.

JaasCredentialsRequired

is a Boolean value. If set to true, then the login module requires credentials to construct custom properties for the module.

JaasDebug

set this property to true to generate debugging information to the System.out stream.

JaasDomain

identifies the domain in which this login module is authenticating. Requests to authenticate users outside this domain are ignored.

JaasHoldOpenConnection

is a Boolean value. If set to true, then the authentication connection is held open after the login module is driven to avoid TCP/IP overhead.

JaasHost

is the fully qualified domain name for the metadata server. Authentication requests are sent to this host name.

JaasModuleClassName

is the class name for the login module.

JaasModuleFlag

identifies the flag for the login module configuration. Valid values are required, requisite, sufficient, or optional.

JaasPort

identifies the network port that the metadata server is listening on for new connections.

JaasRepository

identifies the repository name to use as the default repository when the connection is returned. For the primary authentication, this repository is usually the foundation repository.

Mail Session Properties

This section defines the properties that are needed to configure a mail session resource. The properties files are named in the pattern MailSession.scope.mailSessionIdentifier.properties.

mailSessionJndiName

is the JNDI name for this mail session resource.

mailSessionName

is the name for this mail session.

mailSessionSmtpHost

is the SMTP host name for this mail session.

scope

identifies the scope for this mail session. Values are SERVER, NODE, or CELL.

server.mailsrv.requires.authentication

is a Boolean value. Set to true if the SMTP server requires credentials for authentication.

servername

is the name of the server configuration where the mail session is configured, such as SASServer1, SASServer2, and so on.

Node Profile Properties

This section defines the properties that are needed to configure a node profile. The properties files are named in the pattern NodeProfile.NODE.profileName.properties.

BOOTSTRAP_ADDRESS

is the RMI bootstrap address for the node agent server.

SOAP_CONNECTOR_ADDRESS

is the SOAP port for the node agent server.

create.nodeprofile.response.file

identifies the fully qualified path to the file that contains all the responses that are needed to create the node profile with the manageprofiles command.

jvmOptions

is the list of JVM options for the node agent server.

Node Profile manageprofile Command Response File Properties

The WebSphere Application Server manageprofiles command uses properties from three sources to create the node profile:

the global properties
the node profile properties file
properties in the create.NodeProfile.NODE.response.profileName.properties file

create

must have a null value so that the manageprofiles command creates the node agent profile.

cellName

use the value for cellname from the websphere.global.properties file

federateLater

must have a value of true so that the manageprofiles command does not federate the node into the cell during the profile creation. The node is automatically federated by the configuration scripting tool with processing that occurs later.

hostname

use the value for webappsrv.admin.host from the websphere.global.properties file.

nodeDefaultPorts

must have a null value to force the manageprofiles command to create the default ports for the nodeagent server.

nodeName

use the value for appsrvnodename from the websphere.global.properties file.

profileName

use the value for profilename from the websphere.global.properties file.

profilePath

use the value for websphere.profile.dir and the value for profilename. Both values are read from the websphere.global.properites file. For example: c\:\\Program Files\\IBM\\WebSphere\\AppServer\\profiles\\SAShost01Node.

templatePath

use the value for websphere.install.dir from websphere.global.properties file and the characters "profileTemplates\\management." For example: c\:\\Program Files\\IBM\\WebSphere\\AppServer\\profileTemplates\\management.

winserviceCheck

used only when the node profile is being created on Windows. This value must be set to true.

winserviceStartupType

used only when the node profile is being created on Windows. This value must be set to automatic.

Server Properties

This section defines the properties that are needed to configure a WebSphere Application Server. The properties files are named in the pattern Server.SERVER.serverName.properties.

BOOTSTRAP_ADDRESS

is the RMI bootstrap address for the Web application server.

SOAP_CONNECTOR_ADDRESS

is the SOAP port for the Web application server.

WC_adminhost

is the port number for the deployment manager server administrative console.

WC_adminhost_secure

is the port number for secure access to the deployment manager server administrative console.

WC_defaulthost

is the HTTP transport port for the deployment manager server.

WC_defaulthost_secure

is the HTTPS transport port for the deployment manager server.

enforceJava2Security

is a Boolean value. Set to true to indicate that Java 2 security must be enforced for all Web applications on this Web application server.

jvmOptions

is the list of JVM options for the Web application server.

scope

set this value to SERVER.

serverid

identifies the server ID of the server configuration where the application is deployed, such as server1, server2, and so on.

servername

identifies the name of the server configuration where the application is deployed, such as SASServer1, SASServer2, and so on.

SIBus Properties

This section defines the properties that are needed to configure the SAS Service Integration Bus. The properties files are named in the pattern SIBus.SERVER.SIBusIdentifier.properties.

SIBusname

is the name for the Service Integration Bus. The default value is SAS_Messaging_Bus.

reuseSIBusMember

is a Boolean value. Set to true to indicate that if a definition with the same name already exists, then reuse the existing definition.

servername

identifies the name of the server configuration where the service integration bus is deployed, such as SASServer1, SASServer2, and so on. The Web application server with the name is added as a new member.