Case Management Accelerator - Install Guide
By:
Last updated:
4:09am Nov 07, 2017

This post provides a quick start guide to installing the Case Management Accelerator 2.0.2 on an installation of ActiveMatrix BPM 4.2 with AMX HF17 using Spotfire 7.10.

Pre-requisites

Case Management Accelerator 2.0.2 requires the following pre-requisites:

  1. ActiveMatrix BPM 4.2 with ActiveMatrix HF 17 should be fully installed and configured (refer to docs.tibco.com for installation instructions and edelivery.tibco.com for software)

    1. Hotfixes available from support.tibco.com
  2. Tibco Business Studio 4.2.0 BPM Edition should be installed
  3. ActiveMatrix BPM should be configured with a CMIS connection if you wish to use the document management components
  4. Analytics template is configured to point to a sample vizualization on Tibco Spotfire Cloud using embedded data
  5. If you wish to use the spotfire capabilities you will need to install spotfire server:
    1. Tibco Spotfire 7.10 Server should be installed and the Web Player should be configured:

      1. To simplify the example application - it is configured using anonymous access to spotfire
      2. You should configure Spotfire to allow anonymous/guest access as per https://community.tibco.com/wiki/configuring-anonymous-access-analysis-files-spotfire-75
      3. Spotfire Javascript API must be enabled
  6. Requires use of either Firefox, Chrome, Safari, Microsoft Edge as a browser - chrome recommended

Installation and Configuration

Case Manager App

  1. Unzip the starter-kit package

    1. Case Management Accelerator 2.0.2.zip
  2. Upload the CaseManager.app.zip using the appdev console
    1. http://localhost:8080/apps
    2. Located in /Case Management Accelerator 2.0.2/AppDev/CaseManager.app.zip
  3. Open Tibco Business Studio BPM Edition and create a new workspace
    1. Import the Service Request example to your workspace (File/Import Existing Business Studio Projects)
    2. Located in /Case Management Accelerator 2.0.2/ BStudio_ServiceRequest/ServiceRequest.zip
    3. Connect to your BPM server using the Deployment pane and deploy (drag/drop) the following BPM projects in order:
      1. CaseManager_Roles_ORG
      2. ServiceRequest_Data
      3. ServiceRequest_CaseView

You should now be able to access the CaseManager Application using http://localhost:8080/apps/CaseManager/index.html (assumes AMX:BPM on default port 8080)

Analytics Configuration

If you wish to use analytics you also need to import the analytics visualizations to spotfire.

Note: before following these steps this you must create one case in the Case Manager Application and click one action. For example: Create a new customer (+ icon on home page) and create a new complaint from the case screen.

  1. Copy and extract the file CaseManager_GenericLibrary_SPOT.zip from the installation package. Copy the file CaseManager_GenericLibrary_SPOT.SQLSERVER.part0.zip to your Spotfire Server Library directory (such as C:\tibco\tss\7.10.0\tomcat\application-data\library)
  2. From Spotfire client, import the library, 
    1. Click on "Tools->Library Administration" menu
    2. Click on "import" then "Browse" and select the file above and click "OK" and close the Library Administration popup. For destination folder use the root (Library). Spotfire will then import the vizualization and data connection.
    3. Click close once the import is complete to exit Library Administration
  3. Configure your Data source
    1. Click on "Tools->Information Designer". You should now see a folder called "CaseManager" under the Elements tab.
    2. Click on "Data Sources" tab. You should see several data sources. Select the right data source for your AMX:BPM database and select "Edit"
  4. Configure to match your database configuration (Connection URL, user and password). Then click save.
  5. Within the Data Sources tab, select your data source and Drill down into the tables to check access to the bpm database, for example try to locate the ec_case_status table.
  6. You now need to re-configure information links for your chosen database
    1. Drill down into your data source and locate bpm/amxbpm/ folder
    2. Select the following tables:
      1. ec_attribute, ec_event_attr, ec_event, ec_case_status
      2. Right click and select Create Default Information model
      3. Click save, drill into /CaseManager and select INFORMATION LINKS. Then click you selected DB folder (SQL/Postgres/Oracle) - dont drill in, just select the folder.
      4. On the next screen select the option to "Replace existing items"
      5. Click OK
    3. You now need to add a filter to the ec_event information link
      1. Locate the ec_event information link on the Elements tab: eg) /CaseManager/INFORMATION LINKS/<DB>/ec_event
      2. Right click and choose edit
      3. Click filter
      4. Click add - choose column message_id and click OK
      5. Select filter Type "Values" and add paste the following values under the values column: CMF_CASE_ACTION_COMPLETED;CMF_CASE_ACTION_STARTED;CMF_CASE_TASK_COMPLETE;CMF_CASE_TASK_OPEN;BDS_GLOBAL_DATA_CASE_STATE_CHANGE
      6. Click Save
      7. Exit the Information Designer tool
    4. Now open the sample vizualization in spotfire from the Library:. Menu: File/Open from Library and select /CaseManager/TEMPLATES/CaseManager_Analytics_V1.0.3 (embedded replace your data sources)
    5. Replace the data sources with your information links:
      1. Perform these steps for each data table (ec_attribute, ec_event_attr, ec_event, ec_case_status)

        1. Click File Menu -> replace data table
        2. Select the data table and choose your newly created information links
        3. Click OK, then Save
        4. IF you use Oracle. You also need to add a transformation for each table:
          1. add a transformation of type "change column names", then select all fields on the left column
          2. click on "Add"
          3. select "Lower" function
          4. click "Insert"
          5. click ok
      2. Click Edit->Data Table Properties. For each table (ec_attribute, ev_event_attr, ec_event, ec_case_status, EC CASE EVENTS, EC EVENTS ATTRIBUTES)
        1. select table
        2. set store data-> linked to source
        3. click apply
      3. Click OK to exit data table properties screen
      4. Now click File Menu, choose reload data. Now select the second tab (Case Dashboard and ensure data is retrieved from your AMX:BPM server)
      5. You can now remove the Instructions tab
      6. Click File Menu, Save As -> Library item
      7. Save the vizualization as: '/CaseManager/TEMPLATES/CaseManager_Analytics_V1.0.3'
      8. You will be given a Web Player URL. Make sure you can open that in a web browser.
  7. Test the sample template click on "File->Open from->Library" and select the "/CaseManager/TEMPLATES/CaseManager_Analytics_V1.0.3" and try to open it in Spotfire
  8. You can now configure the Case Manager App to point to the spotfire vizualization:
    1. In a web browser:

      1. http://localhost:8080/apps
      2. Double click Case Manager application
      3. Double click CaseManager.config.json
      4. Change line 20 to point to the right port number for your Spotfire Server eg:)
        1. "spotfireServer": "http://localhost:28080/spotfire/wp",
      5. Change line 23 to point to the right vizualization
        1. "analysisPath": "/CaseManager/TEMPLATES/CaseManager_Analytics_V1.0.3"
    2. Click applications to return to the top level appdev console screen
      1. Click Edit Applications button (pencil/paper icon on top right) 
      2. Select the Case Manager App by ticking the box in top left corner of the card then click the publish button
      3. You will need to wait a few minutes for the application to publish – be patient it might take some time
    3.        

    4. You should now be able to access the CaseManager Application using http://localhost:8080/apps/CaseManager/index.html

    5. Click the analytics button to check the vizualization is displayed.

Note: If you see a blank screen when clicking analytics in Case Manager it is likely guest access for Spotfire is not properly configured.

Troubleshooting: If you have problems - be sure to check the developer console in your browser for errors.

Roles Configuration

The Case Management Framework also supports role based access to enable/disable certain features. Follow these steps to configure roles for the Case Management Accelerator:

  1. Open the appdev console in your web browser:

    1. http://localhost:8080/apps
    2. Click the roles button on the left hand nav bar
    3. Click upload
    4. Upload the roles zip file provided in /Case Management Accelerator 2.0.2/AppDev
    5. Once the roles zip is installed click the refresh icon on the roles page and you should see the following roles:
      1. Super, Manager, Admin, Worker, Operator
    6. Click the edit icon at top right of roles page, then select the Super role
    7. Click map/unmap role
    8. Drill into CaseManagerOrganization1/CaseManagerRolesOrg and select the super position, then click map
    9.  (Now any user you map to the super position in the org model will get the supervisor (super) role)
    10. Repeat steps f-i for each role and map to the associated org model position
    11. Now in openspace UI (http://localhost:8080/openspace/) login as tibco-admin and use the organization tab to map users to the org model positions (super/manager/admin/worker/operator). Ensure that each user is only mapped to one of these positions.
  2. Enable Roles for the Case Manager Application
    1. Click the applications tab on the left hand nav bar
    2. Double click the Case Manager application
    3. Double click CaseManager.config.json
    4. Scroll down to line 77 and set useRoles = true
    5. Click save
    6. Click the applications tab
    7. Click the edit icon at top right of screen
    8. Select the CaseManager application
    9. Click Publish application

Roles should now be enabled for your application as per the following image:

So for example, a super user will be able to access any of the Case Management functions but the operator user will not see OrgModel or Analytics icons in the UI.

If you want to customize the roles configuration then please review the AMX:BPM documentation on using appdev roles:

https://docs.tibco.com/pub/amx-bpm/4.2.0/doc/html/bpmhelp/GUID-B5FC64D3-5BAD-48C7-90D0-63AEF422AC7D.html

 

 

 

 

Feedback (1)