setup

The setup Ant task provides an alternative method for you to configure or modify the Rule Execution Server installation.

For example, you can use the setup Ant task for the following configuration tasks:

To change the persistence type: See Changing the persistence type by using an Ant task
To enable the TCP/IP management mode: See Configuring the Rule Execution Server console for the TCP/IP management mode

To run this Ant task, you call it from the Ant script file <odm_install_dir>/executionserver/bin/ressetup.xml.

Note: The elements bai.enable and bai.properties are deprecated and replaced with event.enable and event.properties. The deprecated elements remain compatible, but they are no longer maintained.

setup element attributes

The following table describes the attributes of the Ant task elements and specifies whether they are mandatory or optional.

Table 1. setup element attributes
Element attribute	Description	Mandatory/optional
event.enable	Set the parameter to true to enable the ODM event emitter plug-in in the execution unit (XU) configuration. Set to false to remove the plug-in.	Optional
event.properties	The path to the file that contains the configuration of the ODM event emitter. The path can be absolute or relative. The relative path is with respect to the directory where the command is launched. The following examples are both valid values for the PROPERTIES_FILE path. /Users/me/config/bai-config.properties ../../config/bai_config.properties	Mandatory if bai.enable is true. Not used if bai.enable is false.
compiledArchivesCache.properties	When you enable the compiled archives cache, use this parameter to specify the maximum number of compiled archives in the cache, and its path.	Optional For use with the decision engine only. The default value for maxSize is 10. By default, the compiled archives cache is disabled. You can enable it, by specifying a valid directory. Each instance of the XU must use a different path.
console.war.in	The path to the input Rule Execution Server console WAR file	Pair C® At least one of the 4 pairs, A, B, C, or D, is required.
console.war.out	The path to the output Rule Execution Server console WAR file.
console.ear.in	The path to the input management EAR file.	Pair D At least one of the 4 pairs, A, B, C, or D, is required.
console.ear.out	The path to the output management EAR file
management.protocol	Set this parameter to specify the protocol for communication with Rule Execution Server runtime. The valid values are jmx or tcpip. Set the parameter to the tcpip value to enable communication outside an application server. Example: Java™ SE XU instances	jmx is the default value. If you enable the tcpip value, the JMX management mode remains enabled. You cannot disable it.
management.tcpip.port	When you enable the TCP/IP management mode, use this parameter to specify the port to which the management server must connect.	Optional The default value is 1883.
metering.enable	Set this parameter to true to insert or to false to remove the metering plugin in the Decision Server configuration.	Optional
metering.application.level.id	Uniquely identifies the application level for a specific server instance. For example: `com.ibm.rules.metering.application.level.id=pricing`	Mandatory for data grouping and aggregation
metering.environment.level.id	Uniquely identifies the environment level for a specific server instance. For example: `com.ibm.rules.metering.environment.level.id=development`	Mandatory for data grouping and aggregation
metering.host.name	The name of the Operational Decision Manager server that sends the metrics. Allows you to differentiate the servers.	Optional
metering.install.directory	Installation directory of the Operational Decision Manager server. Helps distinguish two server instances.	Optional For example: /opt/IBM/MyServer/MyRuntime
metering.instance.identifier	Identifier to distinguish emitting servers that have the same host name.	Optional For example: MyInstanceID
metering.server.url	Endpoint where the usage metrics are sent	Mandatory
metering.source.url	URL of the server that emits the metrics.	Optional
metering.war.in	The path to the input HTDS/Decision Runner/testing WAR files for the metering configuration
metering.war.out	The path to the output HTDS/Decision Runner/testing WAR files for the metering configuration
persistence.type	The persistence type: `file` for file persistence in Java SE `datasource` for database persistence in Jakarta EE `jdbc` for database persistence in Java SE Restriction: You cannot set the persistence type to `memory` (memory persistence in Java SE) by using the Ant task.	Optional If you choose to define the persistence type, set the attribute to the appropriate configuration value.
persistence.jdbc.user	The login to use with the database connection for Java SE.	Configuration jdbc
persistence.jdbc.password	A password to use with the database connection for Java SE
persistence.jdbc.url	The JDBC URL used to connect to the database
persistence.jdbc.crypted.password.enabled	The password is encrypted in the XU configuration file.
persistence.jdbc.driver	A driver implementation class to establish a connection with the database.
persistence.datasource.jndi	The JNDI name of the data source.	Configuration `datasource`
persistence.file.directory	The path to the top directory that contains rulesets.	Configuration `file`
xom.persistence.type	The persistence type: file for file persistence in Java SE datasource for database persistence in Jakarta EE jdbc for database persistence in Java SE	Optional If you choose to define the persistence type, set the attribute to the appropriate configuration value.
xom.persistence.jdbc.user	The login to use with the XOM database connection for Java SE	Configuration XOM jdbc The default value is false.
xom.persistence.jdbc.password	A password to use with the XOM database connection for Java SE.
xom.persistence.jdbc.url	The JDBC URL used to connect to the XOM database.
xom.persistence.jdbc.crypted.password.enabled	If you set this attribute to true, the password is encrypted in the XU configuration file for the XOM database.
xom.persistence.jdbc.driver	A driver implementation class to establish a connection with the database that contains XOM resources
xom.persistence.datasource.jndi	The JNDI name of the data source that contains XOM resources.	Configuration XOM datasource
xom.persistence.file.directory	The path to the top directory that contains XOM resources.	Configuration XOM file
xu.in	The path to the input XU RAR file	Pair A At least one of the 4 pairs, A, B, C, or D, is required.
xu.out	The path to the output XU RAR file
xu.config.in	The path to the input XU ra.xml file	Pair B At least one of the 4 pairs, A, B, C, or D, is required.
xu.config.out	The path to the output XU ra.xml file