This topic applies only to the IBM Business Process Manager Standard configuration.This topic applies only to the IBM Business Process Manager Advanced configuration.

Enabling indexing of BPD-related data on an IBM BPM server in a federated environment

When a business process definition (BPD) runs on an IBM® BPM system, BPD-related data is written to the Process Server database (BPMDB). For this data to be included in the Process Federation Server index, you must create change log tables in the Process Server database, and enable BPD indexing on Process Federation Server.

Before you begin

  • If you are enabling indexing on an IBM BPM system that is earlier than V8.5.6, verify that the required APARs are installed on the system. For more information, see Technote 1699090.
  • Verify that the Process Server on the IBM BPM server is stopped.

About this task

Updates to the data are logged on the IBM BPM server. Process Federation Server monitors the logs for changes. When changes become available, Process Federation Server pulls them from the Process Server database, and then indexes the changed data.

Procedure

  1. Create the change log tables in the Process Server database on the IBM BPM system. Use the create_bpd_change_log.ddl script that is provided with Process Federation Server to create the tables.
    1. On Process Federation Server, go to the pfs_install_root\ibmProcessFederationServer\wlp-ext\dbscripts directory and go to the directory under it for your specific database type.
    2. Move the script to your IBM BPM system.
    3. Read the instructions in the script and replace the variables with the correct names.
      • Replace @SCHEMA@ with the schema name. Because the existing IBM BPM database user will be writing to the change log tables, ensure that the schema name is consistent with the schema name that is used for other IBM BPM database tables.
    4. Run the script.
  2. Configure the IBM BPM server to emit changes to the change log tables.

    Update the 100Custom.xml file on the IBM BPM server to include the federated-index-enabled configuration parameter.

    1. Open the 100Custom.xml file in a text editor and add the following code snippet:
      <server>
        <search-index merge="mergeChildren">
           <federated-index-enabled merge="replace">true</federated-index-enabled>
         </search-index>
      </server>
      For more information about the 100Custom.xml file, see The 99Local.xml and 100Custom.xml configuration files.
    2. Save your changes.
    3. Restart the Process Server on the IBM BPM server.
    4. Resynchronize the nodes of the application cluster and then restart the application cluster.
  3. Enable BPD indexing on Process Federation Server.
    1. Open the server.xml configuration file for editing. By default, the configuration file is in the pfs_install_root/usr/servers/server_name directory on Process Federation Server.
    2. Configure the library and dataSource elements for your Process Server database. The BPD indexing service uses these properties to connect to the database. The following code snippet shows an example of configured library and dataSource elements for a DB2 database:
      <library id="DB2JCC4Lib">
         <fileset dir="pfs_install_root/wlp-ext/jdbcdrivers/DB2" 
            includes="db2jcc4.jar db2jcc_license_cisuz.jar"/>
      </library>
      <dataSource id="bpd_db2" 
         commitOrRollbackOnCleanup="commit" isolationLevel="TRANSACTION_READ_COMMITTED" 
         jndiName="jdbc/bpmdata" type="javax.sql.DataSource"> 
         <jdbcDriver libraryRef="DB2JCC4Lib"/> 
         <properties.db2.jcc serverName="localhost" portNumber="50000" 
            databaseName="BPMDB" user="db2admin" password="db2admin" /> 
      </dataSource>
    3. Update the configuration properties for the BPD indexing service in the ibmPfs_federatedSystem, ibmPfs_bpdIndexer, and ibmPfs_bpdRetriever elements.

      For information about the configuration properties, see Configuration properties for the Process Federation Server index.