Building an IBM Case Manager – IBM WebSphere ILOG …...Case designers can create and customize solution layout Manager widgets or custom built At runtime, case management users

IBM Industry Solutions

Building an IBM Case Manager – IBM WebSphere ILOG JRules Solution

Miniresidency – Report and Experience

IBM ICM Case Manager Solution Implementation

Authored by IBM team:

Bert Bukvarevic IBM Software Group, Industry Solutions ECM

Boris Becker IBM Software Group, Industry Solutions ECM

Carsten Rieger IBM Software Group, Industry Solutions ECM

Dr. Tek-Seng The IBM Software Group, Industry Solutions ECM

Walter Mayer IBM Software Group, Center Of Excellence ECM

Werner Fuehrich IBM Software Group, WebSphere BPM Dev. and Operations

Witold Szczeponik IBM Software Group, WebSphere ,Senior IT Architect

Building an IBM Case Manager

Table of Contents

Revision History ................................

Motivation and Solution Definition

Overview ................................

IBM Case Manager (ICM) ................................

IBM Case Manager Builder

Case Builder Tasks and Business Process Mapping

IBM Case Manager Client

Case Manager API ................................

Case Manager Administration Client

Case Management Reporting Tools

Case Management Content Analytics

Forms ................................

IBM WebShere ILOG JRules (ILOG)

ILOG JRules Architecture

ICMILOG Integration ................................

Sample Solution Scenario ................................

Implementing the ILOG JRules Solution

Selecting the Project Workspace

Creating the Rule Project ................................

Defining Input and Output Parameters

Define Rule Packages ................................

Defining the Rules ................................

Creating a Decision Table ................................

Creating the Ruleflow ................................

Creating a RuleApp ................................

Deploying the RuleApp ................................

Validating the Rule Execution Environment

Implementing the Case Solution

Defining the Case Properties

Defining the Case Roles ................................

Defining the Document Types

Defining the Personal In-Basket


Table of Contents

................................................................................................

Motivation and Solution Definition ................................................................

................................................................................................................................

................................................................................................

IBM Case Manager Builder ................................................................................................

Case Builder Tasks and Business Process Mapping ................................

IBM Case Manager Client ................................................................................................

................................................................................................

Manager Administration Client ................................................................

Case Management Reporting Tools ................................................................

Case Management Content Analytics ................................................................

................................................................................................................................

IBM WebShere ILOG JRules (ILOG) ................................................................

ILOG JRules Architecture ................................................................................................

................................................................................................

................................................................................................

Implementing the ILOG JRules Solution ................................................................

Selecting the Project Workspace ................................................................

................................................................................................

fining Input and Output Parameters ................................................................

................................................................................................

................................................................................................

................................................................................................

................................................................................................

................................................................................................

................................................................................................

Validating the Rule Execution Environment ................................................................

Implementing the Case Solution ................................................................................................

Defining the Case Properties ................................................................................................

................................................................................................

Defining the Document Types ................................................................

Basket ................................................................

IBM WebSphere ILOG JRules Solution | Page 2 of 64

.......................................................... 4

............................................................... 5

..................................... 6

........................................ 6

.................................. 7

........................................................... 7

.................................... 8

.............................................. 8

.................................................... 9

........................................................ 9

.................................................... 10

.................................... 10

..................................................... 10

.................................. 11

.......................................... 12

......................................... 14

.................................................... 16

........................................................... 16

....................................... 17

................................................... 18

........................................... 20

................................................. 20

..................................... 22

............................................ 23

............................................... 24

.......................................... 27

........................................... 30

................................ 34

................................. 34

........................................ 36

............................................................... 37

............................................................ 37


Defining the Case-Type ................................

Adding the Tasks ................................

Designing the Task Workflows

Integrating the Case Solution with IBM WebSphere ILOG JRules

Opening the Workflow Definition For Editing

Enabling Direct Access to WSDL Links

Determining the WSDL Link For the BRMS Rule Application

Adding a Web service Invocation Step

Registering Partner Link ................................

Mapping of Workflow Parameters to the Web service Interface

Updating Case Attributes ................................

Deploying the Case Manager Solution

Testing the Solution ................................

Summary ................................


................................................................................................

................................................................................................

e Task Workflows................................................................

Integrating the Case Solution with IBM WebSphere ILOG JRules ................................

Opening the Workflow Definition For Editing................................................................

Enabling Direct Access to WSDL Links ................................................................

Determining the WSDL Link For the BRMS Rule Application ................................

Adding a Web service Invocation Step ................................................................

................................................................................................

Mapping of Workflow Parameters to the Web service Interface Parameters

................................................................................................

Deploying the Case Manager Solution ................................................................

................................................................................................

................................................................................................................................


......................................... 37

................................................... 40

............................................................... 44

............................................. 48

.......................................... 48

................................................. 49

................................................. 51

................................................. 53

........................................ 54

Parameters .......................... 56

....................................... 57

...................................................... 59

................................................... 60

................................... 64


Revision History

Rev Date Author

1.0 24/11/2011 Team 1.1 02/12/2011 Boris Becker

1.2 04

04/12/2011 Walter Mayer

1.3 xyz

22/01/2012 Witold Szczeponik

1.4 06/02/2012 Walter Mayer F MAyerSummary1.5 21/02/2012 Walter Mayer


Contributors Description

Initial Draft Boris Becker Consolidation / Review

Walter Mayer Review

Witold Szczeponik ILOG Consolidation, Figures, Form

Walter Mayer F MAyerSummary

Summary, Final

Walter Mayer Update ILOG steps and figures


/ Review

ILOG Consolidation, Figures, Form

Summary, Final

Update ILOG steps and figures


Motivation and Solution

The mini-residency “Building an IBM Case Managersolution in the IBM Germany Böblingen Labwith the following motivation:

• Exchange experience and knowledge between IBM Case Manager“One BPM” initiative and

• Demonstrate how to build predefined time frame

• Implementation of a pilot to reuse in future customer or business partner events

• Get deep insights for the products in

• Create and publish a document describing the tasks to setup an ICM solution using ILOG JRules step by step, to enable consultants working with ICM and/or ILOG reproduce our scenario implementation. Basic technical knowledge of ICM and JRules will be required to use this description.

Choosing from a list of possible sample scenarios as a result of a team decided to implement andiscussing the various use casesmanagement sample was well suited to implement the samplewe were planning to test and document.

First, the main characteristics of the software components used are described in “Overview”. The implementation details of the sstarting with describing the sample use case in by a step by step description of the implementation in the chapters “JRules Solution”, “Implementing the WebSphere ILOG JRules”.

The mini residency team jointlyimage which already included an ILOG JR


Solution Definition

an IBM Case Manager (ICM) – IBM WebSphere the IBM Germany Böblingen Lab from 21-25 November 2011 was setup and defined

Exchange experience and knowledge between IBM Case Managerand IBM WebSphere ILOG experts

how to build an ICM solution exploiting ILOG JRules from scratch

ilot workshop scenario for a hands-on ICM/ILOG future customer or business partner events

deep insights for the products involved, exchange knowledge and experience

and publish a document describing the tasks to setup an ICM solution using ILOG , to enable consultants working with ICM and/or ILOG

ur scenario implementation. Basic technical knowledge of ICM and will be required to use this description.

possible sample scenarios as a result of a brainstorming n “Airline Customer Complaint” case management solution

use cases proposed, it became clear, that the airline customer was well suited to implement the sample ICM/ILOG integration scenarios

document.

the main characteristics of the software components used are described in The implementation details of the solution are described in the subsequent chapters

starting with describing the sample use case in the chapter “Sample Solution step by step description of the implementation in the chapters “Implementing the

Implementing the Case Solution”, and “Integrating the Case Solution with IBM

The mini residency team jointly developed the solution using a copy of the “which already included an ILOG JRules installation.


IBM WebSphere ILOG JRules” was setup and defined

Exchange experience and knowledge between IBM Case Manager, IBM WebSphere

from scratch in a

on ICM/ILOG JRules integration

volved, exchange knowledge and experience

and publish a document describing the tasks to setup an ICM solution using ILOG , to enable consultants working with ICM and/or ILOG JRules to

ur scenario implementation. Basic technical knowledge of ICM and ILOG

brainstorming session, the case management solution. When that the airline customer

ICM/ILOG integration scenarios

the main characteristics of the software components used are described in the chapter in the subsequent chapters,

Sample Solution Scenario” followed Implementing the ILOG

Case Solution with IBM

the “ICM PoT” VMWare


Overview

Implementing a robust and effective case management solution requires a software platform providing a range of functionality, including content management, process managementbusiness rules, collaboration and analytics.

Advanced Case Managementpeople to provide a complete working on a case.

The following diagram shows the high level architecture of the IBMincluding the various components providing case management functionality. The different components are described in more detail in the subsequent sections.

IBM Case Manager (ICM)IBM Case Management provides functionality to collect structured and unstructured caseinformation and to coordinate knowledge workers (or case workers) to achieve an optimized

IBM Case Manager is built on themanagement and process management capabilities.01.ibm.com/software/data/advanced

The various components of the IBM Case Manager sections.


Implementing a robust and effective case management solution requires a software platform a range of functionality, including content management, process management

and analytics.

anagement (ACM) from IBM brings together information, processes, and complete case view for the user(s) and to achieve optimized

The following diagram shows the high level architecture of the IBM case management platform including the various components providing case management functionality. The different components are described in more detail in the subsequent sections.

Figure 1 - ICM High Level Architecture

se Manager (ICM) provides functionality to collect structured and unstructured case

coordinate and process case tasks. Many case activities are driven(or case workers) to achieve an optimized case outcome.

built on the FileNet P8 Platform and thus enables seamless use of process management capabilities. See also “http://www-

01.ibm.com/software/data/advanced-case-management/ “

The various components of the IBM Case Manager platform are described in the following


Implementing a robust and effective case management solution requires a software platform a range of functionality, including content management, process management,

information, processes, and optimized outcomes when

case management platform including the various components providing case management functionality. The different

provides functionality to collect structured and unstructured case and process case tasks. Many case activities are driven by the

case outcome.

seamless use of content -

are described in the following



IBM Case Manager Builder is the tool used to build astraightforward graphical user interface, management solutions, allowing business analysts to directly define the main artifacts of their business solution.

Using Case Manager Builder, business analysts can the development environment. Defining the solution consists of definingdocument types, case types, task types, and proc

After having created the solution, IBM Case Manager Builder is used to deploy the solution an execution environment on the development environment. This enables the solution designer to quickly test the solution and solution is well tested it is deployed to the production system(s).

A development environment can be segmented into project areasstore as a sandbox execution environment to test the solutioncan be individually reset if needed

Case Builder Tasks and Business Pr

A task consists of one or more steps, or a reused business process workflow. A case type can have one or more tasks that must be completed by a case worker in the Case Manager Client to close the case.

You can associate a task with workflowIntegration Designer or the IBM (FileNet) Process Designer.supports extended workflow features that the Case Manager Builder does not support. You can edit your solution workflows in Process Designer, and later continue working in the Step Editor.

Or you can associate solutionBusiness Process Manager Integration Designerthat implements the workflow for that task. The business process is implemented as an external web service.

By using IBM Business Process Manager with IBM Case Manager, you can take advantage of the strengths each product offers

� IBM Business Process Manprocess applications that involve human tasks or automated business processes.

� IBM Case Manager provides a platform on which you can implement case tasks that require casedocuments and other content objects.

The components of IBM Business Process Manager provide a unified BPM repository, tooling for authors, administrators, and users, and a runtime platform. Diffproduct support different levels of complexity and involvement with business process management.

The following diagram illustrates a typical IBM Business Process Manager configuration:



is the tool used to build a case management solution. straightforward graphical user interface, Case Manager Builder simplifies the design

, allowing business analysts to directly define the main artifacts of their

Using Case Manager Builder, business analysts can create their case management solution inthe development environment. Defining the solution consists of defining property types, document types, case types, task types, and processes linked to the tasks

After having created the solution, IBM Case Manager Builder is used to deploy the solution an execution environment on the development environment. This enables the solution designer to quickly test the solution and thus supports an iterative development approach.solution is well tested it is deployed to the production system(s).

evelopment environment can be segmented into project areas, each providingexecution environment to test the solution. Each project

reset if needed.

Case Builder Tasks and Business Process Mapping

consists of one or more steps, or a reused business process workflow. A case type can have one or more tasks that must be completed by a case worker in the Case Manager Client to

You can associate a task with workflows implemented with the IBM Business Proceor the IBM (FileNet) Process Designer. The FileNet P8 Process Engine

supports extended workflow features that the Case Manager Builder does not support. You can kflows in Process Designer, and later continue working in the Step Editor.

task(s) with an automated process that is created by using IBM Business Process Manager Integration Designer and map the task to a new business procesthat implements the workflow for that task. The business process is implemented as an external

By using IBM Business Process Manager with IBM Case Manager, you can take advantage of each product offers:

IBM Business Process Manager provides a platform on which you can implement process applications that involve human tasks or automated business processes.IBM Case Manager provides a platform on which you can implement case tasks that require case workers to act on decisions that are based on the context of documents and other content objects.

The components of IBM Business Process Manager provide a unified BPM repository, tooling for authors, administrators, and users, and a runtime platform. Different configu

different levels of complexity and involvement with business process



case management solution. Providing a Case Manager Builder simplifies the design of case

, allowing business analysts to directly define the main artifacts of their

create their case management solution in property types,

esses linked to the tasks.

After having created the solution, IBM Case Manager Builder is used to deploy the solution to an execution environment on the development environment. This enables the solution designer

supports an iterative development approach. When a

providing a target object project area object store

consists of one or more steps, or a reused business process workflow. A case type can have one or more tasks that must be completed by a case worker in the Case Manager Client to

s implemented with the IBM Business Process Manager FileNet P8 Process Engine

supports extended workflow features that the Case Manager Builder does not support. You can kflows in Process Designer, and later continue working in the Step Editor.

with an automated process that is created by using IBM map the task to a new business process

that implements the workflow for that task. The business process is implemented as an external

By using IBM Business Process Manager with IBM Case Manager, you can take advantage of

ager provides a platform on which you can implement process applications that involve human tasks or automated business processes. IBM Case Manager provides a platform on which you can implement case tasks

workers to act on decisions that are based on the context of

The components of IBM Business Process Manager provide a unified BPM repository, tooling for erent configurations of the

different levels of complexity and involvement with business process



Figure 2 - Typical IBM Business Process Manager configuration


Case Manager Client is an iWidgetas the container for the ICM widgets.

Case designers can create and customize solution layoutManager widgets or custom built

At runtime, case management users management solution.

Case Manager API

The Case Manager API consists of three REST

• Content Management In

• PE REST API

• Case REST API


IBM Business Process Manager configuration


iWidget-based application. IBM WebSphere Business Space is used as the container for the ICM widgets.

Case designers can create and customize solution layouts using the out-ofbuilt widgets.

At runtime, case management users access the resulting web application to work with the case

The Case Manager API consists of three REST-based APIs:

Content Management Interoperability Services (CMIS)


IBM WebSphere Business Space is used

of-the-box IBM Case

resulting web application to work with the case


The Case Manager API provides an integration laycomponents and the underlying IBM FileNetof functionalities for developers


The Case Manager Administration Client (CMAC) is used environment. CMAC is also used production environment. Optionally FileNet Deployment Manager (FDM) can be used for migrating Case Manager solution components between environments.

The following diagram shows the use of CMAC in development and production environments and for migrating solutions between these environments.

Figure 3 - CMAC used for migration of solutions from development environment to production

Case Management Reporting ToolsIBM Case Analyzer is a component that allows extracting audit data from the underlying IBM FileNet engines (Content Engine (CE) Case Analyzer makes these event records adatabase. The Case Analyzer cubes created in this database are used for historical data reports based on case management data and

For real-time monitoring, Cognos Real Time Monitoring (data and present it to the users. Cognos RTM also uses the data from the IBM FileNet engines


The Case Manager API provides an integration layer between the IBM Case Manager components and the underlying IBM FileNet engines. The Case Manager API

developers to build custom applications on top of Case Manager.


The Case Manager Administration Client (CMAC) is used for configuring the IBM Casused for migrating solutions from a development environment to

Optionally FileNet Deployment Manager (FDM) can be used for migrating Case Manager solution components between environments.

ollowing diagram shows the use of CMAC in development and production environments and for migrating solutions between these environments.

CMAC used for migration of solutions from development environment to productionenvironment

Case Management Reporting Tools IBM Case Analyzer is a component that allows extracting audit data from the underlying IBM

ngine (CE) and PE Process Engine (PE) ) using the Event Publisher. event records available in a dedicated reporting and analysis

database. The Case Analyzer cubes created in this database are used for historical data reports data and events.

time monitoring, Cognos Real Time Monitoring (Cognos RTM) is used to prepare the data and present it to the users. Cognos RTM also uses the data from the IBM FileNet engines


er between the IBM Case Manager The Case Manager API provides a full set

to build custom applications on top of Case Manager.

the IBM Case Manager development environment to a

Optionally FileNet Deployment Manager (FDM) can be used for

ollowing diagram shows the use of CMAC in development and production environments

CMAC used for migration of solutions from development environment to production

IBM Case Analyzer is a component that allows extracting audit data from the underlying IBM using the Event Publisher.

vailable in a dedicated reporting and analysis database. The Case Analyzer cubes created in this database are used for historical data reports

Cognos RTM) is used to prepare the data and present it to the users. Cognos RTM also uses the data from the IBM FileNet engines


sent to the Case Analyzer database using the Event Publisher. Optionally Cognos BIIntelligence) can be used to load a

Case Management Content AnalyticsIBM Content Analytics supports crawling for unstructured and structured data associated to cases. Using this information, associated to these cases into account.

Forms IBM Case Manager provides an integration of P8 eForms and IBM Forms to use electronic form functionality in case management solutions.

IBM Case Manager provides forms integration allowing the transfer of the forms data and they can be accessed from the case or the case tasks.

IBM WebShere ILOG JRules (ILOG)A Business Rules Management System (and decisions from business processes and manage them independently, thereby allowing theprocesses to be streamlined.

Content Centric IBM Case Management BPM tasksto deliver case management solutions

For example, in our sample airthe eligibility of customer complaints have to consider rights and at the same time have to make sure tovouchers to maximize the airline’s profit

Therefore, hard coding these policies in hard to manage and update the rulesthe business rules from the complaint process itself.

IBM WebSphere ILOG JRules provides the functionality to manage and execute these rules and allows integrating the rules execution within Case Manager tasks.

The three ILOG modules Rules Studio, Rule Execution Server and Rule Team Server (see diagram below) can be installed on one server or


sent to the Case Analyzer database using the Event Publisher. Optionally Cognos BIcan be used to load and display advanced reports.

Case Management Content Analytics IBM Content Analytics supports crawling for unstructured and structured data associated to

it allows analyzing historic case data, taking all information ed to these cases into account.

IBM Case Manager provides an integration of P8 eForms and IBM Forms to use electronic form functionality in case management solutions.

IBM Case Manager provides forms integration allowing capturing of user data from a to the case and task objects. Forms can also be added to a case

and they can be accessed from the case or the case tasks.

IBM WebShere ILOG JRules (ILOG) Business Rules Management System (BRMS) enables customers to extract business rules

from business processes and manage them independently, thereby allowing the

Content Centric IBM Case Management BPM tasks systems and the ILOG solutions which provide high agility and extensibility.

airline complaint verification process, the business policies to assess complaints have to consider legal regulations regarding

and at the same time have to make sure to avoid unnecessary paybacks or mileage maximize the airline’s profit without losing customer loyalty.

Therefore, hard coding these policies in the process definition is not a good idea, since itupdate the rules. It is much better to separate the design and execution of

from the complaint process itself.

IBM WebSphere ILOG JRules provides the functionality to manage and execute these rules and egrating the rules execution within Case Manager tasks.

Rules Studio, Rule Execution Server and Rule Team Server (see can be installed on one server or they can be distributed to multiple machines.


sent to the Case Analyzer database using the Event Publisher. Optionally Cognos BI (Business

IBM Content Analytics supports crawling for unstructured and structured data associated to it allows analyzing historic case data, taking all information

IBM Case Manager provides an integration of P8 eForms and IBM Forms to use electronic form

of user data from a form and to the case and task objects. Forms can also be added to a case

to extract business rules from business processes and manage them independently, thereby allowing the

the ILOG BRMS are integrated high agility and extensibility.

, the business policies to assess regulations regarding passenger

paybacks or mileage

is not a good idea, since it is then design and execution of

IBM WebSphere ILOG JRules provides the functionality to manage and execute these rules and

Rules Studio, Rule Execution Server and Rule Team Server (see they can be distributed to multiple machines.


Figure

The Eclipse based Rules Studio is required to define the rule dataflows, and rule verbalizations. Rules Studio can also be used to define the rules. The rules are then processed on the Rules Execution Server.

Rules Team Server is required when business users need to dynamically access and update the business rules. It provides a user interface to access rules definitions manages role based access to rules, controls and audits changes and manages the deployment process.are stored in the Rules Team Server db repository, more details are described below.


IBM WebSpehere ILOG JRules is a comprehensive Business Rules Management System, which comprises of three main components:

• Rule Execution Server

• Central Rule Repository

• Rule Editing and Testing Tools

Each of these components will be described in more details in the following sections.

Rule Execution Server

The Rule Execution Server is responsible for all runtime aspects of the execution of business rules. This includes the actual execution of the rules, i.e., the evaluation of the rules, depending on the data the rules operate on. All rules are grouped in sobundled in dedicated rule set containers, so called “Rule Applications”. The Rule Execution Server can maintain multiple versions of individual applications simultaneously. To this end, the Rule Execution Server maintato from other tools.

Being the execution unit, the Rule Execution Server can also feed the “Decision Warehouse”, a store where the decision trail can be stored, documenting the rules being ewhich they were executed, as well as the data that was being utilized in the decision process. The “Decision Warehouse” is highly configurable and can be adapted to individual needs and requirements. This feature is particularly inter


Figure 4 - ILOG JRules architecture and how to use

The Eclipse based Rules Studio is required to define the rule data-model, rule flows, and rule verbalizations. Rules Studio can also be used to define the rules. The rules are

processed on the Rules Execution Server.

Rules Team Server is required when business users need to dynamically access and update the business rules. It provides a user interface to access rules definitions manages role based

audits changes and manages the deployment process.are stored in the Rules Team Server db repository, more details are described below.


IBM WebSpehere ILOG JRules is a comprehensive Business Rules Management System, h comprises of three main components:

Rule Execution Server (module “Rule Execution Server”)

Central Rule Repository (module "Rule Team Server”)

Rule Editing and Testing Tools (module “Rule Studio”)


Rule Execution Server

The Rule Execution Server is responsible for all runtime aspects of the execution of business rules. This includes the actual execution of the rules, i.e., the evaluation of the rules, depending on the data the rules operate on. All rules are grouped in so called “Rule Sets” which in turn are bundled in dedicated rule set containers, so called “Rule Applications”. The Rule Execution Server can maintain multiple versions of individual applications simultaneously. To this end, the Rule Execution Server maintains a repository of Rule Applications where they can be deployed

Being the execution unit, the Rule Execution Server can also feed the “Decision Warehouse”, a store where the decision trail can be stored, documenting the rules being ewhich they were executed, as well as the data that was being utilized in the decision process. The “Decision Warehouse” is highly configurable and can be adapted to individual needs and requirements. This feature is particularly interesting for compliance conformance.


, rule structure, rule flows, and rule verbalizations. Rules Studio can also be used to define the rules. The rules are

Rules Team Server is required when business users need to dynamically access and update the business rules. It provides a user interface to access rules definitions manages role based

audits changes and manages the deployment process. The rules are stored in the Rules Team Server db repository, more details are described below.

IBM WebSpehere ILOG JRules is a comprehensive Business Rules Management System,


The Rule Execution Server is responsible for all runtime aspects of the execution of business rules. This includes the actual execution of the rules, i.e., the evaluation of the rules, depending

called “Rule Sets” which in turn are bundled in dedicated rule set containers, so called “Rule Applications”. The Rule Execution Server can maintain multiple versions of individual applications simultaneously. To this end, the

ins a repository of Rule Applications where they can be deployed

Being the execution unit, the Rule Execution Server can also feed the “Decision Warehouse”, a store where the decision trail can be stored, documenting the rules being executed, the order in which they were executed, as well as the data that was being utilized in the decision process. The “Decision Warehouse” is highly configurable and can be adapted to individual needs and

esting for compliance conformance.


Finally, the Rule Execution Server offers several interfaces to access the individual “Rule Sets”, exposing them as “Transparent Decision Services” which can be consumed in a SOA like service fashion.

If it was to be described in very simple terms, the “Rule Execution Server” is the centralized Business Rule Execution engine, sometimes abbreviated as BRE.

Central Rule Repository

The “Rule Repository”, tagged “Rule Team Server Repository” in the architecture picture, stoall artifacts related to rule development and governance. The rules that are stored in this repository can be then exported to the “Rule Execution Server” where they can be made available for execution.

The purpose of the central repository is to provaugmented with metadata (e.g., an “expiration date”), where the change history of the rules is maintained, access to the rules is given or granted depending on a user's role and its associated rights, etc. Being a central component, this repository can be used by multiple clients, each being able to make changes that are transparent independent of the client used to access the repository.

The repository plays an important role in the deployment of a BRMS smakes it possible to implement a business role governance supported by dedicated tools that is not an integral part of an IT department but rather can be implemented by the business departments which can define, write, test, andepartments. (All of this of course only works, if the proper processes and models are in place.)

Rule Editing and Testing Tools

In order to fully utilize the power of the components described above, toolmake use of these components. These are part of the development and authoring tools which support different user groups by providing them with different tools, if required or wanted (business user may want to use his or her familisomeone else may be absolutely fine with a browser based tool set).

Irrespective of the user group, these tools need to be able to support rule definition, validation, and testing. As the rule execution needmay become impossible to manage hundreds if not thousands of rules and their corresponding interdependencies, these tools need also allow for the orchestration of the rules. And finally, as rule definition, testing, and deployment is subject to some (rule) governance model, the tools need support for it as well.

Needless to say, that an integration of the rule editing and testing tools with the other components needs to be seamless, allowing for a ful

ICMILOG Integration

The ICM task implementations using an IBM FileNet Process Engine coupled with the WebSphere ILOG Rules Execution server using implemented using PE web services invocation system steps

The following high level configuration IBM Case Manager task implementation:

• In Rules Studio or Rules Team Server, create theJRules Rules Execution Server

• In Case Builder, create the ICM task and implement the task workflow


Finally, the Rule Execution Server offers several interfaces to access the individual “Rule Sets”, exposing them as “Transparent Decision Services” which can be consumed in a SOA like

scribed in very simple terms, the “Rule Execution Server” is the centralized Business Rule Execution engine, sometimes abbreviated as BRE.

Central Rule Repository

The “Rule Repository”, tagged “Rule Team Server Repository” in the architecture picture, stoall artifacts related to rule development and governance. The rules that are stored in this repository can be then exported to the “Rule Execution Server” where they can be made

The purpose of the central repository is to provide a centralized place where rules can be stored, augmented with metadata (e.g., an “expiration date”), where the change history of the rules is maintained, access to the rules is given or granted depending on a user's role and its associated

Being a central component, this repository can be used by multiple clients, each being able to make changes that are transparent independent of the client used to access the

The repository plays an important role in the deployment of a BRMS solution in the sense that is makes it possible to implement a business role governance supported by dedicated tools that is not an integral part of an IT department but rather can be implemented by the business departments which can define, write, test, and deploy rules without the direct involvement of IT departments. (All of this of course only works, if the proper processes and models are in place.)

Rule Editing and Testing Tools

In order to fully utilize the power of the components described above, tools are needed that make use of these components. These are part of the development and authoring tools which support different user groups by providing them with different tools, if required or wanted (business user may want to use his or her familiar office tools for rules development, whereas someone else may be absolutely fine with a browser based tool set).

Irrespective of the user group, these tools need to be able to support rule definition, validation, and testing. As the rule execution needs to be put into an organized context, for otherwise it may become impossible to manage hundreds if not thousands of rules and their corresponding interdependencies, these tools need also allow for the orchestration of the rules. And finally, as

ition, testing, and deployment is subject to some (rule) governance model, the tools

Needless to say, that an integration of the rule editing and testing tools with the other components needs to be seamless, allowing for a full rule lifecycle. …

The ICM task implementations using an IBM FileNet Process Engine (PE) with the WebSphere ILOG Rules Execution server using web services

implemented using PE web services invocation system steps.

onfiguration steps are required to integrate IBM ILOG JRules with task implementation:

In Rules Studio or Rules Team Server, create the rules and deploy Rules Execution Server where they are exposed as Web service

In Case Builder, create the ICM task and implement the task workflow


Finally, the Rule Execution Server offers several interfaces to access the individual “Rule Sets”, exposing them as “Transparent Decision Services” which can be consumed in a SOA like

scribed in very simple terms, the “Rule Execution Server” is the centralized

The “Rule Repository”, tagged “Rule Team Server Repository” in the architecture picture, stores all artifacts related to rule development and governance. The rules that are stored in this repository can be then exported to the “Rule Execution Server” where they can be made

ide a centralized place where rules can be stored, augmented with metadata (e.g., an “expiration date”), where the change history of the rules is maintained, access to the rules is given or granted depending on a user's role and its associated

Being a central component, this repository can be used by multiple clients, each being able to make changes that are transparent independent of the client used to access the

olution in the sense that is makes it possible to implement a business role governance supported by dedicated tools that is not an integral part of an IT department but rather can be implemented by the business

d deploy rules without the direct involvement of IT departments. (All of this of course only works, if the proper processes and models are in place.)

s are needed that make use of these components. These are part of the development and authoring tools which support different user groups by providing them with different tools, if required or wanted (e.g., a

ar office tools for rules development, whereas

Irrespective of the user group, these tools need to be able to support rule definition, validation, s to be put into an organized context, for otherwise it

may become impossible to manage hundreds if not thousands of rules and their corresponding interdependencies, these tools need also allow for the orchestration of the rules. And finally, as

ition, testing, and deployment is subject to some (rule) governance model, the tools

Needless to say, that an integration of the rule editing and testing tools with the other

(PE) workflow are loosely ervices calls that are

ntegrate IBM ILOG JRules with an

rules and deploy them to the ILOG ervice

In Case Builder, create the ICM task and implement the task workflow


• In FileNet Process Designer, open the Case Manager solution and update the workflowdefinition for the case management taskexecution

The steps to integrate the rules execution in the task workflow are described in detail in section “Integrating the Case Solution with IBM WebSphere ILOG


In FileNet Process Designer, open the Case Manager solution and update the workflowdefinition for the case management task inserting the web services call invoking the rules

The steps to integrate the rules execution in the task workflow are described in detail in section Case Solution with IBM WebSphere ILOG JRules”.


In FileNet Process Designer, open the Case Manager solution and update the workflow inserting the web services call invoking the rules

The steps to integrate the rules execution in the task workflow are described in detail in section


Sample Solution

The sample solution implements a customer complaint management system for an airline. simplified complaint process includes the following steps:

1. The customer calls or send2. The agent opens the case in the case management system

document (case status “3. A “Verify Complaint” task is

task consists of a single step assigned to the “Agent” role to verify that the complaint is valid. The agent can either chose to closecontinue processing the

4. When the status is set to “automatically

5. In the “Investigate Complaint” task, certain settlement options are automatically evaluated using the rules engithen displayed to the agent in an “Investigate Complaint” step assigned to the “Agent” role.

6. The agent has the option to either close the case in this “Investigate Complaint” or mark the case as “Accepted”.

7. When the case status has been set to “A

The following diagram shows the task sequence of the three case tasks described and the possible status changes.

Figure


Sample Solution Scenario

The sample solution implements a customer complaint management system for an airline. process includes the following steps:

or sends an email to the agent and initiates a complaint caseThe agent opens the case in the case management system and add the complaint

(case status “New”) A “Verify Complaint” task is started automatically. For our sample implementation, this task consists of a single step assigned to the “Agent” role to verify that the complaint is valid. The agent can either chose to close the case (case status set to “C

ng the case by setting its status to “Verified” When the status is set to “Verified”, the task “Investigate Complaint” is started

In the “Investigate Complaint” task, certain settlement options are automatically evaluated using the rules engine. The result of this evaluation (score, legal entitlement) is then displayed to the agent in an “Investigate Complaint” step assigned to the “Agent”

The agent has the option to either close the case in this “Investigate Complaint” or mark ccepted”.

e case status has been set to “Accepted” the task “Settle Complaint” is started.

The following diagram shows the task sequence of the three case tasks described and the

Figure 5 - Flow chart of the complaint tasks


The sample solution implements a customer complaint management system for an airline. The

the agent and initiates a complaint case and add the complaint

started automatically. For our sample implementation, this task consists of a single step assigned to the “Agent” role to verify that the complaint is

the case (case status set to “Closed”) or to

erified”, the task “Investigate Complaint” is started

In the “Investigate Complaint” task, certain settlement options are automatically ne. The result of this evaluation (score, legal entitlement) is

then displayed to the agent in an “Investigate Complaint” step assigned to the “Agent”

The agent has the option to either close the case in this “Investigate Complaint” or mark

ccepted” the task “Settle Complaint” is started.

The following diagram shows the task sequence of the three case tasks described and the


The decision management system is used within the “Investigate Complaint” task to determine

• whether the customer has a legal entitlement to complaint

• what his “score” is, whereby the score determines the range within the agent can decide whether and how to compensate the customer bonus miles, vouchers, etc.the agent will have

Input for these rules will be the case data entered in the “Complaint Verification” phase (as for example the type of complaint, the flight delay, etc.).

In the sample implementation, the agent also has to enter customer related data l“customer status”, etc. – these values would be retrieved from a backend solution implementation.



whether the customer has a legal entitlement to receive a compensation

what his “score” is, whereby the score determines the range within the agent can decide whether and how to compensate the customer (for example by granting him additional bonus miles, vouchers, etc.). The higher the score, the more options for compensation

Input for these rules will be the case data entered in the “Complaint Verification” phase (as for laint, the flight delay, etc.).

In the sample implementation, the agent also has to enter customer related data lthese values would be retrieved from a backend db



a compensation based on his

what his “score” is, whereby the score determines the range within the agent can decide granting him additional

The higher the score, the more options for compensation

Input for these rules will be the case data entered in the “Complaint Verification” phase (as for

In the sample implementation, the agent also has to enter customer related data like “total miles”, db system in a real live


Implementing the

The following steps are required to implement the ILOG case management sample scenario

1. Create Project Workspace2. Create Rule Project 3. Define In and Outcomes4. Define Rule Packages and Business Rules5. Create Rule Flow

a. Create Rules b. Create Decision table

6. Create RuleApp 7. Deployment 8. Technical validation

a. Rules Execution Serverb. e.g. SOAP UI

Selecting the Project WorkspaceIn the "Rule Studio" select or create a new workspace as tstep is not necessary if you want to use an already existing workspace. However, i“Rule Studio” for the very first time, you will be asked for the location of a workspace unconditionally.

After the project workspace has been Users used to the Eclipse product will find the layout familiar and intuitive to use.


Implementing the ILOG JRules Solution

steps are required to implement the ILOG JRules part for the case management sample scenario:

Project Workspace

and Outcomes Define Rule Packages and Business Rules

Create Decision table

Rules Execution Server

Project Workspace In the "Rule Studio" select or create a new workspace as the current project environment.step is not necessary if you want to use an already existing workspace. However, i“Rule Studio” for the very first time, you will be asked for the location of a workspace

Figure 6 - Choosing a workspace

has been created or selected, “Rules Studio” opens its main window. Users used to the Eclipse product will find the layout familiar and intuitive to use.


for the airline complaint

he current project environment. This step is not necessary if you want to use an already existing workspace. However, if you start “Rule Studio” for the very first time, you will be asked for the location of a workspace

selected, “Rules Studio” opens its main window. Users used to the Eclipse product will find the layout familiar and intuitive to use.


Figure

Creating the Rule ProjectNow that the project workspace has been defined, the next logical step is to create the actual rules. To this end, we need to create a soan ILOG JRules solution. In addition, each “Rule Project” defines a “Rule Set”, which smallest collection of executables artifacts. parameters and includes the actual logic to perform the business rule execution. The latter is also called the “Orchestration” of business rules.

To create a “Rule Project”, select “New” from the “File” menu. From the choices given, select “Rule Project” which will open a new project wizard which will guide you through the process of creating a new rule project.


Figure 7 - Main window of "Rules Studio"

Project ace has been defined, the next logical step is to create the actual

To this end, we need to create a so-called “Rule Project” which will contain all artifacts of an ILOG JRules solution. In addition, each “Rule Project” defines a “Rule Set”, which

collection of executables artifacts. A “Rule Set is defined by its input and output parameters and includes the actual logic to perform the business rule execution. The latter is also called the “Orchestration” of business rules.

te a “Rule Project”, select “New” from the “File” menu. From the choices given, select “Rule Project” which will open a new project wizard which will guide you through the process of

Figure 8 - New "Rule Project" Wizard


ace has been defined, the next logical step is to create the actual called “Rule Project” which will contain all artifacts of

an ILOG JRules solution. In addition, each “Rule Project” defines a “Rule Set”, which is the A “Rule Set is defined by its input and output

parameters and includes the actual logic to perform the business rule execution. The latter is

te a “Rule Project”, select “New” from the “File” menu. From the choices given, select “Rule Project” which will open a new project wizard which will guide you through the process of


The wizard offers several choices of which the first, “Standard Rule Project”wanted.1 After the project type has been selected, a click on “Next” presents the next screen. On this screen, you can enter the name of the rule project. In our example, we used the name “CSMAL Rules” as the project name.

Figure

The following pages of the wizard are for the more experienced user where she or he can provide additional information for the creation of the project. Clicking “Finish” is a viable option for the scenario set forth in this document. This action creates tnecessary artifacts, and opens the perspective to work with rule projects.

Figure

After this step, the parameters, the This is done in the following sections.

Defining Input and Output All rules work on so-called factsengine that is executing these rules.

1 The “Hello World Project” is a simple project that says “Hello” and helps to get started, while the “Rule

Project with a BOM” creates a more complex project with an embedded “Business Object Model”, BOM. 2 The term “fact” is used in the academic world and by some other tools.

“Business Objects”.


The wizard offers several choices of which the first, “Standard Rule Project”After the project type has been selected, a click on “Next” presents the next screen.

On this screen, you can enter the name of the rule project. In our example, we used the name “CSMAL Rules” as the project name.

Figure 9 - Providing a name for a Rule Project

The following pages of the wizard are for the more experienced user where she or he can provide additional information for the creation of the project. Clicking “Finish” is a viable option for the scenario set forth in this document. This action creates the actual project, including all necessary artifacts, and opens the perspective to work with rule projects.

Figure 10 - "Rule Studio”, main screen

After this step, the parameters, the rule orchestration logic, and the actual rulThis is done in the following sections.

Input and Output Parameters called facts2 which need to be made available by some means to the rule

engine that is executing these rules. The easiest way to make them available is to declare input

simple project that says “Hello” and helps to get started, while the “Rule Project with a BOM” creates a more complex project with an embedded “Business Object Model”, BOM.

The term “fact” is used in the academic world and by some other tools. In ILOG JRules, these are


The wizard offers several choices of which the first, “Standard Rule Project”, is the one that is After the project type has been selected, a click on “Next” presents the next screen.

On this screen, you can enter the name of the rule project. In our example, we used the name

The following pages of the wizard are for the more experienced user where she or he can provide additional information for the creation of the project. Clicking “Finish” is a viable option

he actual project, including all

orchestration logic, and the actual rules can be defined.

which need to be made available by some means to the rule available is to declare input

simple project that says “Hello” and helps to get started, while the “Rule Project with a BOM” creates a more complex project with an embedded “Business Object Model”, BOM.

In ILOG JRules, these are called


and output parameters for a rule project. This way, the ruleset that is represented by the rule project will receive the parameters defined as input and return the parameters defined as output. One can think of it as a service.

In order to define these parameters, menu, where you can perform many actions on this project. To define the input and output parameters, select “Properties”, which is located at the endwindow, where different properties can be selected on the left hand side of the window. The ruleset parameters are defined through the “Ruleset Parameters” entry.

Figure

In the window that is displayed on the right side of the screen, you can add, edit, or remove either input or output parameters. For our example, we will define parameters:

Name Type

miles int

status java.lang.String

complainttype java.lang.String

delay int

score int

entitlement boolean


and output parameters for a rule project. This way, the ruleset that is represented by the rule project will receive the parameters defined as input and return the parameters defined as output.

ice.

In order to define these parameters, select the rule project and right-click. This opens a context menu, where you can perform many actions on this project. To define the input and output parameters, select “Properties”, which is located at the end of the menu. This opens a new window, where different properties can be selected on the left hand side of the window. The ruleset parameters are defined through the “Ruleset Parameters” entry.

Figure 11 - Defining input and output parameters

In the window that is displayed on the right side of the screen, you can add, edit, or remove either input or output parameters. For our example, we will define the following input and output

Input, or output, or both

Default value

input

java.lang.String input

.lang.String input

input

output 0

output False

Table 1 - Input and output parameters


and output parameters for a rule project. This way, the ruleset that is represented by the rule project will receive the parameters defined as input and return the parameters defined as output.

click. This opens a context menu, where you can perform many actions on this project. To define the input and output

This opens a new window, where different properties can be selected on the left hand side of the window. The

In the window that is displayed on the right side of the screen, you can add, edit, or remove the following input and output

Verbalization

miles flown

the status

the complaint

the flight delay

the score

the legal entitlement


Of special interest is the last column in this table: the “verbalization”. representation of the parameter (name) in the business rules. Thibusiness rule are written.

Define Rule PackagesBefore we can create a Ruleflow we need to define the Rule package and the Business Rules which will help us to better structure the project. Open the project and right click onfolder. From here, select “New” and “Rule Package”, and follow the wizard to create the individual packages. The following packages need to be created

1. initialization 2. investigation

a. initialization b. entitlement c. score d. finalization

3. refinement

Defining the Rules It is now time to define the actual rules. Business rules describe in non(business language) a condition that needs to be satisfied in order for some action to be executed. They follow a simple “if…then…” pattern.

Business rules are created in rule packages which we have created in the previous section. Again, wizards help us to create such rules.

The following two figures beloPlease note the terms that areand output parameters.

Beneath the 1. initialization rule package we define the business rules (select New � Business Rule):

� init entitlement o Code: “then

� init score o Code: "then

Beneath the 2.b investigation.entitlementright click � New � Business Rule):

� baggage loss o Code: “if 'the complaint'

legal entitlement'

� flight delay o Code: “if 'the complaint'

delay' is at least

3 This is not completely true. There are also “if…then…else…” patterns and some more choices.

However, for the sake of simplicity, the “if…then…” pattern will suffice.


Of special interest is the last column in this table: the “verbalization”. It defines the representation of the parameter (name) in the business rules. This will become clear when the

Rule Packages Before we can create a Ruleflow we need to define the Rule package and the Business Rules which will help us to better structure the project. Open the project and right click onfolder. From here, select “New” and “Rule Package”, and follow the wizard to create the individual packages. The following packages need to be created:

It is now time to define the actual rules. Business rules describe in non-technical terms (business language) a condition that needs to be satisfied in order for some action to be executed. They follow a simple “if…then…” pattern.3

iness rules are created in rule packages which we have created in the previous section. Again, wizards help us to create such rules.

The following two figures below show two business rules, each having a descriptive name. Please note the terms that are used to define the rules and compare them to the verbalized input

rule package we define the business rules (select

then set 'the legal entitlement' to false

set 'the score' to 0 ;” 2.b investigation.entitlement rule package we define the business rules (select

Business Rule):

'the complaint' contains "Baggage Loss"

legal entitlement' to true ;”

'the complaint' contains "Flight Delay"

is at least 5 then set 'the legal entitlement'

There are also “if…then…else…” patterns and some more choices. ty, the “if…then…” pattern will suffice.


It defines the s will become clear when the

Before we can create a Ruleflow we need to define the Rule package and the Business Rules which will help us to better structure the project. Open the project and right click on the “rules” folder. From here, select “New” and “Rule Package”, and follow the wizard to create the

technical terms (business language) a condition that needs to be satisfied in order for some action to be

iness rules are created in rule packages which we have created in the previous section.

having a descriptive name. used to define the rules and compare them to the verbalized input

rule package we define the business rules (select � right click �

false ;”

rule package we define the business rules (select �

"Baggage Loss" then set 'the

"Flight Delay" and 'the flight

'the legal entitlement' to true ;”

There are also “if…then…else…” patterns and some more choices.


Figure

Figure


Figure 12 - Business Rule "Baggage Loss"

Figure 13 - Business Rule "Flight Delay"



Creating a Decision Table

Beneath the 2.c investigation.right click � New � Decision Table):

� status

Business rules can also be described as sosuited when several rules have the same structure but differ only in selected parameters. In a “Decision Table”, each row describes a rule, whereas emakes “Decision Tables” so powerful is that the actual values for the parameters need not to be set: in this particular case, the corresponding part of the rule is omitted from the rule.

� So our first column named applied

o 'the status' contains <a string>� So our second column named

applied o 'miles flown' is <a number>

� Our third column named Definition applied

o set 'the score' to ( 'the score' + <a number> )

The following figure shows ournumber, the actual rule is hovered.


Creating a Decision Table

investigation.score rule package above we define a decision table (select Decision Table):

Business rules can also be described as so-called “Decision Tables”. This format is particularly suited when several rules have the same structure but differ only in selected parameters. In a “Decision Table”, each row describes a rule, whereas each column defines a parameter. What makes “Decision Tables” so powerful is that the actual values for the parameters need not to be set: in this particular case, the corresponding part of the rule is omitted from the rule.

So our first column named Status (Condition Column) has the Condition Definition

'the status' contains <a string> So our second column named Miles (Condition Column) has the Condition Definition

'miles flown' is <a number> Our third column named Score Bonus (Note: This is our Action Column) has the Action

set 'the score' to ( 'the score' + <a number> )

our “Decision Table” status. When the cursor is places over a row number, the actual rule is hovered.

Figure 14 - A "Decision Table"


rule package above we define a decision table (select �

called “Decision Tables”. This format is particularly suited when several rules have the same structure but differ only in selected parameters. In a

ach column defines a parameter. What makes “Decision Tables” so powerful is that the actual values for the parameters need not to be set: in this particular case, the corresponding part of the rule is omitted from the rule.

(Condition Column) has the Condition Definition

(Condition Column) has the Condition Definition

Action Column) has the Action

. When the cursor is places over a row


Creating the Ruleflow Now that that inputs and outputs have been defined,is time to define the “Ruleflow” which describes how the rules, which will be organized by packages, are executed.

The ruleflow defines the execution logic

• it has a start and stop point

• is can include branching

• it can be nested

The tasks that are to be executed by the rule flow, the soindividual rules, or packages, or combinations of both.

In order to define the rule flow, “Ruleflow”. A new window opens, the “Ruleflow Editor” where you can define the ruleflow itself.

The following figure depicts the result of the ruleflow definition. The rule tasks have been defineby dragging the individual packages onto the editor’

1. initialization 2. investigation (nested

a. initialization b. entitlement c. score d. finalization

3. refinement

Figure 15 – Our main investigation


Ruleflow Now that that inputs and outputs have been defined, the business rules and our decision tableis time to define the “Ruleflow” which describes how the rules, which will be organized by

execution logic using the following features:

has a start and stop point

is can include branching

The tasks that are to be executed by the rule flow, the so-called “Rule Tasks”, comprise of either individual rules, or packages, or combinations of both.

In order to define the rule flow, select and right click the rule project, select “New” and “Ruleflow”. A new window opens, the “Ruleflow Editor” where you can define the ruleflow itself.

The following figure depicts the result of the ruleflow definition. The rule tasks have been defineby dragging the individual packages onto the editor’s pane. In our case the packages:

(nested �)

Our main investigation Ruleflow with nested “investigation” Ruleflow


the business rules and our decision table it is time to define the “Ruleflow” which describes how the rules, which will be organized by

called “Rule Tasks”, comprise of either

select and right click the rule project, select “New” and then “Ruleflow”. A new window opens, the “Ruleflow Editor” where you can define the ruleflow itself.

The following figure depicts the result of the ruleflow definition. The rule tasks have been defined In our case the packages:

with nested “investigation” Ruleflow


Figure 16- The nested “investigation” Ruleflow

Creating a RuleApp The “RuleSet”, as described by the “Rule Project”, is the smallest executable unit. However, in order to be executable by the “RuleApp”s. One “RuleApp” can contain one or more “RuleSets”.

The creation of a “RuleApp” follows the same pattern as the creation of a “Rule Project”. A wizard can be started from the “File” menu, selecting “New” and “Other…”. This artifacts that can be created using the “New”continue.


The nested “investigation” Ruleflow

The “RuleSet”, as described by the “Rule Project”, is the smallest executable unit. However, in “Rule Execution Server”, it needs to be packacan contain one or more “RuleSets”.

The creation of a “RuleApp” follows the same pattern as the creation of a “Rule Project”. A wizard can be started from the “File” menu, selecting “New” and “Other…”. This artifacts that can be created using the “New”-wizards. Select “RuleApp Project” from the list to


The “RuleSet”, as described by the “Rule Project”, is the smallest executable unit. However, in “Rule Execution Server”, it needs to be packaged into so-called

The creation of a “RuleApp” follows the same pattern as the creation of a “Rule Project”. A wizard can be started from the “File” menu, selecting “New” and “Other…”. This will list all

wizards. Select “RuleApp Project” from the list to


Figure

As with a “Rule Project”, a “RuleApp Project” needs to have a nam“CSMAL RuleApp” and click “Next”.

Figure

This will open a new wizard window where “Rule Projects” can be selected. select the “Rule Project” “CSMAL Rules”.


Figure 17 - Creating a "RuleApp Project"

As with a “Rule Project”, a “RuleApp Project” needs to have a name. For the example, we chose “CSMAL RuleApp” and click “Next”.

Figure 18 - Giving a "RuleApp Project" a name

This will open a new wizard window where “Rule Projects” can be selected. select the “Rule Project” “CSMAL Rules”.


e. For the example, we chose

This will open a new wizard window where “Rule Projects” can be selected. Click “Add…” and


Figure 20 - Selecting a “Rule Project” for a "RuleApp Project"

Now, the “Rule Project” is included by the “RuleAp


Figure 19 - An empty RuleApp

Selecting a “Rule Project” for a "RuleApp Project"

Now, the “Rule Project” is included by the “RuleApp”.


Selecting a “Rule Project” for a "RuleApp Project"


Figure 21 - A "RuleApp Project" definition after a "Rule Project" was added

Clicking on “Finish” finally creates the “RuleApp Project”. The result is shown the following picture.

Figure

If required, additional “Rule Projects” can be added to the “RuleApp Project” later.

Deploying the RuleAppNow that the RuleApp has been prepared, it can be deployed to the “Rule Execution Server”, RES. The basic steps are very simple: a reference to the RES needs to be defined and thereafter, the RuleApp can be deployed.


A "RuleApp Project" definition after a "Rule Project" was added

Clicking on “Finish” finally creates the “RuleApp Project”. The result is shown the following

Figure 22 - The workspace with two projects


App Now that the RuleApp has been prepared, it can be deployed to the “Rule Execution Server”, RES. The basic steps are very simple: a reference to the RES needs to be defined and thereafter, the RuleApp can be deployed.


A "RuleApp Project" definition after a "Rule Project" was added

Clicking on “Finish” finally creates the “RuleApp Project”. The result is shown the following


Now that the RuleApp has been prepared, it can be deployed to the “Rule Execution Server”, RES. The basic steps are very simple: a reference to the RES needs to be defined and


Deploying a RuleApp means to transferRuleSets that are defined by rule

To deploy a RuleApp, you can either

• either open the file “archive.xml” in the “RuleApp Project” and to click on the “Deploy” link on the right pane,

• or right-click on the “RuleApp Project”

Both alternatives are depicted in the following figures.

Figure 23 -

Figure 24

Both alternatives start the same deployment wizardfirst.


Deploying a RuleApp means to transfer all artifacts that make up a RuleApp. This includes all RuleSets that are defined by rule projects.

To deploy a RuleApp, you can either

either open the file “archive.xml” in the “RuleApp Project” and to click on the “Deploy” link

“RuleApp Project” and select “RuleApp” and “Deploy”

Both alternatives are depicted in the following figures.

Deploying a RuleApp from the RuleApp manager

24 - Deploying a RuleApp from the context menu

Both alternatives start the same deployment wizard which asks for a version numbering scheme


all artifacts that make up a RuleApp. This includes all

either open the file “archive.xml” in the “RuleApp Project” and to click on the “Deploy” link

“RuleApp” and “Deploy”.

Deploying a RuleApp from the RuleApp manager

ploying a RuleApp from the context menu

which asks for a version numbering scheme


Figure

RuleApps are versioned by the “Rule ExeRuleApp can be deployed at any time. Each version number consists of a version number of the RuleApp itself and of version numbers of the referenced rulesets. Each version number has a major and a minor number part, e.g., 2.1, where the “2” is the major part while the “1” is the minor part.

For the sake of simplicity, we select the first option which increments the RuleApp major version. Hence, if the previous version of the RuleApp were 2.1, the new versio

After the versioning scheme was selected, the next step is to choose the RES where to deploy the RuleApp to.

Figure

Keep or select “Create a temporary Rule Execution Execution Server” installation and enter the corresponding user credentials for interactively logging into the RES.


Figure 25 - Selecting RuleApp versioning scheme

RuleApps are versioned by the “Rule Execution Server”, and more than one version of RuleApp can be deployed at any time. Each version number consists of a version number of the RuleApp itself and of version numbers of the referenced rulesets. Each version number has a

er part, e.g., 2.1, where the “2” is the major part while the “1” is the

For the sake of simplicity, we select the first option which increments the RuleApp major version. Hence, if the previous version of the RuleApp were 2.1, the new version would start with 3.

After the versioning scheme was selected, the next step is to choose the RES where to deploy

Figure 26 - Choosing an RES for deployment

Create a temporary Rule Execution Server configuration:” installation and enter the corresponding user credentials for interactively


cution Server”, and more than one version of a RuleApp can be deployed at any time. Each version number consists of a version number of the RuleApp itself and of version numbers of the referenced rulesets. Each version number has a

er part, e.g., 2.1, where the “2” is the major part while the “1” is the

For the sake of simplicity, we select the first option which increments the RuleApp major version. n would start with 3.

After the versioning scheme was selected, the next step is to choose the RES where to deploy

as the local “Rule installation and enter the corresponding user credentials for interactively


The values presented by the wizard are the of the RES was done without changing of any of the values that can be tweaked during the installation.

Note: If you perform this step for the first time, you may be asked if the changes you made to the configuration of the “RuleApp Project” are to be saved o

The deployment of the RuleApp is is quick process that finishes usually within a few seconds. During the deployment, status messages are displayed in the “Console” view.

Figure

A successful deployment may look like the following code snippet.

The "CSMAL RuleApp" RuleApp project was successfully deployed on the "temporaryServer" configuration.

/CSMALRuleApp/1.0 -> /CSMALRuleApp/2.0: Version c

/CSMALRuleApp/1.0/CSMALRules/1.0

Validating the Rule Execution EnvironmentThe Rule Execution Server can expose the deployed RuleApp as a Web service, i.e., it automatically generates a WSDL file and implements the actual service itself. This is sometime very useful, particularly for testing purposes.

To validate the deployment of the transferred, the WSDL can be retrieved, a technical test (not tools like soapUI (http://en.wikipedia.org/wimplemented this way.

The easiest way to verify that the RuleApp has been deployed properly is to login into the “Rule Execution Server” and to look up the application using the RES’s console.


The values presented by the wizard are the default values which can be used if the deployment the RES was done without changing of any of the values that can be tweaked during the

If you perform this step for the first time, you may be asked if the changes you made to the configuration of the “RuleApp Project” are to be saved or not. Please do so.


Figure 27 - A successful RuleApp deployment

A successful deployment may look like the following code snippet.


> /CSMALRuleApp/2.0: Version changed and element added

/CSMALRuleApp/1.0/CSMALRules/1.0 -> /CSMALRuleApp/2.0/CSMALRules/1.0: Version changed and element added

ng the Rule Execution Environment The Rule Execution Server can expose the deployed RuleApp as a Web service, i.e., it automatically generates a WSDL file and implements the actual service itself. This is sometime very useful, particularly for testing purposes.

of the RuleApp and to ensure that the deployment has been transferred, the WSDL can be retrieved, a technical test (not functional) can be started

http://en.wikipedia.org/wiki/SoapUI), even simple unit tests can be



values which can be used if the deployment the RES was done without changing of any of the values that can be tweaked during the

If you perform this step for the first time, you may be asked if the changes you made to r not. Please do so.



> /CSMALRuleApp/2.0/CSMALRules/1.0: Version changed and element added

The Rule Execution Server can expose the deployed RuleApp as a Web service, i.e., it automatically generates a WSDL file and implements the actual service itself. This is sometime

ensure that the deployment has been really ) can be started. Using

), even simple unit tests can be



To this end, start a Web browser and point it to the RES URL, which is by default.4 As the RES Console and to provide proper credentials. In the following sections, we logged in as the RES’s administrator, resAdmin.

After access to the console has been granted, the RES Explorer is displayed. There are several tabs, of which the “Explorer” will guide us through the application.

Figure

To this end, expand the “RuleApp” folder oRuleApps that are deployed, together with their version number. Below the RuleApp folder, each ruleset that is included in the RuleApp, is displayed. We can see that the “CSMALRules” ruleset is deployed. In order to verify the WSDL

4 This is same URL as the one used by the “Rule Execution Server” configuration during the deployment

of the RuleApp.


a Web browser and point it to the RES URL, which is http://As the RES Console uses a role model for its components, a user needs to log in

and to provide proper credentials. In the following sections, we logged in as the RES’s

Figure 28 - Logging in into RES

onsole has been granted, the RES Explorer is displayed. There are several tabs, of which the “Explorer” will guide us through the application.

Figure 29 - Main screen of the RES Console

To this end, expand the “RuleApp” folder on the left hand side of the screen. This displays all RuleApps that are deployed, together with their version number. Below the RuleApp folder, each ruleset that is included in the RuleApp, is displayed. We can see that the “CSMALRules” ruleset

ed. In order to verify the WSDL, we open the ruleset by clicking on its link.

he one used by the “Rule Execution Server” configuration during the deployment


http://localhost:9080/res uses a role model for its components, a user needs to log in

and to provide proper credentials. In the following sections, we logged in as the RES’s

onsole has been granted, the RES Explorer is displayed. There are several

n the left hand side of the screen. This displays all RuleApps that are deployed, together with their version number. Below the RuleApp folder, each ruleset that is included in the RuleApp, is displayed. We can see that the “CSMALRules” ruleset

, we open the ruleset by clicking on its link.

he one used by the “Rule Execution Server” configuration during the deployment


Of particular interest are the two lines

• “Get HTDS WSDL for the ruleset version”

• “Get HTDS WSDL for the latest ruleset version”

which will retrieve the WSDL files for this ruleset. The difference between the former and the latter is that the latter will retrieve the most upRuleApp version, whereas the

Hint: Iterating the deployment process leads to several versions of the RuleAppcould decide whether to take the latest version or one of the prior developed applications (e.g. for troubleshooting or test scenarios).

A well formatted xml-file should appear after having selected one of the above mentioned WSDL-links.

This concludes the technical deployment test. It remains tcommunication.


Figure 30 - A ruleset in the RES

Of particular interest are the two lines

DS WSDL for the ruleset version”

for the latest ruleset version”

which will retrieve the WSDL files for this ruleset. The difference between the former and the latter is that the latter will retrieve the most up-to-date version of the ruleset in the selected RuleApp version, whereas the former will retrieve the exact version of the ruleset.

Iterating the deployment process leads to several versions of the RuleAppcould decide whether to take the latest version or one of the prior developed applications (e.g.

leshooting or test scenarios).

file should appear after having selected one of the above mentioned

Figure 31 - The WSDL of a ruleset

This concludes the technical deployment test. It remains to verify the Web


which will retrieve the WSDL files for this ruleset. The difference between the former and the date version of the ruleset in the selected

former will retrieve the exact version of the ruleset.

Iterating the deployment process leads to several versions of the RuleApp-packages. You could decide whether to take the latest version or one of the prior developed applications (e.g.

file should appear after having selected one of the above mentioned

eb service


We will now briefly show how a technical test using the soapUI tool can be performed. As it is outside of the scope of this document to describe how to use the tool, we just show the relevant picture which shows the result of a request to be sent to the “result of this request.

Figure 32

Comparing the results with the input and the rules defined above, we see that the ruleset delivers the proper results.


We will now briefly show how a technical test using the soapUI tool can be performed. As it is outside of the scope of this document to describe how to use the tool, we just show the relevant picture which shows the result of a request to be sent to the “Rule Execution Server” and the

32 - Testing the ruleset using a SOAP testing tool

Comparing the results with the input and the rules defined above, we see that the ruleset


We will now briefly show how a technical test using the soapUI tool can be performed. As it is outside of the scope of this document to describe how to use the tool, we just show the relevant

Rule Execution Server” and the

Testing the ruleset using a SOAP testing tool

Comparing the results with the input and the rules defined above, we see that the ruleset


Implementing the

This section describe how the Case Manager Builder.

Open the Case Builder application in the browser (URL for the PoT VMWare used in the residency e.g. http://localhost:9083/CaseBuilder/login/login.jspuser.

On the Case Manager Builder start page, select pane. .We name our solution Customer Management AirLinewith prefix CSMAL..

Figure 33 Create a ICM solution with IBM Case Manager Builder

Note: The final solution definition is stored in the Design Object Store. solution is represented by a set of files, the

• Solution Definition File (SDF)

• Configuration files – XML files

• Workflow definition files o One per case type

The implementation of the scenario can be done straight forward by completing the configuration tasks in the Case Builder tabsartifacts are defined:

• Properties

• Roles

• Document types

• Personal In-baskets

• Case Types

Defining the Case PropertiesAdd the properties to the solution as described below. Properties without description are optional.


Implementing the Case Solution

how the “Customer Management Airline” solution is implemented with

Open the Case Builder application in the browser (URL for the PoT VMWare used in the http://localhost:9083/CaseBuilder/login/login.jsp) and login as an administrative

Case Manager Builder start page, select "Add Solution" in the "Creating the solution" Customer Management AirLine (CustomerManagement

Create a ICM solution with IBM Case Manager Builder

solution definition is stored in the Design Object Store. Whereby esolution is represented by a set of files, the “solution package” including the:

Solution Definition File (SDF)

XML files

Workflow definition files – XPDL files One per case type

The implementation of the scenario can be done straight forward by completing the configuration tabs one by one from left to right. In these steps the following solution

Properties properties to the solution as described below. Properties without description are optional.


is implemented with IBM

Open the Case Builder application in the browser (URL for the PoT VMWare used in the and login as an administrative

"Creating the solution" (CustomerManagementAirLine)

Create a ICM solution with IBM Case Manager Builder

Whereby each case “solution package” including the:

The implementation of the scenario can be done straight forward by completing the configuration In these steps the following solution

properties to the solution as described below. Properties without description are optional.


The properties ComplaintStatus and Complfollowing values:

PropertyName

ComplaintStatus


Figure 34 - Case Properties Tab

The properties ComplaintStatus and ComplaintType have an associated choice l

ComplaintStatus ItemName ItemValues

New New

Settled Settled

Verified Verified

Closed Closed

Accepted Accepted


associated choice list with the


Table

PropertyName

ComplaintType

Figure 35 -

Defining the Case RolesIn the sample scenario only one role is needed: “Agent”.configuration of the role In-basket.


Table 2 – Complaint Status Choice List

ItemName ItemValues

Baggage Loss Baggage Loss

Flight Delay Flight Delay

Other Other

Table 3 – PropertyName Choice List

Example of defining a property with a choice list

Roles scenario only one role is needed: “Agent”. A subtask of the role definition is the

basket.

Figure 36 - Role Definition


Baggage Loss

property with a choice list

A subtask of the role definition is the


Defining the Document TypesOptionally a complaint document type can be defineddocuments that belong to a case and can assigncase or as a precondition for a task.

Note: As our focus was on rules integration wesample scenario triggering the rules execution.

Figure

Defining the Personal InYou have the ability to create

Note: In our sample scenario, all task steps will be associated to the Agent role and therefore will appear in the “Agent” role

Defining the Case-Type In the Case-Type definition the taskpreliminary stages. A case type contains tasks. A task has one or more steps that must be completed in order to complete the task. A ccompleted or manually disabled. Case Manager Client) that case workers must complete to close the case.


ocument Types document type can be defined. Document types organize and classify the

documents that belong to a case and can assign e.g. a complaint document type to start a new case or as a precondition for a task.

cus was on rules integration we decide not to require a document to run our sample scenario triggering the rules execution.

Figure 37 – Add a new Document Type

Defining the Personal In-Basket You have the ability to create a personal In-basket for Users.

In our sample scenario, all task steps will be associated to the Agent role and therefore t” role In-basket, not in the personal In-basket.

Figure 38 - Personal In-basket

Type Type definition the tasks are configured and linked to the objects prepared in the

A case type contains tasks. A task has one or more steps that must be completed in order to complete the task. A case is not complete until all required tasks are completed or manually disabled. A case organizes all of the tasks and steps (work items in the Case Manager Client) that case workers must complete to close the case.


Document types organize and classify the document type to start a new

require a document to run our

In our sample scenario, all task steps will be associated to the Agent role and therefore

are configured and linked to the objects prepared in the A case type contains tasks. A task has one or more steps that must be

ase is not complete until all required tasks are A case organizes all of the tasks and steps (work items in the


Click "Add Case Type" you will get to the “Complaint”

Figure


Figure 39 - Add a new Case Type

"Add Case Type" you will get to the screen as shown below. Our case type name is

Figure 40 – Specify the new Case Type attributes


Our case type name is


In the Properties pane add "all Properties" defined for the

For the view “Case Data”, add all properties assigned to the case type according to your needs:


ll Properties" defined for the solution to the “Complaint” case type.

Figure 41 – Add and define properties

dd all properties assigned to the case type and adjust the layout


solution to the “Complaint” case type.

and adjust the layout


Figure 42 – Define how the Compl

For the views “Case Summary” and “Case Search”, add the properties you want to make visible for these views. As we are not using created for the solution.

Adding the Tasks In the next steps the tasks as identified for the sample scenario (see chapter “Scenario”) are added for the case type “Complaint”.

Hit the "Add Task" Button and create three tasks corresponding to the three phases of the example scenario:

• "Verify Complaint"

• "Investigate Complaint"

• "Settle Complaint".


Define how the Complaint properties in the Case Data View are displayed in the Case Manager Client

views “Case Summary” and “Case Search”, add the properties you want to make visible As we are not using documents for our sample scenario, no

In the next steps the tasks as identified for the sample scenario (see chapter “”) are added for the case type “Complaint”.

Hit the "Add Task" Button and create three tasks corresponding to the three phases of the

"Investigate Complaint"


are displayed in the Case

views “Case Summary” and “Case Search”, add the properties you want to make visible documents for our sample scenario, no case folders are

In the next steps the tasks as identified for the sample scenario (see chapter “Sample Solution

Hit the "Add Task" Button and create three tasks corresponding to the three phases of the


When you select the pencil symbol on the right side of the task box, the task propertybe opened. Set the task parameters as shown below


Figure 43 – Add Tasks

symbol on the right side of the task box, the task propertybe opened. Set the task parameters as shown below for the different tasks


symbol on the right side of the task box, the task property pane will for the different tasks.


Figure 44 – Edit and d

Figure 45 – Edit and d


Edit and define the “Verify Complaint” Task properties

Edit and define the “Investigate Complaint” Task properties


properties

properties


For the “Investigate Complaint” task, tmet" and the condition “ComplaintStatus = Verified” needs to be added. This will make sure the task is automatically started once the Verification phase is completed.

Figure 46 – Pre

In our sample solution, this will be done manually by the agent, changingproperty to “Verified”.

Settle Complaint task properties

Figure 47 – Edit and define the “SettleComplaint” Task properties


For the “Investigate Complaint” task, the "Precondition" must be set to "A Propertyand the condition “ComplaintStatus = Verified” needs to be added. This will make sure the

task is automatically started once the Verification phase is completed.

Precondition to start the “Investigate Complaint

our sample solution, this will be done manually by the agent, changing the “ComplaintStatus”

properties:

Edit and define the “SettleComplaint” Task properties


Property condition is and the condition “ComplaintStatus = Verified” needs to be added. This will make sure the

ate Complaint” task

the “ComplaintStatus”

Edit and define the “SettleComplaint” Task properties


For the “Settle Complaint” task, tand the condition “ComplaintStatus = “Accepted” needs to be added. This will make sure the task is automatically started once the Verification phase is completed.

Figure 48 –

In our sample solution, this will be done manually by the agent, changing the “ComplaintStatus” property to “Accepted”.

Designing the Task WorkflowsFor each of the tasks added, the task workflows have to be defined. This is done clicking on the “Open Step Editor” symbol on the right side of

For each of the tasks, add a Role Lane by dragging tMake sure the role “Agent” is assigned.


For the “Settle Complaint” task, the "Precondition" must be set to "A Propertyand the condition “ComplaintStatus = “Accepted” needs to be added. This will make sure the

omatically started once the Verification phase is completed.

– Precondition to start the “SettleComplaint” task

In our sample solution, this will be done manually by the agent, changing the “ComplaintStatus”

Task Workflows For each of the tasks added, the task workflows have to be defined. This is done clicking on the “Open Step Editor” symbol on the right side of each task box.

For each of the tasks, add a Role Lane by dragging the role icon below the existing swimMake sure the role “Agent” is assigned.


Property condition is met" and the condition “ComplaintStatus = “Accepted” needs to be added. This will make sure the

Precondition to start the “SettleComplaint” task

In our sample solution, this will be done manually by the agent, changing the “ComplaintStatus”

For each of the tasks added, the task workflows have to be defined. This is done clicking on the

he role icon below the existing swim-lanes.


Figure

For each of the three tasks, add a single step in the “Agent” Launch step. Create the following agent steps

• “Verify Complaint” for the

• “Investigate Complaint” for the

• “Settle Complaint” for the “Settle

Example for the “Verify Complaint” task:

Figure


Figure 49 – “Verify Complaint” Step Editor

, add a single step in the “Agent” swim-lane and connect it to the Launch step. Create the following agent steps

“Verify Complaint” for the “Verify Complaint” task

“Investigate Complaint” for the “Investigate Complaint” task and

ettle Complaint” for the “SettleComplaint” task

“Verify Complaint” task:

Figure 50 – “Verify Complaint” step and connection


and connect it to the


For all three tasks, select the step you added to the workflow and add the available properties in the “Step properties” pane to the field “Parameters

Figure 51 – Add

Click OK in the “Case Properties” popafter also click OK in the “Step Properties”

Save the solution and close the


For all three tasks, select the step you added to the workflow and add the available properties in the “Step properties” pane to the field “Parameters”

Add case properties to the “Verify Complaint” step

Click OK in the “Case Properties” pop-up windows , add the Responses “Verified, Close” click OK in the “Step Properties”

lose the solution design page.


For all three tasks, select the step you added to the workflow and add the available properties in

properties to the “Verify Complaint” step

, add the Responses “Verified, Close” and


Figure

For the Investigate Complaint task we add two “Stub Steps” (name Invoke and Assign) Implemented , see next chapter, with the Process Designer to calthe Score and Legal Entitlement returns to our corresponding case properties.

Note: You can add properties to a stub step in an application outside of IBM Case Manager, such as Process Designer. Stub steps appear only in the connect a stub step to the appropriate parts of the process.

Click Validate. The steps and routes are validated and a message is displayed in the status bar. Correct any errors before proceeding. To save thValidate�Save and Close the solution.


Figure 52 - “Investigate Complaint” step Editor

For the Investigate Complaint task we add two “Stub Steps” (name Invoke and Assign) Implemented , see next chapter, with the Process Designer to call the Rules Engine and assign the Score and Legal Entitlement returns to our corresponding case properties.

You can add properties to a stub step in an application outside of IBM Case Manager, such as Process Designer. Stub steps appear only in the system swimlane. Use a connector to connect a stub step to the appropriate parts of the process.

Click Validate. The steps and routes are validated and a message is displayed in the status bar. Correct any errors before proceeding. To save the task and solution, click Save

Save and Close the solution.


For the Investigate Complaint task we add two “Stub Steps” (name Invoke and Assign) l the Rules Engine and assign

the Score and Legal Entitlement returns to our corresponding case properties.

You can add properties to a stub step in an application outside of IBM Case Manager, system swimlane. Use a connector to

Click Validate. The steps and routes are validated and a message is displayed in the status bar. lution, click Save� Close �


Integrating the Case Solution with IBM WebSphere ILOG JRules

Now the the rules invocation step needs to be inserted indefinition.

This webservice invocation is implemented using an “Invocation” system workflow step in the “Investigate Complaint” task workflow implementation.Process Designer is used to edit the

The following high level steps are required to integrate the rules execution

- Opening the “Investigate Complaint” Process Designer

- Enabling Direct WDSL link- Determining ILOG exec- Registering Partner Link- Adding the webservice invocation in the workflow- Mapping of workflow parameters- Assigning returned values to the case

Opening the Workflow Open IBM FileNet WorkplaceXT and start the Process Designer

Figure

Open the “Customer Management AirLine” solution (File Design Object Store by:


Case Solution with IBM WebSphere

the rules invocation step needs to be inserted in our “Complaints” case task

This webservice invocation is implemented using an “Invocation” system workflow step in the workflow implementation. To insert this step, the IBM FileNet

Process Designer is used to edit the IBM FileNet Process Engine (PE) task

The following high level steps are required to integrate the rules execution

the “Investigate Complaint” PE workflow definition for editing

Enabling Direct WDSL link Determining ILOG execution server webservice endpoint Registering Partner Link Adding the webservice invocation in the workflow

parameters to webservice interface parametersAssigning returned values to the case

orkflow Definition For Editing pen IBM FileNet WorkplaceXT and start the Process Designer

Figure 53 – Open IBM FileNet Process Designer

Open the “Customer Management AirLine” solution (File � Solution � Edit


Case Solution with IBM WebSphere

our “Complaints” case task workflow

This webservice invocation is implemented using an “Invocation” system workflow step in the To insert this step, the IBM FileNet

sk workflow definition.

PE workflow definition for editing in Workplace XT –

parameters

Edit …) from the ICM


Figure 54 – Edit a process solution definition in IBM FileNet Process Designer

Figure 55 – Select and Open the Customer Management AirLine Solution Definition

Enabling Direct Access to WSDL You need to allow entering a WSDL link using a directory registration when creating the Partner Link.

To change this configuration, open the “Configuration Console”:


Edit a process solution definition in IBM FileNet Process Designer

Select and Open the Customer Management AirLine Solution Definition

ccess to WSDL Links entering a WSDL link in the Process Designer without browsing for the WSDL

when creating the Partner Link.

To change this configuration, open the “Configuration Console”:


Edit a process solution definition in IBM FileNet Process Designer

Select and Open the Customer Management AirLine Solution Definition

without browsing for the WSDL


Figure

Open the “Properties” page for the IBM FileNet PE region configuration:

Figure

Switch to the “Web Services” tab and tick the checkbox “Enable Process Designer to enWSDL links without browsing for Web Services” and select “OK”if exist but not the Configuration tabworkflow


Figure 56 – Open the Configuration Console

Open the “Properties” page for the IBM FileNet PE region configuration:

Figure 57 – Open PE region Properties

Switch to the “Web Services” tab and tick the checkbox “Enable Process Designer to enWSDL links without browsing for Web Services” and select “OK”. Note: Close and workflow tabs

Configuration tab ! and after open e.g . the CSMAL_SettleComplaint


Switch to the “Web Services” tab and tick the checkbox “Enable Process Designer to enter Close and workflow tabs

open e.g . the CSMAL_SettleComplaint


Figure 58 – Tick “Enable Process Designer to enter WSDL links without browsing for Web Services”

Note: After setting the parameter, make sure to close any open workflow tabs and reopen the workflow for editing to apply the configuration change.

Determining the WSDLOpen the rules execution server web console

Figure


Tick “Enable Process Designer to enter WSDL links without browsing for Web Services”

After setting the parameter, make sure to close any open workflow tabs and reopen the workflow for editing to apply the configuration change.

WSDL Link For the BRMS Rule ApplicationOpen the rules execution server web console

Figure 59 – Sign into Rule Execution Server


Tick “Enable Process Designer to enter WSDL links without browsing for Web Services”

After setting the parameter, make sure to close any open workflow tabs and reopen the

lication


Switch to the “Explorer” tab and navigate to the “CSMALRules” rule set in the Rule Apps tree.

Figure

Select the “Get HTDS WSDL for the latest ruleset version”, copy the WSDL link and paste it into a text editor

Figure

Remove the version “1.0” in the URL if you want to make sure to always access the latest Rule App version:

Figure 62 - Our Rules Application WSDL link without Version



Figure 60 – Rule Execution Server Ruleset View

Select the “Get HTDS WSDL for the latest ruleset version”, copy the WSDL link and paste it into

Figure 61 – Our Rules Application WSDL link

emove the version “1.0” in the URL if you want to make sure to always access the latest Rule

Our Rules Application WSDL link without Version



Select the “Get HTDS WSDL for the latest ruleset version”, copy the WSDL link and paste it into

emove the version “1.0” in the URL if you want to make sure to always access the latest Rule

Our Rules Application WSDL link without Version


Verify the URL, using a browser session. Make sure the WSDL shown below

Adding a Web service Switch to the “CSMAL_InvestigateComplaint” workflow definition:

Figure 64

Note: Make sure the “Web Services Palette” is enabled:


Verify the URL, using a browser session. Make sure the WSDL specification is displayed as

Figure 63 – Verify the WSDL URL

service Invocation Step Switch to the “CSMAL_InvestigateComplaint” workflow definition:

– Open CSMAL_InvestigateComplaint workflow

Make sure the “Web Services Palette” is enabled:


specification is displayed as

CSMAL_InvestigateComplaint workflow


Figure

Delete all steps accept the Launch and Investigate Complaint Step if exist. system step into the workflow map between the Launch Step and the “Investigate Complaint” and connect the Launch step to the Invoke step and the Invoke step to the Investigate Complaint step.

Select the “Invoke” Step and change the Step Name to “In

Figure

Registering Partner LinkSwitch to „Workflow Properties“


Figure 65 – If not enable “Web Services Palette”

Delete all steps accept the Launch and Investigate Complaint Step if exist. system step into the workflow map between the Launch Step and the “Investigate Complaint”

tep to the Invoke step and the Invoke step to the Investigate

Select the “Invoke” Step and change the Step Name to “Invoke ILOG Rule”:

Figure 66 – Enter Step Name of the Invoke step

Registering Partner Link to „Workflow Properties“ � “Web Services” � “Partner Links” .


Delete all steps accept the Launch and Investigate Complaint Step if exist. Drag the “Invoke” system step into the workflow map between the Launch Step and the “Investigate Complaint”

tep to the Invoke step and the Invoke step to the Investigate

Rule”:


Figure 67 – Create a new Partner Link in the Web

Create a new partner link. Specify the name “ILOGInvestigationRule” and tick the checkbox “Invoke”. Enter the WSDL link you prepared in the previous stepsfield “WDSL URL”. Make sure “DecisionServiceCSMALRules” is selected as Port Type

Figure

Select “Invoke ILOG Rule” step you created in the steps before and select the operation “executeDecisionService”


Create a new Partner Link in the Web Services pane

Create a new partner link. Specify the name “ILOGInvestigationRule” and tick the checkbox “Invoke”. Enter the WSDL link you prepared in the previous steps, ses Figure 62 above,

Make sure “DecisionServiceCSMALRules” is selected as Port Type

Figure 68 – Enter Web Service WSDL URL

“Invoke ILOG Rule” step � General � select the Partner Link “ILOGInvestigationRule” you created in the steps before and select the operation “executeDecisionService”


Services pane

Create a new partner link. Specify the name “ILOGInvestigationRule” and tick the checkbox Figure 62 above, into the

Make sure “DecisionServiceCSMALRules” is selected as Port Type !

Partner Link “ILOGInvestigationRule” you created in the steps before and select the operation “executeDecisionService”


Figure 69

Mapping of Workflow Parameters Not all in and out parameters for the rules web services interface attributes that have been defined in Case Builder

Nevertheless all webservice interface parameters the invoke step settings.

Therefore additional local workflow attributes need to be defined for that do not correspond to case fields:

• Outgoing Parameters: o DecisionID

• Incoming Parameters: o Ilog.rules.outputStringo Ilog.rules.firedRo DecisionID


69 – Select Operation executeDecisionService

orkflow Parameters to the Web service Interface

in and out parameters for the rules web services interface need notthat have been defined in Case Builder.

Nevertheless all webservice interface parameters must be mapped to some

Therefore additional local workflow attributes need to be defined for the following parameters that do not correspond to case fields:

Ilog.rules.outputString Ilog.rules.firedRulesCount


Select Operation executeDecisionService

nterface

need not be mapped to data

some workflow fields in

the following parameters


To create workflow properties used for the mappings of these fields, navigate to “Workflow Properties” and select the tab “Data Fields”.

Add the following attributes

• TempDecisionID (String)

• TempFired (Integer)

• TempOutput (String)

The default value for the attribute “TempDecisionID” can be any fixed string value.

Figure 70

Switch back to “Invoke ILOG Rule” step configuration and select the matching inparameters:

Figure 71 – Invoke ILOG Rule Step In and Out Parameters Mapping

Updating Case AttributesAt runtime the workflow attributes

• CSMAL_Score and

• CSMAL_Entitlement


To create workflow properties used for the mappings of these fields, navigate to “Workflow tab “Data Fields”.

TempDecisionID (String)

efault value for the attribute “TempDecisionID” can be any fixed string value.

70 – Define new Workflow Properties Data Fields

Switch back to “Invoke ILOG Rule” step configuration and select the matching in

Invoke ILOG Rule Step In and Out Parameters Mapping

Case Attributes workflow attributes


To create workflow properties used for the mappings of these fields, navigate to “Workflow

efault value for the attribute “TempDecisionID” can be any fixed string value.

Define new Workflow Properties Data Fields

Switch back to “Invoke ILOG Rule” step configuration and select the matching in- and outgoing

Invoke ILOG Rule Step In and Out Parameters Mapping


will be populated in the “Invoke ILOG Rule” stepcase object fields using an “assign” workflow step

Insert an “Assign” workflow system step after the “Invoke ILOG Rule” step.

Figure 72

Select the “Assign” step and configure the assignment of the workflow attribute values Entitlement) to the case fields. The case object fields are accessed using the

• F_CaseFolder.<case attribute name>

Figure 73 – Assigning the Investigate Compl

Save the workflow, so the corresponding Investigate Complaint updated in the Design Object storeManagement AirLine solution accessed by the Case Builder when we Edit our solution or deploy our solution from the Design Object Store to the Target Object Store.


in the “Invoke ILOG Rule” step, so we need to copy them to case object fields using an “assign” workflow step .


72 – Add and Insert and “Assign” workflow step

lect the “Assign” step and configure the assignment of the workflow attribute values to the case fields. The case object fields are accessed using the

F_CaseFolder.<case attribute name>

ssigning the Investigate Complaint Score and Entitlement workflow attributes to the corresponding Case Fields

Save the workflow, so the corresponding Investigate Complaint Workflow definition updated in the Design Object store, which is part of the solution definition files for the Customer Management AirLine solution accessed by the Case Builder when we Edit our solution or deploy our solution from the Design Object Store to the Target Object Store.


, so we need to copy them to the appropriate


Add and Insert and “Assign” workflow step

lect the “Assign” step and configure the assignment of the workflow attribute values (Score, to the case fields. The case object fields are accessed using the notation

Score and Entitlement workflow attributes to the

Workflow definition XPDL file is rt of the solution definition files for the Customer

Management AirLine solution accessed by the Case Builder when we Edit our solution or deploy our solution from the Design Object Store to the Target Object Store.


Deploying the Case Manager

Login to the case Builder. In the Case Builder main page, select the “CustomerManagementAirLine”

Figure 74 – Deploy the Customer Management AirLine solution

Check the status messages and make sure the (green arrow in the upper right corner)

Figure 75 –


Case Manager Solution

In the Case Builder main page, select the “CustomerManagementAirLine” solution and click “Deploy”

Deploy the Customer Management AirLine solution

Check the status messages and make sure the solution is correctly deployed(green arrow in the upper right corner):

– Successful Deployment shown by green arrow


Deploy the Customer Management AirLine solution

solution is correctly deployed without errors

Successful Deployment shown by green arrow


Testing the Solution

Open the Case Client and navigate to the “Case” tab in the “CustomerManagementAirLine” solution in Business Space.

Click “Manage Roles” and add your

Figure

Select “Add Case” � “Complaint” and enter the case data.

Figure 77 – Add a new Customer Management Airline complaint case

Make sure to enter the value “New” for


the Solution

Open the Case Client and navigate to the “Case” tab in the “CustomerManagementAirLine”

Click “Manage Roles” and add your login user to the “Agent” role. Refresh the Case Client view.

Figure 76 – Add user(s) to the Agent role

“Complaint” and enter the case data.

Add a new Customer Management Airline complaint case

value “New” for the Complaint Status


Open the Case Client and navigate to the “Case” tab in the “CustomerManagementAirLine”

user to the “Agent” role. Refresh the Case Client view.

Add a new Customer Management Airline complaint case


The following values are used as Input parameter.

• Customer Status

• Total Miles

• Flight Delay

• Complaint Type

• Flight Valid

Make sure to enter valid data for these fields before adding the case.

Figure

Click “Add” to create the case,

Navigate to the “Work” tab and select the work item for the case listed in the “Agent” inbasket.


used in our solution from the rules engine in the Invoke ILOG Rule step

Make sure to enter valid data for these fields before adding the case.

Figure 78 – Add Complaint Case input Case Data

Click “Add” to create the case, add some more complaint cases.



in our solution from the rules engine in the Invoke ILOG Rule step



Figure 79 – Cu

Open a Complaint by e.g. double click a line “Verified” and complete the stepautomatically and the Invoke ILOG rule step will be executed and the Score and Legal Entitlement fields are populated, based on the defined rules, by the ILOG Complete the step.

Note: Complete the step will make sure live case management implementation, the status would be automatically chaselecting “Verified”.

Figure

Switch back to the “Agent” inbasket again and Complaint” task. Open the step and check the value for the attribute “Score” and “Legal Entitlement”. Make sure, the values are set correctly based on the rules you defined rules engine and the values you entered


Customer AirLine complaint in the Agent Inbasket

Complaint by e.g. double click a line and make sure to set the “Complaint Status” to complete the step. Now the Investigate Complaint task – workflow is called

e ILOG rule step will be executed and the Score and Legal populated, based on the defined rules, by the ILOG

will make sure that the “Investigate Complaint” task is started. live case management implementation, the status would be automatically cha

Figure 80 – Set the “Complaint Status”

to the “Agent” inbasket again and and you will see the workitem for the “Investigate Complaint” task. Open the step and check the value for the attribute “Score” and “Legal

the values are set correctly based on the rules you defined and the values you entered as Input data when creating the case.


stomer AirLine complaint in the Agent Inbasket

and make sure to set the “Complaint Status” to workflow is called

e ILOG rule step will be executed and the Score and Legal rules engine .

the “Investigate Complaint” task is started. In a real live case management implementation, the status would be automatically changed when

em for the “Investigate Complaint” task. Open the step and check the value for the attribute “Score” and “Legal

the values are set correctly based on the rules you defined in the ILOG when creating the case.


Figure 81 – Complaint Case Data Score after the rules engine is called


Complaint Case Data Score after the rules engine is called


Complaint Case Data Score after the rules engine is called


Summary

We have reached all our defined

• Exchange experience and knowledge between IBM Case “One BPM” initiative and IBM WebSphere ILOG experts

• Demonstrate how to build an ICM solution exploiting ILOG JRules from scratch in a predefined time frame

• Implementation of a pilot workshop scenario for a handsto reuse in future customer or business partner events

• Get deep insights for the products involved, exchange knowledge and experience

• Create and publish a document describing the tasks to setup an ICM solution using ILOG JRules step by step, to ereproduce our scenario implementation

Whereby it’s also clear that forManager and IBM WebSphere ILOG JRules is a basesuccess for your customer and therefore for IBM.

So we hope that this mini-residency description document can be a trigger and support any IBM team which implements

We had a lot of positive experience and productive knowledge exchange during our miniresidency and we want to say

Walter Mayer, Witold Szczeponik


defined targets of the mini-residency:

Exchange experience and knowledge between IBM Case Manager, IBM WebSphere “One BPM” initiative and IBM WebSphere ILOG experts

Demonstrate how to build an ICM solution exploiting ILOG JRules from scratch in a

Implementation of a pilot workshop scenario for a hands-on ICM/ILOG JRules into reuse in future customer or business partner events

Get deep insights for the products involved, exchange knowledge and experience

Create and publish a document describing the tasks to setup an ICM solution using ILOG JRules step by step, to enable consultants working with ICM and/or ILOG JRules to

ce our scenario implementation

for real life customer projects a good knowledge of IBM Case WebSphere ILOG JRules is a base line to make any integ

customer and therefore for IBM.

residency description document can be a trigger and team which implements a customer ICM-ILOG integration

ot of positive experience and productive knowledge exchange during our minisay thanks to all participants.

Witold Szczeponik Germany, 7.2.2012


Manager, IBM WebSphere

Demonstrate how to build an ICM solution exploiting ILOG JRules from scratch in a

on ICM/ILOG JRules integration

Get deep insights for the products involved, exchange knowledge and experience

Create and publish a document describing the tasks to setup an ICM solution using ILOG nable consultants working with ICM and/or ILOG JRules to

real life customer projects a good knowledge of IBM Case to make any integration solution a

residency description document can be a trigger and a start point to integration solution.

ot of positive experience and productive knowledge exchange during our mini-

Documents

Building an IBM Case Manager – IBM WebSphere ILOG …...Case designers can create and customize solution layout Manager widgets or custom built At runtime, case management users