BPMSnapshotCleanup command

From a Process Center server, use the BPMSnapshotCleanup command to delete unused snapshots of a process application when they are obsolete or older than a specified snapshot.

The BPMSnapshotCleanup command is run using the AdminTask object of the wsadmin scripting client.

Prerequisites

Location

Start the wsadmin scripting client from the profile_root/bin directory.

Syntax

BPMSnapshotCleanup 
-containerAcronym process_application_acronym
[-containerSnapshotAcronyms process_application_snapshot_acronym]
-containerTrackAcronym track_acronym
[-keptNumber number_of_unnamed_snapshots_to_keep]
[-createdBeforeLocal local_time_on_the_server]
[-createdAfterLocal local_time_on_the_server]
[-createdBeforeSnapshotAcronym snapshot_acronym]
[-deleteArchivedSnapshot true|false]
[-ignoreDependency false]
[-outputFile output_file_name]

Parameters

You can delete unnamed snapshots and archived snapshots by using the same BPMSnapshotCleanup command with different parameters. You can also delete snapshots in batches for better performance.

-containerAcronym process_application_acronym

A required parameter that identifies the process application that contains the snapshots to be deleted. For example, the BillingDispute process application might have an acronym of BILLDISP.

Tip: If you do not know the acronym for a parameter, use the BPMShowProcessApplication command to list the details of a process application, including acronyms.

-containerTrackAcronym track_acronym

On a Process Center server, a required parameter that identifies the acronym of the track associated with the process application.

-containerSnapshotAcronyms process_application_snapshot_acronym

An optional parameter that identifies the acronyms for the set of archived snapshots to be deleted. You can specify a single snapshot acronym or a list of acronyms separated by spaces, for example, -containerSnapshotAcronyms [SS2.0.1 SS2.0.2]. If this parameter is specified, you cannot specify other filters, such as values for the keptNumber, createdBeforeLocal, createdAfterLocal, createdBeforeSnapshotAcronym, or deleteArchivedSnapshot parameters.

-keptNumber number_of_unnamed_snapshots_to_keep

An optional parameter that uses an integer to identify the number of unnamed snapshots to keep when a snapshot cleanup is run. The most recent snapshots are kept. The tip snapshot is not counted in keptNumber.

• If keptNumber is greater than or equal to the total number of unnamed snapshots, no snapshots are deleted.
• If keptNumber equals 0, all the unnamed snapshots are deleted except the tip snapshot.

The keptNumber parameter cannot be specified with the createdBeforeLocal or createdAfterLocal parameters.

-createdBeforeLocal local_time_on_the_server

An optional parameter that specifies a local time value in string format for filtering unnamed snapshots by the date they were created. Unnamed snapshots are deleted if they were created before the specified time. When createdBeforeLocal is used with the createdAfterLocal parameter, createdBeforeLocal deletes the set of snapshots that were created within the specified time period. The specified value can have a yyyy-MM-ddThh:mm:ss (year, month, day, T, hours, minutes, seconds) or yyyy-MM-dd string format.

-createdAfterLocal local_time_on_the_server

An optional parameter that specifies a local time value in string format for filtering unnamed snapshots by the date they were created. Unnamed snapshots that are created after the specified time are deleted. When createdAfterLocal is used with the createdBeforeLocal parameter, createdAfterLocal deletes the set of snapshots that were created within the specified time period. The specified value can have a yyyy-MM-ddThh:mm:ss (year, month, day, T, hours, minutes, seconds) or yyyy-MM-dd string format.

-createdBeforeSnapshotAcronym snapshot_acronym

An optional parameter that specifies the acronym of a named snapshot. Unnamed snapshots are deleted if they were created before the specified snapshot. When createdBeforeSnapshotAcronym is used with the keptNumber parameter, the number of snapshots that are specified is retained. When createdBeforeSnapshotAcronym is used with the createdBeforeLocal or createdAfterLocal parameters, createdBeforeSnapshotAcronym deletes the unnamed snapshots that were created between the time when the named snapshot was created and the time that is specified by the createdBeforeLocal or createdAfterLocal parameter.

-deleteArchivedSnapshot true|false

An optional parameter of the Boolean type that specifies whether the archived named snapshot is deleted with the snapshots that are identified by the filter parameters. If you set the value of deleteArchivedSnapshot to true, both archived and unnamed snapshots are deleted in one command. By default, deleteArchivedSnapshot is set to false.

When deleteArchivedSnapshot is set to true and is used with other filter parameters, such as keptNumber, createdBeforeLocal, createdAfterLocal, and createdBeforeSnapshotAcronym, both archived snapshots that match the conditions that are specified by the other filter parameters and the unnamed snapshots are deleted. Any archived named snapshot that is specified for the createdBeforeSnapshotAcronym parameter is also deleted.

-ignoreDependency false

An optional parameter of the Boolean type that specifies whether to delete snapshots that other project applications depend on. This parameter is set to false. Do not change the default value.

-outputFile file_path

An optional parameter that specifies the file path to write the log messages that result from running the command. The path to the file can be absolute or relative but the directory structure must already exist. If you do not provide this parameter, the message are written to the SystemOut.log file.