Enterprise Vault™ Using the Enterprise Vault Analytics Connector
Creating the Analytics Connector configuration file
A single instance of the configuration file, CrawlerPluginsSettings.xml, holds the configuration for all of the Analytics Connectors in the Enterprise Vault site. If you have implemented a customized version of the Analytics Connector, such as the TrustSphere Relationship Analytics Connector, then the configuration file will already exist. You add a new <plugin> element in the file for each new Analytics Connector instance that you want to configure.
If you have not already implemented any versions of the Enterprise Vault Analytics Connector, then you need to create the configuration file, and place it in the location described in this section.
An example of the connector configuration file is located in the folder, Enterprise_Vault_program_folder\InitialConfigurationData. You can copy and edit this example file for your own environment. The file name must be CrawlerPluginsSettings.xml.
To ensure that the configuration file is available to all Enterprise Vault servers in the site, do the following:
Copy the file to the Enterprise Vault server that is identified by the site alias.
In the Enterprise Vault Administration Console, the Vault site alias is displayed on the General tab of the site properties. Check in DNS to find out which Enterprise Vault server the site alias identifies.
On that server, copy the configuration file to the following folder:
\\EV_site_alias_server\EVCache$\CrawlerPlugins. You may have to create the folder,CrawlerPlugins.
Below is the example configuration file contents. Table: XML elements in the connector configuration file describes the XML elements in the file.
<?xml version="1.0" encoding="utf-8" ?>
<!--
' <copyright text>
-->
<plugins>
<!--Enterprise Vault Analytics Connector plug-in -->
<plugin>
<!--(mandatory) The COM prog id for the plug-in -->
<progid>EnterpriseVault.AnalyticsConnector</progid>
<!--(mandatory) A unique id for the plug-in -->
<uniqueid>811B563D-8466-49FB-B651-C8B0BB6DE343</uniqueid>
<!--(optional) If omitted items are only processed once by the plug-in -->
<onlyonceperitem>false</onlyonceperitem>
<!--List of archives to process. To enable the plug-in, either an archiveid
or an archive type needs to be specified -->
<archives>
<!--(optional) If omitted archiveid is not considered -->
<archiveid>17BDD1CB0AE94AA48AC4EC9DE9152ADD01110000EVSRV</archiveid>
<!--(optional) Wildcard '*' enables all archives -->
<archiveid>*</archiveid>
<!--(optional) If omitted, archive type is not considered -->
<!--Possible archive types:
ARCHIVE_TYPE_SHARED
ARCHIVE_TYPE_MAILBOX
ARCHIVE_TYPE_JOURNAL
ARCHIVE_TYPE_PUBLIC_FOLDER
ARCHIVE_TYPE_FILE_SYSTEM
ARCHIVE_TYPE_SHAREPOINT
ARCHIVE_TYPE_DOMINO_JOURNAL
ARCHIVE_TYPE_DOMINO_MAILBOX
ARCHIVE_TYPE_SMTP
ARCHIVE_TYPE_INTERNETMAIL
-->
<archivetype>ARCHIVE_TYPE_SHARED</archivetype>
<archivetype>ARCHIVE_TYPE_JOURNAL</archivetype>
</archives>
<!--Only the settings section is passed to the plug-in -->
<settings>
<!--(mandatory) The directory must exist -->
<outputdirectory>C:\AnalyticsConnector</outputdirectory>
<!--(mandatory) Requested indexing properties -->
<properties>auea,rtea,subj,Vault.MsgType,Vault.MsgDirection,
date,archiveid, evtag.category</properties>
</settings>
</plugin>
</plugins>Table: XML elements in the connector configuration file lists the elements in the connector configuration file.
Table: XML elements in the connector configuration file
XML element | Mandatory or optional | Description |
|---|---|---|
<plugins> | Mandatory | Defines all of the Analytics Connectors in the site. |
<plugin> | Mandatory | Each connector instance has a separate <plugin> element. This element contains all of the configuration for the connector instance. |
<progid> | Mandatory | The COM program ID for the connector. The value of this element is EnterpriseVault.AnalyticsConnector for the connector that is shipped in Enterprise Vault. If there are several instances of the connector, the <progid> value can be the same, but you must give each connector instance a different value for the <uniqueid> element. |
<uniqueid> | Mandatory | Enter a globally unique ID (GUID) for the connector instance. You can obtain GUIDs from the Internet. |
<onlyonceperitem> | Optional | If set to true, and the connector request for an item's metadata is successful, the Storage Crawler records this in the vault store database, and does not reprocess the item, even if the index is rebuilt. If not set, or set to false, Storage Crawler will reprocess the item if the index is rebuilt. |
<archives> | Mandatory | The archives that the connector is to process. Use <archiveid> or <archivetype> to specify archives by ID or type. |
<archiveid> | Optional | The ID of the archive to process. You can use multiple <archiveid> elements to specify several archives. For testing purposes on a development server, you can use the wildcard "*" to specify all archives. This value is not recommended in a production environment. In the Enterprise Vault Administration Console, the ID of an archive is displayed on the Advanced page of the archive properties. You can copy the ID from there. |
<archivetype> | Optional | The type of archives to process. You can use multiple <archivetype> elements to specify several archive types. You can specify the following types:
|
<settings> | Mandatory | Defines information that Storage Crawler passes to the connector. |
<outputdirectory> | Mandatory | The folder to which the connector writes the output text files for each item it processes. The folder must exist, and can be on the local server, or on a network share. |
<properties> | Mandatory | The Enterprise Vault index properties requested by the connector. The index properties that a connector can request are the same as those available for use in Enterprise Vault classification rules or policies, plus folderid (archive folder ID) and ssid (saveset ID). For details of the index properties available, see the Enterprise Vault classification documentation. |