TIBant allows you to free up your time so that you can spend more energy and development dollars on delivering crucial integration and services and less time on the basics of writing the scripts necessary to get your code built and into production.
TIBant is provided as a set of targets, tasks and macros for Apache Ant, the extremely popular software tool used for automating software build processes.
TIBant not only builds and deploys your BusinessWorks (BW) engines, it also offers a range of innovative features including Designer Launch Control, Property File to Engine Configuration Translation and Service WSDL Generation.
Designer Launch Control allows you to launch TIBCO Designer from Ant, and working on a project-by-project basis from within each project’s build script, will specify and control your file aliases, class paths and other settings. No more need to waste valuable time on incorrect file-aliases.
Property File to Engine Configuration Translation gives you the ability to specify BusinessWorks engine properties in simple property files. TIBant then lets you use these files to generate AppManage-compatible configuration files for each of your environments and is even smart enough to tell you when you’ve forgotten to set a global variable, such as a database password for the production environment.
Service WSDL Generation saves time and money by removing the manual steps currently required to produce a concrete WSDL for Service defined within your project. Even more importantly, because it allows you to specify the global variables to use when generating the WSDL, you will be able to generate a correct WSDL for each environment.
The TIBant homepage can be found at http://tibant.com . Community discussion forums for TIBant can be found at http://windyroad.com.au/discussion/ and the Windy Road team is looking forward to answering your support questions at http://windyroad.com.au/support/ .
More information about Apache Ant can be found at http://en.wikipedia.org/wiki/Apache_Ant and full documentation for Apache Ant can be found at http://ant.apache.org/manual/index.html
© Windy Road Technology Pty. Limited 2009-2014
All Rights Reserved.
Please see the TIBant End User License Agreement supplied with this software. If a copy of the TIBant End User License Agreement was not provided with this software, you may request a copy from http://windyroad.org/support/ .
TIBant is compatible with the following software:
| Name | Version |
|---|---|
| Apache Ant | 1.8.2 to 1.9.4 |
| TIBCO BusinessWorks | 5.2 to 5.12.0 |
TIBant is supported on the following platforms that BusinessWorks is supported on
TIBant should also work on versions of HPUX and AIX that BusinessWorks is supported on, however we do not explicitly test TIBant on those platforms. If you have any issues using TIBant on HPUX or AIX please contact Windy Road Support.
Step one: Pick a BW project
Step two: Create a file called build.xml in a folder above the BW project. e.g. We usually have the build.xml
located somewhere like <SomePath>\MyCoolBWProject\build.xml and the actual BW code at
<SomePath>\MyCoolProject\src\main\bw\MyCoolProject
Step three: Add the following content to the build.xml
<?xml version="1.0" encoding="UTF-8"?>
<project default="designer" name="MyCoolProject">
<import>
<url url="http://windyroad.com.au/tibant-importer/18/full.xml" />
</import>
</project>Step four: If you haven't already, install Apache Ant (http://ant.apache.org). Version 1.8.2 or newer will do.
Make sure it's installed correctly by opening a command prompt and running ant -version.
Step five: From the same directory as your build.xml run ant -p on the command line to get a list of targets you
can run. You'll be asked a number of questions. If you make a mistake, it stores the answers in the Configuration Settings
files desribed below, which you can fix with a text editor.
Step six: From the same directory as your build.xml run ant designer, ant ear and ant validate. They should
all just work.
When you run TIBant, it will look for configuration settings in the following files:
| Filename | Description |
|---|---|
${user.home}/${ant.project.name}.properties | Used to store developer specific settings for a specific project |
${user.home}/build.properties | Used to store developer specific settings for all projects, such as the Windy Road download server credentials |
${basedir}/build.properties | Used to store project settings that are the same for all developers |
${basedir}/ivy.xml | Used to specify project dependencies |
${basedir}/ivysettings.xml | Used to specify where project dependencies should be downloaded/copied from and built artifacts should be uploaded/copied to |
Where:
${user.home} is your home directory
${ant.project.name} is the value of the /project/@name in your build.xml
${basedir} is the directory containing your build.xmlIf TIBant is unable to find the configuration setting it is looking for, it will ask you for the correct value for that
setting and store the value in either ${user.home}/build.properties or ${basedir}/build.properties.
NOTE: The following files should be added to you source control for the project
${basedir}/build.xml
${basedir}/build.properties
${basedir}/ivy.xml
${basedir}/ivysettings.xml| Property Name | Description | Default |
|---|---|---|
| bwda.bw.project.path | Path to your BW project code. | The relative path to the first directory found containing a vcrepo.dat file. |
| bwda.build.dir | Path to the directory where TIBant should place generated files. | build |
| ivy.lib.dir | Path to the directory where TIBant should download dependencies to. | lib |
| bwda.classpath.dir | Path to a directory where TIBant should look for JAR files to automatically include in the TIBCO executables classpaths. | lib |
| bwda.aliases.dir | Path to a directory where TIBant should look for PROJLIB files to automatically include as file aliases and design-time libraries. | lib |
| ivy.organisation | Name of the company, department, group or individual that your project belongs to, typically in reverse domain name format. e.g., au.com.windyroad, org.apache. | com.example.integration |
| bwda.expected.errors | The number of errors reported when your BW project is validated. | 0 |
| bwda.max.warnings | The number of warnings reported when your BW project is validated. | 0 |
| bwda.repo.dir | The absolute path to a shared directory where dependencies should be copied from and built artifacts should be published to. | none |
| bwda.pipeline.version | The version of the project's artifacts that will be used to create a configuration or that will be ed. | The most recent version in your artifact repository |
| bwda.config.deploy.dir | The path to the directory where TIBant should load deployment properties from. | config/deploy |
| bwda.config.gvar.dir | The path to the directory where TIBant should load global variable properties from. | config/gvar |
| bwda.config.sdk.dir | The path to the directory where TIBant should load Adapter SDK properties from. | config/sdk |
| bwda.config.fail.on.unset.global.variables.@{ear} | If true TIBant will fail the build if there are global variables in the EAR that are missing from the project's global variables properties files. | false |
| bwda.config.fail.on.unknown.sdk.properties.@{ear} | If true TIBant will fail the build if there are properties in the project's Adapter SDK properties files that are noT present in the EAR and will be ignored by BW. | false |
| bwda.deployment.domain | The TIBCO Administrator domain that you wish to create a configuration for or deploy to. | none |
| bwda.pipeline.${bwda.deployment.domain}.config.version | The version of the project's configuration for the specified domain that should be used during deployment. | The most recent version in your artifact repository for the version of the bwda.pipeline.version EARs for the specified domain. |
NOTE: All paths are relative to your ${basedir} unless otherwise specified
NOTE: bwda.pipeline.version, bwda.deployment.domain and bwda.pipeline.${bwda.deployment.domain}.config.version are not persisted by TIBant and should be passed in from the command line or by your CI server.
TIBant assumes that you will be using a shared directory to upload and download artifacts and dependencies. However
${basedir}/ivysettings.xml can be modified to instead use a Maven-compatible artifact repository
(e.g. JFrog's Artifactory), ssh, sftp, subversion and more. Please see
http://ant.apache.org/ivy/history/latest-milestone/settings/resolvers.html and https://code.google.com/p/ivysvn/ for
more details or contact Windy Road support if you have any questions about artifact storage.
TIBant will automatically download JAR files and PROJLIB files that are
specified as dependencies in your ${basedir}/ivy.xml and configure and configure designer, buildear, etc to use these files. Please see
http://ant.apache.org/ivy/history/latest-milestone/ivyfile/dependencies.html for more details on specifiying dependencies
or contact Windy Road support if you have any questions about specifying dependencies.
You can search for public JAR files that you can add as dependencies at http://search.maven.org/ or http://mvnrepository.com/
As of TIBant v17, TIBant provides a number of Apache Ant targets for performing typical tasks for a BW project.
Builds the project's EAR files and PROJLIB files. TIBant will automatically determine what to build based on the
.archive files and .libbuilder files in your project. It will also automatically retrieve the project's
dependencies (PROJLIB files and JAR files) as specified in the project's ${basedir}/ivy.xml file.
Additional JAR files and PROJLIB file that cannot be downloaded/copied from your artifact repository can be configured as
file aliases by adding properties to ${basedir}/build.properties in the following format:
engine.aliases.<NAME>.projlib=Z:/SomePath/To/<NAME>.projlib
or
engine.aliases.<NAME>.jar=Z:/SomePath/To/<NAME>.jar
The built files will be created in ${bwda.build.dir}.
Removes all the files in ${bwda.build.dir}.
Retrieves the version of the project's EARs specified by ${bwda.pipeline.version}, extracts the template configuration files,
and builds configuration files for the TIBCO Administrator domain specified by ${bwda.deployment.domain}.
Retrieves the version of the project's EARs specified by ${bwda.pipeline.version}, the version of the project's configuration specified by, ${bwda.deployment.domain} and
${bwda.pipeline.${bwda.deployment.domain}.config.version} and deploys them to the TIBCO Administrator domain
specified by ${bwda.deployment.domain}.
If you are using TRA 5.7.3 or later, the deploy target will first upload the EARs and their configuration without restarting the BW engines. It will then proceed to perform a rolling restart of each BW instance, waiting for each instance to enter a state of "Running" before moving onto the next. In high availability (e.g. load balanced or fault tolterant) scenarios, this results in no-outage during the deployment.
If you are using an earlier version of the TRA, the deploy target will first upload the EARs and their configuration without restarting the BW engines. It will restart all of the BW instances belonging to the EAR, which will result in a short outage.
NOTE: The host on which this is run must be a member of the specified TIBCO Administrator domain.
NOTE: Even though the deploy target can provide a no-outage deployment in high availability secnarios, we strongly recommend that the deployment of critical systems into production environments be performed during a perscribed outage window, in-case there are any issues during the deployment, which result in an outage.
Opens the project in TIBCO Designer. TIBant will automatically retrieve the project's
dependencies (PROJLIB files and JAR files) as specified in the project's ${basedir}/ivy.xml file and configure
Designer's classpath, design time libraries and file aliases accordingly.
As per build, additional file aliases can be configured using engine.aliases.* properties
As per the build target, except only EAR files will be built.
Takes a password as input and outputs an obfuscated result.
As per the build target, except only PROJLIB files will be built.
Retrieves a "snapshot" version of a project's EARs and PROJLIBs specified by ${bwda.pipeline.version} and republishes
them as "release" versions. This is used as a way to indicate that a version of a project's EARs and PROJLIBs have
passed applicable quality gates and have been deemed fit for production deployment.
As per configure-ear and additionally the generated configuration files are uploaded/copied to your artifact repository.
As per build and additionally the generated EARs and PROJLIBs are uploaded/copied to your artifact repository as "snapshot" versions.
Validates the project. TIBant will automatically retrieve the project's
dependencies (PROJLIB files and JAR files) as specified in the project's ${basedir}/ivy.xml file and configure
Designer's classpath, design tiem libraries and file aliases accordingly.
As per build, additional file aliases can be configured using engine.aliases.* properties
TIBant is extremely customisable and extendable to suit your particular needs. The following sections detail the Apache Ant custom tasks and macros provided by TIBant. An understanding of Apache Ant is assumed. If you need help customising or extending TIBant, please contact Windy Road Support.
As of TIBant v16, TIBant provides a new set of TIBCO specific custom tasks implemented as an antlib.
To use the TIBant antlib you need to specify a namespace prefix, which can be done by adding
xmlns:tibant-al="antlib:com.tibant" to the root project element in your build file. For example
<project default="build" name="MyProject" xmlns:tibant-al="antlib:com.tibant">
You can then load the TIBant antlib custom tasks using a taskdef as follows:
<taskdef uri="antlib:com.tibant" resource="com/tibant/antlib.xml">
<classpath>
<pathelement location="${TIBant.jar}" />
</classpath>
</taskdef>NOTE: Import of tibant.xml will be deprecated in future versions, in favour of the antlib mentioned in the previous section
TIBant is used by importing tibant.xml into your Apache Ant build file. If you are new to
Apache Ant and don't have a build file, you can find a starter guide at
http://ant.apache.org/manual/using.html
To import TIBant into your build file, add the following code
<property name="tibant.home" location="C:/Program Files/TIBant"/>
<import file="${tibant.home}/tibant.xml"/>You also need to specify a namespace prefix for the TIBant macros, which can be done by adding
xmlns:tibant="org.windyroad.tibant" to the root project element in your build file. For example
<project default="build" name="MyProject" xmlns:tibant="org.windyroad.tibant">
Lastly, TIBant uses a number of Ant tasks provided by the ant-contrib library. If you
do not already load ant-contrib in your build file, then you also need to add the
following line after your TIBant import call. This can be added either at the top level
or within a target, so long as it get's called before any of the other TIBant macros.
<tibant:load-ant-contrib/>
You will now be able access the TIBant macros from within your build file using the tibant:
prefix. For instance, the following code creates a target that builds an Enterprise Archive
by calling the build-ear TIBant macro.
<target name="ear" description="Builds the ear for the project"> <tibant:build-ear dir="src/bw" project="MyProject" ear="/Build/MyProject" out="build/MyProject.ear"/> </target>
The example project provided, demonstrates how TIBant can be used to build a TIBCO BusinessWorks project, run it locally or deploy to different environements with different configurations.
Various properties and macro attributes documented below allow you to control the value of properties and paths within
the tra files used by the TIBCO executables. To allow you to prepend or append to the existing values, a special token
%EXISTING-VALUE% may be used. For instance to prepend lib/mylib.jar to a path, you would specifiy
lib/mylib.jar;%EXISTING-VALUE%
If you wish to append the jar, you would specify
%EXISTING-VALUE%;lib/mylib.jar
To completely replace the path with your jar, you would specify
lib/mylib.jar
References to Property Sets are used by a number of macros. These properties are used
in various ways such as to determine the values that should be mapped into the Enterprise
Archive configuration file, Global Variables to use when running the the engine locally
or when launching designer. Full documentation for the propertyset type can be found at
http://ant.apache.org/manual/CoreTypes/propertyset.html
Within a propertyset, a propertyref may be used to select a set of properties based
on a prefix or a regular expression. For instance, to select all the properties starting
with dev. you would use
<propertyref prefix='dev.'/>
Within a propertyset, a mapper may be used to modify the property name. For instance,
to remove a dev. prefix you would use
<mapper type='glob' from='dev.*' to='*'/>
Full documentation for the mappers can be found at http://ant.apache.org/manual/CoreTypes/mapper.html
A propertyref and mapper can be combined to allow you to specify properties that apply
only to a particular environment. For instance, the following property set will select all
properties prefixed by dev. and then remove that prefix.
<propertyset id="my-dev-gvars"> <propertyref prefix='dev.'/> <mapper type='glob' from='dev.*' to='*'/> </propertyset>
This approach can be used with the property file loading to allow you store a heirarchy of properties in a number of java properties files. For instance
<property file="myproject-dev-gvars.properties" prefix="myproject.dev."/> <property file="myproject-gvars.properties" prefix="myproject.dev."/> <property file="dev-gvars.properties" prefix="myproject.dev."/> <property file="common-gvars.properties" prefix="myproject.dev."/>
From this we can then create a propertyset of global variables for the myproject project in
Dev
<propertyset id="myproject-dev-gvars"> <propertyref prefix='myproject.dev.'/> <mapper type="glob" from="myproject.dev.*" to="*"/> </propertyset>
The following section details each of the Apache Ant Tasks provided by the TIBant antlib
Determines the statuses of TIBCO Administrator deployed application
NOTE: Requires TRA 5.7.3 or later.
(Available since version 18)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain to query. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| cred | The file containing the obfuscated Administrator domain username and password that has permissions to query instance statuses | Yes | n/a |
| app | The name of the application, who's status will be queried | No | n/a |
| service | The name of the service in the application, who's status will be queried | No | n/a |
| binding | The binding name of the instance of the service in the application, who's status will be queried | No | n/a |
| prefix | The prefix to use when setting instance status properties | No | "" |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| property | Properties to override or addional properties to set for the unerlying code | Yes | No |
| propertyset | Properties to override or addional properties to set for the unerlying code | Yes | No |
Properties used by the task.
| Name | Description | Optional |
|---|---|---|
| tibco.tra.home | Path to the TIBCO TRA home directory | No |
| java.io.tmpdir | Path to use for storing temporary files | No |
Starts a BusinessWorks engine within the current JVM.
(Available since version 16)
NOTE: Only one engine can be run in embedded mode within one JVM at a time.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| dir | The directory the TIBCO Designer Project is in. e.g., src/bw | Yes, unless the tibco.repourl property is specified | n/a |
| project | The name of the TIBCO Designer Project. e.g., MyProject | Yes, unless the tibco.repourl property is specified | n/a |
| createDTLFile | If true, create the /.designtimelibs file in the project root directory, based on the aliases specified. | No | true |
| aliasesRefId | A propertyset refid for the file aliases needed by the project. This is a convenience attribute. All the alias will automatically be mapped to tibco.alias.* properties | No | n/a |
| globalVariableRefId | A propertyset refid for the global variables to be used by the project. This is a convenience attribute. All the global variables will automatically be mapped to tibco.clientVar.* properties | No | n/a |
| engineDir | The working directory for BW to use. This is a convenience attribute that is automatically be mapped to the Engine.Dir property | No | current working directory |
| configRefId | The configuration reference ID to use. If antlib:org.windyroad.tibant:configure has not been called with this ID, it will be called automatically | No | tibant.default |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| property | Property to pass to the BW engine | Yes | No |
| propertyset | Properties to pass to the BW engine | Yes | No |
Stops a BusinessWorks engine running within the current JVM.
(Available since version 16)
Configures properties that TIBant will use to generate TRA files for running the TIBCO components.
The default behaviour is to load the properties from the appropriate
TRA files, using @{configId}. as a prefix.
To override the values for the TRA properties, specify the new values using the property and propertyset
nested elements. e.g.,
<tibant:configure>
<property name="tibco.env.HEAP_SIZE" value="512M"/>
</tibant:configure>Multiple calls to tibant:configure can be made using different configId values. This can be used to override a
TRA property with a value from a TRA property. e.g.,
<tibant:configure configId="tibant.existing"/>
<tibant:configure>
<property name="tibco.env.CUSTOM_EXT_PREPEND_CP"
value="path/to/ajarfile.jar;${tibant.existing.tibco.env.CUSTOM_EXT_PREPEND_CP}"/>
</tibant:configure>(Available since version 16)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| DesignerHome | The path to the TIBCO Designer installation directory. If
not specified, it will search for a designer.tra file starting at the directory
specified by the tibco.home.designer property, the TibHome attribute,
the the TIB_HOME environment variable, the tibco.home property, /opt/tibco/designer,
C:/tibco/desginer, /opt/tibco, C:/tibco, or the root directory. | No | n/a |
| TibHome | The path to the TIBCO installation directory. If not
specified, it will default to the TIBCO_HOME environment variable, the
tibco.home property, or it will be determined from @{DesignerHome}/bin/designer.tra
| No | n/a |
| TraHome | The path to the TIBCO TRA installation directory.
If not specified, it will default to the tibco.home.tra property or it
will be determined from @{DesignerHome}/bin/designer.tra | No | n/a |
| TpclHome | Path to the TIBCO TPCL installation directory. If not specified,
it will default to the tibco.home.tpcl property or it will be determined
from @{DesignerHome}/bin/designer.tra | No | n/a |
| HawkHome | Path to
the TIBCO HAWK installation directory. If not specified, it will default
to the tibco.home.hawk property or it will be determined from @{DesignerHome}/bin/designer.tra
| No | n/a |
| RvHome | Path to the TIBCO RV installation directory If not
specified, it will default to the tibco.home.rv property or it will be
determined from @{DesignerHome}/bin/designer.tra | No | n/a |
| BwHome | Path to the TIBCO BusinessWorks installation directory. If not specified,
it will default to the tibco.home.bw property or it will be determined
from @{DesignerHome}/bin/designer.tra | No | n/a |
| configId | The configuration ID usable in the configRefId attributes of the TIBant tasks. NOTE: the TIBant tasks will search by default for the configuration with the ID "tibant.default", which is the default value. | No | tibant.default |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| property | Used to override a TRA property | Yes | No |
| propertyset | Used to override a TRA property | Yes | No |
Determines the status of and instance of a TIBCO Administrator deployed application
NOTE: Requires TRA 5.7.3 or later.
(Available since version 18)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain to query. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| cred | The file containing the obfuscated Administrator domain username and password that has permissions to query instance statuses | Yes | n/a |
| app | The name of the application, who's status will be queried | Yes | n/a |
| service | The name of the service in the application, who's status will be queried | Yes | n/a |
| binding | The binding name of the instance of the service in the application, who's status will be queried | Yes | n/a |
| property | The name of the property to set, with the status of the instance | No | n/a |
| expectedStatus | The value to compare the instance status with | Yes, if used in a condition | n/a |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| property | Properties to override or addional properties to set for the unerlying code | Yes | No |
| propertyset | Properties to override or addional properties to set for the unerlying code | Yes | No |
Properties used by the task.
| Name | Description | Optional |
|---|---|---|
| tibco.tra.home | Path to the TIBCO TRA home directory | No |
| java.io.tmpdir | Path to use for storing temporary files | No |
The following section details each of the Apache Ant macros provided by TIBant
Peforms an action on TIBCO Administrator using the AppManage utility. All action are exectued in batch mode. Applications to perform the action on are specified using the app macro as nested elements.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| action | The batch action to perform. e.g. upload | Yes | n/a |
| domain | The Administrator domain to perform the action on. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| username | The Administrator domain user that has permissions to perform the action. e.g., admin. Required if | No | empty |
| password | The password for the specified user. Obfuscated passwords are not supported. To use obfuscated passwords use the credentials file. Required if | No | empty |
| credentials-file | The file containing the obfuscated Administrator domain username and password that has permissions to perform the action. Required if | No | empty |
| working-dir | The working directory to use. e.g., build | No | build/working |
| description | A description to pass to AppManage for a deployment. | No | empty |
| nostart | Set true to send the -nostart flag to AppManage. | No | false |
| nostop | Set true to send the -nostop flag to AppManage. | No | false |
| force | Set true to send the -force flag to AppManage. | No | false |
| taskname | No | tibant:administrator |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| tibco-apps | Used to specify applications to perform the action on via nested
NOTE: This element is implicit, which means there is no need to add it as a nested element. Instead you should create nested | yes | true |
<tibant:administrator action="deploy" domain="LOCAL" username="sa" password="sa">
<tibant:app name="Test" ear="build/Test.ear" xml="build/Test.xml" />
</tibant:administrator>The above example deploys to the LOCAL domain, the application named Test using the ear found at build/Test.ear
with the configuration found at build/Test.xml
Configure Enterprise Archives on an Administrator domain.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain to perform the action on. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| username | The Administrator domain user that has permissions to perform the action. e.g., admin. Required if | No | empty |
| password | The password for the specified user. Obfuscated passwords are not supported. To use obfuscated passwords use the credentials file. Required if | No | empty |
| credentials-file | The file containing the obfuscated Administrator domain username and password that has permissions to perform the action. Required if | No | empty |
| working-dir | The working directory to use. e.g., build | No | build/working |
| description | A description to pass to AppManage for a deployment. | No | empty |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| tibco-apps | Used to specify applications to perform the action on via nested
NOTE: This element is implicit, which means there is no need to add it as a nested element. Instead you should create nested | yes | true |
<tibant:administrator-config domain="LOCAL" username="sa" password="sa">
<tibant:app name="Test" xml="build/Test.xml" />
</tibant:administrator-config>Delete (and optionally undeploy) Applications on an Administrator domain.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain to perform the action on. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| username | The Administrator domain user that has permissions to perform the action. e.g., admin. Required if | No | empty |
| password | The password for the specified user. Obfuscated passwords are not supported. To use obfuscated passwords use the credentials file. Required if | No | empty |
| credentials-file | The file containing the obfuscated Administrator domain username and password that has permissions to perform the action. Required if | No | empty |
| working-dir | The working directory to use. e.g., build | No | build/working |
| force | Set true to send the -force flag to AppManage. | No | false |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| tibco-apps | Used to specify applications to perform the action on via nested
NOTE: This element is implicit, which means there is no need to add it as a nested element. Instead you should create nested | yes | true |
Deploy Applications (and optionally upload Enterrpise archives and configure them) on an Administrator domain.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain to perform the action on. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| username | The Administrator domain user that has permissions to perform the action. e.g., admin. Required if | No | empty |
| password | The password for the specified user. Obfuscated passwords are not supported. To use obfuscated passwords use the credentials file. Required if | No | empty |
| credentials-file | The file containing the obfuscated Administrator domain username and password that has permissions to perform the action. Required if | No | empty |
| working-dir | The working directory to use. e.g., build | No | build/working |
| description | A description to pass to AppManage for a deployment. | No | empty |
| nostart | Set true to send the -nostart flag to AppManage. | No | false |
| nostop | Set true to send the -nostop flag to AppManage. | No | false |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| tibco-apps | Used to specify applications to perform the action on via nested
NOTE: This element is implicit, which means there is no need to add it as a nested element. Instead you should create nested | yes | true |
<tibant:administrator-deploy domain="LOCAL" username="sa" password="sa"
nostop="true" description="Deployed version 1.2.3 per CR#1567">
<tibant:app name="Test" ear="build/Test.ear" xml="build/Test.xml" />
</tibant:administrator-deploy>Exports the specified application EAR and it's configuration from a TIBCO Administrator domain.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain export from. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| app | The application to export | Yes | n/a |
| configOutput | The file to write the configuration to | Yes | n/a |
| earOutput | The file to write the EAR to | Yes | n/a |
| username | The Administrator domain user that has permissions to perform the action. e.g., admin. Required if | No | empty |
| password | The password for the specified user. Obfuscated passwords are not supported. To use obfuscated passwords use the credentials file. Required if | No | empty |
| credentials-file | The file containing the obfuscated Administrator domain username and password that has permissions to perform the action. Required if | No | empty |
| working-dir | The working directory to use. e.g., build | No | build/working |
| taskname | No | tibant:administrator-export |
Export Applications from an Administrator domain.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain to perform the action on. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| username | The Administrator domain user that has permissions to perform the action. e.g., admin. Required if | No | empty |
| password | The password for the specified user. Obfuscated passwords are not supported. To use obfuscated passwords use the credentials file. Required if | No | empty |
| credentials-file | The file containing the obfuscated Administrator domain username and password that has permissions to perform the action. Required if | No | empty |
| working-dir | The working directory to use. e.g., build | No | build/working |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| tibco-apps | Used to specify applications to perform the action on via nested
NOTE: This element is implicit, which means there is no need to add it as a nested element. Instead you should create nested | yes | true |
Forcefully stop Applications on an Administrator domain.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain to perform the action on. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| username | The Administrator domain user that has permissions to perform the action. e.g., admin. Required if | No | empty |
| password | The password for the specified user. Obfuscated passwords are not supported. To use obfuscated passwords use the credentials file. Required if | No | empty |
| credentials-file | The file containing the obfuscated Administrator domain username and password that has permissions to perform the action. Required if | No | empty |
| working-dir | The working directory to use. e.g., build | No | build/working |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| tibco-apps | Used to specify applications to perform the action on via nested
NOTE: This element is implicit, which means there is no need to add it as a nested element. Instead you should create nested | yes | true |
Start Applications on an Administrator domain.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain to perform the action on. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| username | The Administrator domain user that has permissions to perform the action. e.g., admin. Required if | No | empty |
| password | The password for the specified user. Obfuscated passwords are not supported. To use obfuscated passwords use the credentials file. Required if | No | empty |
| credentials-file | The file containing the obfuscated Administrator domain username and password that has permissions to perform the action. Required if | No | empty |
| working-dir | The working directory to use. e.g., build | No | build/working |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| tibco-apps | Used to specify applications to perform the action on via nested
NOTE: This element is implicit, which means there is no need to add it as a nested element. Instead you should create nested | yes | true |
Gracefully stop Applications on an Administrator domain.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain to perform the action on. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| username | The Administrator domain user that has permissions to perform the action. e.g., admin. Required if | No | empty |
| password | The password for the specified user. Obfuscated passwords are not supported. To use obfuscated passwords use the credentials file. Required if | No | empty |
| credentials-file | The file containing the obfuscated Administrator domain username and password that has permissions to perform the action. Required if | No | empty |
| working-dir | The working directory to use. e.g., build | No | build/working |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| tibco-apps | Used to specify applications to perform the action on via nested
NOTE: This element is implicit, which means there is no need to add it as a nested element. Instead you should create nested | yes | true |
Undeploy Applications on an Administrator domain.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain to perform the action on. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| username | The Administrator domain user that has permissions to perform the action. e.g., admin. Required if | No | empty |
| password | The password for the specified user. Obfuscated passwords are not supported. To use obfuscated passwords use the credentials file. Required if | No | empty |
| credentials-file | The file containing the obfuscated Administrator domain username and password that has permissions to perform the action. Required if | No | empty |
| working-dir | The working directory to use. e.g., build | No | build/working |
| description | A description to pass to AppManage for a deployment. | No | empty |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| tibco-apps | Used to specify applications to perform the action on via nested
NOTE: This element is implicit, which means there is no need to add it as a nested element. Instead you should create nested | yes | true |
Upload Enterprise Archives (and optionally configure them) to an Administrator domain.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The Administrator domain to perform the action on. The host must be a member of that domain. e.g., DEV | Yes | n/a |
| username | The Administrator domain user that has permissions to perform the action. e.g., admin. Required if | No | empty |
| password | The password for the specified user. Obfuscated passwords are not supported. To use obfuscated passwords use the credentials file. Required if | No | empty |
| credentials-file | The file containing the obfuscated Administrator domain username and password that has permissions to perform the action. Required if | No | empty |
| working-dir | The working directory to use. e.g., build | No | build/working |
| description | A description to pass to AppManage for a deployment. | No | empty |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| tibco-apps | Used to specify applications to perform the action on via nested
NOTE: This element is implicit, which means there is no need to add it as a nested element. Instead you should create nested | yes | true |
<tibant:administrator-upload domain="LOCAL" username="sa" password="sa">
<tibant:app name="Test" ear="build/Test.ear" xml="build/Test.xml" />
</tibant:administrator-upload>Used with the administrator macros to specify the applications, Enterprise Archives and configuration files to work with.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| name | The name of the application. e.g., MyProject | Yes | n/a |
| ear | The location of the enterprise archive. e.g., build/MyProject.ear | No | |
| xml | The location of the configuration file. e.g., build/MyProject.xml | No |
Builds a TIBCO BusinessWorks Enterprise Archive or Design Time Library.
NOTE: On Linux based systems an X-server is required to run the buildear and buildlibrary executables that this macro uses. On headless systems Xvfb can be used to meet this requirement: http://www.x.org/releases/X11R7.6/doc/man/man1/Xvfb.1.xhtml
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| type | Whether to build and Enterprise Archive or Design Time Library. e.g., ear or lib | Yes | n/a |
| resource | The path within the TIBCO Designer project to the Enterprise Archive or Library Builder resource. e.g., /Build/MyProject | Yes | n/a |
| project | The name of the TIBCO Designer Project. e.g., MyProject | Yes | n/a |
| dir | The directory the TIBCO Designer Project is in. e.g., src/bw | Yes | n/a |
| aliases-refid | A propertyset refid for the file aliases needed by the project | No | empty-set |
| working-dir | The working directory. e.g., build/working/@{project} | No | build/working/@{project} |
| create-dtl-file | If true, create the | No | false |
| out | The output file for the Enterprise Archive. e.g., build/MyProject.ear | Yes | n/a |
| validate | if true, validate the project before building | No | false |
| validate-out | The output file for the validation results. e.g., build/working/@{project}/validation.log. Ignored if @{validate} is false. | No | build/working/@{project}/validation.log |
| validate-expected-errors | The number of errors expected during validation. Ignored if @{validate} is false. If the number of validation errors doee not equal this value then the macro will fail.
Normally you whould not change this from 0, however there are times when a project produces validation errors (e.g. when using the
NOTE: The macro will fail if there are less errors than expected. This is to prevent sitbuildions where you have a number of expected validation errors, and then someone makes a change that results in one of them being removed. At this point, unless this macro fails, it would be possible for new unexpected validation errors (that have not been confirmed to operate correctly) to be introduced.
(Available since verison 1.4.0) | No | 0 |
| validate-max-warnings | The maximum number of warnings permitted during validation. If the number of validation warnings exceeds this value then the macro will fail. (Available since version 1.4.0) | No | unlimited |
| force | Force the re-creation of the Enterprise Archive, even if the TIBCO Designer project has not changed. | No | false |
| heap-size | Specifies the initial Java heap size to allocate | No | ${tibco.designer.heap.size} |
| custom-path | the value to use for | No | %EXISTING-VALUE% |
| custom-cp-ext | the value to use for | No | %EXISTING-VALUE% |
| custom-palette-path | the value to use for | No | %EXISTING-VALUE% |
| custom-lib-path | the value to use for | No | %EXISTING-VALUE% |
| application-args | Specifies the remaining command line arguments to pass into the application:
| No | |
| taskname | No | tibant:build |
Builds a TIBCO BusinessWorks Enterprise Archive.
NOTE: On Linux based systems an X-server is required to run the buildear executable that this macro uses. On headless systems Xvfb can be used to meet this requirement: http://www.x.org/releases/X11R7.6/doc/man/man1/Xvfb.1.xhtml
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| ear | The path within the TIBCO Designer project to the Enterprise Archive resource. e.g., /Build/MyProject | Yes | n/a |
| project | The name of the TIBCO Designer Project. e.g., MyProject | Yes | n/a |
| dir | The directory the TIBCO Designer Project is in. e.g., src/bw | Yes | n/a |
| aliases-refid | A propertyset refid for the file aliases needed by the project | No | empty-set |
| working-dir | The working directory. e.g., build/working/@{project} | No | build/working/@{project} |
| create-dtl-file | If true, create the | No | false |
| out | The output file for the Enterprise Archive. e.g., build/MyProject.ear | Yes | n/a |
| validate | if true, validate the project before building | No | false |
| validate-out | The output file for the validation results. e.g., build/working/@{project}/validation.log. Ignored if @{validate} is false. | No | build/working/@{project}/validation.log |
| validate-expected-errors | The number of errors expected during validation. Ignored if @{validate} is false. If the number of validation errors doee not equal this value then the macro will fail.
Normally you whould not change this from 0, however there are times when a project produce validation errors (e.g. when using the
NOTE: The macro will fail if there are less errors than expected. This is to prevent sitbuildions where you have a number of expected validation errors, and then someone makes a change which results in one of them being removed. At this point, unless this macro fails, it would be possible for new unexpected validation errors (that have not been confirmed to operate correctly) to be introduced.
(Available since verison 1.4.0) | No | 0 |
| validate-max-warnings | The maximum number of warnings permitted during validation. If the number of validation warnings exceeds this value then the macro will fail.
(Available since version 1.4.0) | No | unlimited |
| force | Force the re-creation of the Enterprise Archive, even if the TIBCO Designer project has not changed. | No | false |
| heap-size | Specifies the initial Java heap size to allocate | No | ${tibco.designer.heap.size} |
| custom-path | the value to use for | No | %EXISTING-VALUE% |
| custom-cp-ext | the value to use for | No | %EXISTING-VALUE% |
| custom-palette-path | the value to use for | No | %EXISTING-VALUE% |
| custom-lib-path | the value to use for | No | %EXISTING-VALUE% |
| application-args | Specifies the remaining command line arguments to pass into the application
| No | |
| taskname | No | tibant:build-ear |
Builds a TIBCO BusinessWorks design time library (DTL).
NOTE: On Linux based systems an X-server is required to run the buildlibrary executable that this macro uses. On headless systems Xvfb can be used to meet this requirement: http://www.x.org/releases/X11R7.6/doc/man/man1/Xvfb.1.xhtml
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| lib | The path within the TIBCO Designer project to the Library Builder resource. e.g., /Build/MyDTL | Yes | n/a |
| project | The name of the TIBCO Designer Project. e.g., MyProject | Yes | n/a |
| dir | The directory the TIBCO Designer Project is in. e.g., src/bw | Yes | n/a |
| aliases-refid | A propertyset refid for the file aliases needed by the project | No | empty-set |
| working-dir | The working directory for building the DTL. e.g., build/working/@{project} | No | build/working/@{project} |
| create-dtl-file | If true, create the | No | false |
| out | The output file for the DTL. e.g., build/MyDTL.projlib | Yes | n/a |
| validate | if true, validate the project before building | No | false |
| validate-out | The output file for the validation results. e.g., build/working/@{project}/validation.log. Ignored if @{validate} is false. | No | build/working/@{project}/validation.log |
| validate-expected-errors | The number of errors expected during validation. Ignored if @{validate} is false. If the number of validation errors doee not equal this value then the macro will fail.
Normally you whould not change this from 0, however there are times when a project produce validation errors (e.g. when using the
NOTE: The macro will fail if there are less errors than expected. This is to prevent sitbuildions where you have a number of expected validation errors, and then someone makes a change which results in one of them being removed. At this point, unless this macro fails, it would be possible for new unexpected validation errors (that have not been confirmed to operate correctly) to be introduced. (Available since verison 1.4.0) | No | 0 |
| validate-max-warnings | The maximum number of warnings permitted during validation. If the number of validation warnings exceeds this value then the macro will fail. (Available since version 1.4.0) | No | unlimited |
| force | Force the re-creation of the DTL, even if the TIBCO Designer project has not changed. | No | false |
| heap-size | Specifies the initial Java heap size to allocate | No | ${tibco.designer.heap.size} |
| custom-path | the value to use for | No | %EXISTING-VALUE% |
| custom-cp-ext | the value to use for | No | %EXISTING-VALUE% |
| custom-palette-path | the value to use for | No | %EXISTING-VALUE% |
| custom-lib-path | the value to use for | No | %EXISTING-VALUE% |
| application-args | Specifies the remaining command line arguments to pass into the application
| No | |
| taskname | No | tibant:build-library |
Builds a WSDL from a specified service agent. This macro runs the specified project locally (using bw-start) and uses the built-in resource provider to retrieve the WSDL for the specified service agent.
NOTE: Either TIBCO Hawk or TIBCO Administrator must have been configured for the local system.
(Available since version 7)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| service-agent | The path within the TIBCO Designer project to the Service Agent resource. e.g., /Build/MyServiceAgent | Yes | n/a |
| project | The name of the TIBCO Designer Project. e.g., MyProject | Yes | n/a |
| name | The name for the BW engine
(Available since version 14) | No | |
| dir | The directory the TIBCO Designer Project is in. e.g., src/bw | Yes | n/a |
| aliases-refid | A propertyset refid for the file aliases needed by the project | No | empty-set |
| global-variables-refid | A propertyset refid for the Global variables to use when running the project. See the | No | empty-set |
| properties-refid | A propertyset refid for the properties to use when executing the BusinessWorks engine. For instance setting | No | empty-set |
| working-dir | The working directory. e.g., build/working/@{project} | No | build/working/@{project} |
| out | The output file for the WSDL. e.g., build/MyServiceAgent.wsdl | Yes | n/a |
| force | Force the re-creation of the WSDL, even if the TIBCO Designer project has not changed. | No | false |
| domain | The TIBCO Hawk domain use to run the project. e.g., LOCAL | No | LOCAL |
| service | The TIBCO Rendezvous service used by TIBCO Hawk. e.g., 7474 | No | 7474 |
| network | The TIBCO Rendezvous network used by TIBCO Hawk. e.g., ; | No | ; |
| daemon | The TIBCO Rendezvous daemon used by TIBCO Hawk. e.g., 7474 | No | 7474 |
| heap-size | Specifies the initial Java heap size to allocate | No | ${tibco.designer.heap.size} |
| timeout | The number of seconds the engine should run for before quitting.
This can be used to have the engine automatically terminate, in situations where
(Available since version 15) | No | -1 |
| custom-cp-ext-prepend | Customizable Classpath information. All classes and jars in these directories will be automatically picked up. You can also specify individual files. Use forward slashes only. e.g., g:/a1/b1;d:/a2/b2/c.jar | No | %EXISTING-VALUE% |
| custom-cp-ext-append | Customizable Classpath information. All classes and jars in these directories will be automatically picked up. You can also specify individual files. Use forward slashes only. e.g., g:/a1/b1;d:/a2/b2/c.jar | No | %EXISTING-VALUE% |
| application-args | Other arguments to application, JVM etc. | No | |
| taskname | No | tibant:build-wsdl |
Deprecated since v7. Use build-wsdl instead.
(Available since version 1.4.0)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| service-agent | The path within the TIBCO Designer project to the Service Agent resource. e.g., /Build/MyServiceAgent | Yes | n/a |
| project | The name of the TIBCO Designer Project. e.g., MyProject | Yes | n/a |
| name | The name for the BW engine
(Available since version 14) | No | |
| dir | The directory the TIBCO Designer Project is in. e.g., src/bw | Yes | n/a |
| aliases-refid | A propertyset refid for the file aliases needed by the project | No | empty-set |
| global-variables-refid | A propertyset refid for the Global variables to use when running the project. See the | No | empty-set |
| properties-refid | A propertyset refid for the properties to use when executing the BusinessWorks engine. For instance setting | No | empty-set |
| working-dir | The working directory. e.g., build/working/@{project} | No | build/working/@{project} |
| out | The output file for the WSDL. e.g., build/MyServiceAgent.wsdl | Yes | n/a |
| force | Force the re-creation of the WSDL, even if the TIBCO Designer project has not changed. | No | false |
| domain | The TIBCO Hawk domain use to run the project. e.g., LOCAL | No | LOCAL |
| service | The TIBCO Rendezvous service used by TIBCO Hawk. e.g., 7474 | No | 7474 |
| network | The TIBCO Rendezvous network used by TIBCO Hawk. e.g., ; | No | ; |
| daemon | The TIBCO Rendezvous daemon used by TIBCO Hawk. e.g., 7474 | No | 7474 |
| heap-size | Specifies the initial Java heap size to allocate | No | ${tibco.designer.heap.size} |
| timeout | The number of seconds the engine should run for before quitting.
This can be used to have the engine automatically terminate, in situations where
(Available since version 15) | No | -1 |
| custom-cp-ext-prepend | Customizable Classpath information. All classes and jars in these directories will be automatically picked up. You can also specify individual files. Use forward slashes only. e.g., g:/a1/b1;d:/a2/b2/c.jar | No | %EXISTING-VALUE% |
| custom-cp-ext-append | Customizable Classpath information. All classes and jars in these directories will be automatically picked up. You can also specify individual files. Use forward slashes only. e.g., g:/a1/b1;d:/a2/b2/c.jar | No | %EXISTING-VALUE% |
| application-args | Other arguments to application, JVM etc. | No | |
| taskname | No | tibant:build-wsdl |
Starts a BusinessWorks engine locally.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| project | The name of the TIBCO Designer Project. e.g., MyProject | Yes | n/a |
| dir | The directory the TIBCO Designer Project is in. e.g., src/bw | Yes | n/a |
| name | The name for the BW engine. In order to stop the engine, either TIBCO Hawk or TIBCO Administrator must have been configured for the local system.
(Available since version 14) | No | |
| aliases-refid | A propertyset refid for the file aliases needed by the project | No | empty-set |
| global-variables-refid | A propertyset refid for the Global variables to use when running the project. See the | No | empty-set |
| properties-refid | A propertyset refid for the properties to use when executing the BusinessWorks engine. For instance setting | No | empty-set |
| working-dir | The working directory. e.g., build/working/@{project} | No | build/working/@{project} |
| create-dtl-file | If true, create the
(Available since version 1.4.1) | No | false |
| spawn | Whether or not you want the engine to be spawned. If you spawn the engine, its output will not be logged by ant. | No | false |
| heap-size | Specifies the initial Java heap size to allocate | No | ${tibco.designer.heap.size} |
| custom-cp-ext-prepend | Customizable Classpath information. All classes and jars in these directories will be automatically picked up. You can also specify individual files. Use forward slashes only. e.g., g:/a1/b1;d:/a2/b2/c.jar | No | %EXISTING-VALUE% |
| custom-cp-ext-append | Customizable Classpath information. All classes and jars in these directories will be automatically picked up. You can also specify individual files. Use forward slashes only. e.g., g:/a1/b1;d:/a2/b2/c.jar | No | %EXISTING-VALUE% |
| application-args | Other arguments to application, JVM etc. | No | |
| timeout | The number of seconds the engine should run for before quitting.
This can be used to have the engine automatically terminate, in situations where
(Available since version 15) | No | -1 |
| taskname | No | tibant:bw-start |
Stops a BusinessWorks engine running locallay using TIBCO Hawk. Either TIBCO Hawk or TIBCO Administrator must have been configured for the local system.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| project | The name of the BW engine to stop. e.g., MyProject | Yes | n/a |
| domain | The TIBCO Hawk domain use to run the project. e.g., LOCAL | No | LOCAL |
| service | The TIBCO Rendezvous service used by TIBCO Hawk. e.g., 7474 | No | 7474 |
| network | The TIBCO Rendezvous network used by TIBCO Hawk. e.g., ; | No | ; |
| daemon | The TIBCO Rendezvous daemon used by TIBCO Hawk. e.g., 7474 | No | 7474 |
| fork | If true, a seperate JVM will be started to run the Hawk command to stop the BW engine.
It has been noticed that on certain platforms multiple executions of this macro within the same JVM will fail on the second and subsequent execution. In these situations, you should keep @{fork} set to false. (Available since version 14) | No | true |
| taskname | No | tibant:bw-stop |
Checks whether a resource exists (i.e. file or directory).
(Available since version 10)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| resource | The resource, whose presence is checked. | Yes | n/a |
| reportonly | If set to If set to | No | false |
Checks whether the tibco home directories exist.
(Available since version 10)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| reportonly | If set to If set to | No | false |
Create a configuration file based on provide referenced propertysets and a provided xml template, which was extracted from an Enterprise Archive using the extract-config macro. The extracted xml provides a template for creating a configuration file for your Enterprise Archive. TIBant maps values from properties into the structure of the template, to provide a configuration file for the Enterprise Archive. The mappings are documented in the Property Mappings section below.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| xml | The template configuration file produced by the | Yes | n/a |
| out | The location to create the configuration file | Yes | n/a |
| global-variables-refid | A | No | empty-set |
| adapter-sdk-properties-refid | A | No | empty-set |
| deployment-properties-refid | A | Yes | n/a |
| restrict-repoinstance-transport | If set to
(Available since version 1.3.2) | No | false |
| fail-on-unset-global-variables | If set to
(Available since version 1.3.2) | No | false |
| unset-global-variables-refid | A
(Available since version 1.3.2) | No | empty-set |
| do-not-set-global-variables-refid | A
(Available since version 1.3.2) | No | empty-set |
| fail-on-unknown-adapter-sdk-properties | If not specified or set to
(Available since v15) | No | true |
| working-dir | The working directory to use. e.g., build | No | build/working |
| taskname | No | tibant:configure-ear |
The following table details how properties in the propertyset referenced by @{deployment-properties-refid}
are mapped to elements in the template configuration file.
| Property Name | Description | Required | Default | Node Mapped To |
|---|---|---|---|---|
| repoInstanceName | This element corresponds to the Deployment Name field that is
displayed in the Edit Application Configuration panel in the TIBCO Administrator GUI. The element's value is the
#administration-domain#-#application# name. | No | /application/repoInstanceName | |
| description | Information about the application. | No | empty | /application/description |
| contact | Name of the person responsible for this application. | No | empty | /application/contact |
| repoInstances-selected | Indicates the transport selected to be used by the deployment repository instance. Can be set to rv, http, https or local. | No | /application/repoInstances/@selected | |
| repoInstances-httpRepoInstance-server | Name of the administration server under which this application is deployed. | No | /application/repoInstances/httpRepoInstance/server | |
| repoInstances-httpRepoInstance-user | User authorized for this application repository. | No | Defaults to the user currently logged into the AppManage utility. | /application/repoInstances/httpRepoInstance/user |
| repoInstances-httpRepoInstance-password | User's password. | No | /application/repoInstances/httpRepoInstance/password | |
| repoInstances-httpRepoInstance-timeout | Amount of time in seconds allowed for completing a task, such as retrieving information from the server. | No | 600 seconds. | /application/repoInstances/httpRepoInstance/timeout |
| repoInstances-httpRepoInstance-url | The URL with which the client attempts to connect to the server. | No | /application/repoInstances/httpRepoInstance/url | |
| repoInstances-rvRepoInstance-server | Name of the administration server under which this application is deployed. | No | /application/repoInstances/rvRepoInstance/server | |
| repoInstances-rvRepoInstance-user | User authorized for this application repository. | No | The user currently logged into the AppManage utility. | /application/repoInstances/rvRepoInstance/user |
| repoInstances-rvRepoInstance-password | User's password. | No | /application/repoInstances/rvRepoInstance/password | |
| repoInstances-rvRepoInstance-timeout | Amount of time in seconds allowed for completing a task, such as retrieving information from the server. | No | 600 seconds. | /application/repoInstances/rvRepoInstance/timeout |
| repoInstances-rvRepoInstance-discoveryTimeout | Amount of time in seconds allowed for the initial connection to the administration server. | No | /application/repoInstances/rvRepoInstance/discoveryTimeout | |
| repoInstances-rvRepoInstance-daemon | Instructs the transport object about how and where to find the TIBCO Rendezvous daemon and establish communication. See TIBCO Rendezvous Concepts for details about specifying the daemon parameter. | No | 7500 | /application/repoInstances/rvRepoInstance/daemon |
| repoInstances-rvRepoInstance-service | Used by the system to identify the TIBCO Rendezvous service parameter. See TIBCO Rendezvous Concepts for details about specifying the service parameter. | No | 7500 | /application/repoInstances/rvRepoInstance/service |
| repoInstances-rvRepoInstance-network | Used by the system to identify the TIBCO Rendezvous network parameter. See TIBCO Rendezvous Concepts for details about specifying the network parameter. | No | ; | /application/repoInstances/rvRepoInstance/network |
| repoInstances-rvRepoInstance-regionalSubject | TIBCO Rendezvous subject prefix used for regional read-operation in the load balancing mode. For additional information see the TIBCO Administrator Server Configuration Guide. | No | /application/repoInstances/rvRepoInstance/regionalSubject | |
| repoInstances-rvRepoInstance-operationRetry | Number of times to retry after a timeout occurs. | No | Undocumented by TIBCO | /application/repoInstances/rvRepoInstance/operationRetry |
| repoInstances-localRepoInstance-encoding | The encoding for a local repository .dat file | No | ISO8859-1 | /application/repoInstances/localRepoInstance/encoding |
The following table details how properties in the propertyset referenced by @{deployment-properties-refid}
are mapped to archive elements in the template configuration file.
Note: The 'Node Mapped To' path is relative to /application/services/(bw|adapter)[@name=#arname#] within the
template configuration file.
| Property Name | Description | Required | Default | Node Mapped To |
|---|---|---|---|---|
| #arname#-enabled | true or false. Only enabled services are deployed. Disabling a service, effectively undeploys just that service while letting all other services in the application run as normal. For example, this can be useful when you wish to deploy an application that includes a service for which you don't have the required software. | No | true | enabled |
| #arname#-failureCount | The value in this field defines how many restarts should be attempted before resetting the error counter to 0. See the TIBCO Administrator User's Guide for more information about this element. | No | failureCount | |
| #arname#-failureInterval | The value in this field defines how much time should expire before resetting the error counter to 0. | No | failureInterval | |
| #arname#-#proc#-enabled | true or false. Only enabled processes are deployed. Disabling a process, effectively undeploys just that process while letting all other processes in the application run as normal. This can be useful, for example when you wish to deploy an application that includes a process for which you don't have the required software. | No | bwprocesses/bwprocess[@name=#proc#]/enabled | |
| #arname#-#proc#-maxJob | Specifies the maximum number of process instances that can concurrently be loaded into memory. | No | bwprocesses/bwprocess[@name=#proc#]/maxJob | |
| #arname#-#proc#-activation | true or false. Specifies that once a process instance is loaded, it must remain in memory until it completes | No | bwprocesses/bwprocess[@name=#proc#]/activation | |
| #arname#-#proc#-flowLimit | Specifies the maximum number of currently running process instance to start before suspending the process starter. | No | bwprocesses/bwprocess[@name=#proc#]/flowLimit | |
| #arname#-bindings | A comma separated list of binding names for the specified archive | Yes | n/a | bindings/binding/@name |
Additionaly, the following setting are mapped to BW archives
Note: The 'Node Mapped To' path is relative to /application/services/bw[@name=#arname#] within the
template configuration file.
| Property Name | Description | Required | Default | Node Mapped To |
|---|---|---|---|---|
| #arname#-isFt | true or false. If true, indicates that this process is part of a fault tolerant group. | No | isFt | |
| #arname#-faultTolerant-hbInterval | Heartbeat Interval. The master engine of a fault-tolerant group broadcasts heartbeat messages to inform the other group members that it is still active. The heartbeat interval determines the time (in milliseconds) between heartbeat messages. In the event if one process engine fails, another engine detects the stop in the master's heartbeat and resumes operation in place of the other engine. All process starters are restarted on the secondary, and services are restarted to the state of their last checkpoint. | No | faultTolerant/hbInterval | |
| #arname#-faultTolerant-activationInterval | Activation Interval (ms) - A standard TIBCO Rendezvous fault tolerant parameter, documented in the TIBCO Rendezvous Concepts chapter 15, Developing Fault Tolerant Programs. Secondary process engines track heartbeat messages sent from the master engine. This field specifies the amount of time to expire since the last heartbeat from the master before the secondary restarts the process starters and process engines. The Heartbeat Interval should be smaller than the Preparation Interval, which should be smaller than the Activation interval. It is recommended that Activation Interval be slightly over 2 heartbeats. | No | faultTolerant/activationInterval | |
| #arname#-faultTolerant-preparationDelay | Preparation Interval (ms) - A standard TIBCO Rendezvous fault tolerant parameter, documented in the TIBCO Rendezvous Concepts chapter 15 Developing Fault Tolerant Programs). When a master engine resumes operation, the secondary engine shuts down and returns to standby mode. For some sitbuildions, it may be necessary to ensure that the secondary engine has completely shut down before the master engine resumes operation. This field is used to specify a delay before the master engine restarts. When the time since the last heartbeat from an active member exceeds this value, the ranking inactive member will receive a 'hint' so that it can prepare for activation. | No | faultTolerant/preparationDelay |
The following table details how properties in the propertyset referenced by @{deployment-properties-refid}
are mapped to binding elements in the template configuration file.
Note: The 'Node Mapped To' path is relative to /application/services/(bw|adapter)[@name=#arname#]/bindings/binding[@name=#bname#] within the
template configuration file.
| Property Name | Description | Required | Default | Node Mapped To |
|---|---|---|---|---|
| #arname#-#bname#-machine | The machine to bind this application to. | Yes | n/a | machine |
| #arname#-#bname#-product-version | The installed product version to use. | No | product/version | |
| #arname#-#bname#-product-location | The product's directory location. | No | product/location | |
| #arname#-#bname#-container | Lists the Formflow archive name and container. | No | container | |
| #arname#-#bname#-description | Information about the binding. | No | description | |
| #arname#-#bname#-contact | Name of the person responsible for this application. | No | contact | |
| #arname#-#bname#-setting-startOnBoot | Specifies that the service instance should be started whenever its machine restarts. | No | setting/startOnBoot | |
| #arname#-#bname#-setting-enableVerbose | Enables verbose tracing. | No | setting/enableVerbose | |
| #arname#-#bname#-setting-maxLogFileSize | Specifies the maximum size (in Kilobytes) a log file can reach before the engine switches to the next log file. | No | setting/maxLogFileSize | |
| #arname#-#bname#-setting-maxLogFileCount | Undocumented by TIBCO | No | Undocumented by TIBCO | setting/maxLogFileCount |
| #arname#-#bname#-setting-threadCount | Number of threads assigned. | No | 8 | setting/threadCount |
| #arname#-#bname#-setting-NTService-runAsNT | true or false. When true, the service is run as a Microsoft Windows Service. You can then manage the engine as you would any other service, and you can specify that it starts automatically when the machine reboots. | No | setting/NTService/runAsNT | |
| #arname#-#bname#-setting-NTService-startupType | Set to one of the service startup types, Automatic, Manual, or Disabled. | No | setting/NTService/startupType | |
| #arname#-#bname#-setting-NTService-loginAs | The login account for the service, if any. The domain name must be specified. If the login account is defined on the local machine, the domain is '.'. For example, user jeff on the local machine would be specified as .\jeff. | No | setting/NTService/loginAs | |
| #arname#-#bname#-setting-NTService-password | Password for the login account. | No | setting/NTService/password | |
| #arname#-#bname#-setting-java-prepandClassPath | The items you provide here are prepended to your CLASSPATH environment variable. You can specify a Java code editor, or the jar file from a JNDI provider if you wish to use TIBCO BusinessWorks to receive and process JMS messages. | No | setting/java/prepandClassPath | |
| #arname#-#bname#-setting-java-appendClassPath | The items you provide here are appended to your CLASSPATH environment variable. You can specify a Java code editor, or the jar file from a JNDI provider if you wish to use TIBCO BusinessWorks to receive and process JMS messages. | No | setting/java/appendClassPath | |
| #arname#-#bname#-setting-java-initHeapSize | Initial size for the JVM used for the process engine. | No | 32 MB. | setting/java/initHeapSize |
| #arname#-#bname#-setting-java-maxHeapSize | Maximum size for the JVM used for the process engine. | No | 128 MB. | setting/java/maxHeapSize |
| #arname#-#bname#-setting-java-threadStackSize | Size for the thread stack. | No | 128 KB. | setting/java/threadStackSize |
| #arname#-#bname#-ftWeight | When a process joins a fault tolerance group, it specifies its weight as a parameter. Weight represents the ability of a member to fulfill its function, relative to other members of the same group. See the TIBCO Rendezvous Concepts book for information about using fault tolerance groups. | No | ftWeight | |
| #arname#-#bname#-shutdown-checkpoint | When true, the process engine waits for all jobs to finish (up to the maximum timeout) before shutting down the engine, rather than removing jobs at their next checkpoint. | No | shutdown/checkpoint | |
| #arname#-#bname#-shutdown-timeout | The maximum timeout in seconds the process engine will wait for jobs to finish before shutting down the engine. A zero (0) value means 0 seconds, which effectively turns the graceful shutdown into an immediate shutdown. | No | shutdown/timeout |
The Global Variables default to the values specified from with designer. They are applied to all
archives within the Enterpise Archive. You can overide the default by adding properties to the
propertyset referenced by global-variables-refid in the following form:
#global variable name#
For instance, to set the HawkEnabled global variable to true, you need add the HawkEnabled
property to the propertyset referenced by global-variables-refid. The property can be declared
in your Ant build file:
<property name="HawkEnabled" value="true"/>
or in a properties file that is loaded by your Ant build file
HawkEnabled=true
The following global variables are predefined by default:
| Name | Description |
|---|---|
| DirLedger | Used by the system when defining the path name of the TIBCO Rendezvous certified messaging ledger file. The default is the root installation directory. |
| DirTrace | Used by the system to partially create the path name for log file used by the adapter. The default is the root installation directory. |
| HawkEnabled | Used by the system to indicate whether TIBCO Hawk is used to monitor the adapter. True indicates that a Hawk microagent is defined for the adapter. False indicates the microagent is not to be used. Default is False. |
| JmsProviderUrl | A JMS provider URL tells applications where the JMS daemon is located. Setting this value mostly makes sense in early stages of a project, when only one JMS daemon is used. |
| JmsSslProviderUrl | Specifies where the JMS server, running in the SSL mode, is located. Setting this value mostly makes sense in the early stages of a project, when only one JMS server is used. |
| RemoteRvDaemon | Used by the system to identify the TIBCO Rendezvous routing daemon. See TIBCO Rendezvous Administration for details about specifying the routing daemon name. |
| RvDaemon | Used by the system to identify the TIBCO Rendezvous daemon parameter. The parameter instructs the transport object about how and where to find the Rendezvous daemon and establish communication. The default value is 7500, which is the default value used by the Rendezvous daemon. See TIBCO Rendezvous Concepts for details about specifying the daemon parameter. |
| RvNetwork | Used by the system to identify the TIBCO Rendezvous network parameter. Every network transport communicates with other transports over a single network interface. On computers with more than one network interface, the network parameter instructs the TIBCO Rendezvous daemon to use a particular network for all outbound messages from this transport. See TIBCO Rendezvous Concepts for details about specifying the network parameter. |
| RvService | Used by the system to identify the TIBCO Rendezvous service parameter. The Rendezvous daemon divides the network into logical partitions. Each transport communicates on a single service; a transport can communicate only with other transports on the same service. See TIBCO Rendezvous Concepts for details about specifying the service parameter. Default is 7500. |
| RvaHost | Used by the system to identify the computer on which the TIBCO Rendezvous agent runs. See TIBCO Rendezvous Administration for details about specifying the rva parameters. |
| RvaPort | Used by the system to identify the TIBCO Rendezvous agent TCP port where the agent listens for client connection requests. See TIBCO Rendezvous Administration for details about specifying the rva parameters. Default is to 7501. |
| TIBHawkDaemon | Used by the system to identify the TIBCO Hawk daemon parameter. See the TIBCO Hawk Installation and Configuration manual for details about this parameter. Default is the value that was set during domain creation (7474 by default). |
| TIBHawkNetwork | Used by the system to identify the TIBCO Hawk network parameter. See the TIBCO Hawk Installation and Configuration manual for details about this parameter. Default is an empty string. |
| TIBHawkService | Used by the system to identify the TIBCO service parameter. See the TIBCO Hawk Installation and Configuration manual for details about this parameter. Default is 7474. |
| MessageEncoding | The message encoding set for the application. The default value is ISO8859-1, which only supports English and other western European languages that belong to ISO Latin-1 character set. After the project is deployed in an administration domain, the messaging encoding set at design time is overridden by the domain's encoding property. All the TIBCO components working in the same domain must always use the same encoding for intercommunication. See TIBCO Administrator Server Configuration Guide for more information. |
Runtime Variables are Global Variables that have the Service option within Designer checked. This allows different values of the variable to be specified for different archives within the Enterprise Archive.
Runtime Variables are set using properties in the following form:
#archive name#-#global variable name#
For instance, to set the HawkEnabled global variable to false for an archive named
Process Archive.par, you need add the Process Archive.par-HawkEnabled property to the
propertyset referenced by global-variables-refid. The property can be declared in your Ant
build file:
<property name="Process Archive.par-HawkEnabled" value="false"/>
or in a properties file that is loaded by your Ant build file
Process\ Archive.par-HawkEnabled=false
Note: When specifying properties in a property file, you must escape space characters in the
property name using the \ character.
When TIBant is substituting the Runtime Variables in the template configuration file, it will use the matching Runtime Variable property if found, otherwise it will use the equivalent Global Variable property if found, otherwise it will use the value specified from within designer.
Instance Runtime Variables are Global Variables that have the Service option within Designer checked.
This allows different values of the variable to be specified for different instances of archives within the
Enterprise Archive.
Instance Runtime Variables are set using properties in the following form:
#archive name#-#binding name#-#global variable name#
For instance, to set a HTTPPort global variable to 9696 for a binding named PAR 1 and
to 9697 for a binding named PAR 2 in an archive named Process Archive.par, you need add
the Process Archive.par-PAR 1-HTTPPort and Process Archive.par-PAR 3-HTTPPort properties to the
propertyset referenced by global-variables-refid. The properties can be declared in your Ant
build file:
<property name="Process Archive.par-PAR 1-HTTPPort" value="9696"/> <property name="Process Archive.par-PAR 2-HTTPPort" value="9697"/>
or in a properties file that is loaded by your Ant build file
Process\ Archive.par-PAR\ 1-HTTPPort=9696 Process\ Archive.par-PAR\ 2-HTTPPort=9697
Note: When specifying properties in a property file, you must escape space characters in the
property name using the \ character.
When TIBant is substituting the Instance Runtime Variables in the template configuration file, it will use the matching Instnace Runtime Variable property if found, otherwise it will use the equivalent Runtime Variable property if found, otherwise it will use the equivalent Global Variable property if found, otherwise it will use the value specified from within designer.
The Adapter SDK Properties are specified by the properties in the propertyset referenced by
adapter-sdk-properties-refid. Adapter SDK Properties can be are applied to a specific archive
or for all archives.
Adapter SDK Properties for a specific archive are specified in the following form:
#archive name#-#adapter sdk property name#
Adapter SDK Properties for all archives are specified in the following form:
#adapter sdk property name#
For instance, to set the bw.engine.jobstats.enable Adapter SDK Property to true for all archives,
you need add the bw.engine.jobstats.enable property to the propertyset referenced by
adapter-sdk-properties-refid. The property can be declared in your Ant build file:
<property name="bw.engine.jobstats.enable" value="true"/>
or in a properties file that is loaded by your Ant build file
bw.engine.jobstats.enable=true
As another example, to set the bw.engine.jobstats.enable Adapter SDK Property to false for an archive named
Process Archive.par, you need add the Process Archive.par-bw.engine.jobstats.enable property to the
propertyset referenced by adapter-sdk-properties-refid. The property can be declared in your Ant build file:
<property name="Process Archive.par-bw.engine.jobstats.enable" value="false"/>
or in a properties file that is loaded by your Ant build file
Process\ Archive.par-bw.engine.jobstats.enable=false
Note: When specifying properties in a property file, you must escape space characters in the
property name using the \ character.
When TIBant is substituting the Adapter SDK Properties in the template configuration file, it will use
the matching properties in the form #archive name#-#adapter sdk property name# if found, otherwise it
will use matching properties in the form #adapter sdk property name# if found, otherwise it will use
the value in the input xml file.
The Adapter SDK Properties for BusinessWorks engines that can be set using AppManage and TIBCO Administrator are
controlled by the file ${tibant.home.bw}/lib/com/tibco/deployment/bwengine.xml. Adapter SDK Properties that are not
present in bwengine.xml when the EAR is built will be silently ignored by AppManage and will not appear in TIBCO
Administrator. To prevent this from occuring, this macro will generate an error and terminiate if you try to set an
Adapter SDK Property that was not in the bwengine.xml when the EAR was built (new in TIBant version 1.4.0), unless
fail-on-unknown-adapter-sdk-properties is set to false.
The following Adapter SDK Properties are predefined for TIBCO BusinessWorks engines:
| Name | Default | Description |
|---|---|---|
| Trace.Task.* | false | Controls whether or not trace messages for all activities are output. |
| EnableMemorySavingMode | false | Memory saving mode can reduce the memory used by actively running process
instances as well as potentially improve the performance of checkpoints. You can enable memory saving mode for
all process instances by setting the EnableMemorySavingMode property to true. |
| bw.engine.enableJobRecovery | false | This property specifies whether checkpoint data for process instances that fail due to unhandled exceptions or manual termination should be saved. Saving the checkpoint data allows the process instance to be recovered at a later time. By default, this property is set to false indicating that checkpoint data for failed process instances is not saved. Setting this property to true saves checkpoint data for failed process instances and these process instances can be recovered at a later time using the Job Recovery dialog in TIBCO Administrator. |
| bw.engine.autoCheckpointRestart | true | This property controls whether checkpointed process instances are automatically restarted when a process engine restarts. By default, this property is set to true, indicating that checkpointed process instances should automatically be restarted. You can set this property to false, and any checkpointed process instances can later be recovered using the Job Recovery dialog in TIBCO Administrator. This allows you to handle any resource availability problems such as database recovery or bringing up a web server before handling the process instance recovery. |
| bw.engine.jobstats.enable | false | This property controls process instance statistic collection. The default value of this property is false indicating that statistics for each process instance should not be stored. Setting this property to true enables the gathering of statistics for each process instance. |
| log.file.encoding | the default encoding of the Java Virtual Machine | The value of this property specifies the character encoding to use when writing to the log file. Any valid Java character encoding name can be used. For a list of potential character encoding names, see the Encoding field on the Configuration tab of the Parse Data activity. |
| bw.engine.emaEnabled | false | Setting this property to true enables communication with TIBCO EMA. A resource dependency list for all process definitions executing in this engine is created and processes are suspended when TIBCO EMA communicates the unavailability of any dependent resources. |
| bw.container.service | empty | |
| bw.container.service.rmi.port | 9995 | |
| bw.platform.services.retreiveresources.Enabled | false | This property specifies whether the Built-in Resource Provider feature is enabled or not. Setting it to true enables the feature. |
| bw.platform.services.retreiveresources.Hostname | localhost | This property specifies the hostname to which the request will be sent. It is useful to identify the exact host in a multi-host configuration to whom the request will be sent. |
| bw.platform.services.retreiveresources.Httpport | 8010 | This property specifies the port number that is configured to listen for incoming HTTP requests. |
| bw.platform.services.retreiveresources.defaultEncoding | ISO8859_1 | This property specifies the encoding to use for the URL if no charset is specified in the Content Type header of the message. |
| bw.platform.services.retreiveresources.enableLookups | false | This property, when set to true, enables the HTTP client to look up a Domain Name System and resolve the IP address to a DNS Name. Setting this property to true adversely affects the throughput. Hence this property can be enabled only when required. |
| bw.platform.services.retreiveresources.isSecure | false | This property specifies if the incoming requests must use the HTTPS (secure socket layer) protocol. The HTTPS protocol authenticates the server to the client. |
| bw.platform.services.retreiveresources.identity | /Identity_HTTPConnection.id | This property specifies the Identity resource that contains the HTTP Server's digital certificate and private key. This property is available when the bw.platform.services.retreiveresources.isSecure property is set to true. |
| bw.log4j.configuration | empty | Specify the location of the log4j configuration file. If the log4j configuration file is in the XML configuration format, then specify the file name with the .xml file extension. |
| clientAck | false | |
| redelivery | false |
The following Adapter SDK Properties are available for TIBCO BusinessWorks engines, once they have been added to bwengine.xml:
| Name | Default | Description |
|---|---|---|
| bw.engine.dupKey.enabled | true | This property controls whether duplicate detection is performed. true
indicates the process engine will check for identical duplicateKey values. false indicates duplicateKeys
when specified are ignored. |
| bw.engine.dupKey.timeout.minutes | 30 | This property specifies how long (in minutes) to keep stored
duplicateKeys. 0 indicates the duplicateKey is removed when the job is removed. However, if
bw.engine.enableJobRecovery=true, the job is not automatically removed after a failure so the duplicateKey
will remain as long as the job remains. Such a job can be restarted or purged later. -1 indicates to store
duplicateKey values indefinitely. Any positive integer greater than 0 indicates the number of minutes to keep
stored duplicateKeys. |
| bw.engine.dupKey.pollPeriod.minutes | Undocumented by TIBCO | Specifies the number of minutes to wait before
polling for expired duplicateKey values. |
| bw.engine.stats.dir | <engineWorkingDir>/stats | This property specifies the location of the process instance and activity statistic files when statistics storing is enabled. |
| bw.engine.jobstats.rollover | Inconsitantly documented by TIBCO. Either 1024B or 1MB | This property specifies the maximum size (in bytes) for process instance statistic files. Once a file reaches the specified size, a statistics are written to a new file. |
| EnableMemorySavingMode.<processName> | false | Memory saving mode can reduce the memory used by actively running
process instances as well as potentially improve the performance of checkpoints. You can enable memory saving
mode for a specific process instances by setting the EnableMemorySavingMode.<processName> property to
true. |
| Engine.dir | ${tibco.home} / tra / domain / <domainName> / application / <appName> | When the process engine is configured to use local file for storage, this property controls the location of the process engine storage. Normally, you should not need to change the default location of engine storage. |
| Engine.ShutdownOnStartupError | false | By default, checkpointed process instances are restarted when the engine
restarts, and if the engine encounters errors during startup, the restarted process instances continue to be
processed and may eventually be lost depending upon the type of error at startup. You can specify that the
process engine should shutdown if any errors are encountered during startup so that checkpointed jobs are not
lost in the event of an error. Setting this property to true shuts the engine down if errors are encountered
when the engine starts. |
| Engine.StandAlone | true | Under some sitbuildions, a unique constraint violation is thrown when using a database as
the data manager for process engines. Set this property to false if you encounter this sitbuildion. |
| Engine.StepCount | 20 | This property controls the max number of execution steps (unless inside a transaction) for a job before an engine thread switch occurs. Frequent thread switching can cause engine performance degradation, but when a process instance keeps the tread too long, this may cause less concurrency for executing process instances (and therefore inefficient use of CPU). Therefore, it is difficult to determine the correct value for this property. The default value is sufficient for most sitbuildions, but if your process definitions contain a large number of activities and especially if they contain a large number of activities in iteration loops, you may benefit from setting this property to a higher value. |
| Engine.ThreadCount | 8 | This property controls the number of threads available for executing process instances
concurrently. On a multi-CPU machine, this property can be increased. However, too many threads can
cause resource contention. Hence you need to experiment with it to decide on a higher Engine.ThreadCount
value. |
| Hawk.Enabled | Undocumented by TIBCO | Controls whether or not TIBCO Hawk can be used to monitor and manage the
process engine. Also, allows the Engine Command activity to be used. true enables both TIBCO Hawk and Engine
Command activity usage. local enables only Engine Command activity. TIBCO Hawk cannot be used when this value
is used. false disables both TIBCO Hawk and Engine Command activity usage. |
| Hawk.Service | 7474 | Specifies the service parameter for the TIBCO Rendezvous transport of your TIBCO Hawk configuration. |
| Hawk.Network | empty | Specifies the network parameter for the TIBCO Rendezvous transport of your TIBCO Hawk configuration. |
| Hawk.Daemon | tcp:host:7474 | Specifies the daemon parameter for the TIBCO Rendezvous transport of your TIBCO Hawk configuration. |
| Instrumentation.<processName> | false | Some of the TIBCO Hawk instrumentation methods require runtime actions
that impose performance and memory overhead. These actions can be enabled or disabled on a per-process
definition basis at any time by setting this property. The actions that can be enabled or disabled are:
* collection of activity statistics for the GetActivity microagent method
* calls to OnProcessActivity and OnProcessStatusChanged microagent methods.
Setting the engine property Instrumentation.* to true enables those actions for all process definitions.
Setting the property Instrumentation.<processName> to true enables those actions for a specified process
definition. Setting this property to false disables the actions.
The instrumentation properties can be set at runtime by calling the TIBCO Hawk setInstrumentProperties method.
The property value specified in a call to setInstrumentProperties takes effect immediately. |
| Trace.Role.<userRoleName>.Term | Undocumented by TIBCO | controls whether or not messages for the specified
user-defined role are sent to the console; use Trace.Role.*.Term to control console output for all
user-defined roles. |
| Trace.<systemRoleName>.Term | Undocumented by TIBCO | controls whether or not messages for the specified system role (Error, Warn, Info, or Debug) are sent to the console. |
| Trace.Role.<userRoleName>.Log | Undocumented by TIBCO | controls whether or not messages for the specified
user-defined role are sent to the log file; use Trace.Role.*.Log to control log output for all user-defined
roles. |
| Trace.<systemRoleName>.Log | Undocumented by TIBCO | controls whether or not messages for the specified system role (Error, Warn, Info, or Debug) are sent to the log file. |
| Trace.Role.<systemRoleName>.Publish | Assumed to be false | controls whether or not messages for the specified system role (Error, Warn, Info, or Debug) are published as a TIBCO Rendezvous message. By default, the messages are sent on TIBCO ActiveMatrix BusinessWorks default transport. |
| Trace.<systemRoleName>.Publish.Subject | Undocumented by TIBCO | The TIBCO Rendezvous subject used for publishing Trace messages. |
| Trace.<systemRoleName>.Publish.Service | Assumed to be 7500 | The TIBCO Rendezvous service used for publishing Trace messages. |
| Trace.<systemRoleName>.Publish.Network | Assumed to be "" | The TIBCO Rendezvous network used for publishing Trace messages. |
| Trace.<systemRoleName>.Publish.Daemon | Assumed to be tcp:host:7500 | The TIBCO Rendezvous daemon used for publishing Trace messages. |
| Trace.Role.<userRoleName>.Log.Dir | Undocumented by TIBCO | Location for the set of rolling log files for the specified user role |
| Trace.Role.<userRoleName>.Log.File | Undocumented by TIBCO | Filename for the log files for the specified user role. A number is appended to each new log file created up to the specified maximum number of log files. |
| Trace.Role.<userRoleName>.Log.MaxSize | Undocumented by TIBCO | Maximum size of a log file for the specified user role, before entries are directed to the next log file in the sequence. |
| Trace.Role.<userRoleName>.Log.Maximum | Undocumented by TIBCO | Maximum number of log files to create for the specified user role. Entries are directed back to the first log file when the maximum number of log files have been created. |
| Trace.Role.<userRoleName> | Undocumented by TIBCO | Enables or disables the specified user-defined role;
specify Trace.Role.* to enable or disable all user-defined roles. |
| Trace.<systemRoleName>.* | Assumed to be true | Enables or disables the specified system role (Error, Warn, Info or Debug). |
| Trace.Task.<processDefinition>.<activityName> | Assumed to be false | Controls whether or not trace messages for a given activity in a process definition are output. Specifying a wildcard for the process definition name indicates you would like to control trace messages for all activities with a given name. Specifying a wildcard for the activity name indicates you would like to control trace messages for all activities in the specified process definition. |
| Trace.JC.<processStarterName> | Assumed to be false | Controls whether or not trace messages for a given
process starter are output. Specify Trace.JC.* to control trace messages for all process starters. |
| bw.engine.showInput | Assumed to be false | When set to true, resources that have input will include the
input XML in the trace messages for that resource. |
| bw.engine.showOutput | Assumed to be false | When set to true, resources that have output will include the
output XML in the trace messages for that resource. |
| Trace.RV.Advisory.Error | Undocumented by TIBCO | controls whether TIBCO Rendezvous Error advisory messages are sent to the TIBCO ActiveMatrix BusinessWorks log file. |
| Trace.RV.Advisory.Warn | Undocumented by TIBCO | controls whether TIBCO Rendezvous Warn advisory messages are sent to the TIBCO ActiveMatrix BusinessWorks log file. |
| Trace.RV.Advisory.Info | Undocumented by TIBCO | controls whether TIBCO Rendezvous Info advisory messages are sent to the TIBCO ActiveMatrix BusinessWorks log file. |
| com.tibco.xml.xpath.create-dateTime.has.timezone | Undocumented by TIBCO | This property determines whether a
time zone is added by the XPath function create-dateTime. TIBCO strongly advises against modifying this
property unless you are told to do so by TIBCO Support. |
| com.tibco.xml.xpath.variable-declaration-required | false | This property controls whether variable references are checked. |
| com.tibco.xml.schema.preserve-boolean-lexical-value | false | This property specifies whether the lexical value of
xs:boolean is preserved. TIBCO strongly advises against modifying this property unless you are told to do so
by TIBCO Support. |
| bw.plugin.security.strongcipher.minstrength | DISABLED_CIPHERS_BELOW_128_BIT | Specifies the cipher suites you
wish to exclude when the Strong Cipher Suites Only checkbox is checked in an SSL configuration. This property
allows you to choose the types of cipher suites you wish to disable. Equivalent key strength is taken into
account, for example ciphers like 3DES using 168 bits would be equivalent to an equivalent key length of 112
bits. This property is also only applicable for resources that have the Strong Cipher Suites only field
checked.
The following are the valid values for this property:
|
| Engine.WaitNotify.SweepInterval | 60 | Notify timeouts cause the notify information to be marked for removal, but the information is removed at regular intervals. If you wish to alter the interval, you can do so by setting this property to the desired number of seconds. However, as you decrease the number of seconds in the interval you will incur greater engine overhead. |
| log.file.encoding | the default encoding of the Java Virtual Machine used by the process engine | The value of this property specifies the character encoding to use when writing to the log file. Any valid Java character encoding name can be used. For a list of potential character encoding names, see the Encoding field on the Configuration tab of the Parse Data activity. |
| WaitNotify.Service | Undocumented by TIBCO | When Wait and Notify activities are used across multiple engines, TIBCO Rendezvous is used for communication between the engines. This property specifies the service parameter for the TIBCO Rendezvous transport. |
| WaitNotify.Network | Undocumented by TIBCO | When Wait and Notify activities are used across multiple engines, TIBCO Rendezvous is used for communication between the engines. This property specifies the network parameter for the TIBCO Rendezvous transport. |
| WaitNotify.Daemon | Undocumented by TIBCO | When Wait and Notify activities are used across multiple engines, TIBCO Rendezvous is used for communication between the engines. This property specifies the daemon parameter for the TIBCO Rendezvous transport. |
| bw.plugin.http.protocol.single-cookie-header | Undocumented by TIBCO | This property allows you to send multiple cookies in a single, non-repeating Cookie header element for outgoing HTTP requests in the Send HTTP Request activity. |
| bw.plugin.http.server.allowIPAddresses | Undocumented by TIBCO | This property allows you to specify a comma-separated list of regular expression patterns that is compared with the remote client's IP address before accepting or rejecting requests from the client. The remote IP address of the client must match for the request to be accepted. |
| bw.plugin.http.server.restrictIPAddresses | Undocumented by TIBCO | This property allows you to specify a comma-separated list of regular expression patterns that is compared with the remote client's IP address before accepting or rejecting requests from the client. The remote address of the client must not match for any request from this client to be accepted. |
| bw.plugin.http.server.acceptCount | 100 | This property specifies the maximum queue size for incoming requests.
Incoming requests that are not handled by available threads (see bw.plugin.http.server.minProcessors and
bw.plugin.http.server.maxProcessors) are placed on the queue until they can be processed. If the queue is
full, new incoming requests are refused with an error. This property is available only when the server type
'Tomcat' is selected. |
| bw.plugin.http.server.serverType | Tomcat | This property specifies the server type that is to be used for the HTTP Connection resource. Two server types are available: Tomcat and HTTP Component. |
| bw.plugin.http.server.httpcomponents.workerThread | 50 | This property specifies the maximum number of web server threads available to handle HTTP requests for the HTTPComponents server type. |
| bw.plugin.http.server.minProcessors | 10 | This property specifies the minimum number of threads available for incoming HTTP requests. The HTTP server creates the number of threads specified by this parameter when it starts up. |
| bw.plugin.http.server.maxProcessors | 75 | This property specifies the maximum number of threads available for incoming HTTP requests. The HTTP server will not create more than the number of threads specified by this parameter. If the Flow Limit deployment property is set, the value of this property is set to <valueOfFlowLimit> - 1. |
| bw.plugin.http.server.maxSpareProcessors | 50 | This property specifies the maximum number of unused request processing threads that can exist until the thread pool starts stopping the unnecessary threads. |
| bw.plugin.http.client.ParseEntireMultipartMessage | Undocumented by TIBCO | This property enables the HTTP client to parse the entire multi-part message. Note: For BusinessWorks 5.2, an HTTP response message that is received by the HTTP client, is parsed on the content-type header. When the message is a multi-part message, the attachments are put in the attachment list. In BusinessWorks 5.2, the message body that is exposed to the user should contain the entire message body, including the attachments. However, parsing a multi-part message is not a problem in BusinessWorks 5.3 and later versions as MIME attachments are handled differently. |
| bw.plugin.http.client.ResponseThreadPool | 10 | By default, each Request/Response activity that uses the HTTP
protocol (for example, Send HTTP Request or SOAP Request Reply) is associated with a unique thread pool. Each
request is executed in a separate thread, belonging to the thread pool associated with the activity. Setting
this property to a value specifies the size of the thread pool to use for request/response activities. This
thread pool can be for each activity, or all activities can share the same thread pool. See
bw.plugin.http.client.ResponseThreadPool.type for more information about determining the type of thread pool
to use. The thread pool is created when the engine starts, therefore be careful to set the value of this
property to a reasonable number for your system. If you set the value too high, it may result in extra resources
allocated that are never used. |
| bw.plugin.http.client.ResponseThreadPool.type | default | This property determines the type of thread pool to use
for request/response activities. Either one thread pool per activity is created, or one common thread pool is
created to be shared across all activities. Specify default as the value of this property if you wish to
create a thread pool for each activity. Specify single as the value of this property if you wish to create a
single, common thread pool for all activities. The size of the thread pool is determined by the value of the
property bw.plugin.http.client.ResponseThreadPool. When the thread pool type is default, a thread pool of
the specified size is created for each request/response activity. When the thread pool type is single, one
thread pool of the specified size is created and all activities share the same thread pool. |
| bw.plugin.http.client.usePersistentConnectionManager | false | This property specifies that a pool of HTTP
connections to each HTTP server should be created so that connections can be reused by Send HTTP Request
activities. Not all HTTP servers support persistent connections. Refer to your HTTP server documentation for
more information about support for persistent connections.
When this property is set to true, a pool of connections is created for each HTTP server that Send HTTP
Request activities connect to. The total number of connections in the pool is limited by the
bw.plugin.http.client.maxTotalConnections property. The number of connections for each host is limited by the
bw.plugin.http.client.maxConnectionsPerHost property. |
| bw.plugin.http.client.maxConnectionsPerHost | 20 | The value of this property is ignored unless the
bw.plugin.http.client.usePersistentConnectionManager property is set to true. This property specifies the
maximum number of persistent connections to each remote HTTP server. |
| bw.plugin.http.client.maxTotalConnections | 200 | The value of this property is ignored unless the
bw.plugin.http.client.usePersistentConnectionManager property is set to true. This property specifies the
maximum number of persistent connections to create for all HTTP servers. |
| bw.plugin.http.client.checkForStaleConnections | false | The value of this property is ignored unless the
bw.plugin.http.client.usePersistentConnectionManager property is set to true. When using persistent
connections, a connection can become stale. When this property is set to true, a persistent connection is
checked to determine if it is stale before it is used by a Send HTTP Request activity. Checking for stale
connections adds significant processing overhead, but it does improve reliability. |
| bw.plugin.http.handleAllMimePartsAsAttachment | false | In previous releases, when the content-type of an incoming
message was "multipart/*", the first part of the message was presented as the POSTDATA. This is incorrect
according to MIME specification. This property fixes this problem. If this property is set to true and the
top-level content-type of the incoming HTTP message is "multipart/*", then an HTTP Receiver will present all the
MIME parts as attachments and the POSTDATA field will be empty. If this property is set to false, backward
compatibility is maintained and the first MIME part is presented as the POSTDATA.
NOTE: Do not check the Parse Post Method Data field on the HTTP Receiver process starter when this property is
set to true as this causes an error to be thrown. |
| bw.plugin.http.server.debug | Assumed to be fasle | When set to true, specifies that the contents of incoming
HTTP requests are written to the log file. Writing each request to a log file does incur some overhead and
additional processing time. |
| bw.plugin.http.server.defaultHost | Assumed to be localhost | Specifies the name of the default host to use when
the machine has multiple domains or IP addresses. The value of this parameter can be either a host name or IP
address.
When the hostname is localhost, TIBCO BusinessWorks considers the machine as a non-multi-home environment.
Hence it is not required to set this property. However, when the hostname is anything other than localhost,
then TIBCO BusinessWorks considers the machine as a multi-home environment. Set this property
to the same value as has been set in the host field of HTTP Shared Connection for default host. |
| bw.plugin.https.server.deferClientAuthentication | Assumed to be false | Defers client authentication and outputs the client's security context when the client connects to the server using HTTPS. |
| Engine.Database.TestStatement.<name> | Undocumented by TIBCO | When a SQL error occurs during statement
execution, TIBCO ActiveMatrix BusinessWorks executes a test SQL statement to determine if the error is caused by
a bad connection. If the error is due to a bad connection, the statement can be re-executed using a different
connection in the connection pool.
This property allows you to specify a test SQL statement. Specify the
database name in the <name> portion of the property and set the value of the property to a valid SQL
statement. |
| Engine.DBConnection.idleTimeout | 5 | Normally, connections in the database connection pool close after a period of time when they are idle. This property specifies the time (in minutes) to allow database connections to remain idle before closing them. |
| Config.JDBC.Connection.SetLoginTimeout | Undocumented by TIBCO | Time (in seconds) to wait for a successful database connection. Only JDBC drivers that support connection timeouts can use this property. If the JDBC driver does not support connection timeouts, the value of this field is ignored. Most JDBC drivers should support connection timeouts. The value of this property overrides any value set for connection timeouts in the Configuration tab of the JDBC Connection resource. |
| bw.plugin.jms.receiverTimeout | Undocumented by TIBCO | This property specifies the polling interval for JMS activities that receive messages (for example, JMS Topic Subscriber or Wait for JMS Queue Message). Specify an integer as the value of the property to determine the number of seconds to set the default polling interval for all JMS activities that receive messages. Individual activities can override this default polling interval by specifying a value in the Receiver Timeout field on the Advanced tab of the activity. |
| bw.plugin.jms.recoverOnStartupError | Assumed to be false | When a process engine attempts to startup and the JMS server that JMS activities connect to is not up, the JMS process starters cannot connect to the JMS server. Setting this property to true allows the process engine to start and the JMS process starters will wait until the JMS sever is up before starting. |
| bw.plugin.mail.receiverFlattenNesteedAttachments | false | In previous releases, the Receive Mail activity threw
exceptions when receiving email, if the email was in rich text format and the any mime part contained nested
mime sub-parts. You can fix this by setting this property to true which creates a flat output structure where
all sub-parts are siblings. If you rely on the behavior of previous releases, keep this property set to
false. |
| bw.plugin.mail.receiverRetryCount | Not clear from TIBCO documentation | When a mail sender is in the process of sending a message, the mail server may expose the message to the Receive Mail process starter, but indicate later that the message is unavailable. This typically occurs when sending large messages. The Receive Mail process starter attempts to receive the message during subsequent polls of the mail server. By default, the process starter will attempt to receive the message for three minutes. The number of retries within that three-minute limit depends upon the value of the polling interval. For example, if the polling interval is set to 30 seconds, there will be up to six retries. If the polling interval is set to 4 minutes, there will be only one retry. This property allows you to specify the number of times the Receive Mail process starter will attempt to receive the same message. The amount of time allotted for retries will be the value of this property multiplied by the polling interval. For example, if the polling interval is every 10 seconds, and the retry count is set to 12, then the Receive Mail process starter will attempt to receive the message for two minutes. |
| Config.Tibrv.cmQueueTransport.TaskBacklogLimitInBytes | 0 (no limit) | When the RVCMQ transport is used, TIBCO
ActiveMatrix BusinessWorks applies the value of this property to the RVCMQ transport using the RVCMQ API
setTaskBacklogLimitInBytes() method to set the scheduler task queue limits in bytes for the distributed queue
transport. The value of this property must be set to a positive integer. |
| bw.plugin.transaction.xa.arjuna.objectStoreDir | Value from Arjuna property file | By default, when executing the Arjuna Transaction Service within the same JVM as TIBCO ActiveMatrix BusinessWorks, the Arjuna property file is used to determine the location of the object store directory. If you wish to override the value in the Arjuna property file, set this property to a valid directory name. |
| bw.plugin.transaction.xa.isolation | JDBC Driver Dependant | By default in an XA transaction, the transaction
isolation level is set to the default value for the JDBC driver you are using. If you wish to ensure a
particular transaction isolation level, set this property to one of the following values:
|
| bw.plugin.transaction.xa.lock.connection | false | By default, JDBC activities in an XA Transaction groups obtain
database connections from a connection pool and release the connections when the activity completes. This can
cause a database connection to be used concurrently in multiple transactions. Some databases or JDBC drivers
support this behavior and others do not. If you are using a database or JDBC driver that requires database
connections to be used in only one transaction at a time (for example, IBM DB2), set this property to true. When
the value of this property is set to true, once a connection is associated with a transaction, the connection
remains associated with the transaction until the transaction completes. |
| bw.plugin.tcp.server.acceptCount | 50 | This property specifies the maximum number of incoming requests that can be handled by the TCP Server. |
| bw.plugin.ftp.stripLineFeedInPut | false | Prior to release 5.2.0, the FTP Put activity stripped the \n when \r\n
was used for a new line in a file. This caused files to be unusable when a file was taken from a MS Windows
machine and put onto a VMS machine. The FTP Put activity no longer strips the \n, and if you rely on this
behavior in existing projects, you can set this property to true to obtain the behavior of previous releases. |
| bw.plugin.http.client.urlEncodeQueryString | false | As of release 5.2.0, the QueryString input element of the
Send HTTP Request activity is not automatically URL encoded. Prior to release 5.2, the activity used URL
encoding for the Query specified in the QueryString element. It is now the user's responsibility to properly
URL-encode the query specified in the QueryString. Therefore, the activity does attempt to encode the value
supplied in this element. This change may cause backward compatibility issues if you rely on the activity to
perform the URL-encoding of the QueryString. Setting this property to true reverts to the behavior of previous
releases. |
| bw.plugin.javaCode.explicitNull | false | To indicate a null reference, the Java Code activity omits the value in
its output. This causes a String value used as a null place holder when another activity attempts to read the
null in its input. However, other activities did not behave in this way. Other activities pass an explicit null
for null references.
To preserve backward compatibility, the Java Code activity still behaves the same. However, you can set this
property to true to cause the Java Code activity to behave in the same way as other activities. When this
property is set to true, an explicit null is set for a null reference. Keeping this value set to false
maintains the behavior of the previous releases. |
| bw.plugin.parseData.enforceLineLength | true | In previous releases, the line length specified in the Data Format
resource was not enforced. This allowed files with one large line to be parsed in some sitbuildions. In more
recent releases, the line length is enforced so that files containing one large line are no longer allowed. If
you rely on the behavior of the previous releases, set this property to false. |
| bw.plugin.timer.useJavaMonth | Assumed to be false | In previous releases, the Timer process starter used the
Java convention (0-11) for month numbers in its output, however, the expected convention for month numbers is
1-12. In release 5.2.0, the month is returned as a number between 1 and 12. If you rely on the behavior of
previous releases, you can set this property to true to maintain compatibility with previous releases. |
| com.tibco.plugin.soap.no_xsi_type | Assumed to be false | SOAP activities were enhanced in release 2.0.5 to emit
xsi:type attributes. If you wish to maintain backward compatibility and not emit these attributes, you must
set this property to true. |
| com.tibco.xml.xpath.create-dateTime.has.timezone | false | In Release 2.x, the XPath function create-dateTime()
returned a value that included a time zone. In Release 5.1.2 and 5.1.3, the function was changed to omit the
time zone. This property controls whether the time zone is included in the output of the create-dateTime()
function. Setting this property to false omits the time zone from the function output (the same behavior as
5.1.x). Setting this property to true causes the time zone to be included in the function output (the same
behavior as 2.x). |
| Config.JDBC.CallProcedure.InputOptional | Assumed to be false | In releases prior to 5.2.0, the JDBC Call
Procedure activity created input elements that were optional for stored procedure parameters. Optional
parameters have never been supported by this activity. When migrating a project from a previous release, there
will be validation errors for any unspecified input elements for stored procedure parameters. These migrated
projects cannot be executed until the errors are resolved (by using the Mapper Check and Repair button on the
Input tab).
If you wish to migrate a project without fixing this problem, you can do so by setting this property to
true. |
| Config.JDBC.CallProcedure.OutputUseNil | Assumed to be true | Prior to release 5.1.2, if a value returned from a
database table was null, the output element corresponding to that table value was not placed into the output
schema for a JDBC Call Procedure activity, if the output element was optional. The element is now placed into
the output schema and has "xsi:nil = true" to indicate the element is null.
You should surround elements that can be nil with an if statement to determine whether to output the element.
To maintain the behavior of previous releases, this property controls whether elements that are nil are
contained in the output. Set the property to false to achieve the behavior of previous releases. |
| ignore.delimiters.under.quotes | Assumed to be false | Prior to Release 2.0.4, when using the activities in the
Parse palette, delimiter-separated data was not treated in a standard way. There was no mechanism to escape the
specified delimiter character. For example, if you chose a comma as the delimiter, there was no way to have a
field contain a comma as in "Fresno, CA". Also, there was no way to have a field span multiple lines or include
leading and trailing spaces. Now fields can be surrounded in double quotes. To disable this functionality,
set the value of this property to true. |
| java.property.DiscardUTF8BOM | Not clear from TIBCO documentation | When a file is saved on a Windows platform using UTF-8
encoding, Windows adds a Byte Order Mark (BOM) to the beginning of the file. This BOM is not necessary for
UTF-8, but it is valid. Prior to release 2.0.6, the File Reader activity's output includes the BOM at the
beginning of the data read from the file.
The BOM is now stripped when it is encountered. If you wish to retain the functionality of previous releases,
you can set this property to false. In most cases, you will not need to set this property. You may need to set
this property to true if your process definition is expecting a file that contains the BOM. |
| java.property.com.tibco.schema.ae.makeNillable | true | Certain TIBCO ActiveEnterprise-based schema elements do
not display as nillable in the Input mapping tab. This can result in mappings (optional to optional) that do not
copy the xsi:nil attributes at runtime to the output elements, and subsequently validation errors.
Setting this property to true causes mappings that meet the criteria to show warnings. Selecting the input
mapping with an error and clicking the Mapper Check and repair button will display yellow warnings: "The input
and this element are both nillable, set to copy-nil". Clicking OK changes the mappings to add the copy-of for
the nil attribute ("Optional and nillable to optional and nillable"). This is generally a better way to map this
structure and ensures if the element in the source data has the xsi:nil attribute, it will be copied to the
target element.
In Release 5.2.1 and subsequent releases, the default setting for this property is true, which may cause new
warnings to appear in existing projects. Typically, the Mapper Check and repair button can be used to update the
mappings to copy xsi:nil attributes. If it is preferable to have empty elements emitted in this case, then the
property can be set to false.
Any new mapping done by drag-and-drop with the property set to true will have the "Optional and nillable"
style mapping, instead of the "optional to optional" style. |
Opens a project in TIBCO Designer
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| project | The name of the TIBCO Designer Project. e.g., MyProject | Yes | n/a |
| dir | The directory the TIBCO Designer Project is in. e.g., src/bw | Yes | n/a |
| aliases-refid | A propertyset refid for the file aliases needed by the project | No | empty-set |
| global-variables-refid | A propertyset refid for the Global variables to use when running the project in the Designer Tester. See the | No | empty-set |
| properties-refid | A propertyset refid for the properties to use when running the project in the Designer Tester. For instance setting (Available since version 11) | No | empty-set |
| working-dir | The working directory to launch TIBCO Designer from. e.g., build/working/@{project} | No | build/working/@{project} |
| create-dtl-file | If true, create the | No | false |
| heap-size | Specifies the initial Java heap size to allocate | No | ${tibco.designer.heap.size} |
| custom-path | the value to use for tibco.env.PATH | No | %EXISTING-VALUE% |
| custom-cp-ext | the value to use for tibco.class.path.extended | No | %EXISTING-VALUE% |
| custom-palette-path | the value to use for java.property.palettePath | No | %EXISTING-VALUE% |
| custom-lib-path | the value to use for tibco.env.LD_LIBRARY_PATH, tibco.env.SHLIB_PATH, tibco.env.LIBPATH | No | %EXISTING-VALUE% |
| application-args | Specifies the remaining command line arguments to pass into the application:
| No | |
| taskname | No | tibant:designer |
Generates a properties file suitable for use with TIBant from an XML configuration file that's been exported from an Administration Domain.
This macro is primarily of use to new users of TIBant, who currently manage their BW engine environment configurations directly in the XML files that are used during deployment. This macro provides an easy way to move your current settings into properties files, allowing you to simplify your environment configuration.
(Available since verison 1.4.2)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| xml | The Configuration file to extract the properties from | Yes | n/a |
| out | The output file for the extracted properties | Yes | n/a |
| classpath | the classpath to the saxon jar | No | ${saxon-b.jar} |
Creates a template configuration file for an Enterprise Archive.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| ear | The Enterprise Archive to create a template configuration file for. e.g., build/MyProject.ear | Yes | n/a |
| out | The output file for the template configuration file. e.g., build/MyProject.xml | Yes | n/a |
| force | Force the re-creation of the template configuration file, even if the Enterpise archive has not changed. | No | false |
| taskname | No | tibant:extract-config |
Generates a properties file suitable for use with TIBant from an XML configuration file that's been exported from an Administration Domain.
This macro is primarily of use to new users of TIBant, who currently manage their BW engine environment configurations directly in the XML files that are used during deployment. This macro provides an easy way to move your current settings into properties files, allowing you to simplify your environment configuration.
(Available since verison 1.4.2)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| xml | The Configuration file to extract the properties from | Yes | n/a |
| out | The output file for the extracted properties | Yes | n/a |
| classpath | the classpath to the saxon jar | No | ${saxon-b.jar} |
Generates a properties file suitable for use with TIBant from an XML configuration file that's been exported from an Administration Domain.
This macro is primarily of use to new users of TIBant, who currently manage their BW engine environment configurations directly in the XML files that are used during deployment. This macro provides an easy way to move your current settings into properties files, allowing you to simplify your environment configuration.
(Available since verison 1.4.2)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| xml | The Configuration file to extract the properties from | Yes | n/a |
| out | The output file for the extracted properties | Yes | n/a |
| classpath | the classpath to the saxon jar | No | ${saxon-b.jar} |
Generates a properties file suitable for use with TIBant from an XML configuration file that's been exported from an Administration Domain.
This macro is primarily of use to new users of TIBant, who currently manage their BW engine environment configurations directly in the XML files that are used during deployment. This macro provides an easy way to move your current settings into properties files, allowing you to simplify your environment configuration.
(Available since verison 1.4.2)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| xml | The Configuration file to extract the properties from | Yes | n/a |
| out | The output file for the extracted properties | Yes | n/a |
| classpath | the classpath to the saxon jar | No | ${saxon-b.jar} |
Loads the ant-contrib library. The ant-contrib library must be loaded (either via this macro or by your own taskdef statement) before calling any of the other TIBant macros.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| taskname | No | tibant:load-ant-contrib | |
| ant-contrib-jar | (Deprecated.) The path to the ant-contrib.jar is now calcualted automatically based on the | No | |
| commons-httpclient-jar | (Deprecated.) The path to the commons-httpclient.jar is now calcualted automatically based on the | No | |
| commons-logging-jar | (Deprecated.) The path to the commons-loggin.jar is now calcualted automatically based on the | No | ${commons-logging.jar} |
| commons-codec-jar | (Deprecated.) The path to the commons-codec.jar is now calcualted automatically based on the | No | ${commons-codec.jar} |
Obfuscate or encrypts confidential information such as passwords in property files.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| src | A properties file you wish to encrypt. e.g., config/prod.properties | Yes | n/a |
| dest | The file you want to store the encyrpted properties in. e.g., build/prod.properties | Yes | n/a |
| verbose | if true, output diagnostic messages | No | false |
| password | A custom encryption key. The encryption key is derived from a password provided by you. To use it, add the prefix #!! to the data you want to encrypt and use -password or -passwordFile command line parameters as appropriate. The password can contain any keyboard characters and has no length limit. If encrypting sensitive data in the deployment configuration file using your custom password, you need to provide the same password when using -passwordFile(See -passwordFile Option in TIBCO Runtime Agent Scripting Deployment User's Guide).
NOTE: Early versions of the obfuscate utility do not support specifiying an encryption password | No | |
| password-file | An encrypted properties file containing only a single entry, representing your encryption password.
NOTE: Early versions of the obfuscate utility do not support specifiying an encryption password | No | |
| taskname | No | tibant:obfuscate |
Encrypts confidential information such as passwords in property files using an encryption key.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| password | The password you wish to encrypt | Yes | n/a |
| password-file | The target file to encrypt it to. | Yes | n/a |
| taskname | No | tibant:obfuscate-password-file |
Overwrites a destination file with the src file only if they differ. This is a utility macro used by other macros in TIBant and is used a file is generated that other tasks are dependant on. In this sitbuildions the depentant task should not be flagged as out of date if the generated file has not changed.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| src | The file that will be copied. e.g., build/properties.cfg.tmp | Yes | n/a |
| dest | The file that will be overwritten. e.g., build/properties.cfg | Yes | n/a |
| taskname | No | tibant:overwrite-if-diff | |
| verbose | If true, output if the files are the same or not. | No | false |
A utility macro to test if TIBCO Hawk has been configured correctly, using a code sample supplied with TIBCO Hawk.
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| domain | The TIBCO Hawk domain. e.g., LOCAL | No | LOCAL |
| service | The TIBCO Rendezvous service used by TIBCO Hawk. e.g., 7474 | No | 7474 |
| network | The TIBCO Rendezvous network used by TIBCO Hawk. e.g., ; | No | ; |
| daemon | The TIBCO Rendezvous daemon used by TIBCO Hawk. e.g., 7474 | No | 7474 |
| taskname | No | tibant:test-hawk-console |
Allows you to validate resources within a TIBCO BusinessWorks Project.
NOTE: On Linux based systems an X-server is required to run the validate executable that this macro uses. On headless systems Xvfb can be used to meet this requirement: http://www.x.org/releases/X11R7.6/doc/man/man1/Xvfb.1.xhtml
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| project | The name of the TIBCO Designer Project. e.g., MyProject | Yes | n/a |
| dir | The directory the TIBCO Designer Project is in. e.g., src/bw | Yes | n/a |
| expected-errors | The number of errors expected during validation. If the number of validation errors does not equal this value then the macro will fail.
Normally you whould not change this from 0, however there are times when a project produce validation errors (e.g. when using the
NOTE: The macro will fail if there are less errors than expected. This is to prevent sitbuildions where you have a number of expected validation errors, and then someone makes a change which results in one of them being removed. At this point, unless this macro fails, it would be possible for new unexpected validation errors (that have not been confirmed to operate correctly) to be introduced.
(Available since version 1.4.0) | No | 0 |
| max-warnings | The maximum number of warnings permitted during validation. If the number of validation warnings exceeds this value then the macro will fail.
(Available since version 1.4.0) | No | unlimited |
| aliases-refid | A propertyset refid for the file aliases needed by the project | No | empty-set |
| working-dir | The working directory. e.g., build/working/@{project} | No | build/working/@{project} |
| create-dtl-file | If true, create the | No | false |
| out | The output file for the validation results, build/working/@{project}/validation.log | No | build/working/@{project}/validation.log |
| force | Force the re-validation of the project, even if it has not changed. | No | false |
| heap-size | Specifies the initial Java heap size to allocate | No | ${tibco.designer.heap.size} |
| custom-path | the value to use for | No | %EXISTING-VALUE% |
| custom-cp-ext | the value to use for | No | %EXISTING-VALUE% |
| custom-palette-path | the value to use for | No | %EXISTING-VALUE% |
| custom-lib-path | the value to use for | No | %EXISTING-VALUE% |
| application-args | Specifies the remaining command line arguments to pass into the application
| No | |
| taskname | No | tibant:validate-project |
Custom XSLT task using Saxon XSLT engine, to workaround Apache Ant Defect 49271 (https://issues.apache.org/bugzilla/show_bug.cgi?id=49271).
(Available since verison 1.4.1)
Parameters specified as attributes.
| Name | Description | Required | Default |
|---|---|---|---|
| in | specifies a single XML document to be styled. | Yes | n/a |
| out | specifies the output name for the styled result from the in attribute. | Yes | n/a |
| style | name of the stylesheet to use - given either relative to the project's basedir or as an absolute path. | Yes | n/a |
| classpath | (Deprecated.) Now determined by the | No | |
| taskname | No | tibant:xslt |
Parameters specified as nested elements.
| Name | Description | Optional | Implicit |
|---|---|---|---|
| params | additional parameters to pass to saxon in the form | true | true |
<tibant:xslt in="myinput.xml"
out="build/myoutput.xml"
style="src/xslt/mystyle.xslt">
<arg value="+myotherinput=myotherinput.xml" />
<arg value="basedir=${basedir}" />
</tibant:xslt>The above example applies the src/xslt/mystyle.xslt stylesheet against myinput.xml. It sets the parameter basedir
to ${basedir} and the parameter myotherinput to the document node of myotherinput.xml and writes the results to
build/myoutput.xml