Running the bpm-db-cleanup Utility

No installation steps are required for bpm-db-cleanup. You can run the script, using ant, from any folder that it and any related files are located in.

Procedure

  1. Grant yourself, or the username that will be used, the permissions to perform a forced delete. The Force Delete option is only visible, and Force Delete enabled, if you have the necessary permissions. By default no user has the necessary permissions to use Force Delete. See the section "Permissions" in TIBCO ActiveMatrix Administration for information on setting these permissions in Administrator.
  2. Make sure that the BPM node is shutdown before running this tool. Not doing so may result in severe errors. This utility does NOT verify that the node is shutdown.
  3. Run the bpm-db-cleanup script using ant. This generates the SQL for the deployed process and database. You can specify configuration properties on the command line using the -D option. See BDS Global Data Cleanup and Attribute Alias Cleanup for details of the syntax to use in specific cases.
    If you do not do so, the script uses any configuration properties set in the build.xml file. For example:

    -Dapplication.name=findaddress -Ddb.type-=oracle

  4. Use the nodeutil utility to remove all components and endpoints for the application.
  5. Logon to the database as the BPM database user, for example amxbpm, and run the delete script generated.
  6. Startup the system.
  7. Logon to the ActiveMatrix Administrator and remove the application using a forced delete.
  8. Logon to the ActiveMatrix Administrator and remove the application template from the Software Management section.
  9. Since there can be large numbers of database rows for a single deployed process, the SQL generates stored procedures so that the deletion of rows can be done in batches, not generating too much work for the transaction and its rollback information.
    Warning: TIBCO recommends that you disable the Force Delete option once you have finished this procedure, by removing in Administrator the permissions granted in step 1.

What to do next

Running nodeutil on a user application that contains Business Data Services features may not remove the BDS features. Check if there are any remaining BDS features that belong to the user application being cleaned up, and if so, follow the instructions in Cleaning Up the Software Repository.

Next topic: BDS Global Data Cleanup