When you launch the utility from a command prompt with the -h parameter, a list of valid parameters are listed in the command window. Keep in mind these guidelines:
Each parameter must be separated by a space.
If a parameter takes a value, it should not be separated by a space. For example, -d05/08 passes a date.
Commands are not case sensitive.
To launch the utility in a command window, see Using the Transaction History Purge Utility in a Command Window.
The following table describes each parameter available in the command window:
| Parameter | Description |
|---|---|
| -a<n> | Specifies a minimum age to delete, where <n> is an integer number of days.
The maximum value allowed is 100. If you enter a value greater than 100, an error is logged. |
| -d<d> | Specifies a maximum date, where <d> represents the date. The date format should follow the format in the Regional Settings in the Control Panel. The year is not necessary if it is the same as the current year. However, you must specify the month and day. For example, if the current year is 2008, then 9/8 and 09/08 would represent September 8, 2008. |
| -np | Suppresses all prompts. |
| -h | Displays parameters help. |
| -u | Specifies the user name. |
| -p | Specifies the password. |
You can use multiple parameters to complete the process. Examples of commands are listed below:
| Command | Description |
|---|---|
| database_cleanup_utility -u<user> -p<password> | Specifies the user name and password. Every command line execution of the utility requires a user name and password, except the -h command to access the utility help text. |
| database_cleanup_utility -np | Deletes all applicable transaction with no prompts. |
| database_cleanup_utility -d04/08 | Deletes applicable transactions dated on or before April 8th of the current year. |
| database_cleanup_utility -d04/08/2005 | Deletes applicable transactions dated on or before April 8th of 2005 (the year must be specified if the date does not fall within the current year). |
| database_cleanup_utility -a50 | Deletes applicable transactions older than 50 days. |
| database_cleanup_utility -h | Displays the help text. |
|
Note: |
When running the utility on a command line, any errors that occur will display an Exit Code message. |
The following exit codes can be displayed in the command line. The following table lists the exit code, the associated number that displays for the code in the command line, and a description.
| Exit Code | Associated Number | Description |
|---|---|---|
| Success | 0 | The command ran successfully. |
| Input Errors | 1 | The command line parameter that you used is invalid. |
| Configuration File Error | 2 | Problem with the BPMA_Server_Config.xml file. For example, BPMA_Server_Config.xml must be in the same directory as this utility, otherwise an error occurs. Though this file is not needed for database connection information, it still must be present. |
| Connection Failure | 3 | Connection problem accessing the database. |
| Hyperion EPMA Server Not Running | 4 | You must start the Hyperion EPMA Server before launching the Transaction History Purge Utility. See Using the Transaction History Purge Utility in a Command Window for information on starting the Hyperion EPMA Server using a command line. |
| Unknown Error | 5 | Contact Oracle Support. |
| SQL Error | 6 | An error occurred while attempting to run the purge against the database. |
|
Note: |
If you experience problems with the Transaction History Purge Utility timing out, you can increase the value of the CommandTimeout setting. The default timeout is 900 seconds. You can modify the timeout setting in the BPMA_Server_Config.xml file. See the Data_Access_Layer setting in Configuration Settings in BPMA_Server_Config.xml. |