IBM Case Manager Solution Assistant using admin client for Case Manager

Transcription

1 IBM Case Manager Solution Assistant using admin client for Case Manager Technical Note by Mr. Sheikh N Iqbal & Ms. Lannie Troung IBM August 2013 Abstract: The administrative tasks required for IBM case manager can be performed using Admin Client for Case Manager (ACCM) tool. The solution assistant features such as Solution copy, Convert solution to template and create solution from template for the solutions in the default design object stores can be performed using the content navigator plug ins tool. The document provides step by step instruction on how to achieve the solution assistant features and also the prerequisite to be met for the solution in the development environment. Sheikh N Iqbal is working as a QA Engineer for IBM case manager, Enterprise content management-industry solutions. His current responsibilities include performance testing, accessibility, functional verification testing of case builder and solution assistant features testing using new tool admin console for case manager. Reach out to him at sheiiqba@in.ibm.com Lannie is working as a QA Engineer for IBM Case Manager in Enterprise Content Management Industry solutions. Her current responsibilities include lead and test ICM Release 5.2 Admin Client and Viewer integration with IBM Content Navigator. She also leads Sustain Releases testing for all former ICM products. This includes leading local and remote teams in functional verification testing of all areas. Solution Assistant feature is a new tool belonging to the Admin Client suite. Reach out to her at latruong@us.ibm.com

2 Table of Contents Introduction 3 Configuring ACCM in IBM Content navigator desktop...3 Domain with list of object stores...4 Prerequisite for solution assistant operation..5 Solutions list.6 2

3 Introduction The administrative tasks required for IBM Case Manager can be performed using admin client for Case Manager (ACCM) a web browser tool. This document provides an overview of the Case manager solution assistant features accomplished using admin client for Case Manager. The ACCM tool helps to perform following tasks: View and update domain object stores : Provides a tree view list of design and target object stores under the same domain. Update the design or target object store with IBM Case Manager fix packs or releases and restore object store deleted folders. Solution list: List of all the solutions available in the design or staging object store under development or production environment. The UI provides basic options to import/export solution and template, deploy solutions. Extended options provide solution assistant features to copy, convert solution to template and create solution from template. Other features include lock and unlock solutions, configure security and audit for the solutions. Solution templates list: List of all the solutions promoted to template and options to import, export and create solution from template. Project Area /Target Environment list: List the Project Areas in the Development environment to manage solution and solution reset and can be individually registered or deleted. Under Production environment, the list shows Target Environments that can be registered or deleted. Widgets packages: Provide option to register customized widgets into ACCM Configuring ACCM in IBM content navigator desktops ACCM can be added to the IBM Content Navigator desktops via the plug-in upload. Desktops give users access to the repository and search for the contents. Multiple desktops can be created to provide different users access to the contents they need. The steps to be followed in setting the ACCM to be used in Case Client desktop 1. Login to IBM Content Navigator 2. Select and edit the default desktop for Case Manager client 3

4 3. Click on Appearance tab and add IBM Case Manager administration client to selected feature 4. Save and close the default desktop for Case Manager client 5. Login to Case Manager client desktop to view the ACCM wizard Domain with list of Object stores The Root object for the ACCM logged in user is Content Engine domain having design object stores and target object stores. The UI layout for the ACCM will be as shown in figure below: Design object store provides a tree view list of solutions, solution templates, project areas and widget packages. Features on the design object stores are provided via Actions button or context menu actions on each tree node. 4

5 Target object store provides list of all the solutions deployed and case history store. Deployed solution tree nodes are view only. Case History Store can be enabled or delete. Prerequisite for solution assistant operation The solutions created in development environment IBM Case Manager builder must be committed before performing solution assistant operations like copying a solution or promoting solution to template. The Solutions definition file (SDF), XPDL files, Process engine configuration file, Pages, Rules and Views must be checked-in in the design object stores to ensure copy/promote to template be performed successfully. Copying a solution without commit: The Case Manager solution having artifacts locked by any user is blocked from copy, deploy or export solution operation. An error message The selected solution could not be copied because the solution definition file for the original solution is missing content is shown after entering copy solution details like name, prefix, description and clicked ok for an uncommitted solution. Hence, make corrections in the original solution, login to case builder and validate, commit and deploy the solution and then perform copy solution. Deploy solution can be done in Case Builder or ACCM after the changes had been committed. Similar error message is shown when perform copy of solution in case manger builder 5

6 Promote a solution to template without commit: The prerequisite that apply to copy solution is also valid for a solution promoted to template that solution must be committed before trying to convert solution to template in admin client from Case Manager. All the artifacts must be checked-in and solution must not contain any uncommitted changes for successfully performing convert solution to template. An error message The solution cannot be copied because the solution definition file for the original solution is missing content is shown after review the solution properties and click Finish to perform convert to template. Hence, make corrections in the original solution, login to case builder and validate, commit and deploy the solution in case builder or ACCM and then perform convert to template solution operation. Solutions list The solutions list provides the list of all the Case Manager solutions created in the design object store and options to perform tasks such as copy, deploy, export, import, convert to solution template, configure security and audit and lock and unlock solutions. Unlock solution operation in ACCM cancels the changes. If you want to commit the changes, use case builder instead. Copy of a solution: The solution assistant makes a copy of solution by asking for a new name, prefix, description and options to include properties, document types and folders from original solution. The copied solution is saved with new name in new folder under the main solutions location, /IBM Case Manager/Solutions. The Solutions definition file (SDF), XPDL files, Process engine configuration file, Pages and Views are copied into the new subfolder. 6

7 A copied solution can reside only in the same object store as the original solution. If you want to move a solution to a different object store or domain, export the solution package then import the solution package into the target object store or domain. To copy a solution: 1. Select the solution and click on copy 2. View the original solution details and enter new name, prefix and description for the copied solution. The name and prefix must adhere to the same rules as defined for solution creation in the IBM Case Manager builder. 3. Additional properties, document types and folders can also optionally be copied. The options checkbox when selected, the copied solution includes properties and document types having same prefix as original solution. 4. Click on Next button to view the new solution definition 7

8 5. Click Finish to make a copy. The message solutions successfully created with details such as solution name, start time, end time and elapsed time is shown. The copy solution status icon is changed to green to indicate copy is done successfully. 6. Refresh the solutions list under the design object stores to see if copied solution is available. 8

9 Promote solution to template: The solution assistant promotes a solution to a template that can be used to create any number of additional solutions. The solution template is saved with same name as original solution in /IBM Case Manager/Solution Templates folder in the design object store. The Pages and Views file are stored in a separate subfolder. To promote solution to template: 1. Select the solution and click on convert to solution template 2. Review the solution properties to see the original solution details such as name, prefix and description. Additional unique identifiers can also optionally be included in the solution template. 3. Click on Finish button to complete convert solution to template. The message template successfully created and details such as solution template name, start time, end time and elapsed time is shown. The convert solution to template icon is changed to green to indicate template successfully created. The solution template will make the solution into a template by moving the solution into the solution templates folder; the solution will no longer be available in the solutions folder. The promotion of solution to template will be stopped if the new template has same name as a template that already exists in the solution templates folder. Also, Verify the solution template in the case builder by creating a solution from it and then deploying and testing that created solution. 9

10 Creating a solution from template: To create a new solution from the solution templates the steps are the same when making a copy of a solution, the difference being the source solution is in the solution templates folder rather than solution folder. To create solution from template: 1. Select the solution template and click create solution 2. View the solution template details and enter new name, prefix, description and project area name to assign this solution. Additionally unique identifiers, document and folders can also optionally when checked, the new solution has unique identifiers and document types and folders copied from solution template. 3. Review the solution details to see the new solution details such as solution name, prefix, and checkbox options if selected or not. 10

11 4. Click Finish button to complete solution creation from template. The message solution successfully created and details such as solution name, start time, end time and elapsed time is shown. The convert solution to template icon is changed to green to indicate template successfully created. 4. Refresh the solution list to view the solution created in the solution folder of design object stores. In the development environment case builder of Case Manger, edit and view the solution created to see if unique identifiers, artifacts and documents and folders are included from the template. Validate, save and test the solution to see if solution is working as designed. 11