Plug-in Documentation

IBM Operational Decision Manager (ODM)

Overview

IBM Operational Decision Manager provides a development environment and a dedicated user interface for automating and governing frequently occurring, repeatable business decisions. The Operational Decision Manager plug-in includes steps to deploy data models and rule sets to the Rule Execution Server.

To add the Operational Decision Manager plug-in steps to processes, click Application Server > Java > ODM in the step palette of the process editor.

Compatibility

This plug-in requires version 6.1.1.1 or later of IBM UrbanCode Deploy.

This plug-in was developed and tested with IBM Operational Decision Manager version 8.8.

This plug-in is supported to run on all operating systems that are supported by the IBM UrbanCode Deploy agent.

Installation

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

History

Version 12

  • Version 12 of the plug-in uses apiauth in the REST path rather than api.

Version 11

Version 11 of the plug-in includes updates from RFE 104196:

  • Added steps to delete Rule Archive and XOMs from Rule Execution Server.
  • Added automatic capture of properties in fetch steps to output properties.
  • Added ability to pull the latest Rule App, Set, or XOM when version number is not specified.

Version 8

  • Version 8 of the plug-in includes a fix for APAR PI74332, where Deploy Data Model was not properly accepting response codes.

Version 7

  • Version 7 of the plug-in includes support for property file encryption.

Version 6

  • Version 6 of the plug-in includes a step to create or update RuleApp or RuleSet properties on Rule Execution Server.

Version 5

  • Deploy RuleApps implicitly by merging and versioning policy instead of deploying just RuleSets with explicit version and names.

Version 4

  • Converted Deploy Rule Set step from an Ant to a REST-based implementation.

Version 3

  • Version 3 of the plug-in includes a step to fetch a RuleApp or XOM resource from Rule Execution Server.

Version 2

  • Version 2 of the plug-in includes a step to deploy an XOM resource.

Version 1

  • Initial release of the plug-in, which includes a step to deploy a rule set.

Usage

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

Version Import

We suggest two approaches for creating new versions and importing ODM artifacts into IBM UrbanCode Deploy.

  1. IBM Operational Decision Manager Source Config: Import IBM ODM artifacts using our ODM source configuration plug-in.
  2. Creating Versions without a Build or CI Tool: Import IBM ODM artifacts through a component process when a build tool cannot manage the import.

Steps

Process steps in the IBM ODM plug-in

Delete XOM

Delete a XOM from a Rule Execution Server.

Input properties for the Delete XOM step
Name Type Description Required
Hostname String The host name of the server where the Rule Execution Server console is installed.
For example: 192.0.2.1
Yes
Password Password The password to use to log in to the Rule Execution Server console. No
Port String The port number of the Rule Execution Server console. Yes
Resource String The resource to delete from the Rule Execution Server. Use the
following format: xomName/xomVersion.
Yes
User Name String The user name to use to log in to the Rule Execution Server console. No

Delete Rule Archive

Delete a ruleset or ruleapp archive from a Rule Execution Server.

Input properties for the Delete Rule Archive step
Name Type Description Required
Hostname String The host name of the server where the Rule Execution Server console is installed.
For example: 192.0.2.1
Yes
Password Password The password to use to log in to the Rule Execution Server console. No
Port String The port number of the Rule Execution Server console. Yes
Resource String The resource to delete from the Rule Execution Server. For a ruleset archive, use the following
format: ruleAppName/ruleAppVersion/ruleSetName/ruleSetVersion. For a ruleapp archive, use the
following format: ruleAppName/ruleAppVersion.
Yes
User Name String The user name to use to log in to the Rule Execution Server console. No

Deploy Data Model

Deploy an XOM resource to a Rule Execution Server instance of IBM Operational Decision
Manager.

Input properties for the Deploy Data Model step
Name Type Description Required
Hostname String The host name of the server where the Rule Execution Server console is installed.
For example: 192.0.2.1
Yes
Password Password The password to use to log in to the Rule Execution Server console. No
Port String The port number of the Rule Execution Server console. Yes
Resource Name String The name for the resource in the Rule Execution Server. Typically, you specify the
XOM file name.
Yes
User Name String The user name to use to log in to the Rule Execution Server console. No
XOM File String The XOM resource (Java archive or .zip file) to deploy to the Rule Execution Server. Yes

Deploy Rule Archive

Deploy a RuleSet or RuleApp archive to IBM Operational Decision Manager.

Input properties for the Deploy Rule Archive step
Name Type Description Required
Hostname String The host name of the server where the Rule Execution Server console is installed.
For example: 192.0.2.1
Yes
Merging Policy Enumeration:

  • NONE
  • ADD_AT_END_MERGING_POLICY
  • REPLACE_MERGING_POLICY
  • ADD_AT_END_RULESET_MERGING_POLICY
  • REPLACE_RULESET_MERGING_POLICY
Select the merge policy to use to process the RuleApp archive to automatically assign
the version. The policy supersedes any explicitly
set values..
No
Password Password The password to use to log in to the Rule Execution Server console. No
Port String The port number of the Rule Execution Server console. Yes
RuleApp Archive String The full path to the RuleApp archive that contains the ruleset to deploy. Yes
RuleApp Name String The name for the RuleApp archive in the Rule Execution Server console. To manually
specify this value, Merging Policy and Versioning
Policy must both be set to NONE.
No
RuleApp Version String The version for the RuleApp archive in the Rule Execution Server console. To manually
specify this value, Merging Policy and Versioning
Policy must both be set to NONE.
No
RuleSet Name String The name for the RuleSet archive in the Rule Execution Server console. To manually
specify this value, Merging Policy and Versioning
Policy must both be set to NONE.
No
RuleSet Version String The version for the RuleSet archive in the Rule Execution Server console. To manually
specify this value, Merging Policy and Versioning
Policy must both be set to NONE.
No
User Name String The user name to use to log in to the Rule Execution Server console. No
Version Policy Enumeration:

  • NONE
  • MAJOR_VERSION_POLICY
  • MINOR_VERSION_POLICY
Select the version policy to use to process the RuleApp archive to automatically assign
the version. The policy supersedes any explicitly
set values.
No

Fetch Rule Archive

Fetch a ruleset or ruleapp archive from a Rule Execution Server.

Input properties for the Fetch Rule Archive step
Name Type Description Required
Hostname String The host name of the server where the Rule Execution Server console is installed.
For example: 192.0.2.1
Yes
Password Password The password to use to log in to the Rule Execution Server console. No
Port String The port number of the Rule Execution Server console. Yes
Resource String The resource to fetch from the Rule Execution Server. For a ruleset archive, use the following
format: ruleAppName/ruleAppVersion/ruleSetName/ruleSetVersion. For a ruleapp archive, use the
following format: ruleAppName/ruleAppVersion. If no version is specified, the highest will be fetched.
Yes
User Name String The user name to use to log in to the Rule Execution Server console. No

Fetch XOM

Fetch a XOM resource from a Rule Execution Server.

Input properties for the Fetch Rule Archive step
Name Type Description Required
Hostname String The host name of the server where the Rule Execution Server console is installed.
For example: 192.0.2.1
Yes
Password Password The password to use to log in to the Rule Execution Server console. No
Port String The port number of the Rule Execution Server console. Yes
Resource String The resource to fetch from the Rule Execution Server. Use the
following format: xomName/xomVersion. If no version is specified, the highest will be fetched.
Yes
User Name String The user name to use to log in to the Rule Execution Server console. No

Set Property

Create or update a property value for a RuleApp or RuleSet on a Rule Execution Server instance of IBM Operational Decision
Manager.

Input properties for the Set Property step
Name Type Description Required
Create New Property Boolean Mark checkbox if creating a new property. Do not check box if updating an existing property. No
Hostname String The host name of the server where the Rule Execution Server console is installed.
For example: 192.0.2.1
Yes
Password Password The password to use to log in to the Rule Execution Server console. No
Port String The port number of the Rule Execution Server console. Yes
Property Name String The property name to be created or updated. Yes
Property Value String The new property value. No
Resource String The resource path for the property to be updated. For a ruleApp, use the format:
ruleAppName/ruleAppVersion. For a ruleSet, use the format:
ruleAppName/ruleAppVersion/ruleSetName/ruleSetVersion
Yes
User Name String The user name to use to log in to the Rule Execution Server console. No