How To

How to use the IBM UrbanCode Release plug-in part 2: Update Application step


The IBM UrbanCode Release plug-in for IBM UrbanCode Deploy provides tools that integrate the two products more efficiently. Once installed, you can use the four plug-in steps in your IBM UrbanCode Deploy  process design workflows:

Step 1: Add Comment to Task
Add comments in IBM UrbanCode Deploy to  automated tasks started by IBM UrbanCode Release scheduled deployments.

Step 2: Update Application
Update the IBM UrbanCode Release inventory for applications deployed by IBM UrbanCode Deploy.

Step 3: Add Snapshot Status

  • Add a version statuses to snapshots during deployment processes.
  • Add comments and attachments to statuses.

Step 4: Get Release for Environment
Get the name of a release that is active for a specific environment, to facilitate auto progression for releases.

This article covers the Update Application step.  The other steps are described in the following articles:

Part 1:  Add Comment to Task step

Part 3: Add Snapshot Status

Plugin prerequisites:
Download the IBM UrbanCode Release plug-in from the IBM UrbanCode Deploy Plugin page, and then import the file (Home > Settings > Plugins  > Load Plugin).

Define  authentication properties required by the plug-in as system properties. System properties are accessible from anywhere, and, when changed, are automatically updated across all process steps that use them.


Step: Update Application

When an integration runs, it updates the IBM UrbanCode Release inventory to match that of  IBM UrbanCode Deploy.   An integration can be run manually or automatically on some interval, such as minute, hour, or day.  An IBM UrbanCode Deploy application can also run an integration as part of its process workflow. If an application creates a snapshot during deployment processing, for example, it can use the Update Application step to immediately update the IBM UrbanCode Release inventory. This can be important if the next scheduled integration is minutes or hours away.

In this example, an IBM UrbanCode Deploy deployment process creates a snapshot that contains all component versions deployed to a DEV environment.  By using the Update Application step,  the IBM UrbanCode Release inventory is updated  as soon as the snapshot is created.


Update Application plug-in step fields:
URL contains the location of IBM UrbanCode Release server.
User and Password provide user credentials for authentication.
Application UUID contains the ID of the current application.  The property reference ${} retrieves the ID of the current application.


When the step runs, it updates the IBM UrbanCode Release inventory with the content of the current application.
In this instance, all steps are successful and the new snapshot is  reflected in IBM UrbanCode Release inventory.


By using this step, there is no need to run an integration in IBM UrbanCode Release.

Because the inventory is updated during processing, you can reference the snapshot later in the same workflow. In the next article in the series, How to use the IBM UrbanCode Release plug-in part 3: Add Snapshot Status, we use the Add Snapshot Status step to add a status to the new snapshot.