Configuring endpoint URLs for Process Portal

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
To enable Process Portal for a federated environment, configure endpoint URLs so that Process Portal can communicate with Process Federation Server and the federated systems. You can configure the URLs in the 100Custom.xml configuration file.

Before you begin

Single sign-on must be configured for all servers in the federated environment, including the server that hosts Process Portal. For more information, see Configuring SSO for federated environments.

About this task

To configure the endpoint URLs on the server that hosts Process Portal, update the 100Custom.xml file with the following <portal> elements:
<bpm-data-endpoint>
The URL for Process Federation Server. This URL must point to the SSL-secured port (https) that is defined in the httpEndpoint element in the server.xml file. If there is an HTTP Server in front of Process Federation Server, use the HTTP Server URL.
<trusted-sources>
A comma-separated list of URLs of the federated servers that need to be trusted. The servers can be Business Automation Workflow or IBM® BPM servers, or the HTTP Server in front of them. The hosts and ports must be the same as those specified in the ibmPfs_federatedSystem taskCompletionUrlPrefix attribute in the Process Federation Server server.xml file.
Note that the port number is not required if a web server host name is provided for the ibmPfs_federatedSystem taskCompletionUrlPrefix attribute in the Process Federation Server server.xml. Specify a port number only to add an extra layer of validation, in case you are serving multiple servers on the same host, as long as the specified port number is not the default port number for HTTP(80) or HTTPS(443).
Important: Process Portal automatically trusts all the servers that are federated by Process Federation Server. Process Portal retrieves the set of federated servers through the Systems Metadata Resource - GET External link opens a new window or tab API and trusts the endpoints it returns. If you want to add a load balancer or an IBM HTTP Server (IHS) to the set of trusted sources, you must add to the original configuration in the 100Custom.xml file. These changes apply only if you list all the endpoints of your federated systems in the trusted-sources element, and the endpoints are returned by the Systems Metadata Resource - GET External link opens a new window or tab API. If you want to use the 100Custom.xml configuration, Process Portal simply merges the sources from Process Federation Server with the sources specified in the 100Custom.xml file.

For more information about the 99Local.xml and 100Custom.xml files, see The 100Custom.xml file and configuration.

Procedure

  1. Open the 100Custom.xml files in a text editor.
  2. Copy the following code snippet to the 100Custom.xml file and update the URLs for your environment: 
    <server merge="mergeChildren">
  <portal merge="mergeChildren"> 
    <bpm-data-endpoint>https://pfs.mycompany.com:port/rest/bpm/federated</bpm-data-endpoint>
   <trusted-sources>https://bpm1.mycompany.com:port,https://bpm2.mycompany.com:port</trusted-sources>
  </portal>
</server>
  3. Save your changes.
  4. To avoid any Content Security Policy issue when Process Portal sends requests to Process Federation Server and federated systems URLs declared in <bpm-data-endpoint> and <trusted-sources>, ensure that the Security.ContentSecurityPolicyHeaderValue property is correctly configured and allows calls to these URLs. For more information about the Security.ContentSecurityPolicyHeaderValue property configuration, see Security.ContentSecurityPolicyHeaderValue.