Topics | How To | Related Topics
Once you have installed the Content Indexing Engine, you can set the following options in the CI Engine Properties dialog box from the CommCell Console to improve the performance of the content indexing operation: (In the case of multi-node installation, you can set these options for the Content Indexing Engine in the Admin node.)
Maximum Number of Batch Slots - You can set this option to determine the maximum number of batch slots to be sent at a time to the Content Indexing Server for content indexing. By default, the value is set to 40. It is recommended to set this value to 80.
Maximum Number of Documents Per Batch - You can set this option to determine the maximum number of documents to be included in a batch for content indexing. By default, the value is set to 100. It is always recommended to include 20 documents in a batch.
In addition to the above configurations, you can use the following registry keys to set the maximum time taken for the Content Indexing Engine to process a batch.
For step-by-step instructions on setting these options, see Configure Content Indexing Engine Options.
DocProcessingMaxTime - Use this registry key to set the timeout value for the "document processed" (first acknowledgement) notification from the Content Indexing Engine.
DocReceivedByIndexingMaxTime - Use this registry key to set the timeout value for the "document received by the indexer" (second acknowledgement) notification from the Content Indexing Engine.
DocPersistedByIndexingMaxTime - Use this registry key to set the timeout value for the "document persisted by the indexer" (third acknowledgement) notification from the Content Indexing Engine.
When content indexing large files, you will need to place the files to be content indexed in a temporary staging location prior to content indexing.
The staging path can either be on the local drive or on a network share. When specifying the staging location, ensure that the size (in KB) of the staging directory is twice greater than the number of batches * number of files per batch * the average file size in KB.
When you specify a local staging path, make sure that the staging path is not on the same drive as that of the content index.
|
 |
On a multi-node Content Indexing Engine, you can use a network share to stage the files to be content indexed. When using a network share, you will also need to set the user authentication to access the network share. Note the following when specifying the network share:
It is recommended not to use the administrator user account for the network share.
|
 |
After installing the Content Indexing Engine, you can configure the Offline Content Index before running or scheduling content indexing operations. This includes the following tasks: (If you have not already installed the software, see Deployment - Content Indexing and Search for more information on how to install the Content Indexing Engine.)
See Enable (or Disable) Storage Policies for Content Indexing for step-by-step instructions.
Note that, when you disable content indexing for a storage policy, a warning message is displayed prompting you to whether de-configure and remove all the content indexes associated with this policy. On selecting Yes, all the content indexes associated with the specific storage policy gets pruned and the content indexing feature is disabled. On selecting No, the content indexes are retained, but the content indexing feature will be disabled for the storage policy.
|
When you enable content indexing on clients with Exchange Server agents or Domino Server agents, you will be prompted to register a new domain controller with the CommServe.
See Enable (or Disable) Clients for Content Indexing for step-by-step instructions.
See Filter File Types that Must be Content Indexed for step-by-step instructions.
You can also define global filters for offline content indexing operations. For more information, see Global Filters. The global filters will be applied to all offline content indexing operations within the CommCell. However, you can include or exclude the global filters for a specific offline content indexing operation using Include Global Filters option in the Storage Policy Properties (Content Indexing) tab in the CommCell Console.
It is strongly recommended that you filter out files that are not required to be content indexed. This would help you to limit the size of the index to only those documents that require to be content indexed.
When filtering the files for content indexing, note that the CommCell Console enables filtering based on the file extensions, whereas the Content Indexing Engine filters the files based on the file/MIME types. Multipurpose Internet Mail Extensions (MIME) type is an Internet standard that is used to identify the type of information in a file.
For example, if you change the file extension of a word document to a JPEG image and provide a filter for .jpg files in the CommCell console, the specific file will not be sent to the Content Indexing Engine for content indexing. However, if you do not provide a filter for .jpg files in the CommCell Console, the file is sent to the Content Indexing Engine and will be content indexed as a word file, since the MIME type identifies the file as a word document.
By default the system content indexes all the file/MIME types listed in Supported Document Formats. (This list also provides a list file/MIME types that can be included or excluded from being content indexed.)
By default the system does not content indexes the file types listed in Common File Types Excluded From Content Indexing.
See Configure Retention Criteria for the Content Index for step-by-step instructions.
See Specify the Backup Selection Criteria for Content Indexing for step-by-step instructions.
Once again, it is recommended that you enable content indexing for data associated with long-term retention, such as a monthly/yearly full backups or for data with extended retention periods, which would help you to limit the size of the index.
See Add (or Remove) Subclient for Content Indexing for step-by-step instructions.
See Disable Preview of Search Results for step-by-step instructions.
| Content Indexing Engine Error: If the content indexing engine fails, the auxiliary copy job manager will skip an archive file and continue job on the next files. Upon completion of all jobs, the skipped portions will be attempted again. |
Rights Management Service (RMS) is a technology that works with RMS enabled applications (such as, Microsoft Office applications, Microsoft Exchange Server, and Microsoft SharePoint) to set usage rights on the documents or emails. This is basically used by content authors to set permissions on their documents/emails so as to limit access to other users. For more information on Rights Management Service, refer Microsoft documentation.
Offline content indexing is supported for RMS protected documents/emails of the following applications:
Use the following steps to enable content indexing for RMS protected files:
|
 |
|
 |
Similarly when you change the configurable options for content indexing, such as the backup selection criteria or add a subclient, etc. the changes will be applied only on data which are subsequently content indexed. To content index existing data using the specified parameters you must pick the specific jobs from the jobs associated with the storage policy and then run the Content indexing operation.
See Add (or Remove) Specific Jobs for Content indexing for step-by-step instructions.
Make sure that the Windows Operating system is configured for best performance and priority is given for background processes.
Once you have configured offline content indexing, you can start to run or schedule the Content Indexing Operations. See Operations - Content Indexing and Search for more information.
General
Make sure that the Windows Operating system is configured for best performance and priority is given for background processes.
Once you have installed an Online Content Indexing agent, you need to configure it before running or scheduling any online content indexing operations. (If you have not already installed the agent, see Deployment - Content Indexing and Search for information on installing the Online Content Indexing agents.)
When installed, the software by default creates a content index set with a default subclient. However, you can also create user-defined subclients based on your content indexing needs. Prior to performing content indexing operations, configure the following:
If necessary, you can also configure the following:
The other configurable properties available for the Online Content Indexing Agents are User Administration and Security and Activity Control.
General
Make sure that the Windows Operating system is configured for best performance and priority is given for background processes.
Online Content Indexing for File System Agent
Once the Online Content Indexing subclient is configured you can start to run or schedule the Content Indexing Operations on the subclient. See Operations - Content Indexing and Search for more information.
Security must be configured in the CommCell to grant permissions for users and user groups to search data before searches can be performed. This includes the following tasks for each search tool:
Perform the following security configuration tasks for the Search Console as appropriate for your implementation:
Perform the following security configuration tasks for the CommCell Console as appropriate for your implementation:
Perform the following security configuration tasks for the Outlook Add-In as appropriate for your implementation:
In order to take advantage of basic Find and Search Console capabilities from Outlook Add-In, end-users and compliance users must be granted full permissions for the following registry key: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\Outlook\Addins\Galaxy.Ex2KMBDM.CVEAAddin; To set permissions for this key, from Registry Editor right-click the registry key and select Permissions, click Add, type in the <User ID> then click OK. Select Allow Full Control, then click Apply.
The Single Sign On (SSO) feature enables users to login to the CommServe using their user-account credentials from the Active Directory service provider, inheriting capabilities on the CommServe based on their Active Directory group membership mapping on the CommServe user groups, which must include the Browse capabilities. Single sign on works only for Intranet based sites and will be working for the domain where the WebClient is installed. To support SSO on other domains you will need to install a web client package on a machine which belongs to the domain.
Prior to enabling Single Sign On on a Name Server, note the following:
For step-by-step instructions on enabling Single Sign On, See Enable/disable Single Sign On.
You can configure the Single sign On from the Command line interface.
Follow the procedure given below to configure Single sign On from command prompt.
cvspn.bat -A domainName\userName
Here the userName must match with the Name Server Registration done in the CommCell GUI.
Once SSO is Enabled on the NameServer in the Commcell Console, you need to restart the Webserver(IIS) since domain Information is cached in the server.
|
Once you have installed the Web Search Server and the Web Search Client, you need to perform certain configuration tasks before you begin searching for data from the Search Console. This includes the following tasks: (If you have not already installed the software, see Deployment - Content Indexing and Search for more information on how to install the Web Search Server and Web Search Client.)
The search console now also supports single sign on to external domains configured with secure Lightweight Directory Access Protocol (LDAP) for additional security. For more information on using external domains with secure LDAP , see Single Sign On.
In order to enable end-user search for Lotus Notes Domino users, you need to create a new domain controller for Domino Directory Services (DDS). For detailed information on adding a domain controller for DDS, see Add a New Domain Controller for Domino Directory Services. In addition, also ensure that Web Access is enabled and the user has an Internet Password set from the Domino Server.
If the end-user is an administrator or super user, the user can search for emails sent between other users.
|
Once the configuration tasks have been completed, and content indexing operations have been performed, you can begin conducting searches on the data. For more information, see Data Discovery and Search.
You can control the disk space utilization and search result display for each user from the User Administration page of the Search Console. To do this, you need to be a user with CommCell wide administrative rights. For more information, see User Administration.
To change the location of the URLs for accessing the Search Console or User Administration page, see Configure the Search Server URLs.
You can also view the name and URL of the Web Search Server associated with the Web Search Client. Note that, the Web Search Server association cannot be changed without re-installing the Web Search Client. Also note that, the Web Search Server URL specified in the Client Properties (Search Server URLs) tab is not directly accessible by the user from any Web browsers.
To change the language preferences for the Search Console, see Select Language Preferences for Search Console
To view the supported languages, see Languages - Support.
When you perform a delegated search on Exchange mailbox backups/archives from a previous version, the search results may not be accurate since the emails would have not been optimized prior to the backup/archive operation.
Make sure one of the following agents is installed to collect the Delegated Information: Mailbox, Mailbox Archiver, Public Folder, Mailbox Public Folder Archiver.
Use the following steps to enable delegated search:
Once enabled, you can perform search on delegated mailboxes from the Web Console. See Searching Emails in Delegated Mailboxes for step-by-step instructions. |
 |
Use the following steps to enable secured access on the Web search client. This will allow you to access the Search Console using https instead of http.
C:\java -version
If you find that JAVA with the latest updates has not been installed, uninstall JAVA that you have installed and reinstall it again with all the updates. Navigate to the command prompt on the Web client computer, and run the command specified in step 4 to verify if JAVA has been installed successfully.
Skip this step if the updates are installed successfully.
C:\<PRODUCT_INSTALL_PATH>\Apache\bin>tomcat6w.exe //ES//GxTomcatInstance001
where, Instance001 is the instance installed on the WebClient computer.
Use the following steps for configuring SSL (Secure Socket layer) on the Tomcat Server:
C:\Program Files\Java\jre6\bin>keytool -genkey -alias cvtomcat -keyalg RSA -keystore "C:\Program Files\company\product\Apache\cert\keystore"
<Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="on" />
Modify the above entry as following:
<Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="off" />
<Connector port="443" protocol="org.apache.coyote.http11.Http11NioProtocol" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" clientAuth="false" keystoreFile="C:/Program Files/CommVault/Simpana/Apache/cert/keystore" keystorePass="mnoettomcat" sslProtocol="TLS" />
Prior to configuring SSL on the compliance search client running Apache Tomcat Server, note the following:
Use the following steps to enable SSL on the Tomcat server:
keytool -genkey -alias tomcat -keyalg RSA -keystore "C:\mykeystore.jks"
This command requires the following parameters:
| Parameter | Description |
| Alias | In this case, we used alias tomcat and is used for reference purposes while importing or installing the certificate. This can be chosen as any simple name used for cross reference. After certificate signing is done by certificate authority and returned back to the customer, then we’d need to use exact same alias to import the certificate. Importing / installing certificate step is explained later. |
| Password | Default is changeit and it is recommended to use a strong password |
| First and Last name | Site (fully qualified domain) Name such as www.testsite.com,
someName.somecompany.com which has to run using https When requesting
for wildcard certificate, it can be *.someportal.com.
If the value given for this parameter is not the starting part of the URL for the web site (server) you are requesting the certificate, then note that browser may treat it as an untrusted site. An error or warning message like this would be shown in such cases: The security certificate presented by this website was issued for a different website's address. |
| Organizational Unit | Optional. If applicable, you can enter the DBA (Doing Business As) name in this field. |
| Organization Name | Full legal name of your organization. This listed organization must be legal registrant of the domain name in the certificate request. If you are enrolling as an individual, please enter the certificate requestor’s name. |
| City / Locality | Name of the city (do not abbreviate) in which your organization is located. |
| State / Province | Name of state or province (do not abbreviate) where your organization is located. |
| Country Code | The two letter international organization for standardization (ISO) format country code where your organization is legally registered. |
keytool -certreq -keyalg RSA -alias tomcat -file C:\somename.csr -keystore C:\mykeystore.jks
| Parameter | Description |
| Alias | Should be same as the one used when generating keystore. |
| File | Path including file for CSR creation |
| Keystore | Should be the path including file name of keystore we just created |
You do not need to change the following parameters: -certreq -keyalg RSA
| Note that this may be different based on the certificate authority and it is recommended to follow the KB article or guide-lines provided by the CA. |
The following certificates need to be downloaded and installed:
keytool -import -alias root -keystore C:\mykeystore.jks -trustcacerts -file C:\valicert_class2_root.crt
keytool -import -alias intermed -keystore C:\mykeystore.jks -trustcacerts -file C:\gd_intermediate.crt
keytool -import -alias tomcat -keystore C:\mykeystore.jks -trustcacerts -file C:\server_certificate_whatevername.crt
<!--<Listener className="org.apache.catalina.core.AprLifecycleListener" SSLEngine="off" />
<Connector port="443" protocol="org.apache.coyote.http11.Http11NioProtocol" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" clientAuth="false" keystoreFile="<software_install_path>/Apache/cert/mykeystore.jks" keystorePass="changeit" sslProtocol="TLS" />
In place of the default password changeit, use the correct password that you used to create the keystore.
Also, make sure 443 port is not used by any other server or program on the server.
<!--<Connector protocol="HTTP/1.1" redirectPort="443" port="80" />-->
The User Administration page enables you to set user preferences, such as disk space utilization and search result display, etc., for each user for performing searches from the Search Console. You can also use this page to upload customized logos and view the search analysis on the Content Indexing Engine.
In order to access the User Administration page, you need to be a CommCell administrator. See Security Configuration for Search Console for information on creating a user with administrative rights.
You can use the Preferences page to view and set the user preferences for End-User and Compliance User Search Consoles.
The following user preferences can be added or modified for all the end users/compliance users or for specific individual users.
Preferences |
Description |
Possible Values |
Default Value |
| Hide File Advanced Search Tab | Use this preference to hide/show the advanced search window for the user. | True or False | False |
| Max Number of Queries | Use this preference to specify the number of queries that can be saved by each user. Once the specified number is reached, you are not allowed to create any more queries, unless some of the existing queries are removed. | 10, 20, 30, 50, 100 | 100 |
| Enable Document Highlighting | Use this preference to highlight the search keyword in the search result items. | On or Off | On |
| Results Polling Interval | Use this preference to set the time interval (in seconds) for viewing the status of the operations performed on the review sets. | 30, 60, 120, 180 | 30 |
| Disable Browse Window | Use this preference to disable/enable the Browse window for the user. | True or False | False |
| Default Search tab to show |
Use this preference to specify the default search tab to be displayed. You
can choose one of the following options;
You can also set this user preference from the end-user or compliance user search page. The value set for this preference in the end-user/compliance user search page overrides the value set in the User Administration page. |
All_File_Email, Email, File | All_File_Email |
| End User Based Security | Specifies that the emails will be searched for the end-users based on mailbox ownership or recipient list. | Based on Recipient | Based on Recipient |
| Export Emails to PST | Use this preference to enable/disable export of emails to a PST file for the user. You can set this preference for the end-user or compliance-user view level and cannot be assigned for individual users. | On or Off | OFF |
| Search Timeout | Specifies the maximum time allowed for the search operation, after which a timeout error will be displayed. | 30, 60, 120, 180 | 60 |
| Switch to Review Set Upon adding Items | Specifies that once you add the search result items to a review set from the search result page, the review set page is opened and the added list will be displayed. | On or Off | On |
| Disable My Contents Window | Use this preference to enable/disable the My Contents window for the user. | True or False | False |
| Max number of Review Set | Specifies the maximum number of Review Sets that can be created by the specific user. | any positive integer | 500 |
| Disable Search Window | Use this preference to disable the Search functionality for the user. If this preference is set to True, the user will not be allowed to perform any search operations. | True or False | False |
| Hide Email Advanced Search Tab | Use this preference to hide/unhide the Email options in the Advanced tab for the user. | True or False | False |
| Enable lemmatization | Use this preference to enable or disable lemmatization by default | Yes or No | Yes |
| Disable My Contents Window | Use this preference to enable or disable the My Contents tab in the Search Console | True or False | True |
| Display Email Field Original Value | Use this preference to enable or disable the display of email address of the sender. When disabled, the From field of the email messages will display only the sender's display name. When enabled, the address of the sender is also displayed. | True or False | False |
| Search Engine | Use this preference to set the default content indexing engine to be
used for the search operations. You can also set this user preference from the end-user or compliance user search page. The value set for this preference in the end-user/compliance user search page overrides the value set in the User Administration page. |
Content Indexing Engine name | DefaultCIEngine |
| Query Language |
Use this preference to set the default query language to be used for the
search operation.
You can also set this user preference from the end-user or compliance user search page. The value set for this preference in the end-user/compliance user search page overrides the value set in the User Administration page. |
All languages supported by the Content Indexing Engine | English |
When adding a user preference, note that you can configure the user details for only those users who have performed a search operation using the Search Console.
Use the following steps to add a user preference:
|
 |
User the following steps to modify the user preference. Note that, in order to modify the user preference for an individual user, you need to add the user preference for the user with the modified value.
|
 |
User the following steps to delete a user preference:
|
 |
You can use the Users window in the User Administration page, to view the users who had logged into the Search Console. You can also view the preferences that were set for each user. In order to add or modify the preferences, you need to navigate to the Preferences window. Note that, you can configure and view the user details for only those users who have performed a search operation using the Search Console.
The Users window also displays the Last login time and Last logged in system details for each user.
You can use the Customize Logo window to upload the logo image for Compliance user and End-user Search Consoles. These logos will appear in the main search window of the Search Console. For step-by-step instructions, see Upload Customized Logos.
The Search Analytics window in the User Administration page, enables you to view the statistics of search operations performed on a Content Indexing Engine. This is basically used by administrators to monitor the usage and improve the performance of the Content Indexing Engines. For step-by-step instructions, see View Search Analytics.
The following agent-specific configuration tasks are required for content indexing and search operations.
If you wish to perform content indexing operations for the Domino Server's journaling mailbox, you must configure the following administrative settings for the Domino Server's journaling mailbox:
Note the following:
In order to perform an end-user search for the Domino Mailbox Archiver agent, make sure that the Collect User Identity check box is selected in the Subclient Properties (General) dialog box from the CommCell Console.
In order to take advantage of Search Console capabilities from the Outlook Add-In, perform the following configuration tasks:
The Outlook toolbar buttons to launch the Search Console will appear as follows:
| Compliance Search |  |
| End-User Search |  |
Only compliance search can be performed on NAS iDataAgent offline content indexed data. (End-user search is not supported for NAS iDataAgent offline content indexed data)
To take advantage of the new features, it is recommended to upgrade the Web Search Server and the Web Search Client along with the CommServe upgrade.
|