icon-unified.svg
Experience Center

Creating an Indexed Document Match Template

Using the Index Tool, you can create, modify, or delete an Indexed Document Match (IDM) index template.

You can create up to 64 IDM templates for your organization. The largest file you can upload to an IDM template is 400 MB. You can index up to 100 GB of files for your organization.

Creating an IDM Template

You can create manual or scheduled IDM templates:

  • Manual IDM Templates: A manual IDM template allows you to manually upload your organization’s critical documents.
  • Scheduled IDM Templates: A scheduled IDM template allows you to set up an SSH connection and schedule updates between the template and your organization’s storage server for the critical documents.

To create an IDM template:

  1. Go to https://<IP Address of the Index Tool VM> to access the Index Tool. Log in to the Index Tool with your Admin Portal login credentials.

  1. Click Indexed Document Match Templates.
  2. In the Indexed Document Match Templates dashboard, click Create New Template and then click one of the following:
  • When you first create a new manual IDM template, you can only upload one file. Once you save the template, you can edit the template to add more files.

    In the Manual Indexed Document Match Template window:

    1. Enter a Template Name. After the template is saved, this name appears in the Indexed Document Match page in the Admin Portal.
    2. Click Upload File.

    The Select File window appears.

    1. Drag and drop a file into the window or click Choose File to select a file.
    2. Click Upload.

    1. Click Save.
    Close
  • When you create a scheduled IDM template, you must set up an SSH connection between the template and your organization’s document server. You must then schedule regular updates between the template and server.

    In the Scheduled Indexed Document Match Template window:

    1. Under General:
      1. Enter a Template Name. After the template is saved, this name appears in the Indexed Document Match page in the Admin Portal.
      2. For Host, enter the IP address or domain for the document server.
      3. Specify the Port for the document server.
      4. Specify the File Path for the directory where the documents are located in the document server.

    1. Under SSH Configuration:
      1. Click Download to download the SSH key.
      2. Copy the username. You will use this username to create a user in your document server.
      3. Go to your document server and complete the following steps:
        1. Create a user with the username you copied from the Index Tool.
        2. Add the downloaded SSH key to the user’s trusted keys.
        3. Ensure that the user has read access to the directory in the specified file path.
      4. Click Verify in the template to verify the SSH setup configuration. You cannot save the template until the setup is configured properly and verified.

    1. Under Schedule:
      1. Repeat: Choose if the update will repeat Monthly, Weekly, or Daily.
      2. Every: If you selected Monthly or Weekly, choose when in the selected period the update will repeat. For example, if you selected Weekly, you can choose to have the update happen every Friday.
      3. Time: Select what time the schedule update will happen on.
      4. Time Zone: Select the time zone your update will happen in.
      5. Update Now: Select to immediately update the template.

    1. (Optional) Enter a Description for the template.
    2. Click Save.
    Close

After saving the template, you are redirected to the Indexed Document Match Template dashboard, and the tool will process the template. If the template was created properly, Completed is shown in the Status column. If the template was created, but the documents weren’t indexed yet, then Created is shown. If the template was not created properly, then Error is shown.

Once an IDM template is created, it appears on the Indexed Document Match page of the Admin Portal, where you can view the template’s details or delete it. You cannot change the template name after creation. In order to change the name, you must create a new template.

Modifying an IDM Template

You can submit new documents or delete indexed documents for manual IDM templates in the Index Tool.

In order to submit new documents or delete indexed documents for scheduled IDM templates, you must make the changes in the document server. The template will update at the scheduled time, or you can schedule an immediate update for the template in the Index Tool. To reschedule a scheduled template's update, click the Calendar icon in the Actions column.

To modify a manual IDM template:

  1. Log in to the Index Tool.
  2. In the Indexed Document Match Templates dashboard, locate the manual template you want to modify.

In the Template Name column, you can click the Search icon to search for a specific template.

  1. In the Actions column, click the Edit icon.

  1. In the Manual Indexed Document Match Template:
    • If you need to submit a new document for the template, click Upload File. In the window that appears, drag and drop the file into the window or click Browse to select the file.
    • If you need to delete a document from the template, locate the document in the table and click the Delete icon.

In the File Name column, you can click the Search icon to search for a specific file.

  1. Click Save.

Deleting an IDM Template

To delete a manual or scheduled IDM template:

  1. Log in to the Index Tool.
  2. In the Indexed Document Match Templates dashboard, locate the template you want to remove.

In the Template Name column, you can click the Search icon to search for a specific template.

  1. In the Actions column, click the Delete icon.
  2. In the confirmation window that appears, click Delete.

You can also delete the IDM template from the Admin Portal:

  1. Go to Policies > Data Protection > Common Resources > Index Templates.
  2. In the Indexed Document Match tab, locate the template you want to remove.
  3. Click the Delete icon.

  1. In the confirmation window that appears, click OK.
Related Articles
About Indexed Document MatchCreating an Indexed Document Match TemplateDefining IDM Match Accuracy for Custom DLP Dictionaries