IBM BPM, V8.0.1, All platforms > Administer the IT infrastructure > Manage Business Performance Data Warehouses
Use the Performance Data Warehouse command-line tool
To ensure that performance databases are performing optimally, use the command-line tool to resolve any pending records. When you run the command available with the tool, it generates an SQL script that you can use to make the appropriate database changes.
You can run the resulting SQL scripts using the database application appropriate for your environment or you can use the execute argument included with the command-line tool.
To use the command-line tool, go to the following directory: INSTALL_ROOT\BPM\Lombardi\tools\perfdw-tool
The syntax for invoking the command-line tool is:
perfDWTool[.cmd or .sh] -u [user_name] -p [password] command-name -[command-arg] [-groups tracking-group-name-1 tracking-group-name-2 ...]
In addition to user name and password, which are required, the tool includes the following options:
| Option | Action |
|---|---|
| -?, -help | Displays information about the options, commands, and arguments available with this command-line tool. |
| -u, -username | Specifies the user name for connecting to the Performance Data Warehouse. You must include this option each time you invoke the tool. |
| -p, -password | Specifies the password for connecting to the Performance Data Warehouse. You must include this option each time you invoke the tool. |
| -profileName | Specifies the name of the profile for the Performance Data Warehouse to which you want to connect.
|
| -nodeName | Specifies the node name to use if the Performance Data Warehouse is installed in a ND environment. |
| -serverName | Specifies the server name to use if the Performance Data Warehouse is installed in a ND environment. |
This option is not supported on IBM BPM for z/OS .
The tool includes the following commands:
| Command | Action |
|---|---|
| archive | Archives the snapshots that you specify and marks all the metadata in those snapshots with an ARCHIVED timestamp. IBM BPM does not use archived metadata when generating Performance Data Warehouse schema and views. To specify snapshots, use the ID for each snapshot from the SNAPSHOTS view in the performance database. (See "Performance Data Warehouse database architecture" in the "Measuring and improving business processes" topics for more information.) |
| restore | Restores the snapshots that you specify by nulling out the ARCHIVED timestamp and allowing the snapshots' metadata to contribute to the Performance Data Warehouse physical schema and views. To specify snapshots, use the ID for each snapshot from the SNAPSHOTS view in the performance database. (See "Performance Data Warehouse database architecture" in the "Measuring and improving business processes" topics for more information.) |
| pending | Identifies failed definition records and resolves their pending state. Also enables you to review and then commit pending schema changes from the archive and restore commands. |
The following arguments are available for use with the pending command:
The archive and restore commands leave the system with pending representation actions, so use the pending command to either preview or complete the schema changes.
| Argument | Action |
|---|---|
| -preview | Generates a preview of the SQL script generated as a result of the invoked command. No changes are made to the database. |
| -prepare | Generates a preview of the SQL script and prepares the database for the pending actions. |
| -execute | Invokes the command without providing a preview
SQL script.
Use the -execute argument with extreme caution. It is run when the Performance Data Warehouse is running (online), without the ability to review the SQL script before its start. If the scope of changes is complex there is a chance of data loss because during the running of the command, data might become out of sync, and this might cause a failure from which the system is not be able to recover. |
Use the optional -groups attribute to specify individual tracking groups. This attribute is useful when the scope of changes to your tracked performance data is limited to known tracking groups. If you do not specify tracking groups, all groups in the database are processed when the command is run.
Before running a command
Before running a command, complete the following:
- Ensure that you have installed or upgraded your Performance Data Warehouses to the latest version of IBM BPM.
- Start the Performance Data Warehouse. If you are running in a clustered environment, ensure that all servers in the cluster are running.
- Create a backup of the performance database.
- Go to the following directory: INSTALL_ROOT\BPM\Lombardi\tools\perfdw-tool
Use the archive command
You can invoke the archive command as shown in the following example:
perfDWTool.cmd -u [user_name] -p [password] archive [snapshot-id-1 snapshot-id-2 ...]
Where [snapshot-id] is the SNAPSHOT_ID for each snapshot from the SNAPSHOTS view in the Performance Data Warehouse database. See "Performance Data Warehouse database architecture" in the "Measuring and improving business processes" topics for more information.
Use the pending command to complete the archive. You can use the pending command with the -preview argument to review the changes before completing them. Or, you can simply start the archive using the pending command with the -execute argument.
Use the restore command
You can invoke the restore command as shown in the following example:
perfDWTool.cmd -u [user_name] -p [password] restore [snapshot-id-1 snapshot-id-2 ...]
Where [snapshot-id] is the SNAPSHOT_ID for each snapshot from the SNAPSHOTS view in the Performance Data Warehouse database. See "Performance Data Warehouse database architecture" in the "Measuring and improving business processes" topics for more information.
Use the pending command to complete the restore. You can use the pending command with the -preview argument to review the changes before completing them. Or, you can simply run the restore using the pending command with the -execute argument.
Use the pending command
To invoke the pending command with the -preview argument:
-
Run the pending -preview command against the performance database as shown in the following example:
perfDWTool.cmd -u [user_name] -p [password] pending -preview c:\temp\PS_pending_script.sql
- Review the SQL script that was saved to the specified output file (c:\temp\PS_pending_script.sql).
To invoke the pending command with the -prepare argument:
-
Run the pending -prepare command against the performance database as shown in the following example:
perfDWTool.cmd -u [user_name] -p [password] pending -prepare c:\temp\PS_pending_script.sql
The command-line tool creates the SQL script and prepares to move the pending records to the database. During this time, data loading is disabled until the pending actions are complete.
- Stop all Performance Data Warehouses.
- Review the SQL script that was saved to the specified output file (c:\temp\PS_pending_script.sql).
-
Run the SQL script against the performance database using the database maintenance tool of your choice.
The pending records are added to the database.
- Restart all Performance Data Warehouses.
Use the pending -execute command only in a development environment where potential data loss is not a concern.
To invoke the pending command with the -execute argument:
-
Run the pending -execute command against the performance database as shown in the following example:
perfDWTool.cmd -u [user_name] -p [password] pending -execute
The command-line tool runs the SQL script against the performance database so that tracked data records that were in a pending state are successfully transferred to the database.