You can remove a disposition hold placed on an entity to
restart execution of its disposition schedule.
Remove a disposition hold using the Hold Sweep tool. The Hold Sweep
tool can be run using a command line, or manually.
- Remove disposition holds that were placed on entities by Hold
Sweep by initiating a remove hold request and running Hold Sweep.
- Remove holds through a command line by specifying particular holds
or, for special circumstances, by forcing the removal of all holds.
- Manually remove holds that were placed manually, as described
in the placing entities on hold topic.
To determine the type of hold on an entity, browse to the entity,
right-click, select Get Info, and click
Holds. If the
IsDynamic value is
False, the hold is manual, and you can remove the hold manually or through
the command line. If the value is
True, the
hold was placed by Hold Sweep. The only way you can remove the hold
is by running Hold sweep.
Remove manual holds
To remove a hold using
the information page of the entity:
- Go to the entity from which you want to remove the disposition
hold.
- Click its Get Info icon.
- Click Holds in the first section of the
panel.
- Select the check boxes of any holds you want to remove.
- Click Remove Hold.
- Click OK on the confirmation page.
To remove a hold using the information page of the hold:
- Select the Disposition tab.
- Click Holds:

- Click the Get Info icon of the hold you
want to remove.
- Click Entities on Hold in the panel.
- If necessary, filter the entities that are displayed in the Entities on Hold page by entering search criteria and
clicking Search. For details about filtering
the entities, see the entities on hold topics.
- You can change the set of properties for which to enter search
criteria by clicking Change.
- In the Property Criteria Settings page, specify
up to seven properties and an operator for each property, and click Accept Changes.
- To perform a new search, enter the search criteria and click Search.
- Select the check boxes of the entities from which you want to
remove the hold.
- Click Remove Hold.
- Click OK on the confirmation page.
If you cannot remove a manual hold
If you
cannot remove a hold manually, then the hold is probably applied by
Hold Sweep. Hold Sweep can take over a manually applied hold if the
conditions of the hold are met by the entity. In that case, you can
remove conditional holds as mention in the following section.
Remove conditional holds using Hold Sweep
You can remove conditional holds by initiating a hold request, and
running Hold Sweep. Generally, run the scheduled Hold Sweep when system
usage is low.
After you request removal of the holds in the
next Hold Sweep run, you can still cancel this request before the
next Hold Sweep runs. After Hold Sweep removes a conditional hold
on an entity, the entity receives a flag that tells Hold Sweep not
to put it on hold again. If you do want to put it on hold again, you
can reactivate it for hold processing.
Initiate a Remove Hold Request
To initiate
a Remove Hold Request:
- Select the Disposition tab.
- Click Holds.
- Right-click the hold and select Initiate Remove Hold
Request. The Remove Hold Request page asks if you want to remove this hold from associated entities
in the next hold sweep run.
- Click Accept to remove the hold or Exit to close without initiating the request.
Cancel a remove hold request
After you set
a remove hold request, you can cancel it before the next Hold Sweep
run. This way the entities remain or are placed on hold again. To
cancel the remove hold request:
- Select the Disposition tab.
- Click Holds.
- Right-click the hold and select Cancel Remove Hold
Request. The Cancel Remove Hold Request page asks if you want to cancel the Remove Hold Request.
- Click Accept to cancel or click Exit to keep the remove hold request.
Reactivate a hold request
After you select Cancel Remove Hold Request and run Hold Sweep, you see Activate for Hold Sweep Processing in the hold menu.
Selecting this option sets the hold to be processed during the next
Hold Sweep. This option is also the way you put an entity back on
conditional hold during the next Hold Sweep run.
Use a command to remove holds immediately
An alternative to the Request Remove Hold mechanism
is to use the -ForceRemoveHold Hold Sweep command
line. When you remove holds this way, the remove hold applies whether
the hold is active or inactive. The remove hold applies whether the
holds were applied manually or by Hold Sweep. In the second case,
you must specify the removal in the command. You cannot specify the
removal by setting up the Object store name and hold names or GUIDs
in the configure screen.
- -Objectstore "objectstorename": If the object store name uses extended characters,
use the GUID instead of the object store name.
- -ForceRemoveHold "hold
list or GUIDs": Each Hold Sweep takes the Object
Store and hold list from the command line rather than the configuration
user interface. This condition is true if you are using a default
configuration, not using -profile, or a specific
profile, using -profile. Each hold name or GUID
is separated by a pipe symbol (|), each string of holds is enclosed
in quotation marks ('' "). The limit of five holds applies in command
mode as well. If the hold name uses extended characters, use the GUID
instead of the hold name.
- -profile "profile name": The -profile parameter is an
optional parameter that allows you to define more than one configuration.
When it is not used, the default profile is used. The command is intended
to be used during the normal sweep process, -HoldSweep -profile "profile name". The -profile command is supported by -ForceRemoveHold. The -profile parameter
must be added to the end of the command line. When the -profile parameter is used, the -ForceRemoveHold option
uses only the server name and login credentials specified in the profile.
However, the option uses the hold lists specified in the command line
and ignore the lists that are specified in the profile.
Windows
RecordsManagerSweep.bat -HoldSweep -ObjectStore "objectstorename" -ForceRemoveHold "Hold1|Hold2|{E4F6F8F9-4E1A-4762-B062-344980B2B92}" [-profile "profile name"]
AIX, HP-UX, Linux, and Solaris
./RecordsManagerSweep.sh -HoldSweep -ObjectStore "objectstorename" -ForceRemoveHold "Hold1|Hold2|{E4F6F8F9-4E1A-4762-B062-344980B2B92}" [-profile "profile name"]
Force removal of all holds
Alternatively,
you can use the -All option with -ForceRemoveHold to remove all holds across the entire object store. This option
removes all holds regardless of whether they are active or inactive
or whether they are conditional or manual. This option would be used
only for a special purpose.
RecordsManagerSweep.bat -HoldSweep -ObjectStore "objectstorename" -ForceRemoveHold -All [-profile "profile name"]
Removing holds on empty containers
Removing
a hold from empty containers can cause the Conditions information
page of the hold to become read only. This condition happens if you:
- Use the -ForceRemoveHold option at the command
line
- Select Initiate Remove Hold Request on the menu of the hold and
then run Hold Sweep
Either of these scenarios causes the hold to become inactive
for Hold Sweep processing. You must activate the hold by selecting
Activate for Hold Sweep Processing from the menu of the hold.