Predefined OpenSearch aliases and indices

By knowing the structure of OpenSearch configurations, you can implement your strategy for purging, backing up, and restoring data.

Predefined configuration

The predefined OpenSearch configuration describes how OpenSearch is configured for the IBM Cloud Pak® for Business Automation platform components, namely IBM Business Automation Workflow, IBM Operational Decision Manager, IBM Content Cortex.
The following patterns take the example of the index that is named icp4ba-bai-process-timeseries in IBM Business Automation Insights. This index is represented by the <name> placeholder. The names of the OpenSearch index and aliases are derived as follows.
  • The name of an index that gets created in OpenSearch uses this pattern: <name>-idx-ibm-bai-{now/d}-000001. The {now/d} placeholder represents the index creation date.

    Example: icp4ba-bai-process-timeseries-idx-ibm-bai-2020.10.14-000001

  • The name of the write alias that is dedicated to index documents in the active index follows this pattern: <name>-ibm-bai-write-ibm-bai

    Example: icp4ba-bai-process-timeseries-write-ibm-bai

  • The name of the read alias is the name of the index that complies with this pattern: <name>-ibm-bai

    Example: icp4ba-bai-process-timeseries-ibm-bai

Aliases and indices for times series and summaries

The following tables list and describe the alias-index pairs for times series and summaries that Flink jobs produce from IBM Cloud Pak for Business Automation events.
IBM Business Automation Workflow events
Table 1. Aliases and indices for process summaries
Alias Description Indices
icp4ba-bai-process-summaries-active-write-ibm-bai Used by data processing jobs to write the active summaries. icp4ba-bai-process-summaries-active-idx-ibm-bai-{now/d}-000001
icp4ba-bai-process-summaries-completed-write-ibm-bai Used by data processing jobs to write the completed summaries. icp4ba-bai-process-summaries-completed-idx-ibm-bai-{now/d}-000001
icp4ba-bai-process-summaries-completed-ibm-bai Used to query the completed summaries. icp4ba-bai-process-summaries-completed-idx-ibm-bai-*
icp4ba-bai-process-summaries-ibm-bai Used to query all summaries, whether completed or still active. icp4ba-bai-process-summaries-*-idx-ibm-bai-*
icp4ba-bai-process-timeseries-write-ibm-bai Used by data processing jobs to write time series. icp4ba-bai-process-timeseries-idx-ibm-bai-{now/d}-000001
Table 2. Aliases and indices for case summaries
Alias Description Indices
icp4ba-bai-case-summaries-active-write-ibm-bai Used by data processing jobs to write the active summaries. icp4ba-bai-case-summaries-active-idx-ibm-bai-{now/d}-000001
icp4ba-bai-case-summaries-completed-write-ibm-bai Used by data processing jobs to write the completed summaries. icp4ba-bai-case-summaries-completed-idx-ibm-bai-{now/d}-000001
icp4ba-bai-case-summaries-completed-ibm-bai Used to query the completed summaries. icp4ba-bai-case-summaries-completed-idx-ibm-bai-*
icp4ba-bai-case-summaries-ibm-bai Used to query all summaries, whether completed or still active. icp4ba-bai-case-summaries-*-idx-ibm-bai-*
Operational Decision Manager decisions
Table 3. Aliases and indices for decisions time series
Alias Description Indices
icp4ba-bai-odm-timeseries-active-write-ibm-bai Used by data processing jobs to write the ODM time series. icp4ba-bai-odm-timeseries-idx-ibm-bai-{now/d}-000001
IBM Content Cortex events
Table 4. Aliases and indices for content time series
Alias Description Indices
icp4ba-bai-content-timeseries-write-ibm-bai Used by data processing jobs to write the Content time series. icp4ba-bai-content-timeseries-idx-ibm-bai-{now/d}-000001