Configuration properties for the Process Federation Server data store

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
You can configure Process Federation Server to store federated saved search definitions that Process Portal uses in a Federated Data Repository index or a relational database. Use the ibmPfs_federatedPersistence element in the server.xml file to configure the data store for Process Federation Server. This data store contains federated saved search definitions that IBM® Process Portal uses.

You can configure the data store in one of the following ways:

  • Federated Data Repository index: An index in Elasticsearch or OpenSearch, as referenced by the ibmPfs_remoteElasticsearch configuration element.
  • Relational database: A supported relational database system.
The following table contains the common configuration properties.
Table 1. Configuration properties for the Process Federation Server data store
Property Default value Description
useElasticsearch None Required.

Type: Boolean.

Specifies where saved searches are stored.

  • If set to true, saved searches are stored in a Federated Data Repository index.
  • If set to false, saved searches are stored in a relational database. In this case, you must also specify the schemaName and dataSourceRef properties.
Attention: The use of false is deprecated.
schemaName (deprecated) FEDERATED Type: String.

The name of the schema that contains the database tables. The name must be the same as the name that was used when the Process Federation Server tables were created.
dataSourceRef (deprecated) None Type: String.

The data source ID for the Process Federation Server database instance. This property refers to the data source ID set in the <datasource id> attribute.

indexName

 ibmpfssavedsearches

Type: String.

The name of the Federated Data Repository index used to store saved searches.
numberOfShards 3

Type: Integer.

Number of shards of the Federated Data Repository index used to store saved searches. It cannot be changed once the index has been created.
numberOfReplicas 1

Type: Integer.

Number of replicas (pods) of the Federated Data Repository index used to store saved searches.
batchSize 100

Type: Integer.

Batch size used for retrieving saved searches from the Federated Data Repository.