TIBCO Business Studio Command-Line Task Reference

sds.addProjectDependency

Adds a dependency on a reference project to a source project.

sds.createComponent

Creates a component from a component implementation. See component development manuals for configuration specific to each component type.

sds.createComposite

Creates a composite in an SOA project.

sds.createDAA

Packages child elements into a distributed application archive.

sds.createSoaProject

Creates an empty SOA project.

sds.generateDeploymentScript

Generate an Administrator CLI script (see Administrator Command-Line Interface) to deploy a DAA into a remote Administrator server. It generates a deployment script (that is, a build file and a data file) from a DAA that only contains custom features using TIBCO ActiveMatrix Administrator CLI format.

Generating a Deployment Script with Custom Features

You can generate a deployment script from a DAA that only contains custom features. This capability is only available via headless mode (sds.generateDeploymentScript target of TIBCO Business Studio CLI). This generates a build file and a data file using TIBCO ActiveMatrix Administrator CLI format.

Sample TIBCO Business Studio CLI script for a deployment script generation:

<sds.generateDeploymentScript
daaloc="/path/to/MyApplication.daa" 
outputloc="/path/to/generate/deployment/scripts"
tokenizescript="false" 
excludeVersionQualifier="true"
includeCleanupTasks="false">
<featureconfig environmentName="DevEnvironment"
nodeNames="DevNode"
syncNodes="true" upgrade="true"/>
<adminserver version="<version_number>" url="http://localhost:8120" 
username="root" password="test"/>
</sds.generateDeploymentScript>

The generated build file has the following targets:

• upload.daa: Uploads the DAA containing features to Administrator.
• addOrUpgrade.features or enable.features:
  • If upgrade is set to true, the generated target is called addOrUpgrade.features. This target replaces old features on a node with new ones from the DAA. More details are provided below.
  • If upgrade is set to false, the generated target is called enable.features. This target only adds the new features from the DAA but leaves the old features on the node as is.

  The addOrUpgrade CLI action has been added for the <Node> and <Feature> elements. The Studio CLI uses this action. This action adds the features from your data file to the nodes. For example, feature com.acme.myapp.feature 1.5.0 gets added to DevNode with status Marked for Install. This action also removes any other versions of the same feature, if they were present on the nodes. Features with a different major version are not affected. For example, feature com.acme.myapp.feature 1.0.0 and 1.6.0 are changed to status Marked for Uninstall, since any version not matching "1.5.0" will be marked for removal. However, feature com.acme.myapp.feature 2.0.0 is left as is, because it has a different major version.

• reprovision.nodes: Applies feature changes to runtime in resolve mode, which restarts the nodes to rewire existing applications to use the new versions of features. If syncNodes is set to false, this target is not generated in the build file.

sds.generateDistribution

Generates a default distribution, with all elements mapped to node Node1.

tbs.importProjects

Imports one or more Eclipse projects (including ActiveMatrix BPM, SOA, Implementation, Java, and so on) from archives (.zip, .tar, .tar.gz) or project folder structures.

Two approaches can be adopted when importing projects using this task:

• A simple, attribute-only based, approach suitable for basic scenarios
• A more flexible approach making use of the pre-existing nested Ant tasks, FileSet and DirSet

A single invocation of the task must be configured to import projects from either folder-based structures or archives, but not both.

When importing a single archive from a known location, the simple task format can be used. In this case, the task declaration includes the file attribute. The dir attribute cannot be used for archive importing.

For example, to import projects from a specific archive (C:\project_archives\testprojs.zip), the following simple task declaration can be used:

<tbs.importProjects file="C:\project_archives\testprojs.zip"/> 

For more flexible archive importing, the task's nested format can be used. This permits the importing of multiple archives and a more flexible way to describe the locations of the archives to be imported. To do this, the useArchives attribute needs to be set to true and one or more of the supported nested elements must be declared to describe candidate archive locations. Both types of nested elements (FileSet and DirSet) can be used for archive importing.

For example, to import projects from a specific archive (C:\project_archives\testprojs.zip), the nested FileSet element can be used as follows:

<tbs.importProjects useArchives="true"> <fileset
dir="C:\src\projects" includes="testproj.zip"/>
</tbs.importProjects>

A more useful implementation of the nested element format can be seen in the following example where importing is set up to be selective for tar archives:

<tbs.importProjects useArchives="true"> <fileset
dir="C:\src\projects" includes="**/*.tar"/>
</tbs.importProjects>

When importing a project or a set of projects contained within a single directory structure, the task's simple format can be used. This, however, does not allow you to be selective about which projects within the directory structure are imported; all identified projects are imported. To use the simple format, the task declaration needs to include the dir attribute.

For example, to import all folder-based projects contained within a directory, the following format can be used:

<tbs.importProjects dir="C:\folder_projects" /> 

For more flexible folder-based project importing, the task's nested format can be used where one or more DirSet elements can be declared to specify the directories to search.

Using the nested format, the previous example could be expressed as:

<tbs.importProjects> <dirset dir="C:\src\projects"/>
</tbs.importProjects> 

A more useful application of the nested element format could be the following, where only projects contained within directories having a certain substring in their name are considered:

<tbs.importProjects> <dirset dir="C:\src\projects">
<include name="**/*bpmproj"/> </dirset>
</tbs.importProjects> 

Optionally, the copyProjects attribute can also be used with project folder imports. When set to false, no copy of the imported projects is made to the workspace.

sds.promoteAll

Promotes all a component's unwired services and references to the composite level.

sds.wire

Wires a component reference to a component service.