Deploy

ActiveMatrix BusinessWorks application archives may be deployed directly to an appropriate Silver Fabric Engine (TIBCO Logical Machine) by making REST calls. In this document cURL syntax is used to show the REST inputs in a generic form:

For 5.x Version

curl -u UserName:Password \
     -X POST \
     -H "Accept:application/json" \
     -H "Content-Type: multipart/form-data" \
     -F "archiveFile=@YourArchiveName.zip" \
     -F "deploymentFile=@YourDeploymentFileName.properties" \
    [-F "LogicalAnd=false"]
     -v "http://YourSFBroker.com:<port>/livecluster/rest/v1/sf/engines/archives"
    [-F "AppName=YourDirABC/YourAppName"]
    [-F "AppSettings.element1.element2=SomeValue"]
    [-F "ArchiveSettings.element1.element2=SomeValue"]
    [-F "Archives=Archive_A,Archive_B,Archive_X"]
    [-F "configurationFile=YourConfigurationfile.xml"]
    [-F "ForceDeploy=true"]
    [-F "FTWeight=1"]
    [-F "GV=globalVariableA=123,globalVarB=SomeString"]
    [-F "InstanceSettings.element1.element2=SomeValue"]
    [-F "NoDeploy=true"]
    [-F "NoStart=true"]
    [-F "VariableProvider=Some_PROVIDER(S)_Name"]

For 6.x Version

curl -u UserName:Password \
     -X POST \
     -H "Accept:application/json" \
     -H "Content-Type: multipart/form-data" \
     -F "archiveFile=@YourArchiveName.zip" \
     -F "deploymentFile=@YourDeploymentFileName.properties" \
     -v "http://YourSFBroker.com:<port>/livecluster/rest/v1/sf/engines/archives"
    [-F "NoStart=true"]
    [-F "Profile=<Profile_Name>.substvar
    [-F "VariableProvider=Some_PROVIDER_Name"]

Where inputs bounded by square brackets are optional; file names, elements, variable names, and any values shown in italics should be substituted by your implementation values.

Tip: In a cURL statement all values must be URL-encoded so that special characters like spaces, for example, are converted to "%20". Other special characters like forward slashes "/" must also be converted to"%2F" or their respective URL encoded values so they may be sent and received properly.

Expressions in the generic form cURL expression as mentioned earlier were separated by line breaks to help with readability, but normally a string is submitted in the execution as in the example that follows:

The following is an example cURL archives deploy statement: 

curl -u admin:admin -X POST -H "Accept:application/json" -H "Content-Type: multipart/form-data" -v http://MySFBroker.com:8080/livecluster/rest/v1/sf/engines/archives -F "archiveFile=@MyProcessOrder.ear" -F "AppName=MyOrders/MyProcOrder" -F "deploymentFile=@MyDeployCriteria.properties"

Where the user specified by -u must have Silver Fabric administrator level permissions, and the form-data fields (-F "property=value") may be specified in any order. See Mandatory form-data fields for more details about form-data fields (-F).