V11 SP8
Loading...

Configuring Settings for ContentStore Email Viewer Clients

Table of Contents

Enabling Real Time Communication for ContentStore Email Viewer Client Configurations

With ContentStore Email Viewer, administrators can send configurations to client computers using the ContentStore Command feature in the Search Admin page (see Configuring ContentStore Email Viewer Clients from the Search Admin Page). By enabling the real time communication option in the Proxy Server for ContentStore settings, configurations can be sent from the Search Admin page to connected ContentStore Email Viewer clients immediately.

Client Polling and Real Time Communication

By default, administrator configurations are not sent to ContentStore Email Viewer clients in real time. Instead clients communicate with, or poll, the Proxy Server at regular intervals to check for administrator configurations. When real time communication is enabled, clients that have Outlook Add-In with ContentStore Email Viewer running on their computer will receive configuration commands as soon as they are sent from the Search Admin page.

Real Time Connection Client Limit

The number of ContentStore Email Viewer clients that can be connected to the proxy server in real time depends on the Internet Information Services (IIS) connection limit on the computer where Proxy Server for ContentStore is configured. By default, the maximum number of clients that can be configured in real time is 30% of the IIS connection limit. If the number of clients using the proxy server is greater than this number, then the remaining clients will check with the Proxy Server for new configurations according to the polling interval set from the Search Admin page (see ContentStore Commands for the ContentStore Email Viewer).

To increase the number of clients that you want to connect in real time, see Microsoft's documentation for how to change the IIS connection limit.

Before You Begin

Procedure

  1. Log in to the Web Console client where Proxy Server for ContentStore is configured.
  2. Open Internet Information Services (IIS) Manager.
  3. Under Connections, expand Web Console client name > Sites > Consoles and click ProxySvc.
  4. Under Features View in the ASP.NET section, double-click Application Settings.
  5. Right-click the RTC_SUPPORT setting and click Edit.
  6. In the Edit Application Setting box, change the Value parameter to true and then click OK.
  7. Under Connections, right-click Consoles, point to Manage Website, and then click Restart.

Managing Configuration Commands for ContentStore Email Viewer Clients from the Search Admin Page

Administrators can configure ContentStore Email Viewer settings on client computers using the ContentStore Commands option in the Search Admin page.

Client Polling and Real Time Communication

By default, administrator configurations are not sent to ContentStore Email Viewer clients in real time. Instead clients communicate with, or poll, the Proxy Server at regular intervals to check for administrator configurations. When real time communication is enabled, clients that have Outlook Add-In with ContentStore Email Viewer running on their computer will receive configuration commands as soon as they are sent from the Search Admin page.

To send configurations to ContentStore Email Viewer clients in real time, you must have enabled real time communication on the Proxy Server for ContentStore. See Enabling Real Time Communication for ContentStore Email Viewer Client Configurations.

Before You Begin

Procedure

  1. In your web browser, enter the following URL to open the Search Admin page:

    http://ComplianceSearchURL/searchadmin

    Where ComplianceSearchURL is the name of the client where Compliance Search is installed.

  2. Log in using your credentials.
  3. Under Options, click ContentStore Commands.

    A table appears that contains a list of previously created configuration commands.

  4. To create or edit a configuration command:
    • To create a new configuration command, click Add.
    • To edit a previously created configuration, click the name of the configuration command and then click Edit.
  5. Under Basic Details:
    • In the Name box, enter a name for the configuration command. The name you enter appears in the list of configuration commands.
    • To add a description of the configuration command, in the Notes box enter some details about the configuration command.
  6. Under Select User or Group, select the users or user groups whose ContentStore Email Viewer you want to configure:
    • To send configurations to all users, select the Everyone check box.
    • To send configurations to select users or groups, enter the name of a user or group in the Group or User Names box.

      Note: To skip the auto suggestion feature and add a user immediately, enter the complete domain\username that you want to add and then press CTRL and Enter.

  7. Under Add Actions and Parameters, click the list and select the configuration that you want to perform. If the selected action requires additional parameters, click Select Parameters and supply the required information. See ContentStore Commands for the ContentStore Email Viewer.
  8. To add additional actions to the configuration command, click the add button (+) and select another action.
  9. Under Schedule:
    • To send the configuration command immediately, select Immediate.

      Note: Only new commands will be sent immediately after you save the command configurations. If you are editing a previously created command, then the Immediate option will not automatically send the configuration command to clients when you click Save. Edited configuration commands with Immediate selected must be sent manually from the list of ContentStore commands in the Search Admin interface. See Running a ContentStore Email Viewer Configuration Command.

    • To schedule the configuration command to be sent to clients automatically, select Schedule and define how often you want the configuration command to run using the schedule options that appear.
  10. Under Retention, select an option to retain the command setting:
    • Infinite Retention: The command will remain in your Search Admin page until you delete it.
    • Definite Retention: The command will remain in your Search Admin page for the specified number of days.
  11. After you have selected all of your configurations and parameters, click Save.

    The configuration appears in the list of ContentStore commands.

If real time communication is enabled on the Proxy Server, then configurations are sent to connected clients immediately. If real time communication is not enabled, then clients will poll the Proxy Server at regular intervals for new configurations.

Running a ContentStore Email Viewer Configuration Command

After you have created a ContentStore Email Viewer configuration command, you can send the configuration command on-demand to ContentStore Email Viewer clients from Search Admin page.

Note: If you created a configuration command with the Immediate schedule option selected, then you must perform this procedure to send the configuration command to the ContentStore Email Viewer clients. Immediate commands are only retained for 7 days in the recent commands list.

Before You Begin

You must have created a configuration command. For more information, see Managing Configuration Commands for ContentStore Email Viewer Clients from the Search Admin Page.

Procedure

  1. In your web browser, enter the following URL to open the Search Admin page:

    http://ComplianceSearchURL/searchadmin

    Where ComplianceSearchURL is the name of the client where Compliance Search is installed.

  2. Log in using your credentials.
  3. Under Options, click ContentStore Commands.

    A table appears that contains a list of previously created configuration commands.

  4. Click the configuration command that you want to run.

    The Command Details section appears, which contains information about the selected configuration command.

  5. To run the command, click the Run/Send Now button at the top of the page.

    In the Command Details section, the Runs table updates with the corresponding CommCell Job ID, status, and run time of the performed operation.

Using CVPConfigurationTool from the Command Line

Individual users can configure settings for ContentStore Email Viewer from Outlook (see ContentStore Email Viewer Settings). To change ContentStore Email Viewer settings for all of the users in your environment, use CVPConfigurationTool.

About This Task

  • Parameter names are case sensitive.
  • If you want to add values that contain a space, you must enclose the value in escaped quotation marks, \"<value>\".

    For example, the command to change the location of the Cache Directory to C:\my data\cache folder is:

    CVPConfigurationTool -setconfig "-CacheDir "C:\my data\cache folder\""

Procedure

  • On the command line, go to CVArchiverAddin (the installation directory for Outlook Add-In with ContentStore Email Viewer) and type the following command:

    CVPConfigurationTool -setconfig "-<parameter_name A> <new_value A> <parameter_name B> <new_value B>..."

    where:

    • parameter_name is the name of the parameter that you want to change
    • new_value is the value for the parameter that you want to change

    See ContentStore Email Viewer Parameters for parameter names and values.

ContentStore Email Viewer Parameters

The following table contains the list of ContentStore Email Viewer settings (Setting Name), their corresponding parameter name (Parameter Name) for the CVPConfigurationTool, and their possible values:

ContentStore Email Viewer Settings Setting Name Parameter Name Values
Display Name The name displayed in Outlook name Any user-defined name, for example, "Archived Emails". The default value is ContentStore.
General Settings tab Use Local Cache Mode EnableCaching True or False
Show only archived emails ShowStubsOnly True or False
Show mails from delegate mailbox ShowDelegatedEmail True or False
Synchronize every <n> minutes SyncUpInterval 1 to 60
Proxy Server Proxyserver URL of Proxy Server
Web Console Webconsole URL of Web Console
Offline Mode tab Sync only when connected to internal network SyncOnlyInInternalNetwork True or False
How many items to keep in the cache RetentionPeriodInMonths
  • 0 = All of the data
  • 3 = Last 3 Months
  • 6 = Last 6 Months
  • 12 = Last 12 Months
How many folders to show MaxOfflineFoldersCount Any integer
Stop sync when free space reaches <n>% FreeSpaceRatio 1%-100%
Cache Directory CacheDir
  • Full path to the directory
  • Path cannot contain special characters
Online Mode tab Max number of items in each folder MailsPerFolder Any integer
Max number of search results SearchMailCount Any integer
Default Search Language SearchingLanguage
  • ENGLISH
  • CHINESE SIMPLIFIED
  • CHINESE TRADITIONAL
  • JAPANESE
  • KOREAN