The Process Federation Server server.xml configuration file

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-01-20 10:38
You can edit and update the template server.xml file to meet the requirements of your environment. In this file, you can configure your federated systems, configure a common user registry, single sign-on, the federated data repository service, the Liberty HTTP server, secure communications, or enable specific features.

Configurable elements in the server.xml file

Note: To ensure compatibility with configuration files created for previous versions of Process Federation Server, the federated data repository is configured in server.xml using the ibmPfs_remoteElasticsearch configuration element for both Elasticsearch and Opensearch implementations of this repository.

Elements specific to Process Federation Server

<ibmPfs_bpdIndexer/>
Description: Contains configuration properties for indexing business process definition (BPD)-related data on a federated system.
Note: Federating a Business Automation Workflow 24.0.0.0 process system by configuring the indexer in Process Federation Server is deprecated, and is only required when federating Business Automation Workflow 23.0.2 and earlier. As of 24.0.0.0, you should configure the federated Business Automation Workflow system to index directly into the federated data repository as described in Enabling the federated data repository process indexing.
Required: false

For more information about this element and its attributes, see Configuration properties for the Process Federation Server index.

For specific configurations and usage, also see Enabling indexing of BPD-related data in a federated environment and Adding a Business Automation Workflow system to the federated environment.

Back to top

<ibmPfs_bpdRetriever/>
Description: Contains configuration properties for retrieving BPD-related data from a federated system by using REST services.
Required: false

For more information about this element and its attributes, see Configuration properties for the Process Federation Server index.

For specific configurations and usage, also see Third-party authentication in federated process environments, Enabling indexing of BPD-related data in a federated environment, Adding a Business Automation Workflow system to the federated environment, and Maintaining the Process Federation Server index.

Back to top

<ibmPfs_bpelIndexer/>
Description: Contains configuration properties for indexing BPEL-related data on a federated system.
Required: false

For more information about this element and its attributes, see Configuration properties for the Process Federation Server index.

For specific configurations and usage, also see Enabling indexing of BPEL-related data in a federated environment and Adding a Business Automation Workflow system to the federated environment.

Back to top

<ibmPfs_bpelRetriever/>
Description: Contains configuration properties for retrieving BPEL-related data from a federated system by using REST services.
Required: false

For more information about this element and its attributes, see Configuration properties for the Process Federation Server index.

For specific configurations and usage, also see Enabling indexing of BPEL-related data in a federated environment and Adding a Business Automation Workflow system to the federated environment.

Back to top

<ibmPfs_caseRetriever/>
Description: Contains configuration properties for retrieving Case-related data from a federated system by using REST services.
Required: false

For more information about this element and its attributes, see Configuration properties for the Process Federation Server index.

For specific configurations and usage, also see Adding a Business Automation Workflow system to the federated environment.

Back to top

<ibmPfs_remoteElasticsearch/>
Description: Contains the configuration properties for the external Elasticsearch or Opensearch cluster that provide the federated data repository service.
Required: false

For more information about this element and its attributes, see Configuration properties for a remote Elasticsearch service.

Back to top

<ibmPfs_federatedPersistence/>
Description: Defines the Process Federation Server database configuration.
Required: true
Attributes:
  • Draft comment: amadelin
    those attributes are documented in http://bidoc.canlab.ibm.com:9080/support/knowledgecenter/SSFPJS_8.5.7/com.ibm.wbpm.main.doc/topics/cfg_fps_database.html. Delete them from there and point to this ref topic instead? Or duplicate info?
    schemaName
    • Description: 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.
    • Default value: FEDERATED
    • Required: false
    • Data type: string
  • dataSourceRef
    • Description: 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.
    • Required: true
    • Data type: string

For specific configurations and usage, also see Configuring the Process Federation Server database.

Back to top

<ibmPfs_federatedSystem/>
Description: Contains general configuration properties for the federated system and its index. You configure an ibmPfs_federatedSystem element for each federated system.:
Required: false

For more information about this element and its attributes, see Configuration properties for the Process Federation Server index.

For specific configurations and usage, also see Enabling indexing of BPD-related data in a federated environment, Enabling indexing of BPEL-related data in a federated environment, Adding a Business Automation Workflow system to the federated environment, Federation considerations for dashboards, processes, and services in Process Portal, Configuring allowed origins for Process Portal .

Back to top

<ibmPfs_launchableEntity/>
Description: Contains properties for launchable entities configuration.
Required: false

For more information about this element and its attributes, see Federation considerations for dashboards, processes, and services in Process Portal.

Back to top

<ibmPfs_restConfig/>
Description: Contains configuration properties for the REST web end-point cache.

For more information about this element and its attributes, see Configuration properties for the Process Federation Server index.

Back to top

Generic elements configurable for Process Federation Server

Tip: For more information about these elements and their attributes, see the child topics of IBM® WebSphere® Application Server Liberty topic Server configuration.
<featureManager>
Description: Defines how the server loads features.

For specific configurations and usage, also see Configuring LDAP user registries for Process Federation Server, Configuring a custom user registry for Process Federation Server , Securing inbound communications to Process Federation Server .

Back to top

<feature>
Description: Specifies a feature to be used when the server runs.

For specific configurations and usage, also see Configuring LDAP user registries for Process Federation Server, Configuring a custom user registry for Process Federation Server , Securing inbound communications to Process Federation Server .

Back to top

<httpEndpoint/>
Description: Configuration properties for an HTTP endpoint.

For specific configuration and usage, also see Securing inbound communications to Process Federation Server .

Back to top

<logging/>
Description: Contains the trace specifications for the Process Federation Server components.

For specific configurations and usage, also see Logging and tracing for Process Federation Server.

Back to top

<keyStore/>
Description: A repository of security certificates that are used for SSL encryption.

For specific configurations and usage, also see Securing outbound communications between Process Federation Server and federated systems, Securing inbound communications to Process Federation Server , Securing communications between Process Federation Server and LDAP.

Back to top

<ssl/>
Description: An SSL repertoire with an ID, a defined keystore, and an optional truststore.

For specific configurations and usage, also see Securing inbound communications to Process Federation Server , Securing communications between Process Federation Server and LDAP.

Back to top

<sslDefault/>
Description: The default repertoire for SSL services.

For specific configurations and usage, also see Securing inbound communications to Process Federation Server .

Back to top

<basicRegistry>
Description: Basic user registry configuration.

For specific configurations and usage, also see Configuring a basic user registry for Process Federation Server .

Back to top

<ldapRegistry>
Description: Configuration properties for the LDAP user registry.

For specific configurations and usage, also see Configuring LDAP user registries for Process Federation Server, Securing communications between Process Federation Server and LDAP.

Back to top

<federatedRepository>
Description: Configuration for the user registry federation. For example, you can configure it to change the default behavior when you have multiple LDAP servers in your federated environment.

For specific configurations and usage, also see Configuring LDAP user registries for Process Federation Server.

Back to top

<primaryRealm>
Description: Primary realm configuration properties.

For specific configurations and usage, also see Configuring LDAP user registries for Process Federation Server.

Back to top

<participatingBaseEntry/>
Description: The base entry that is part of the realm.

For specific configurations and usage, also see Configuring LDAP user registries for Process Federation Server.

Back to top

<uniqueGroupIdMapping/>
Description: The input and output property mappings for unique group ID in a user registry operation.

For specific configurations and usage, also see Configuring LDAP user registries for Process Federation Server.

Back to top

<ltpa/>
Description: Lightweight Third Party Authentication (LTPA) token configuration properties.

For specific configurations and usage, also see Configuring SSO for federated environments by using LTPA keys.

Back to top

<authorization-roles>
Description: A collection of role names and mappings of the roles to users, groups, or special subjects.

For specific configurations and usage, also see Validating the Process Federation Server and federated environment configuration .

Back to top

<security-role>
Description: A role that is mapped to users and groups in a user registry.

For specific configurations and usage, also see Validating the Process Federation Server and federated environment configuration .

Back to top

<library>
Description: The database management system that you use for the Process Federation Server database.

For specific configurations and usage, also see Configuring the Process Federation Server database, Configuring single sign-on for federated environments by using a custom trust association interceptor (TAI), Enabling indexing of BPD-related data in a federated environment, Enabling indexing of BPEL-related data in a federated environment.

Back to top

<fileset/>
Description: Specifies a set of files starting from a base directory and matching a set of patterns.

For specific configurations and usage, also see Configuring the Process Federation Server database, Enabling indexing of BPD-related data in a federated environment, Enabling indexing of BPEL-related data in a federated environment.

Back to top

<datasource>
Description: Defines a data source configuration for your Process Federation Server database.

For specific configurations and usage, also see Configuring the Process Federation Server database, Enabling indexing of BPD-related data in a federated environment, Enabling indexing of BPEL-related data in a federated environment, Adding a Business Automation Workflow system to the federated environment, Configuring secure access to DB2 databases in federated environments, Configuring secure access to Oracle databases in federated environments, Configuring secure access to SQL Server databases in federated environments.

Back to top

<webAppSecurity/>
Description: Configures web container application security.

For specific configurations and usage, also see Configuring SSO for federated environments by using LTPA keys.

Back to top

<trustAssociation>
Description: Controls the operation of the trust association interceptor (TAI)

For specific configurations and usage, also see Configuring single sign-on for federated environments by using a custom trust association interceptor (TAI).

Back to top

<interceptors>
Description: Defines a trust association interceptor.

For specific configurations and usage, also see Configuring single sign-on for federated environments by using a custom trust association interceptor (TAI).

Back to top

<pluginConfiguration/>
Description: Contains properties to enable the use of IBM HTTP server.

For specific usage, also see Configuring IBM HTTP Server for federated environments.

Back to top