Deployment using Maven Plug-in

To deploy TIBCO ActiveMatrix BusinessWorks™ applications on TIBCO Cloud™ Integration using Maven plug-in follow the below procedure:

Note: Support Maven Plug-in 2.8.1 and BWCE 2.6.2 onwards.

Procedure

  1. Log in to the TIBCO Cloud™ Integration portal https://cloud.tibco.com/. Choose your region and subscription. Select your profile and click Settings.

  2. It opens the settings page, click OAuth Access Tokens.

  3. Click Generate Token to generate a new token.

  4. Provide token name, validity period (max 30 days), and permissions and click Generate.

  5. Copy access token to clipboard, this can be used later with the maven plug-in.

  6. By default the TIBCO Cloud™ Integration platform API is not enabled for the user, it needs to be enabled explicitly by invoking the below endpoint,

    Endpoint: https://api.cloud.tibco.com/tci/docs/#/Organization/enablePlatformAPI

  7. Create a sample BW application. Ensure that the project is enabled for "TIBCO Cloud" deployment target. Right-click the Application Project and Select Generate POM for Application

  8. The POM Generation wizard is launched. Select TCI from the deployment dropdown options. Verify the other details.

  9. Click Next. It shows a TIBCO Cloud™ Integration deployment configuration page.

  10. Provide the instance count and other details. Click Finish.

    Note: The Application specific information is provided as part of pom.xml configuration properties, whereas TIBCO Cloud Integration platform information is provided via environment variables so that it can be shared for all applications and it also includes an Access token, which gets expired after a certain duration.

    It will mavenize the project and generate parent project pom.xml files for each project. It also generates below artifacts -

    • Process diagrams: svg diagrams of the processes (gets packaged in EAR and displayed on TIBCO Cloud Integration UI).

    • manifest.json: metadata used to TIBCO Cloud Integration deployments includes endpoints, app variable default values and other TIBCO Cloud Integration specific information.

    • default_appvar.json: JSON file generated by the wizard to override default app var values. User can edit and make copies of this file to deploy different configurations for promoted application variables.

    • default_enginevar.json: JSON file generated by the wizard to override default engine var values. User can edit and make copies of this file to deploy different configurations for engine variables.

  11. Open Maven run/debug configurations.

  12. Select the environment tab and provide environment variable details:

    Environment Variables Description Default Value
    TCI_PLATFORM_API_ENDPOINT The REST Endpoint URL for the TIBCO Cloud Integration platform API. Defaults to production endpoint. api.cloud.tibco.com
    TCI_PLATFORM_API_ACCESS_TOKEN OAuth Access Token for TIBCO Cloud Integration platform API secure access. Expires after 30 days. NA
    TCI_PLATFORM_SUBSCRIPTION_LOCATOR The subscription locator of the user for TIBCO Cloud Integration platform subscription. 0

  13. Click Run.

  14. Switch back to the TIBCO Cloud Integration portal to see the application deployed and already in scaling/running state.

  15. From BWCE 2.6.2 onwards, bwdesign Utility supports generating manifest.json from project.

    Maven command

    mvn clean com.tibco.plugins:bw6-maven-plugin:bwdesignUtility install