Deployment File

When deploying an archive by REST you must include a deployment file, which specifies at least one selection criteria for determining which engine and component receives the deployed archive.

The deployment file is a simple properties text file specified by a form-data field like the following for REST upload with the archive: 
     -F "deploymentFile=@YourDeploymentFileName.properties"

The deployment file contains one or more logical statements with a criteria, a comparator, and a value, delimited by spaces: 

criteria comparator value

Some criteria require an argument to be specified in parentheses: 

criteria(argument) comparator value

For example, what follows is a simple statement to deploy an archive to an engine running a component with a component type that contains BusinessWorks as part of the name and which has a domain name of YourDomain: 

ComponentType contains BusinessWorks
ImportedVariable(TIBCO_DOMAIN_NAME) = YourDomain

By default all deployment file criteria statements must be satisfied for the deployment to occur, but you can change how the properties file criteria are evaluated to make them logical OR statements by using the optional cURL form-data switch:   -F "LogicalAnd=false"

Supported Criteria
Name Definition
ComponentName The name of the component.
ComponentType The type of the component.
EnablerName The name of the Enabler running the component.
EnablerVersion The version of the Enabler running the component.
Account The name of the account running the component.
EngineProperty(name) The following named engine properties can be used: 
Engine Id
Engine GUID
Engine Instance
IP Address
Host Name
Number of CPUs
Total CPU Processing Power
Total Memory (KB)
Free Memory (KB)
Free Disk Space (MB)
OS Platform
OS Version
OS Username
Location
vimTemplate
Group
Description
ActivationInfoProperty(name) A named property, such as ClusterName, or HTTP_STATIC_ROUTE_PREFIX within the component’s ActivationInfo object. Archives that can be scaled elastically keep a list of ActivationInfo properties and their respective values for failover Broker.
ImportedVariable(name) A variable imported into a component.
ExportedVariable(name) A variable exported from a component.
Statistic(name) Supported BusinessWorks Enabler statistic like: 
BW Process Count
BW Memory Free Bytes
BW Percentage of Memory Used
BW Average Elapse Execution Time
BW Total Number Error
BW Last Number Error
Total Memory
Free Memory
Free Disk
CPU Utilization
DS CPU Utilization
Expected Engine Count
Actual Engine Count
Allocating Engine Count
ArchiveStatistic(statName, archiveName) A named statistic for a specified archive.
DependencyComponent A named dependency on a component.
DependencyEngine(componentName) A named dependency on an engine running the named component.
Comparator
Valid comparators include =, !=, >, <, <=, >=, matches, contains, !matches, and !contains.

The following is the sample deployment file: 

# Sample deployment file
ComponentType = "TIBCO ActiveMatrix BusinessWorks"
Statistic(CPU Utilization) < 80
ActivationInfoProperty(ClusterName) matches dev_cluster.*