Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an...

27
Service Case Manager for Financial Services COMBINING MULTIPLE APPLICATIONS GUIDE 7.1.3

Transcript of Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an...

Page 1: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

Service Case Manager for Financial Services

COMBINING MULTIPLE APPLICATIONS GUIDE

7.1.3

Page 2: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

Copyright 2015 Pegasystems Inc., Cambridge, MA

All rights reserved.

This document describes products and services of Pegasystems Inc. It may contain trade secrets and proprietary information. The document and product are protected by copyright and distributed under licenses restricting their use, copying, distribution, or transmittal in any form without prior written authorization of Pegasystems Inc.

This document is current as of the date of publication only. Changes in the document may be made from time to time at the discretion of Pegasystems. This document remains the property of Pegasystems and must be returned to it upon request. This document does not imply any commitment to offer or deliver the products or services provided.

This document may include references to Pegasystems product features that have not been licensed by your company. If you have questions about whether a particular capability is included in your installation, please consult your Pegasystems service consultant.

PegaRULES, Process Commander, SmartBPM® and the Pegasystems logo are trademarks or registered trademarks of Pegasystems Inc. All other product names, logos and symbols may be registered trademarks of their respective owners.

Although Pegasystems Inc. strives for accuracy in its publications, any publication may contain inaccuracies or typographical errors. This document or Help System could contain technical inaccuracies or typographical errors. Changes are periodically added to the information herein. Pegasystems Inc. may make improvements and/or changes in the information described herein at any time.

This document is the property of:

Pegasystems Inc. 1 Rogers Street Cambridge, MA 02142-1209 Phone: (617) 374-9600 Fax: (617) 374-9620 www.pega.com

Document: Combining Multiple Applications

Software Version: 7.1.3

Updated: May 2015

Page 3: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

CONTENTS

About this Document ......................................................................................... i Situation and approach ................................................................................... i Document Scope ............................................................................................ i Assumptions ................................................................................................... i Prerequisites .................................................................................................. ii

Integrating Multiple Pega 7 Application Assets .............................................. 1 Creating an application .................................................................................. 1

Approach 1: Using ruleset referencing ..................................................... 1 Approach 2: Using built-on applications ................................................... 2

Including case and data assets ...................................................................... 2 Case configuration ......................................................................................... 4 Case creation ................................................................................................ 4

Creating a case from the Create menu .................................................... 4 Creating a case using an event ................................................................ 4 Data propagation ..................................................................................... 5

Combining Lists from Separate Work Tables (Reporting) .............................. 6 Assignments .................................................................................................. 6 Work objects .................................................................................................. 6

Approach 1: Creating a database view ..................................................... 6 Approach 2: Creating combined data pages ............................................ 9

Launching a Service Case from an Integrated Application .......................... 13

Displaying Case Stages .................................................................................. 17

Displaying Work Baskets ................................................................................ 20

Page 4: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

This document explains the preferred approach to combining multiple components, frameworks, or other Pega 7 assets into a single delivered application.

Situation and approach This document describes the scenario where multiple frameworks and other Pega 7 assets are combined into a single application. For example, the business is looking to manage the resulting application as a single asset, typically with one release cycle and centralized development team(s).

For this situation, the recommended approach is to combine the necessary assets into a single Pega 7 application running on a single Pega 7 instance. This can be accomplished by combining the necessary rulesets into a consolidated application stack. After which, each of the work objects and supporting data assets can be configured to work together.

Note: If you are delivering multiple applications and need the flexibility to support different release cycles for those applications, you should instead evaluate Federated Case Management for your needs.

Document Scope This document describes the technical steps required to combine multiple Pega 7 assets into a single working application. It is divided into two main sections and covers the following topics:

1. General steps required to integrate multiple Pega 7 application assets

a. Application setup b. Case configuration c. Reporting

2. Additional steps required to support CPM implementations

a. Including work objects in the interaction driver b. Dialog setup

Assumptions You should be familiar with:

Business use work objects that are required to decide which approach is appropriate

Pega 7 and Case Management

CPM – only if using CPM or CPM based applications

About this Document

Combining Multiple Applications Guide i

Page 5: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

Prerequisites Pega 7 (Pega 7.1 or later)

Customer Process Manager v 7.1.3 if applicable

Combining Multiple Applications Guide ii

Page 6: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

Creating an application Approach 1: Using ruleset referencing Make sure all of the required rulesets are in your application stack.

For example, let’s say you are combining the Service Case Manager (SCMFS) and Onboarding for Financial Services (OBFS) applications from Pega.

Create a new application, for example PegaSCMFSOnboarding, built on the FSIF application with the rulesets from both the applications in the ruleset stack. A new ruleset, for example PegaSCMFSOnboarding is created to save rules for this integration. Update your application rule to include the rulesets from both of these applications as follows:

1 Integrating Multiple Pega 7 Application Assets

Combining Multiple Applications Guide 1

Page 7: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

Note: Your application will not look exactly like the above figure, as it will depend on the applications you are combining and any additional rulesets you have defined for your own application configuration.

Approach 2: Using built-on applications Another way of setting up the application is to create a new application, for example, PegaSCMFSOnboarding, and build it on top of an existing application to use the rulesets from the existing application.

For instance, you can build PegaSCMFSOnboarding on the PegaOBFS application and you can include SCMFS application rulesets in the application stack. This ensures access to both applications and avoids the need to change the ruleset versions each time it is changed in OBFS applications.

The screenshot of this method of ruleset inclusion is shown as follows:

Including case and data assets Now that you have added the rulesets to your application, you have access to the entire rule configuration included, but the work objects and data types are not yet visible throughout your design time experience. You can add the work objects and data types to the appropriate tab on the application form or landing page and you will see them appear in your Case and Data Explorers.

Case Explorer

Combining Multiple Applications Guide 2

Page 8: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

Data Explorer

Combining Multiple Applications Guide 3

Page 9: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

Case configuration Once the steps above have been completed, you can configure case behaviors just as you would in any other Pega 7 application development effort. Use the Case Designer to define the case relationships across all of the work objects in your new application, and to define the stage lifecycle and processes for each of these stages. Beyond case designer, all other normal configuration will be available now as well.

The following figure shows the Case Designer with the SCM and OBFS work objects combined:

You can also invoke any of the standard case APIs to work across applications. As an example, we can use the CreateNewWork API to create an OBFS case from within a Service Case Manager flow. We can also override NewDefaults to pass in the required data to run the flow.

Case creation Creating a case from the Create menu If the Name checkbox from the above screenshot is enabled for a case, any starting process that exists in that case can be seen in the Create menu. The user can create the respective case by clicking on the starting process from the Create menu.

Creating a case using an event If a case needs to be created using an event from the end user interface, you can configure a cell in the layout to have Action sets to call the Create Work API, as shown below.

Combining Multiple Applications Guide 4

Page 10: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

In the above screenshot, the Create Work API takes two parameters: class name and flow name.

Data propagation If additional data needs to be passed into the OBFS case from the SCMFS case at runtime, save it as NewDefaults activity in the OBFS case but save it in the PegaSCMFSOnboarding application ruleset.

The NewDefaults activity is an extension rule that can be saved into any ruleset.

Combining Multiple Applications Guide 5

Page 11: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

Combining application assets, using this method, typically results in the work data being stored in multiple database tables and all assignment data being stored in a single shared database table. This section describes how you report on the data stored in those tables.

Assignments Since the assignments belonging to these multiple application assets reside in a shared worklist or workbasket table (pc_assign_worklist or pc_assign_workbasket), the reports and the sections can be used to display various assignments throughout your application.

Examples include the report definition pyUserWorklist, which is used to retrieve the assignments from the pc_assign_worklist table. And the similarly named Section pyUserWorklist, which displays a user’s worklist in the out-of-the-box end user portal.

Work objects The work objects for each application will reside in the application work table. Work objects from the SCMFS Application reside in the SCM_Work table and those from the OBFS application reside in the OBFS_Work table.

Approach 1: Creating a database view Perform the following steps to display consolidated work objects from more than one application in the portal.

1. Create a view based on the work tables to hold the result set of all the work objects.

2. A minimum of 3 columns are required. pyID, pyLabel and pzInsKey.

A sample view SQL is shown below.

CREATE OR REPLACE VIEW "PEGA"."WORK_VIEW" ("PYLABEL","PYID", "PZINSKEY", "PXCREATEOPERATOR","PXCREATEDATETIME","PXURGENCYWORK","PYSLADEADLINE","PYSTATUSWORK") AS

SELECT PYLABEL AS PYLABEL, pyID AS pyID, pzInsKey AS pzinsKey, PXCREATEOPERATOR AS PXCREATEOPERATOR, PXCREATEDATETIME AS PXCREATEDATETIME, PXURGENCYWORK AS PXURGENCYWORK, PYSLADEADLINE AS PYSLADEADLINE, PYSTATUSWORK AS PYSTATUSWORK FROM scm_work UNION

SELECT PYLABEL AS PYLABEL, pyID AS pyID, pzInsKey AS pzinsKey, PXCREATEOPERATOR AS PXCREATEOPERATOR, PXCREATEDATETIME AS PXCREATEDATETIME, PXURGENCYWORK AS PXURGENCYWORK, PYSLADEADLINE AS PYSLADEADLINE, PYSTATUSWORK AS PYSTATUSWORK FROM OBFS_work

3. Create a concrete work class or a data class and connect this class to the view by creating a new instance of Data-Admin-DB-Table.

2 Combining Lists from Separate Work Tables (Reporting)

Combining Multiple Applications Guide 6

Page 12: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

4. Create a report definition with the Applies-To class from step 2.

Combining Multiple Applications Guide 7

Page 13: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

5. Call the above report definition in a section in a Repeat Grid layout.

6. Update the pyID property cell panel to use the Link HTML control. In the Actions tab, define a

Click action and Open Work By Handle event to launch the case when the user clicks the PYID row.

Combining Multiple Applications Guide 8

Page 14: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

7. The section is displayed, as shown below

8. Clicking any case ID from the PYID column will display the case, as shown below.

Approach 2: Creating combined data pages Create a data page D_FetchSCMFSMyWork objects to fetch SCMFS work objects using a FetchSCMFSWorkObjects report definition which fetches all the columns required for displaying in the My Cases tab.

Combining Multiple Applications Guide 9

Page 15: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

Create a D_FetchOBFSMyWork data page to fetch SCMFS work objects using a FetchOBFSWorkObjects report definition which fetches all the columns required for displaying in My Cases tab.

Combining Multiple Applications Guide 10

Page 16: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

Create a ConsolidateWork data transform to append and merge the results from the D_FetchSCMFSMyWork and D_FetchOBFSMyWork data pages to the D_FetchUnifiedMyWork data page.

Combining Multiple Applications Guide 11

Page 17: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

Configure the D_FetchUnifiedMyWork data page onto the section that displays Work objects. Do steps 5 -7 as listed in Approach 1 to make the work objects clickable links to open the work objects in a Review harness.

Combining Multiple Applications Guide 12

Page 18: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

To launch a service case from the integrated application, let’s look at the PegaSCMFSOnboarding application.

To launch an OBFS case from the SCMFS application, you must make changes to the following rules.

In the GetClassName map value, enter the class name from the OBFS class.

3 Launching a Service Case from an Integrated Application

Combining Multiple Applications Guide 13

Page 19: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

In the GetFlowName map value, enter the starting flow for the service case, as shown.

These configurations enable us to launch an OBFS flow as a service case from a category like Needs Assessment, as shown below:

Combining Multiple Applications Guide 14

Page 20: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

Similarly, you can launch OBFS flows for adding a prospect from the Other Actions button in the Customer Search screen as follows:

In the button, we configure a menu with a Navigation rule

The Navigation rule can launch a script when you click on a menu item, similar to launching it from a category, to launch a new flow as shown below:

Combining Multiple Applications Guide 15

Page 21: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

Combining Multiple Applications Guide 16

Page 22: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

You can display case stages for multiple applications on the dashboard. Described below is an example of how you can achieve this with the PegaSCMFSOnboarding application.

Create a report definition to fetch work classes from work pools that are passed as parameters to the report definition. Here we pass the OBFS and SCMFS work pools as parameters.

The GetUnifiedWorkClasses report definition fetches all classes from the work pools of both the applications that are integrated here.

A GetUnifiedWorkClasses activity is created to invoke the report definition.

4 Displaying Case Stages

Combining Multiple Applications Guide 17

Page 23: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

A D_AllWorkInApp data page is created to override the existing one to call the GetUnifiedWorkClasses activity.

The parameters to the activity are work pool names that are passed.

D_AllWorkInApp is configured in the pxDisplayStagesReport section that displays the drop down for case stages for all work objects.

Combining Multiple Applications Guide 18

Page 24: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

Case stages are displayed as follows:

Combining Multiple Applications Guide 19

Page 25: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

On the dashboard, you can display the workbaskets from multiple applications by fetching the workbaskets from multiple work groups.

To do this, do the following steps:

A report definition UnifiedWorkBaskets is created to fetch the work baskets from the work groups that are passed as params. Here we have 3 work groups – SCMFS, KYCAnalysts and Default.

Configure the report definition in the D_FetchUnifiedWorkBaskets data page.

5 Displaying Work Baskets

Combining Multiple Applications Guide 20

Page 26: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

The data page is configured in the section pyWorkGroupBaskets which displays the list of work baskets.

From the section, we pass the parameters for fetching the workbaskets from the specified work groups.

The workbaskets are all listed in the section in the dashboard from the required work groups, as shown.

Combining Multiple Applications Guide 21

Page 27: Service Case Manager for Financial Services - Pega...we can use the CreateNewWork API to create an OBFS case from within aService Case Manager flow. We can also override NewDefaults

TITLE of INTERNAL DOCUMENT – Arial Bold 12 pt

The same D_FetchUnifiedWorkBaskets data page and the params are configured in the pyWorkGroupBasketsShowAll section. You can click the See all link to show the expanded list of all workbaskets.

Combining Multiple Applications Guide 22