Plug-in Documentation

IBM Operational Decision Manager (ODM) Source Config

Overview

The IBM Operational Decision Manager source configuration plug-in supports creating component versions from Decision Center RuleApps.

Compatibility

  • IBM UrbanCode Deploy version 6.0.1 or later
  • Version 3: IBM Operational Decision Manager 7.5 or later
  • Version 4+: IBM Operational Decision Manager 8.6 or later
  • Version 10+: IBM Operational Decision Manager 8.9.1 or later

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode products.

Special note for ODM version 8.9.0 and earlier

ODM version 8.9.1 introduces a REST API which is used by version 10 of this plugin. For older ODM versions which do not offer the REST API, several jars from the ODM server must be made available to the plugin in order for the plugin steps to run properly. The JAR files are listed below and can be found in the following location on the ODM server in the directory: $ODM_SERVER_LOCATION$/teamserver/lib. The jars must either be copied to the UCD agents lib directory, or specified in the JAR Path of the plug-in configuration.
The plugin requires the following ODM JARs:

  • jrules-engine.jar
  • jrules-language.jar
  • jrules-ruleartifacts.jar
  • jrules-teamserver.jar
  • jrules-dataaccess-rs4j.jar
  • jrules-model-dataaccess.jar
  • jrules-synchronization.jar
  • wbemodel.jar

History

Version 10

  • Fixes APAR PI87707, a regression where the user who requested a manual version import was not being tracked.
  • Fixes APAR PH00399 Plugin now only shows warning when Manage Properties permission not set.
  • Fixes APAR PI81075 ODM Source Config plug-in creating unnecessary snapshots when redeploying from existing snapshots.
  • Adds support for the REST API introduced in ODM 8.9.1.

Version 7

Fixes APAR PI87636 Next Version Number not auto-incrementing is now fixed.

Version 6

Fixes APAR PI85260 Plug-in no longer throws NullPointerException when auto import is set.

Version 5

  • Fixes APAR PI79804 Plugin failing to extract non-deployment snapshots.
  • Removed need to name Rule App Archive.
  • Updated error catching and logging.

Version 4

Added the ability to export RuleApps with Deployment Configurations from Decision Services.

Version 3

Added jar path field and eliminated need to copy open-source supporting jars when importing RuleApps from ODM Classic Rule Projects.

Version 2

Support property file encryption.

Version 1

Initial release of the plug-in.

Settings

Settings in the IBM ODM Source Config plug-in

Create a Component importing from an Operational Decision Manager Classic Rule Project

The following settings are available when you create a component by using the IBM ODM Source Config plug-in for importing from Classic Rule App Projects (Version 3 and before).

Settings for creating components
Name Type Description
Data Source String JDBC name of the datasource. (ex. jdbc/ilogDataSource)
Decision Center URL String Hostname and Port number for the IBM Decision Server instance. (ex. http://example.server.com:8080)
Extensions of Files to Convert String A list, separated by commas, of extensions that specify files which must be
converted to a new Character set when downloaded.
Jrules Jar Path String Path to the required ODM jrules jars. This path must be specified if the jars were not copied into the plugin lib directory. (ex. lib/odmJars)
Next Version Number Integer Specify the version number for the next version. This value increments automatically after each Version import.
Password String Decision Center password.
Preserve Execute Permissions Boolean When enabled, file execute permissions are saved with files.
RuleApp Name String The name of the ruleApp to be imported.
Username String Decision Center username.
Version Name Pattern String Specify a pattern for each version name. For example, the ibm-ucd pattern produces versions such as ibm-ucd-1, ibm-ucd-2, and so on, based on the Next Version Number.

Import New Version

The following settings are available when you import component versions.

Settings for importing new versions of components
Name Type Description
ODM Snapshot String Name of an existing ODM snapshot to pull archive from. This will create a version with this name, overriding the next version numbering scheme.

Create a Component importing from IBM Decision Services

The following settings are available when you create a component by using the IBM ODM Source Config plug-in for importing from Decision Services (Version 4 and later)

Settings for creating components
Name Type Description
Branch Name String The name of the Branch (ex. Spring Release). Pulls from main if left blank.
Data Source String JDBC name of the datasource. (ex. jdbc/ilogDataSource)
Decision Center URL String Hostname and Port number for the IBM Decision Server instance. (ex. http://example.server.com:8080)
Deployment Configuration String The name of the deployment configuration. (ex. test deployment)
Extensions of Files to Convert String A list, separated by commas, of extensions that specify files which must be
converted to a new Character set when downloaded.
Jrules Jar Path String Path to the required ODM jrules jars. This path must be specified if the jars were not copied into the plugin lib directory. (ex. lib/odmJars)
Next Version Number Integer Specify the version number for the next version. This value increments automatically after each Version import.
Password String Decision Center password.
Preserve Execute Permissions Boolean When enabled, file execute permissions are saved with files.
Project Name String The name of the Project. (ex. Loan Validation Service)
RuleApp Archive Name String The name to give the ruleApp archive file. Note that .jar will be automatically appended to the end.
Target Server String The name of the Target Server to deploy to. Leave blank to only extract the archive and skip deployment.
Username String Decision Center username.
Version Name Pattern String Specify a pattern for each version name. For example, the ibm-ucd pattern produces versions such as ibm-ucd-1, ibm-ucd-2, and so on, based on the Next Version Number.

Import New Version

The following settings are available when you import component versions.

Settings for importing new versions of components
Name Type Description
ODM Snapshot String Name of an existing ODM snapshot to pull archive from. This will create a version with this name, overriding the next version numbering scheme.

Usage

For a full ODM plug-in usage tutorial, refer to IBM Operational Decision Manager (ODM) with UrbanCode Deploy

To create a component by importing from Decision Center, complete the following steps. For more information, see Creating components.

  1. On the Components page in IBM UrbanCode Deploy, click Create New Component.
  2. In the Source Config Type list, select IBM ODM.
  3. Provide all of the necessary information.
  4. Click Save.
  5. Click the Versions tab for the component.
  6. Click Import New Versions.