This release of IBM UrbanCode Velocity is a maintenance release and includes bug fixes. This release is recommended for all customers.


On the Settings page, when you click Authentication > LDAP, the required fields are obvious and indicated with red asterisks for admins for readily editing and configuring LDAP.


Based on the your installed version of IBM UrbanCode Velocity, plugins not compatible with that version are prevented from installing in the product. If the installed version of IBM UrbanCode Velocity is equal or greater than the product version that the plugin supports, the installation of the plugin is possible. Plugins prevented from installation are detailed for the following three scenarios:

  • On the Settings page, click the Plugins tab.
  • Locate the required plugin in the list and click the Install button.
  • The error Plugin <name> is only supported on IBM UrbanCode Velocity versions equal to or greater than x.x.x is displayed on the right side of the Status field for that plugin.
  • On the Settings page, click the Plugins tab.
  • Click the Load plugin button.
  • In the Load a custom plugin window, click in the Plugin Image field and enter the required plugin.
  • Click the Submit button.
  • The error Plugin <name> is only supported on IBM UrbanCode Velocity versions equal to or greater than x.x.x is displayed in the Load a custom plugin window.
  • On the Settings page, click the Integrations tab.
  • Locate the required plugin and then click on the overflow menu and select Upgrade.
  • In the Status field for the plugin, Upgrade failed is displayed.

For scheduled events plugins, perform the following steps:

  • On the Settings page, click the Plugins tab.
  • Locate the required plugin and then click the Add integration button.
  • In the Add Integration window, click the Show hidden properties check box.
  • Click in the Initial Sync Date field to specify only pulling data after the selected date on the initial run.
  • Fill in the remaining required fields in the Add Integration window.
  • Click the Add button.

If the plugin does not support the sync feature, the Initial Sync Date field is not displayed when you click the Show hidden properties check box in the Add Integration window.


Based on the responsiveness of a given Kubernetes environment, you are able to configure liveness and readiness probes and specify dynamic timeouts to prevent persistent removal of pods.


The following table is a cumulative list of fixes in the 2.5.4 version.

PI99873 On the Value streams page, when you click Search with DQL and enter a query, resolved issue of long query retrieval times for a larger number dots and issues attempted in search. Optimized code to ensure efficient data retrieval times.
On the Value streams page, corrected WorkFlowQuery (WFQ) returning internal server error by updating code with utilization of a suitable data structure for effective processing correcting the following issues:

  • Insights page not loading.
  • VSM not loading.
  • Plugin containers not being removed after execution.
PI99869 On the Insights page, when you perform the following:

  • Click on the Reports tab.
  • Click on the required report.
  • Click on the Results link of a previously run report or click the Run report button to generate a new report with a Results link.
  • When you share the report link, the server port is used versus using the assumed port number 443.
On the Insights page, when you perform the following:

  • Click on the Reports tab.
  • Click on the Deployment audit report.
  • In the Deployment audit window, click in the Timezone drop-down field and select the Coordinated universal time (UTC) required for the report.
  • In the Deployment audit window, fill in the remaining required fields.
  • Click the Confirm button to run the report.
  • Click the Results link to display the Deployment audit report in the selected time zone.
PI99876 When performing upgrades of IBM UrbanCode Velocity, fixed issue of deleted groups not migrating correctly.
Resolved LDAP login issue.

Plan and prepare

For supported platforms and requirements you can dynamically generate a system requirements report using the Software Product Compatibility Reports (SPCR) tool.

Install the server

There are two option to obtaining the installation package: online installer and offline installer. Both options require a master license key, which can be acquired from IBM Passport Advantage.

Online installer

The online installer option for installing the product requires an internet connection for the entire process. It requires minimum storage for the downloaded package. The downloaded image contains only the Helm charts used to pull the product Docker images from a GitHub location. This is our recommended installation method.

Download the online installer package depending on the platform, the product is being installed.

After the download completes, start the executable file to begin the install process.

Offline installer

Use the offline installer to install Velocity without internet connection. You will still need internet connection at some point to download the installer itself. Once downloaded, the installer will include all containers needed to successfully install the product. For this reason, the offline installer is larger than the online installer and will require more time/bandwidth and disk space when downloading.

The installation package is available from IBM Fix Central. Search and select the installation package appropriate for the installation platform.

After downloading the installation package, decompress the contents into two directories: one for Kubernetes and the other for Docker Compose. See the documentation section on installation for instructions about how to install the server.

A product license key is required to install the product. To obtain a key, you must agree to the terms and conditions provided on Passport Advantage.


To learn more about UrbanCode Velocity, see documentation.

For help installing or using UrbanCode Velocity, post your questions in the UrbanCode forums. Tag your question with velocity.

To suggest an enhancement to the product, visit the RFE Community

Get support

For information from support, including FAQs, visit the IBM Support portal. You can configure the support portal to view information about specific products.


MongoDB Version 3.6 end of support

The MongoDB version 3.6 has reached end of life and all MongoDB 3.6 instances must be upgraded to MongoDB 4.0 for IBM UrbanCode Velocity 2.3.0 to start. This upgrade applies only if you are running UrbanCode Velocity in a Docker Compose environment.

If you are upgrading or have ever upgraded from a UrbanCode Velocity version prior to v1.4.5, which was released in March 2020, you must migrate your MongoDB. The procedure to complete is described in the following table. The procedure depends on several items.

Scenario 1 Scenario 2 Scenario 3
IBM UrbanCode Velocity version 1.4.4 or earlier Upgraded from 1.4.4 or earlier to a version between 1.4.5 to 2.2.4 New installation of 1.4.5 or higher
MongoDB version 3.4 3.6 3.6
MongoDB compatibility flag version 3.4 3.4 3.6
Solution A Upgrade to version 2.2.5, then to 2.3.0 Upgrade to version 2.2.5, then to 2.3.0 Upgrade directly to version 2.3.0
Solution B N/A Run MongoDB command:

db.adminCommand( { setFeatureCompatibilityVersion: 3.6 } )

to set compatibility flag to version 3.6

Solution C Contact support. Contact support. N/A

Upgrade information

Starting in 2.4.1

When upgrading from an IBM UrbanCode version prior to 2.4.0 for Kubernetes and OpenShift upgrades, you are required to perform a Helm uninstall and install prior to performing a full installation of version 2.4.x.

For Docker Compose upgrades of IBM UrbanCode Velocity with a default certificate replaced with a custom certificate, the installer tracks the latter certificate and reads the associated files from the directory location.

Starting in 2.4.0

When upgrading from an IBM UrbanCode version prior to 2.4.0 for Kubernetes and OpenShift upgrades, you are required to perform a Helm uninstall and install prior to performing a full installation of version 2.4.x.

Starting in 2.1.0

The Jenkins UrbanCode Velocity plug-in is now prerequisite and must be installed. The allows for running Jenkins jobs as a part of a deployment plan in UrbanCode Velocity. Version 2.1.0 of the plug-in is required. For more information about the plugin, see the Jenkins website.

Starting in 2.0.0

Starting in UrbanCode Velocity v2.0.0, the MongoDB server 3.4 is no longer supported. UrbanCode Velocity v2.0.0 supports MongoDB server versions: 3.6, 4.0, and 4.2. For more information about out of service MongoDB server versions, see Mongo website.

  • Docker Compose installations automatically upgrade to 3.6.
  • Helm installations require manual upgrade or installation of the MongoDB server to 3.6 or later.
  • New Helm installations use MongoDB 4.2 according to the Helm chart.

1.5.1 Improves Upgrade Support for all Prior Versions

All versions can be directly upgraded to 1.5.1 or later. Helm upgrades from 1.4.5 and 1.5.0 avoid previous complications. Velocity 1.5.1 also fixes an old issue that required versions older than 1.2.6 to upgrade to 1.2.6 before upgrading further.

NOTE: Helm upgrades from versions prior to 1.5.0 still require helm delete --purge

Starting in 1.5.0

Starting with v1.5.0, we have added and modified some Helm Selectors to adhere with best practices. Therefore, running the helm upgrade command from a previous version of UrbanCode Velocity will fail. All upgrades from a version prior to v.1.5.0 to v1.5.0 or later will require a Helm purge as described below.

  1. Delete your currently installed release with helm delete --purge , where is the name of your current UrbanCode velocity release.
  2. Follow the normal install directions with all previous name and values from your previous release.

Note: Your Mongo database will be not be modified as it is maintained outside of the installation.

Starting in 1.4.5

In v1.4.5, the distributed version of MongoDB was upgraded from v3.4 to v3.6. Docker Compose installs will see the upgrade happen automatically. Other Docker platforms, such as: OpenShift and Kubernetes will need to manually upgrade their MongoDB instance. MongoDB v3.4 is still supported as of the release of v1.4.5. However, MongoDB v3.4 has been End of Life by Mongo, so we recommend customers upgrade at their earliest convenience.

Going forward, when our shipped version of MongoDB is upgrade, we continue to support the prior version of MongoDB, but deprecate the version before that. For example, when the shipped version of MongoDB is upgrade to v4.0, support is continued for v3.6 and and v3.4 is deprecated. We estimate that this will require two MongoDB upgrades per year, which should not force our Enterprise Docker Platform users to upgrade their MongoDB image more than once a year.