Configuring bwagent
The bwagent can be configured for a multi-agent, multi-machine environment.
The bwagent is configured using the bwagent.ini file in the BW_HOME\config folder. The bwagent.ini file template is a configuration file and contains the BW Admin data store configuration properties. Properties are pushed to the configuration file using JSON files.
|
Properties |
Description |
|---|---|
| BW Agent general configuration | |
| bw.admin.mode | The Admin mode. BW Administration tools can work in two modes, enterprise mode or local mode. In the enterprise mode it works with the agents across machines. In the local mode it works only with local machine and assumes no data store and transport and agents are available. The actions performed in local mode are not visible to the agents when ever they are started or even the admin tool when it is started in the enterprise mode. |
| bw.agent.networkName | The name of the network. Must be the same for all the bwagents in the network. For more information, see Creating an Agent Network. |
| bw.agent.memberName | The name of the bwagent. Must be unique within the network. For more information, see Creating an Agent Network. |
| bw.agent.technology.db.create.schema | Add this property manually to
bwagent.ini file. Set the property to
true to allow BWAgent to run create table script on startup.
When you set the property to false, the default behavior of BWAgent changes, and it restricts BWAgent from runing create table script on startup. |
| Logging configuration | |
| logback.configurationFile | The logback configuration file to be used by the agent. |
| bw.agent.http.port | The HTTP port. |
| bw.agent.http.host | The HTTP interface (default=localhost). |
| bw.appnode.agent.http.communication.port | The internal HTTP communication port the Thor engine uses to communicate with bwagent to send the status of AppNodes and applications. Update this property to specify a port to start the internal server on. The default port number is 56565. |
| bw.agent.http.access.log.config | The HTTP Request Access Log Configuration file. |
| bw.agent.bw.auth | The authentication mechanism used by the REST API, BASIC (default) or DIGEST. |
| bw.agent.https.port | The secure port. |
| bw.agent.https.truststorepath | The truststore. |
| bw.agent.https.truststorepassword | The truststore password |
| bw.agent.https.keystorepath | The keystore. |
| bw.agent.https.keystorepassword | The keystore password. |
| bw.agent.https.excludeprotocols | The protocols to be excluded. |
| bw.agent.https.includeprotocols | The protocols to be included. |
| Configuration for AppNode to agent communication | |
| bw.agent.appnode.user | The user used by the AppNodes to communicate with the bwagent. |
| bw.agent.appnode.password | The password for user used by AppNodes to communicate with the bwagent. If not set, the obfuscated password is read from the configured realm file. For example, $BW_HOME/config/realm.properties. |
| bw.agent.appnode.status.notify.timeout | Time interval in seconds when the AppNode reports its status to the bwagent. |
| TEA Agent configuration | |
| bw.agent.tea.agent.host | Identifies the bwagent for TEA to be registered. |
| bw.agent.tea.agent.port | Identifies the bwagent for TEA to be registered. |
| bw.agent.tea.agent.context.path=/bwta | Used to create bwagents register URL for TEA. |
| bw.agent.tea.server.url | The bwagent uses this URL to identitfy which server to be registered to. |
| Technology Type Configuration. Supported types are DBEMS or DBFTL | |
| bw.agent.technology.type | The provider to use for the datastore such as an external database (PostgreSQL , MySQL, Microsoft SQL, Oracle, db2 or MariaDB, ) with transport as TIBCO FTL® or TIBCO Enterprise Message Service (EMS).
Set to either: For more information, see the following topics: |
| bw.agent.technology.requestTimeout | Timeout for requests sent to other bwagents. The default value is 60000 ms. |
| DBEMS technology type | |
| bw.agent.technology.dbems.db.provider | Database provider. Supported options are postgresql, mysql and oracle database 12c, MS sqlserver, db2 and MariaDB. |
| bw.agent.technology.dbems.db.driver | The DB driver.
Example: dbDriver=org.postgresql.Driver Example: dbDriver=com.mysql.jdbc.Driver Example: dbDriver=oracle.jdbc.OracleDriver Example: dbDriver=com.microsoft.sqlserver.jdbc.SQLServerDriver Example: dbDriver=com.ibm.db2.jcc.DB2Driver Example: dbDriver=org.mariadb.jdbc.Driver |
| bw.agent.technology.dbems.db.connectionURL | The DB connection URL.
Example: dbConnectionURL=jdbc:postgresql://db:5432/bwadmindb Example: dbConnectionURL=jdbc:mysql://db:3306/bwadmindb Example: dbConnectionURL=jdbc:oracle:thin:@db:1521:bwadmindb Example: dbConnectionURL=jdbc:sqlserver://db:1433;databaseName=bwadmindb Example: dbConnectionURL=jdbc:db2://db:50000/bwadmindb Example: dbConnectionURL=jdbc:mariadb://db:3306/databaseName=bwadmindb |
| bw.agent.technology.dbems.db.userName | The DB user.
Example: dbUserName=bwuser |
| bw.agent.technology.dbems.db.password | The DB password.
Example: dbPassword=bwuser |
| bw.agent.technology.dbems.ems.serverUrl | The EMS server URL.
Example: emsServerUrl=tcp://ems:7222 |
| bw.agent.technology.dbems.ems.connectionFactoryName | The EMS connection Factory name.
Example: ldap.connectionFactoryName=QCFN |
| bw.agent.technology.dbems.ems.userName | The EMS user.
Example: emsUserName=admin |
| bw.agent.technology.dbems.ems.password | The EMS user password.
Example: emsPassword= |
| bw.agent.technology.dbems.ems.requestQueueName | The EMS member queue.
Example: requestQueueName=bw6.admin.operations.queue.{{membername}} |
| bw.agent.technology.dbems.ems.qin.EMSPrefix | The BW Agent Qin group name prefix. This property is optional and the default value is "EMSGMS". |
| bw.agent.technology.dbems.ems.ssl.trust.identity | The EMS ssl configuration.
client identity consisting of the certificate, private key and optionally extra issuer certificates can be included into a single data block using PKCS12, KeyStore or Entrust Store encodings. Example:bw.agent.technology.dbems.ems.ssl.trust.identity={EMS_HOME}/samples/certs/client_identity.p12 |
| bw.agent.technology.dbems.ems.ssl.trust.cert.location | The set of Trusted Certificates represents all trusted issuers of the server certificate. It must be specified by the client application unless the host certificate verification is completely disabled. Example: bw.agent.technology.dbems.ems.ssl.trust.location={EMS_HOME}/samples/certs/server_root.cert.pem |
| bw.agent.technology.dbems.ems.ssl.trust.password | EMS SSL connection trust password. This property is required if the JMS server protocol is ssl. The password may be clear text or supplied as an obfuscated string. |
| bw.agent.technology.dbems.ems.ssl.disable.verify.host.name | The trusted certificate commonname must match the ems server hostname if set to false. |
| bw.agent.technology.dbems.ems.ssl.disable.verify.host | The client and server certificates must match if set to false. |
| bw.agent.technology.dbems.ems.reconnection.interval | Interval for EMS reconnection. Value is in milliseconds (default: 10s). |
| DBFTL technology type | |
| bw.agent.technology.dbftl.db.provider | The Database provider. Supported options are postgresql, mysql and oracle database 12c, MS sqlserver, db2 and MariaDB. |
| bw.agent.technology.dbftl.db.driver | The DB driver.
Example: dbDriver=org.postgresql.Driver Example: dbDriver=com.mysql.jdbc.Driver Example: dbDriver=oracle.jdbc.OracleDriver Example: dbDriver=com.microsoft.sqlserver.jdbc.SQLServerDriver Example: dbDriver=com.ibm.db2.jcc.DB2Driver Example: dbDriver=org.mariadb.jdbc.Driver |
| bw.agent.technology.dbftl.db.connectionURL | The DB connection URL.
Example: dbConnectionURL=jdbc:postgresql://db:5432/bwadmindb Example: dbConnectionURL=jdbc:mysql://db:3306/bwadmindb Example: dbConnectionURL=jdbc:oracle:thin:@db:1521:bwadmindb Example: dbConnectionURL=jdbc:sqlserver://db:1433;databaseName=bwadmindb Example: dbConnectionURL=jdbc:db2://db:50000/bwadmindb Example: dbConnectionURL=jdbc:mariadb://db:3306/databaseName=bwadmindb |
| bw.agent.technology.dbftl.db.userName | The DB user.
Example: dbUserName=bwuser |
| bw.agent.technology.dbftl.db.password | The DB password.
Example: dbPassword=bwuser |
| bw.agent.technology.dbftl.ftl.realmserver | The FTL Realm server URL.
Example: ftlRealmServerUrl=http://localhost:8070 |
| bw.agent.technology.dbftl.ftl.application | The FTL application name.
Example: ftlApplicationName=bwadmin |
| bw.agent.technology.dbftl.ftl.identifier | The FTL identifier.
Example: ftlIdentifier= |
| bw.agent.technology.dbftl.ftl.secondary | The FTL secondary realm server.
Example: ftlSecondaryUrl=http://localhost:8070 |
| bw.agent.technology.dbftl.ftl.username | The FTL user.
Example: ftlUserName=admin |
| bw.agent.technology.dbftl.ftl.password | The FTL user password.
Example: ftlPassword= |
| bw.agent.technology.dbftl.ftl.endpoint | The FTL endpoint.
Example: ftlEndpoint=bw-endpoint |
| bw.agent.technology.dbftl.ftl.dataformat | The FTL data format.
Example: ftlDataformat= |
| bw.agent.technology.dbftl.ftl.inbox | The FTL inbox name.
Example: ftlInbox= |
| Statistics Provider Configuration | |
| bw.agent.technology.statsProvider | The stats provider technology. |
| bw.agent.technology.statsProvider.db.provider | The Database provider. Supported options are postgresql, mysql and oracle database 12c, MS sqlserver, db2 and MariaDB. |
| bw.agent.technology.statsProvider.db.driver | The DB driver.
Example: dbDriver=org.postgresql.Driver Example: dbDriver=com.mysql.jdbc.Driver # Example: dbDriver=oracle.jdbc.OracleDriver Example: dbDriver=com.microsoft.sqlserver.jdbc.SQLServerDriver Example: dbDriver=com.ibm.db2.jcc.DB2Driver Example: dbDriver=org.mariadb.jdbc.Driver |
| bw.agent.technology.statsProvider.db.connectionURL | The DB connection URL.
Example: dbConnectionURL=jdbc:postgresql://db:5432/bwadmindb Example: dbConnectionURL=jdbc:mysql://db:3306/bwadmindb Example: dbConnectionURL=jdbc:oracle:thin:@db:1521:bwadmindb Example: dbConnectionURL=jdbc:sqlserver://db:1433;databaseName=bwadmindb Example: dbConnectionURL=jdbc:db2://db:50000/bwadmindb Example: dbConnectionURL=jdbc:mariadb://db:3306/databaseName=bwadmindb |
| bw.agent.technology.statsProvider.db.userName | The DB user.
Example: dbUserName=bwuser |
| bw.agent.technology.statsProvider.db.password | The DB password.
Example: dbPassword=bwuser |
| Governance and Policy Director Configuration - The properties in this section are applicable to Governance Lifecycle Event Listener and it is used to communicate with the TIBCO Policy Director Administrator. | |
| bw.governance.enable | To enable or disable the Governance Lifecycle Event Listener. This property is optional and specifies whether the Governance Lifecycle Event Listener should be enabled or disabled in the BW Agent. The supported values are: true or false. The default value is 'false'. |
| bw.governance.jms.server.url | The Policy Director Administrator JMS URL. This property is optional and is used to specify the JMS server URL used to communicate with the Policy Director Administrator. If this property is not set, then the Lifecycle Event Listener will not attempt to connect to the JMS server. The URL is expected to start with 'tcp://' or 'ssl://' and the failover URLs can be specified as a ',' or '+' separated list. |
| bw.governance.jms.server.username | The Policy Director Administrator JMS User Name. This property is required if the Policy Director Administrator JMS URL is specified. |
| bw.governance.jms.server.password | The Policy Director Administrator JMS User Password. This property is required if the Policy Director Administrator JMS URL is specified. |
| bw.governance.jms.ssl.trust.store.type | The Policy Director Administrator JMS SSL connection trust store type. This property is required if the JMS server protocol is ssl. The supported values are 'JKS' and 'JCEKS'. The default value is 'JKS'. |
| bw.governance.jms.ssl.trust.store.location | The Policy Director Administrator JMS SSL connection trust store location. This property is required if the JMS server protocol is ssl. |
| bw.governance.jms.ssl.trust.store.password | The Policy Director Administrator JMS SSL connection trust store password. This property is required if the JMS server protocol is ssl. The password may be clear text or supplied as an obfuscated string. |
| bw.governance.jms.reconnect.attempt.count | The Policy Director Administrator JMS Connection attempt count. This property is required if the Policy Director Administrator JMS URL is specified and it specifies the number of JMS connection attempts the Lifecycle Event Listener will make. The default value is '120'. |
| bw.governance.jms.reconnect.attempt.timeout | The Policy Director Administrator JMS Connection attempt timeout. This property # is required if the Policy Director Administrator JMS URL is specified and # it specifies the timeout between the attempt to reestablish connection to # the JMS server. The default value is '500'. |
| bw.governance.jms.reconnect.attempt.delay | The Policy Director Administrator JMS Connection attempt delay. This property is required if the Policy Director Administrator JMS URL is specified and it specifies the delay in milliseconds between attempts to establish reestablish connection the JMS server. The default value is '500'. |
| bw.governance.jms.queue.pd.receiver.name | The Policy Director Administrator JMS receiver queue name prefix. This property is required if the Policy Director Administrator JMS URL is specified and it specifies receiver queue name prefix for the Lifecycle Event Listener and Policy Director Administrator communication. This property value must match the value specified in the Policy Director Administrator configuration. The default value is 'governance.de.bw.default'. |
| bw.governance.jms.application.property.<UserCustomProperty> | The Policy Director Administrator JMS JNDI custom property. This property is optional and it provides the ability to specify custom property for the JMS JNDI Initial Context. For example to provide a custom property called "myProperty" for the JNDI Initial Context, then specify a property "bw.governance.jms.application.property.myProperty=". |
The default location of the domains folder, where runtime entities are stored, can be changed. For information, see Configuring the Location of the Default Datastore.