Indexing case instances

The case management tools support indexing of case instances in a federated data repository index. Full reindexing and live index updates are supported.

About this task

After case federation is enabled, an administrator or operator needs to trigger the rebuild of the federated data repository index for the historical case instances to be indexed. The first indexing must be done before a case management system is registered to Process Federation Server. Subsequent full reindexing is rarely needed, but you can initiate full reindexing if you find that the index is not up to date. Case instances that have the following properties are indexed:

  • Fixed well-known metadata properties
  • Business properties (case properties) that are defined in the Search or Summary views of the case solution, except business objects.

Procedure

  1. Perform a POST request to the following URL: 
    <Business_Automation_Workflow_External_base_URL>/CaseManager/CASEREST/v1/<TOS_name>/index
    where
    • <Business_Automation_Workflow_External_base_URL> can be determined by looking into the workflow-server-access-info key (for Workflow Runtime) or bastudio-access-info (for Workflow Authoring) key of the configmap named "<ICP4Cluster_Custom_Resource_name>-cp4ba-access-info", and
    • <TOS_name> is the symbolic name of the target object store.
    • <admin_user> is the LDAP admin user if you config LDAP, or the Cloud Pak foundational services admin user.
    Workflow Runtime example:
    curl -X POST -u <admin_user> https://cpd-myproject.myocp.com/baw1/CaseManager/CASEREST/v1/ABCD1234-EF56-AB12-34CD-ABCD1234EF56/index --insecure
    Workflow Authoring example:
    curl -X POST -u <admin_user> https://cpd-myproject.myocp.com/bas/CaseManager/CASEREST/v1/ABCD1234-EF56-AB12-34CD-ABCD1234EF56/index --insecure
  2. To perform partial reindexing, use the syntax and URL described earlier, but also specify the following parameter (where UTC_time is the time that is specified in UTC): 
    {"skipCaseInstancesNotModifiedSince" : "UTC_time"}

    For example,

    {"skipCaseInstancesNotModifiedSince" : "2020-09-05 12:00:00"}
    Partial reindexing is automatically performed in certain situations: for example, when you add a case property in case summary or case search views and then redeploy. In this particular situation, all the case instances under the case type are reindexed to capture the values of the new fields for the case instances.
    However, you might want to manually perform partial reindexing by using the skipCaseInstancesNotModifiedSince parameter in certain situations. For example, when index inconsistencies are suspected after a disaster recovery.