Using the Administration scripts to access the indexers MBeans

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 access remotely the process or BPEL indexer MBeans using the administration scripts to monitor the values of the attributes and to execute a specific action on the indexer.

Accessing the Administration scripts

These administration scripts are located in the PFS_INSTALL_DIR/ibmProcessFederationServer/wlp-ext/adminScripts directory.

Preparing your environment for the Administration scripts

Before your use these scripts, make sure that the following environment variables are correctly set in your environment:
  • JAVA_HOME : A directory where the Java™ runtime environment is installed. If this environment variable is not defined then the PATH is checked for a java executable.
  • WLP_HOME : The Liberty wlp directory. This variable is used to locate the restConnector.jar file in WLP_HOME/clients. If this environment variable is not defined, then it is assumed that the restConnector.jar file is located in ./clients.
  • PFS_ADMIN_HOME : The directory that contains the PFS_Admin_Command.jar file. If this environment variable is not defined, then it is assumed that this file is located in the current directory.
  • PFS_JAVA_OPTS: Java options to use when running the Admin script.

    If the CN of the certificate exposed by Process Federation Server does not match the hostname defined in the options file, you can define: PFS_JAVA_OPTS="-Dcom.ibm.ws.jmx.connector.client.disableURLHostnameVerification=true".

    If you get a Read timed out exception when you run a script, you can specify a custom timeout (in milliseconds) with: PFS_JAVA_OPTS="-Dcom.ibm.ws.jmx.connector.client.rest.readTimeout=<timeout>". The following example is for a 3 minutes (180 seconds) timeout: PFS_JAVA_OPTS="-Dcom.ibm.ws.jmx.connector.client.rest.readTimeout=180000"

    You can combine more than one Java option, as in the following example: PFS_JAVA_OPTS="-Dcom.ibm.ws.jmx.connector.client.disableURLHostnameVerification=true -Dcom.ibm.ws.jmx.connector.client.rest.readTimeout=180000"

Using the Administration scripts

Using the listBpdIndexerUniqueIDs script
This script displays the list of the unique indexer IDs of the running process indexer MBeans.
Syntax
  • Linux®/Unix: listBpdIndexerUniqueIDs.sh -file optionsFile [-verbose]
  • Windows: listBpdIndexerUniqueIDs.bat -file optionsFile [-verbose]
Options
The following table lists all the options available:
Table 1. Options of the listBpdIndexerUniqueIDs script
Option Description Required
-help Displays information about the options, the attributes that can be queried, and the properties that must be set in the options file. No
-file filename Specifies the absolute path name of the option file that must contain the following properties:
  • host=<Process Federation Server host name>
  • port=<HTTPS server port>
  • user=<user with administrative role defined on the server>
  • password=<user password>
  • trustStoreFile=<name and path of the truststore for SSL connection with the server>
  • trustStoreType=<truststore type>
  • trustStorePassword=<truststore password>
 Yes
-verbose Verbose output of the script execution. No
Using the listBpelIndexerUniqueIDs script
This script displays the list of the unique indexer IDs of the running BPEL indexer MBeans.
Syntax
  • Linux/Unix: listBpelIndexerUniqueIDs.sh -file optionsFile [-verbose]
  • Windows: listBpelIndexerUniqueIDs.bat -file optionsFile [-verbose]
Options
The following table lists all the options available:
Table 2. Options of the listBpelIndexerUniqueIDs script
Option Description Required
-help Displays information about the options, the attributes that can be queried, and the properties that must be set in the options file. No
-file filename Specifies the absolute path name of the option file that must contain the following properties:
  • host=<Process Federation Server host name>
  • port=<HTTPS server port>
  • user=<user with administrative role defined on the server>
  • password=<user password>
  • trustStoreFile=<name and path of the truststore for SSL connection with the server>
  • trustStoreType=<truststore type>
  • trustStorePassword=<truststore password>
 Yes
-verbose Verbose output of the script execution. No
Using the monitorBpdIndexer script
You can use this script to retrieve the attributes value of a running process indexer MBean.
Syntax
  • Linux/Unix: monitorBpdIndexer.sh -file optionsFile -id BPD_uniqueIndexerID -attribute attributeName [-verbose]
  • Windows: monitorBpdIndexer.bat -file optionsFile -id BPD_uniqueIndexerID -attribute attributeName [-verbose]
Options
The following table lists all the options available:
Table 3. Options of the monitorBpdIndexer script
Option Description Required
-help Displays information about the options, the attributes that can be queried, and the properties that must be set in the options file. No
-file filename Specifies the absolute path name of the option file that must contain the following properties:
  • host=<Process Federation Server host name>
  • port=<HTTPS server port>
  • user=<user with administrative role defined on the server>
  • password=<user password>
  • trustStoreFile=<name and path of the truststore for SSL connection with the server>
  • trustStoreType=<truststore type>
  • trustStorePassword=<truststore password>
 Yes
-id Specifies the unique indexer ID of the process indexer MBean that this script accesses remotely. 
This unique indexer ID can be retrieved with script listBpdIndexerUniqueIDs. Yes
-attribute
One attribute among:
  • status
  • currentDatabaseTime
  • scheduledChangeLogCompaction
  • scheduledSyncTasks
  • scheduledSyncInstances
  • scheduledSyncTaskDeletes
  • scheduledIndexLogTrim
  • nextScheduledChangeLogCompactionTime
  • nextScheduledSyncTasksTime
  • nextScheduledSyncInstancesTime
  • nextScheduledSyncTaskDeletesTime
  • nextScheduledIndexLogTrimTime
  • lastCyclesIndexerResults
  • numberIndexerFailures
  • lastKnownIndexerException
  • lastCycleIndexingRate
  • averageLastCyclesIndexingRates
  • federatedSystemInfo
  • federatedSystemDatabaseInfo
  • indexName
  • columnName
  • lastIndexedDocumentsRate
  • averageLastCyclesIndexedDocumentsRate
  • averageClaimedChangeLogEntriesDurations
  • averageFetchDataToIndexDurations
  • averageConsumedChangeLogEntriesDurations
Yes
-verbose Verbose output of the script execution. No
Using the monitorBpelIndexer script
You can use this script to retrieve the attributes value of a running BPEL indexer MBean.
Syntax
  • Linux/Unix: monitorBpelIndexer.sh -file optionsFile -id BPEL_uniqueIndexerID -attribute attributeName [-verbose]
  • Windows: monitorBpelIndexer.bat -file optionsFile -id BPEL_uniqueIndexerID -attribute attributeName [-verbose]
Options
The following table lists all the options available:
Table 4. Options of the monitorBpelIndexer script
Option Description Required
-help Displays information about the options, the attributes that can be queried, and the properties that must be set in the options file. No
-file filename Specifies the absolute path name of the option file that must contain the following properties:
  • host=<Process Federation Server host name>
  • port=<HTTPS server port>
  • user=<user with administrative role defined on the server>
  • password=<user password>
  • trustStoreFile=<name and path of the truststore for SSL connection with the server>
  • trustStoreType=<truststore type>
  • trustStorePassword=<truststore password>
 Yes
-id Specifies the unique indexer ID of the BPEL indexer MBean that this script accesses remotely. 
This unique indexer ID can be retrieved with script listBpellIndexerUniqueIDs. Yes
-attribute
One attribute among:
  • status
  • currentDatabaseTime
  • scheduledSyncTasks
  • scheduledIndexLogTrim
  • nextScheduledSyncTasksTime
  • nextScheduledIndexLogTrimTime
  • lastCyclesIndexerResults
  • numberIndexerFailures
  • lastKnownIndexerException
  • lastCycleIndexingRate
  • averageLastCyclesIndexingRates
  • federatedSystemInfo
  • federatedSystemDatabaseInfo
  • indexName
  • columnName
  • lastIndexedTasksRate
  • averageLastCyclesIndexedTasksRate
  • averageClaimedChangeLogEntriesDurations
  • averageFetchDataToIndexDurations
  • averageConsumedChangeLogEntriesDurations
Yes
-verbose Verbose output of the script execution. No
Using the controlBpdIndexer script
You can use this script to execute an operation or to modify the value of a read/write attribute of a BDP indexer MBean.
Syntax
  • Linux/Unix: controlBpdIndexer.sh -file optionsFile -id BPD_uniqueIndexerID -action actionName [-verbose]
  • Windows: controlBpdIndexer.bat -file optionsFile -id BPD_uniqueIndexerID -action actionName [-verbose]
Options
The following table lists all the options available:
Table 5. Options of the controlBpdIndexer script
Option Description Required
-help Displays information about the options, the attributes that can be queried, and the properties that must be set in the options file. No
-file filename Specifies the absolute path name of the option file that must contain the following properties:
  • host=<Process Federation Server host name>
  • port=<HTTPS server port>
  • user=<user with administrative role defined on the server>
  • password=<user password>
  • trustStoreFile=<name and path of the truststore for SSL connection with the server>
  • trustStoreType=<truststore type>
  • trustStorePassword=<truststore password>
 Yes
-id Specifies the unique indexer ID of the process indexer MBean that this script accesses remotely. 
This unique indexer ID can be retrieved with script listBpdIndexerUniqueIDs. Yes
-action
One action among:
  • runUnscheduledChangeLogCompaction
  • runUnscheduledSyncTasks
  • runUnscheduledSyncInstances
  • runUnscheduledSyncTaskDeletes
  • runUnscheduledIndexLogTrim
  • enableScheduledChangeLogCompaction
  • enableScheduledSyncTasks
  • enableScheduledSyncInstances
  • enableScheduledSyncTaskDeletes
  • enableScheduledIndexLogTrim
  • disableScheduledChangeLogCompaction
  • disableScheduledSyncTasks
  • disableScheduledSyncInstances
  • disableScheduledSyncTaskDeletes
  • disableScheduledIndexLogTrim
 Yes
-verbose Verbose output of the script execution. No
Using the controlBpelIndexer script
You can use this script to execute an operation or to modify the value of a read/write attribute of a BPEL indexer MBean.
Syntax
  • Linux/Unix: controlBpelIndexer.sh -file optionsFile -id BPEL_uniqueIndexerID -attribute attributeName
  • Windows: controlBpelIndexer.bat -file optionsFile -id BPEL_uniqueIndexerID -attribute attributeName
Options
The following table lists all the options available:
Table 6. Options of the controlBpelIndexer script
Option Description Required
-help Displays information about the options, the attributes that can be queried, and the properties that must be set in the options file. No
-file filename Specifies the absolute path name of the option file that must contain the following properties:
  • host=<Process Federation Server host name>
  • port=<HTTPS server port>
  • user=<user with administrative role defined on the server>
  • password=<user password>
  • trustStoreFile=<name and path of the truststore for SSL connection with the server>
  • trustStoreType=<truststore type>
  • trustStorePassword=<truststore password>
 Yes
-id Specifies the unique indexer ID of the BPEL indexer MBean that this script accesses remotely. 
This unique indexer ID can be retrieved with script listBpellIndexerUniqueIDs. Yes
-action
One action among:
  • runUnscheduledSyncTasks
  • runUnscheduledIndexLogTrim
  • enableScheduledSyncTasks
  • enableScheduledIndexLogTrim
  • disableScheduledSyncTasks
  • disableScheduledIndexLogTrim
 Yes
-verbose Verbose output of the script execution. No