Optional: Enabling the Timeline Visualizer widget to display Business Automation Workflow process activity flow

You can enable the Timeline Visualizer widget in Workflow Runtime environment to display Business Automation Workflow process activities on Cloud Pak for Business Automation.

Before you begin

The Timeline Visualizer widget provides a visual representation of the extended history for a case. The visual representation of the extended history for a case shows the progression of events, tasks, and work items over time for the case. For detailed information, see Timeline Visualizer widget. The Case History Visualizer widget also supports displaying Business Automation Workflow process activities on Cloud Pak for Business Automation.

To view Business Automation Workflow process activity details in the Case History visualizer widget, the Case History emitter needs to be configured in Business Automation Workflow on the Cloud Pak for Business Automation environment.

About this task

The Case History emitter can be configured in the following two scenarios:
A. Existing Case History store:
If a Case History store exists in the Cloud Pak for Business Automation environment, the Case History emitter can be configured by using the parameters as mentioned in step 3. Table: Case History emitter parameters. The Case History emitter emits the events to the existing Case History store.
B. New Case History store:
If no Case History store exists in the Cloud Pak for Business Automation environment, follow the procedure steps 1 - 3 to configure the Case History emitter. The following procedure helps you to create a new Case History store. The Case History emitter is configured to emit events to the new Case History store.

Procedure

To create and enable a Case History store:

  1. Prepare a database for the Case History store.
    If you plan to use the Timeline Visualizer widget to view Case History over time, you must prepare a database to record extended Case History data.

    For detailed information, see Preparing a database for the case history store

  2. Configure a new Case History store.
    To create a new Case History store along with enabling the Case History emitter:
    1. Add Case History database sensitive configuration data to the IBM FileNet Content Manager secret. For more, refer Creating secrets to protect sensitive IBM FileNet Content Manager configuration data.
      For example, you can use the dc_os_label parameter by using value ch, and add chDBUsername and chDBPassword keys with the Case History database credentials into the IBM FileNet Content Manager secret.
    2. Specify other Case History database configuration data in the custom resource file to create a data source in the Content Platform Engine server. For more, refer Datasource parameters
      For example,
      datasource_configuration:
        dc_cpe_datasources:
          - database_name: chdb
            database_port: ‘5432’
            database_servername: <hostname>
            dc_common_cpe_datasource_name: CASEHISTORYDS
            dc_common_cpe_xa_datasource_name: CASEHISTORYDSXA
            dc_database_type: postgresql
            database_ssl_secret_name: chdb-ssl-cert-secert
            dc_os_label: ch
            dc_common_conn_name: ‘jos10_connection’
  3. Configure the Case History emitter
    To configure the Case History emitter in the Cloud Pak for Business Automation environment, set the following parameters in the baw_configuration section in the custom resource file.
    Note: For authoring environment, you must set the following parameters in the workflow_authoring_configuration section.
    Table 1. Case History emitter parameters
    Parameter Description Example values
    case.case_history_emitter.enable
    Whether to enable Case History emitter true
    case.case_history_emitter.case_history_store_schema_name
    Schema name of Case History store CHSCHEMA
    case.case_history_emitter.dc_common_cpe_datasource_name
    Content Platform Engine data source name of Case History store CASEHISTORYDS

    The following example shows sample values:

    case_history_emitter:
     enable: true
     case_history_store_schema_name: CHSCHEMA
     dc_common_cpe_datasource_name: CASEHISTORYDS
    

What to do next

After you have prepared for each capability that you want to install, deploy the custom resource (CR) file. See Creating a production deployment.