Register

You can register and classify content in your collections on the IGS via the Register tab of the IGS Client Application.

Tell me about...

• The type of files that I can register using the IGS Client Application

  You can register normal (example: text files), archive (example: Microsoft Office files) or compressed (example: .zip or .rar files) files using the IGS Client Application. You can also register files of up to 500MB in size.

  You can register folders containing multiple files, as well as individual files and sub-folders.

  The IGS Client Application does not allow you to register:

  • allow listed items, as these need to be tightly controlled by the Compliance Officer
  • multiple occurrences of the same file (unless registered to different collections)

How do I...

• Add files for registration using the IGS Client Application?

  You can add files for registration by:

  • Clicking Add Files or Add Folders in the Register tab.
  • Dragging and dropping files or folders into the File pane in the center of the Register tab.
  • Right-clicking files on your desktop and selecting Register item(s) with IG Server from the shortcut menu. These files should appear in the File pane in the center of the Register tab.
  • Using the command line.

  After adding files and selecting a collection and classification for them, you need to click Register File(s) to register them on your IGS.

  The IGS does not store copies of any files you register. This means you should not delete your original files after registration.

  Ensure that the supplied content has been registered using the Registry Search feature. To access the Registry Search feature from the IGS Client Application, navigate to the Tools tab in the IG User Interface.

• Add files to a collection using the IGS Client Application?

  1. Go to the Register tab in the IGS Client Application.

  2. Select a collection from the Collection drop down menu.

     You are only able to add content to collections that you own on an IGS. This also applies for Compliance Officers. For security reasons Compliance Officers are only allowed to use their own collections in the IGS Client Application. To access all collections, Compliance Officers need to go to the IGS User Interface.

• Add a new collection using the IGS Client Application?

  1. Go to the Register tab in the IGS Client Application.

  2. Select Create New Collection from the Collection drop down menu.

     The New Collection Name: dialog is displayed.

  3. Enter the collection name and click Add.

  You can also create a new collection from the command line, if it does not exist when you attempt to register a file.

• Classify content using the IGS Client Application?

  1. Go to the Register tab in the IGS Client Application.

  2. Select a classification from the Classification drop down menu.

     Your IGS will be installed with default classifications but, depending on if the classification has been modified for your organization, these definitions might vary.

     Each organization should communicate their classification strategy to IGS Client Application users.

• Use the IGS Client Application from the command line?

  • To use the client as as Windows application, run the following command:

    igp-registry-client [--fileset <filename or folder> [<filename or folder>…]] [--collection <collection>] [--classification <classification>]

    where:

    --fileset <filename> is the name of a file or folder you want to add to the list for registration

    --collection <collection> is used to specify which collection is used. If this collection doesn't already exist on the IG Server, you will be prompted to create it.

    --classification <classification> is used to specify which classification is used. This collection must already exist on the IG Server.

    When a file is successfully registered with the IG Server, the client caches the collection and the classification that was used. If this file is subsequently re-registered, the user interface defaults to the saved collection and classification.

  • To use the client as a console application, run the following command:

    igp-registry-client --console [--assume-yes] --fileset <filename> [<filename>…] --collection <collection> [--classification <classification>] [--owner <domainuser>]

    where:

    --assume-yes configures the client to answer 'yes' to any prompts from the console.

    --fileset <filename> is the name of a file or folder you want to add to the list for registration

    --collection <collection> is used to specify which collection is used. If this collection doesn't already exist on the IG Server, you will be prompted to create it.

    --classification <classification> is used to specify which classification is used. This collection must already exist on the IG Server.

    --owner <domainuser> is the domain user that becomes the owner of any documents registered by a client that is run as a local system account. For example, this could be a client that is integrated with an external application, such as Microsoft File Server Resource Manager.

    Show me examples...

    • Example 1. Registering a single file

      I want to register a single file (c:\documents\secret\secret.docx) with a classification of 'secret' into the 'secret-files' collection.

      igp-registry-client --console [--assume-yes] --fileset c:\documents\secret\secret.docx --collection secret-files --classification secret

    • Example 2. Registering all files in a folder

      I want to register all the files in a folder (c:\documents\secret) with a classification of 'top secret' into the 'top-secret-files' collection.

      igp-registry-client --console [--assume-yes] --fileset c:\documents\secret --collection top-secret-files --classification "top secret"

    • Example 3. Registering a folder and separate files at the same time

      I want to register all the files in a folder (c:\documents\secret) with a classification of 'secret' into the 'secret-files' collection.

      I also want to register a single file in a separate folder (c:\documents\secret2\secret2.docx).

      igp-registry-client --console [--assume-yes] --fileset c:\documents\secret c:\documents\secret2\secret2.docx --collection secret-files --classification secret

• Complete tasks that are not possible using the IGS Client Application?

  The IGS Client Application cannot perform all tasks that are available in the IGS user interface. For example, you cannot view a collection, or modify or delete a registered document. To complete these tasks, you can navigate to your IGS by clicking IG User Interface in the Register tab.

• Integrate the IGS Client Application with the Windows File Server Resource Manager (FSRM)?

  For information on how to integrate the IGS Client Application with the FSRM, refer to the File Server Resource Manager (FSRM) Integration Guide.

See also...

• Activity