bpeconfig.properties

 

+

Search Tips   |   Advanced Search

 

 

#***********************************************************************************
###
### Properties for batch (silent) mode of bpeconfig.jacl.
###
### DISCLAIMER: The information in this file may be incomplete or even incorrect.
### Not everything that can be done in interactive mode can be specified on the
### command line in silent mode. In particular it is currently not possible to
### configure several application servers in an ND environment from the command
### line.
###
### The key names are the same as the command line parameter names, for example
###   dbType=DB2
###   dbUser=db2admin
###   :
### corresponds to
###   wsadmin -f bpeconfig.jacl -dbType DB2 -dbUser db2admin ...
###
### This can be used to invoke bpeconfig.jacl with the <wsadmin> Ant task:
###   <property file="bpeconfig.properties" prefix="bpe"/>
###   <wsadmin script="bpeconfig.jacl"
###            conntype="NONE"
###            user="user ID to authenticate with"
###            password="password to authenticate with">
###     <arg value="-dbType"/>
###     <arg value="${bpe.dbType}"/>
###     <arg value="-dbUser"/>
###     <arg value="${bpe.dbUser}"/>
###     :
###   </wsadmin>
###
### bpeconfig.jacl always writes a log file, <was_install_root>/logs/bpeconfig.log.
### Check this file first when in doubt what exactly bpeconfig.jacl did and why.
###
#***********************************************************************************

#-----------------------------------------------------------------------------------
### This file contains the english description only.
### For more details visit: http://url
#-----------------------------------------------------------------------------------

#-----------------------------------------------------------------------------------
### IMPORTANT NOTES:
###
### 1.
### The following properties are mandatory and have to be set:
### a) node and server OR cluster (unless there is exactly one node with exactly one server)
### b) adminBFMUsers and adminBFMGroups
### c) adminHTMUsers and adminHTMGroups
### d) monitorBFMUsers and monitorBFMGroups
### e) monitorHTMUsers and monitorHTMGroups
### f) jmsBFMRunAsUser and jmsBFMRunAsPwd 
### g) jmdHTMRunAsUser and jmdHTMRunAsPwd
### h) dbType
### i) mqType
### j) mqUser and mqPwd
###
### 2.
### Regarding all database related properties:
### A database property has only to be specified if the used database system is mentioned 
### in the comment above the corresponding property.
### If the used database system is not mentioned in the comment above a property, the 
### property does not have to be set.
###
### 3.
### Process choreographer cannot automatically be configured in a cluster using this
### properties file and the corresponding bpe-config task.
### The interactive mode of bpeconfig.jacl must be used.
###
#-----------------------------------------------------------------------------------

#-----------------------------------------------------------------------------------
### The node name and the server name where to configure process choreographer.
### If there is exactly one node and exactly one server, these properties
### need not be set. If there is more than one server, then both properties must be
### set unless the "cluster" property is used.
### If nothing is specified the node name and the server name are auto-detected.
node=
server=

#-----------------------------------------------------------------------------------
### The user names and group names from the user registry to map the
### "BPESystemAdminstrator" J2EE role to. The separator character is "|". These
### properties are needed for installing the business process container.
### They have no default value. At least one of the two must be set.
adminBFMUsers=wpsbind
adminBFMGroups=wpsadmins

#-----------------------------------------------------------------------------------
### The user names and group names from the user registry to map the
### "TaskSystemAdminstrator" J2EE role to. The separator character is "|". These
### properties are needed for installing the task container.
### They have no default value. At least one of the two must be set.
adminHTMUsers=wpsbind
adminHTMGroups=wpsadmins

#-----------------------------------------------------------------------------------
### The user names and group names from the user registry to map the
### "BPESystemMonitor" J2EE role to. The separator character is "|". These
### properties are needed for installing the business process container.
### They have no default value. At least one of the two must be set.
monitorBFMUsers=wpsbind
monitorBFMGroups=wpsadmins

#-----------------------------------------------------------------------------------
### The user names and group names from the user registry to map the
### "TaskSystemMonitor" J2EE role to. The separator character is "|". These
### properties are needed for installing the task container.
### They have no default value. At least one of the two must be set.
monitorHTMUsers=wpsbind
monitorHTMGroups=wpsadmins

#-----------------------------------------------------------------------------------
### The "run-as" user id and password for the process container JMS API (MDB). These
### properties are needed for installing the business process container.
### They have no default value and must be set.
jmsBFMRunAsUser=wpsbind
jmsBFMRunAsPwd=

#-----------------------------------------------------------------------------------
### The "run-as" user id and password for the task container MDB. These
### properties are needed for installing the task container.
### They have no default value and must be set.
jmsHTMRunAsUser=wpsbind
jmsHTMRunAsPwd=

#-----------------------------------------------------------------------------------
### The virtual host where the BPC explorer should run.
### The default value is "default_host"
hostName=

#-----------------------------------------------------------------------------------
### The URL of the BPC explorer. If not specified, a default will be computed in
### non-cluster environments. For example, http://localhost:9080. This setting is used
### to fill the "EscalationMail.ClientDetailURL" custom property of the human task
### manager.
explorerHost=

#-----------------------------------------------------------------------------------
### The type of the process choreographer database. It is needed for installing the
### business process container, for creating the database or database tables and for
### creating the DataSource.
### It has no default value. Allowed values are:
### z/OS: "zOS-DB2" "Cloudscape"
### iSeries: "iSeries-DB2"
### Other platforms: "DB2" "zOS-DB2" "iSeries-DB2" "Informix" "Sybase" "Oracle" 
###                  "MSSQL" "Cloudscape"
### Note: Cloudscape is not supported in an ND environment.
### Note: iSeries-DB2, zOS-DB2, and Sybase are not supported in BPC 6.0 and BPC 6.0.1.
dbType=Cloudscape

#-----------------------------------------------------------------------------------
### The version of the database system. Depends on the database type (dbType). It is
### needed for installing the business process container and for creating the database
### or the database tables.
### It has no default value. Allowed values are:
### zOS-DB2: "7" "8"
dbVersion=

#-----------------------------------------------------------------------------------
### The installation directory of the database system. It is needed for creating the
### database or the database tables and for creating the DataSource.
### Note: Where needed, the default location of the JDBC driver is implicitly derived
### from this setting.
### Note: For DB2, the directories ${dbHome}/bnd and ${dbHome}/bin must exist.
### Note: For Oracle, the file ${dbHome}/jdbc/lib/odbc14.jar must exist.
### Note: For Sybase, the file ${dbHome}/jConnect-*/classes/jconn2.jar must exist.
### Note: For Informix, the file ${dbHome}/jdbc/lib/ifxjdbc.jar must exist.
### Default values are:
### DB2 on Windows: <current drive>/Program Files/IBM/SQLLIB
### DB2 on SunOS: /export/home/${dbUser}/sqllib
### DB2 on other platforms: /home/${dbUser}/sqllib (if the DB is on iSeries, this is only needed for the remote client system)
### Oracle on Windows; c:/oracle/ora90
### Oracle on SunOS / HP-UX: /opt/oracle
### Oracle on other platforms: /usr/oracle
### Sybase on Windows; <current drive>/Program Files/Sybase
### Sybase on SunOS / HP-UX: /opt/sybase
### Sybase on other platforms: /usr/sybase
### Informix on Windows: <current drive>/Program Files/Informix
### Informix on SunOS / HP-UX: /opt/informix
### Informix on other platforms: /usr/informix
dbHome=

#-----------------------------------------------------------------------------------
### The installation directory of the JDBC driver. It is needed for creating the
### iSeries-DB2 DataSource, the Oracle DataSource, or the MSSQL DataSource
### (only when using the "DataDirect" driver type), and when using a type 4 driver
### for DB2 or zOS-DB2.
### For iSeries-DB2 or MSSQL, it has no default value.
### For DB2 and zOS-DB2 the default value is ${dbHome}/java.
### For Oracle, the default is ${dbHome}/jdbc/lib
dbJava=

#-----------------------------------------------------------------------------------
### The name of the process choreographer database. It is needed for creating the
### database or the database tables and for creating the DataSource. For Oracle, this
### is the TNS.
### The default values are:
### DB2 on iSeries: "*LOCAL/BPEDB"
### All other platforms: "BPEDB"
dbName=

#-----------------------------------------------------------------------------------
### The user id and password to access the process choreographer database. It is
### needed for creating the database tables and for creating the DataSource.
### Default values for dbUser are:
### DB2 on Windows: "db2admin"
### DB2 on other platforms: "db2inst1"
### Oracle: "system"
### Sybase on Windows: <currently logged on user>
### Sybase on other platforms: "sa"
### MSSQL: <currently logged on user>
### Informix: "informix"
dbUser=
dbPwd=

#-----------------------------------------------------------------------------------
### The database administrator id. For some database types it is needed on Unix
### platforms for creating the database or the database tables (the appropriate
### command is executed on behalf of this user).
### Default values are:
### zOS-DB2: "db2inst1"
### iSeries-DB2: "db2inst1"
### Oracle: "oracle"
### Sybase: "sybase"
dbAdmin=

#-----------------------------------------------------------------------------------
### The JDBC driver type to use. Depends on the database type (dbType). It is needed
### for installing the business process container (Oracle only), for creating the
### database tables (z/OS only), and for creating the DataSource.
### DB2: "Universal" "CLI"
### Oracle: "oci8" "thin"
### MSSQL: "Embedded" "DataDirect"
driverType=

#-----------------------------------------------------------------------------------
### The directory where to create the table spaces. Only needed by database types DB2
### and Oracle. It is needed for creating the database or the database tables.
### For DB2, its default value is empty and no table spaces are created.
### For Oracle, there is no default value and it must be set.
dbTablespaceDir=

#-----------------------------------------------------------------------------------
### The host.name of process choreographer's database server. It is needed for
### creating the database (Sybase only) and for creating the DataSource (DB2,
### Informix, Oracle with the thin JDBC driver, Sybase, and MSSQL).
### When using DB2 UDB (not zOS-DB2 or iSeries-DB2) then it is optional. If not specified,
### a type 2 driver will be configured for DB2. If specified, a type 4 driver will be
### configured for DB2.
### For DB2, the default value is empty. For all other database types, the default value
### is the fully qualified host.name of the local host.
dbServerName=

#-----------------------------------------------------------------------------------
### The TCP/IP port of process choreographer's database server. It is needed whenever
### "dbServerName" is set.
### Default values are:
### DB2: "50000"
### Informix: "1526"
### Oracle with the thin JDBC driver: "1521"
### Sybase: "4100"
### MSSQL: "1433"
dbServerPort=

#-----------------------------------------------------------------------------------
### Storage group of the process choreographer z/OS database. It is needed for
### creating the database tables.
### It has no default value and must not be empty.
dbStorageGroup=

#-----------------------------------------------------------------------------------
### Subsystem name of the process choreographer z/OS database. It is needed for
### creating the database tables and for creating the DataSource.
### Ihe default value is "BPEDB"
dbSubSystem=

#-----------------------------------------------------------------------------------
### Schmema qualifier for the process choreographer z/OS database. It is needed for
### creating the database tables.
### It has no default value and may be empty. If set, it requires the Universal JDBC driver.
dbSQLID=

#-----------------------------------------------------------------------------------
### Instance name for the process choreographer Informix database.
### The default value is "ids1".
dbInstance=

#-----------------------------------------------------------------------------------
### The type of JMS provider to use for process choreographer. It is needed for
### creating the queue manager and the queues and for creating the ListenerPorts or
### ActivationSpecs and the connection factories. WebSphere platform messaging ("WPM")
### is always available whereas "MQSeries" requires the WebSphere MQSeries product to
### be installed.
### Allowed values are: "WPM" for default messaging and "MQSeries" for WebSphere MQ.
### The default value is "WPM".
mqType=WPM

#-----------------------------------------------------------------------------------
### Controls whether to create the queue manager and the queues. It is only needed
### for the "MQSeries" JMS provider. When using the "WPM" JMS provider, the
### queue manager is managed by WebSphere and already exists.
### The default value is: "yes".
### Allowed values are: "yes" "no"
createQM=

#-----------------------------------------------------------------------------------
### The queue manager name for "GET" requests. It is only used with the "MQSeries"
### JMS provider and it is needed for creating the queue manager and the queues and
### for creating the ListenerPorts and the queue connection factories. It must not
### contain the "-" character.
### The default name is "BPC_<nodeName>_<serverName>".
qmNameGet=

#-----------------------------------------------------------------------------------
### The name of the WebSphere cluster where the messaging engines run when using the
### "WPM" JMS provider for a clustered process choreographer configuration. It is
### needed for creating the messaging engine, the connection factories, and the queues.
### It has no default value.
### The name of the WebSphere MQ cluster when using the "MQSeries" JMS provider.
### It is needed for creating the queue manager and the queues and for creating the
### ListenerPorts and queue connection factories. It must not contain the "-" character.
### The default value is "MQCluster".
mqClusterName=

#-----------------------------------------------------------------------------------
### The queue manager name for "PUT" requests. It is only used when with the "MQSeries"
### JMS provider and when mqClusterName has been set. It is needed for creating the
### queue manager and the queues and for creating the ListenerPorts and the queue
### connection factories. It must not contain the "-" character and it must be different
### from qmNameGet.
### The default name is "BPCC_<nodeName>_<serverName>".
qmNamePut=

#-----------------------------------------------------------------------------------
### The installation directory of WebSphere MQSeries. If the WebSphere variable
### "MQ_INSTALL_ROOT" is set, its value will be used (and not be overwritten).
### It is needed for creating the queue manager and the queues (Windows only) and for
### creating the ListenerPorts and the queue connection factories. This parameter is
### ignored when using the "WPM" JMS provider.
### Default values -- if "MQ_INSTALL_ROOT" is not set -- are:
### Windows: <current drive>/Program Files/IBM/WebSphere MQ
### AIX: "/usr/mqm"
### iSeries: "/QIBM/ProdData/mqm"
### SunOS / HP-UX: "/opt/mqm"
mqHome=

#-----------------------------------------------------------------------------------
### The user id and password to access WebSphere Platform Messaging when using the
### "WPM" JMS provider. It is needed for creating the ActivationSpecs and the connection
### factories. The default value is the currently logged on user.
### The user id and password to access WebSphere MQSeries when using the "MQSeries"
### JMS provider. It is needed for creating the queue manager and the queues on
### non-Windows platforms. The default value is "mqm".
mqUser=wpsbind
mqPwd=

#-----------------------------------------------------------------------------------
### The database schema for the messaging engine when using the "WPM" JMS provider.
### It is needed when creating the messaging engine.
### The database and the schema must already exist.
### The default value is "BPEME"
mqSchemaName=

#-----------------------------------------------------------------------------------
### Flag inidicating whether to automatically create the messaging engine tables when
### using the "WPM" JMS provider.
### It is needed when creating the messaging engine. The default value is "true"
### Allowed values are: "true" "false"
mqCreateTables=

#-----------------------------------------------------------------------------------
### The JNDI name for the messaging engine DataSource when using the "WPM" JMS provider.
### It is needed when creating the messaging engine.
### The default value is "jdbc/BPEMEDB_${mqClusterName}_BPC.${cellName}.Bus"
mqDataSource=

#-----------------------------------------------------------------------------------
### The shell to use when executing external commands on Unix platforms.
### Default value is "/bin/sh"
shell=

#-----------------------------------------------------------------------------------
### The host.name of the mail server to be used by the human task manager to send
### notification mails. It is needed when configuring the mail session. If this
### parameter is not set, the mail session configuration will be skipped.
### The default value is the fully qualified host.name of the local host.
mailServerName=

#-----------------------------------------------------------------------------------
### The user id and password to access the mail server. It is needed for creating the
### mail session for the human task manager to send notification mails.
### The default for mailUser is empty (i.e., no authentication is required to access
### the mail server).
mailUser=
mailPwd=

#********************************** END OF FILE ************************************