IBM Business Automation Workflow V
18.0.0.2

Configuring the remote Elasticsearch service

If you choose to use Process Federation Server with a remote Elasticsearch 6.x cluster rather than an embedded Elasticsearch 1.7.2 node, you must enable the capability and specify the endpoints.

About this task

Process Federation Server can use a remote Elasticsearch cluster to provide a distributed index that contains data from the business process management systems in the federated environment. The distributed index ensures that users have fast access to federated data, and relieves business process management systems from expensive queries. Process Federation Server creates an Elasticsearch index for each server in the federated environment, and offers a common REST-based query service that provides data to Process Federation Server clients, such as federated Process Portal.

By default, for backward compatibility reasons, Process Federation Server starts an embedded Elastisearch 1.7.2 node. Therefore, if you want Process Federation Server to use the external Elasticsearch cluster that you have installed, you must explicitly set up the connection. You set up such connection modifying the server.xml configuration file.

Procedure

Open the Process Federation Server server.xml configuration file for editing.

By default, you can find it on Process Federation Server in the pfs_install_root/usr/servers/server_name directory.
Add an ibmPfs_remoteElasticsearch configuration element.
Set the enabled attribute to true, and specify the endpoints, as in the following example.
```
<ibmPfs_remoteElasticsearch
        enabled="true"
        endpoints="http[s]://my.elasticsearch.host:port/optional/path[,http[s]://myother.elasticsearch.host:otherport/optional/path]"/>
```
For information about the properties that you can set, see Elasticsearch service configuration properties.

What to do next

If you experience problems with the index, you can delete it. The index is rebuilt the next time Process Federation Server is restarted. For more information, see Maintaining the Process Federation Server index.