File Analysis Suite 3.8.2 Manage Help Center

# Holds

A hold is a way of protecting content indefinitely when it cannot be removed from the system according to the normal retention schedule. This might be the result of a number of actions such a legal preservation order, a pending investigation, or a regulatory request. Content that is on hold cannot be destroyed until the hold has been released.

A workspace may have multiple holds associated with it. A document cannot be deleted from File Analysis Suite until all holds from all workspaces are released.

For any documents placed on hold that have not been collected, collection and full processing are triggered at the time the hold is created. You can view the status of the collection on the Holds page for the workspace.

The Holds page is accessed from the HOLDS tab of the workspace artifacts panel on the workspace overview page. The artifacts panel provides a quick view of active holds and provides access to the Holds page for more detailed information and to take action. On the Holds page, use the filter above the list of holds to show all holds or holds with the desired status. Click in the row for an individual hold to reveal action icons

Open the detail panel () for a selected hold to take action and to see the responsible person, the date the hold was created, the number of documents on hold relative to the number of documents in the workspace, and collection details for the documents on hold.

TIP: You have access to features and functions based on your assigned permissions. You will only see features and functions that have been enabled for the workspace you are viewing and that you have permission to see.

To create a hold

1. On the workspace Overview page, click the HOLDS tab of the workspace artifacts panel and then do one of the following.

   - Click NEW HOLD.

   - Click MANAGE HOLDS. On the resulting Holds page, click NEW HOLD.

   The New Hold dialog box opens.

2. Complete the details for the new hold.

   Option | Description
   --- | ---
   Hold name | Type a meaningful, unique name for the new hold. Limits: Maximum 50 characters.
   Description | Type a meaningful description for the new hold. Limits: Maximum 250 characters.
   Responsible person | Type the user name of the person who will be responsible for this hold. As you type, suggestions display. Click the desired user to select it. Defaults to the user creating the hold. To change to a different user, delete the default entry and then add the name of the desired user. Limits: Only one responsible person can be defined.

   A summary indicates the number of documents selected, number of families (if applicable), and the number of items to be placed on hold.

3. Click CREATE.

   The hold is created and is available for actions to put documents on hold.

To apply a hold to all documents within a workbook

1. On the Workbooks page within a workspace, click the row for the desired workbook and then click the open detail panel icon ().

2. In the workbook detail panel, click ACTIVITY.

   The available actions and workbook action activity history display.

3. In the FILE ACTIONS section, click Hold .

   The Add Items to a Hold dialog opens.

4. Do one of the following:

   - To apply an existing hold, click the desired hold name. Only active holds display.

   - To create a new hold, click NEW HOLD.

     1. In the New Hold dialog, complete the options for the new hold.

        Option | Description
        --- | ---
        Hold name | Type a meaningful, unique name for the new hold. Limits: Maximum 50 characters.
        Description | Type a meaningful description for the new hold. Limits: Maximum 250 characters.
        Responsible person | Type the user name of the person who will be responsible for this hold. As you type, suggestions display. Click the desired user to select it. Defaults to the user creating the hold. To change to a different user, delete the default entry and then add the name of the desired user. Limits: Only one responsible person can be defined.

     2. Click CREATE.

        The new hold is created and now displays in the list of holds.

     3. Click the name of the new hold to select it.

5. Click APPLY.

   The hold process begins. The hold action displays in the history on the ACTIVITY tab of the workbook detail panel.

   You can view the progress of the hold in the detail panel and in the workbook list for the workspace.

To apply a hold to documents in the document list

1. When viewing a document list, do one of the following.

   - To add all documents in the list to a workbook, click Manage > Add all to Hold in the action ribbon.

   - To add selected documents in the list to a workbook, select the desired documents and then click Manage > Add selected to Hold in the action ribbon.

     TIP: To select multiple documents, use shift+click to select consecutive documents or ctrl+click to select non-consecutive documents.

   The Add Items to a Hold dialog opens.

2. Do one of the following:

   - To apply an existing hold, click the desired hold name. Only active holds display.

   - To create a new hold, click NEW HOLD.

     1. In the New Hold dialog, complete the options for the new hold.

        Option | Description
        --- | ---
        Hold name | Type a meaningful, unique name for the new hold. Limits: Maximum 50 characters.
        Description | Type a meaningful description for the new hold. Limits: Maximum 250 characters.
        Responsible person | Type the user name of the person who will be responsible for this hold. As you type, suggestions display. Click the desired user to select it. Defaults to the user creating the hold. To change to a different user, delete the default entry and then add the name of the desired user. Limits: Only one responsible person can be defined.

     2. Click CREATE.

        The new hold is created and now displays in the list of holds.

     3. Click the name of the new hold to select it.

3. Click APPLY.

   The hold is applied to the items in the current document list.

To edit a hold

1. On the workspace Overview page, click the HOLDS tab of the workspace artifacts panel and then click MANAGE HOLDS.

2. On the Holds page, click or hover over an active hold (status is On Hold) and then click the edit icon ().

   TIP: You can also click in the row for the desired active hold, open the detail panel (), and then click EDIT.

   The Edit Hold dialog opens

3. Edit the hold information as desired.

   NOTE: Note: If you change the Hold name, it must be unique. Duplicate Hold names are not allowed within the same workspace.

4. Click OK.

   The hold is updated.

To release a hold

Releasing a hold maintains the data and frees it from its retention hold.

1. On the workspace Overview page, click the HOLDS tab of the workspace artifacts panel and then click MANAGE HOLDS.

2. On the Holds page, click or hover over an active hold (status is On Hold or Release Failed) and then click the release hold icon ().

   TIP: You can also click in the row for the desired active hold, open the detail panel (), and then click RELEASE HOLD.

3. In the confirmation dialog, click YES to confirm the action.

   The hold is released. For documents that were placed on hold and then protected, the pre-protection version of the document is removed from File Analysis Suite when the hold is released.

To request an export from a hold

1. On the workspace overview page, click the HOLDS tab of the workspace artifacts panel and then click MANAGE HOLDS.

2. On the Holds page, click or hover over an active hold (status is On Hold or Release Failed) and then click the export icon ().

   TIP: You can also click in the row for the desired active hold, open the detail panel (), and then click EXPORT.

   NOTE: The export function is disabled under the following conditions:

   - The selected hold has been released.

   - The hold was created, but has not been applied to any documents.

   The Export dialog opens.

1. Select an export location. Do one of the following:

   - To export content to an existing export location, select the desired location. If a single export location exists, this location is selected automatically.

   - To export content to a new export location, click NEW EXPORT LOCATION.

     1. In the New Export Location dialog, complete the options for the new export location.

        Option | Description
        --- | ---
        Name | Type a unique, meaningful name of the new export location. This becomes the name of the folder within the designated FTP resource. Limits: Maximum 50 characters. Cannot contain the `\ / : * ? " < > | .` special characters.
        Description | Type a meaningful description for the workspace template. Limits: Maximum 250 characters.
        Max number of items per output volume | Enter the maximum number of items to be exported per output volume. Additional volumes are created if the maximum is reached. Default: 100000 Limits: whole numbers between 100 and 100000

     2. Click CREATE.

        The new export location is created and is selected as the Export Location.

2. Specify the Content Selection handling option:

   1. To select remaining or new items since the previous export, select Export remaining items. This is an incremental export, and only net new items since the last export are included.

   2. To select all items, select All Items. All documents associated with the hold are exported, regardless of whether they were already in a previous export.

3. To export the family parent only, select Export top-level documents only. Clear the Export top-level documents only to export all documents contained in the family.

   A count of the items to be exported is displayed.

4. Click EXPORT.

   The new export is created.

   NOTE: It may take some time for the export to complete, depending on the number of items in the workbook or hold.

5. When the export is complete, you can download the contents from the FTP location. For documents that were placed on hold and then protected, the pre-protection version of the document is exported.

   For more information, see Download content exports.

To view the documents associated with a hold

Do either of the following to view all documents associated with a hold.

- On the workspace Overview page, click the HOLDS tab of the workspace artifacts panel.

  Hover over or click in the row for the desired hold and then click the view contents icon () that displays in the right column.

- On the workspace overview page, click the HOLDS tab of the workspace artifacts panel and then click MANAGE HOLDS.

  On the Holds page, do any of the following

  - Hover over or click in the row for the desired hold and then click the view contents icon () that displays in the right column.

  - Click in the row for the desired hold . Open the detail panel () and click VIEW CONTENTS.

  - Click in the row for the desired hold . Open the detail panel () and click the bar chart for the documents on hold.

The Content tab opens and displays the list of documents on hold in the context of the workspace. If a document was placed on hold and then protected, you will not see the content of the document.

© Copyright 2019-2023 Micro Focus or one of its affiliates
Version 3.8.2 | Last updated January 2023
Connect
Micro Focus Marketplace
Learn
Support portal
Documentation
Contact

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to FAS.docFeedback@microfocus.com.

We appreciate your feedback!

Product: File Analysis Suite 3.8.2

Topic Title: Holds

Submit or view service request