This is task provides the ability to configure and manage BPM Process Execution Engines.
It can start/stop/create/drop and do general management of Engines.
Example 1: Start an already configured Engine.
<target name="start-engine" description="Start a Fuego Engine">
<!-- Open a session to the Fuego directory -->
<fuego:session
passportref="fuego.passport"
verbose="false"
haltonerror="true" >
<!-- Make sure the keystore is created (this is actually
required only once per installation) -->
<fuego:engine action="enable-location"
engineid="${fuego.engine}">
<fuego:admin participant="${fuego.participant}"
password="${fuego.password}"/>
</fuego:engine>
<!-- Start the Engine -->
<fuego:engine action="start" engineid="${fuego.engine}"/>
</fuego:session>
</target>
Example 2: Create a new Engine
<fuego:session passportref="passport"
verbose="true"
haltonerror="true">
<fuego:engine action="create"
type="ENTERPRISE"
engineid="${bpm.engine.id}"
homedir="${bpm.engine.homeDir}"
connector="${bpm.engine.id}"
runtimeConnector="${bpm.engine.id}"
haltonerror="true"/>
</fuego:session>
Example XML file to specify Engine properties (for use propsfile
attribute). Refer to <engprops> element for the list of available properties.
<!DOCTYPE preferences SYSTEM 'http://java.sun.com/dtd/preferences.dtd'>
<preferences EXTERNAL_XML_VERSION="1.0">
<root type="user">
<node name="J2EE_WEBLOGIC">
<node name="deployment">
<node name="deployerUrl">
<map><entry key="deployerUrl"
value="http://localhost:7001/fuego/deployer/servlet/worker"/>
</map>
</node>
<node name="wltargetname">
<map><entry key="wltargetname" value="BPMCluster"/></map>
</node>
</node>
<node name="disposer">
<node name="archivingConfiguration">
<map><entry key="archivingConfiguration" value="ENGINE_ARCHIVE_DB" /></map>
</node>
<node name="archivingEnabled">
<map><entry key="archivingEnabled" value="true"/></map>
</node>
</node>
<node name="isClusterEnabled">
<map><entry key="isClusterEnabled" value="true" /></map>
</node>
<node name="localhost">
<node name="homeDir">
<map><entry key="homeDir" value="/bpm/engines/MyEngine" /></map>
</node>
</node>
</node>
</root>
</preferences>
| Attribute | Description | Type | Required? |
| newstopicconnectionfactory | JDNI name of the JMS Topic Connection Factory used by the Engine. | String | No Only used if Engine type is J2EE |
| connector | Name of the database External Resource. This is the configuration to use when creating the Engine's back-end database structure. | String |
Yes when creating a new Engine (that is, action="create")
|
| newstopicname | JDNI name of the JMS Topic used by the Engine. | String | No Only used if Engine type is J2EE |
| itemsqueuename | JDNI name of the JMS Queue used by the Engine. | String | No Only used if Engine type is J2EE |
| haltonerror | Whether to stop the ant build process if an error occurs during the execution of this task. | boolean | No Default is true |
| sqlstatementsoutputfile | File |
No Only needed if showSqlStatements is true.
|
|
| type | Specifies the type of engine to create. Only needed if action is set to "create". Possible values: "ENTERPRISE" (for Standalone), "J2EE_WEBLOGIC", "J2EE_WEBSPHERE". | String | No If not set, the default value is the type installed, or if there are more than one engine type installed, will fail. |
| propsfile | File containing properties for the Engine. See nested element <engprops> for a list of available properties. | File |
No Only needed if importProps is true.
|
| homedir | Home directory for the new Engine. | File | Yes when creating a new Engine configuration. |
| showsqlstatements | This attribute is used as a modifier of create-database action when you wish to generate the DDL scripts for database structure instead of actually creating it. | boolean | No Defaults to false. |
| runtimeconnector | Name of the database External Resource. This is the configuration to use for the Engine's back-end database on runtime. | String |
No If omitted, the value of connector is used.
|
| onlydatabase | boolean | No | |
| enginefile | Engine configuration file. | File | Yes when importing/exporting an Engine configuration. |
| engineid | ID of the Fuego Engine to work on. | String | Yes |
| vmarguments | Optional additional arguments to pass to the Java Virtual Machine. When specified, this arguments will override those on the Engine configuration (webconsole). | String | No If not set, the value specified via Web console will be used. |
| importprops | boolean | ? | |
| logdir | Log directory for the new Engine. | File |
No Defaults to ${homedir}/log
|
| action |
Specifies what action to execute:
|
String ["create", "delete", "create-database", "recreate-database", "drop-database", "import", "start", "stop", "status", "enable-location", "clean-database", "modify-properties", "export", "create-archiving-database", "drop-archiving-database"] | Yes |
| itemsqueueconnectionfactory | JDNI name of the JMS Queue Connection Factory used by the Engine. | String | No Only used if Engine type is J2EE |
| directoryconnector | Name of External Resource to connect to BPM Directory database. | String | No Only used if engine type is J2EE |
| arguments | Optional additional arguments to the Fuego Engine. When specified, this arguments will override those on the Engine configuration (webconsole). | String | No If not set, the value specified via Web console will be used |
| Attribute | Description | Type | Required |
If it's used to represent a Fuego Directory administrator, then
participant should be used for the participant
id. For connections to other systems (like DBMSs) the
user attribute will be used.
This element is required when action equals
enable-location, create-database,
clean-database or drop-database.
| Attribute | Description | Type | Required |
| participant | ID of the Fuego Administrator participant. | String | Yes When used to connect to a Fuego Directory |
| user | ID of the Administrator user. | String | Yes When used for connections not to the Fuego Directory |
| password | User or participant's password. | String | Yes |