Configuring the Federated Data Repository connection

Edit online

Business Automation Workflow can index data about process instances, process tasks and case instances in the federated data repository, which can be either Elasticsearch or OpenSearch. If you enable both the process indexing and the case indexing, the same Federated Data Repository is used to store the process and case data.

Before you begin

As a prerequisite, set up a Federated Data Repository cluster that can be one of the following products:
  • OpenSearch 2.5.0 to 2.x
  • The usage of Elasticsearch 8x is supported. Note that versions prior to 8.x are not supported. The usage of Elasticsearch 7.17 to 7.x is deprecated.
In production topologies, the following conditions must be met:
  • The Federated Data Repository cluster must consist of at least three nodes so that it provides high availability.
  • The Federated Data Repository API must be exposed on HTTPS, and basic authentication must be enabled.

About this task

To enable either process or case indexing, you must configure Business Automation Workflow to connect to the Federated Data Repository.

Procedure

When you have a running Elasticsearch or OpenSearch cluster, provide the configuration to connect to the Federated Data Repository API to Business Automation Workflow:
  1. Create a file named <deploymentEnvironment>_BAW_federatedrepoclient.properties in the [BAW_HOME]/profiles/<profileName>/config/cells/<cellName> folder, where
    • <deploymentEnvironment> is the deployment environment name from the WebSphere® console under Server > Deployment Environments.
    • <profileName> is the node profile name from the WebSphere console under System administration > Nodes. If your nodes are configured with a deployment manager, use the deployment manager node name,
    • <cellName> is the cell name from the WebSphere console under System administration > Cell.
  2. In the properties file, provide the configuration required by Business Automation Workflow to connect to the Federated Data Repository REST API. For example: 
    endpoints=https://opensearch-node1:9200,https://opensearch-node2:9200,https://opensearch-node3:9200
authAlias=opensearchAuthAlias
    The properties that you can set to configure the connection to the federated data repository REST API are as follows.
    Table 1. Properties for the configuration of the Federated Data Repository REST API connection
    Property Description Required or optional Default value
    endpoints A comma-separated list of URLs to the Federated Data Repository cluster REST API. In production topologies, to provide high availability, you must use at least two different URLs that point to different nodes of the same federated date repository cluster. Required None
    authAlias The WebSphere authentication alias where you defined the credentials that Business Automation Workflow uses to authenticate when it sends requests to the Federated Data Repository REST API. Required in production topologies.
    Optional in development environments that might communicate with an unsecured Federated Data Repository.    		 None
    connectTimeout The maximum amount of time, in milliseconds, that Business Automation Workflow awaits to connect to the Federated Data Repository REST API. Optional 10000
    readTimeout The maximum amount of time, in milliseconds, that Business Automation Workflow awaits for the federated data repository REST API to respond. Optional 30000
    indexPrefix

    Set the indexPrefix property only when you federate the Business Automation Workflow system from Process Federation Server that runs as part of Cloud Pak for Business Automation or as part of a stand-alone Business Automation Workflow deployment on containers. In such case, set indexPrefix to "icp4ba-pfs".

    		 Optional None