Autonomy DSmail™ 7.5 Administration Guide Revision 2h30359. Governance/Autonomy... · Microsoft is a registered trademark, and MS-DOS, Windows, Windows 95, Windows NT, SharePoint,

Autonomy DSmail™

Administration Guide

Version 7.5

05 August 2011

Document Revision 2

Notices This documentation is a proprietary product of Autonomy and is protected by copyright laws and international treaty. Information in this documentation is subject to change without notice and does not represent a commitment on the part of Autonomy. While reasonable efforts have been made to ensure the accuracy of the information contained herein, Autonomy assumes no liability for errors or omissions. No liability is assumed for direct, incidental, or consequential damages resulting from the use of the information contained in this documentation.

The copyrighted software that accompanies this documentation is licensed to the End User for use only in strict accordance with the End User License Agreement, which the Licensee should read carefully before commencing use of the software. No part of this publication may be reproduced, transmitted, stored in a retrieval system, nor translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise, without the prior written permission of the copyright owner.

This documentation may use fictitious names for purposes of demonstration; references to actual persons, companies, or organizations are strictly coincidental.

Trademarks and Copyrights Copyright © 2011 Autonomy Corporation plc and its affiliates. All rights reserved. Audit Center, Autonomy Consolidated Archive, Autonomy Express Search, Autonomy iManage ConflictsManager, Autonomy iManage RecordsManager, Autonomy Interaction Control Element (ICE), Autonomy Message Manager, Autonomy Notification Server, Autonomy Records Manager, Autonomy Windows Extension, DeskSite, Digital Safe, Digital Supervisor, EAS On-Demand, EAS, Enterprise Archive Solution, FileShare, FileSite, iManage WorkSite MP, iManage WorkSite, iManage, Introspect, Meridio, OffSite, Scrittura, WorkDocs, WorkPortal, WorkRoute, WorkSite MP, WorkSite, WorkTeam, Zantaz, and all related titles and logos are trademarks of Autonomy Corporation plc and its affiliates.

Microsoft is a registered trademark, and MS-DOS, Windows, Windows 95, Windows NT, SharePoint, and other Microsoft products referenced herein are trademarks of Microsoft Corporation.

UNIX is a registered trademark of The Open Group.

AvantGo is a trademark of AvantGo, Inc.

Epicentric Foundation Server is a trademark of Epicentric, Inc.

Documentum and eRoom are trademarks of Documentum, a division of EMC Corp.

FileNet is a trademark of FileNet Corporation.

Lotus Notes is a trademark of Lotus Development Corporation.

mySAP Enterprise Portal is a trademark of SAP AG.

Oracle is a trademark of Oracle Corporation.

Adobe is a trademark of Adobe Systems Incorporated.

Novell is a trademark of Novell, Inc.

Stellent is a trademark of Stellent, Inc.

All other trademarks are the property of their respective owners.

Notice to Government End Users If this product is acquired under the terms of a DoD contract: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of 252.227-7013. Civilian agency contract: Use, reproduction or disclosure is subject to 52.227-19 (a) through (d) and restrictions set forth in the accompanying end user agreement. Unpublished-rights reserved under the copyright laws of the United States. Autonomy, Inc., One Market Plaza, Spear Tower, Suite 1900, San Francisco, CA. 94105, US.

Acknowledgments RSA Data Security, Inc. MD5 Message-Digest Algorithm; zlib general purpose compression library, Jean-loup Gailly and Mark Adler; Info-ZIP, more information at ftp://ftp.info-zip.org/pub/infozip/license.html; HTML-to-RTF Pro DLL 1.8 © 2002-2007 SautinSoft.

Autonomy DSmail™ Administration Guide 5

Contents

Chapter 1: About This Guide 9

Documentation Updates .................................................................. 9 Conventions ............................................................................ 9

Notational Conventions .............................................................. 10 Command-line Syntax Conventions .................................................... 10 Notices ............................................................................ 11

Related Documentation.................................................................. 12 Autonomy Product References ............................................................ 12 Autonomy Customer Support............................................................. 12 Contact Autonomy ...................................................................... 13

Chapter 2: Getting Started 15

About DSmail .......................................................................... 15 DSmail Workflow ....................................................................... 16

Query IDOL Server and Digital Safe Search ............................................. 16 View Documents .................................................................... 16 Collect Statistics .................................................................... 17

DSmail Architecture..................................................................... 17 DSmail Administration .................................................................. 17

Chapter 3: Installing DSmail 19

Installation ............................................................................ 19 Requirements ...................................................................... 19 Install DSmail Web .................................................................. 20 DSmail Directory Structure ........................................................... 20

Upgrade .............................................................................. 20 Clear the Cache..................................................................... 21 Update the Application ............................................................... 21

Run DSmail............................................................................ 21 Start DSmail ....................................................................... 22

Contents

6 Autonomy DSmail™ Administration Guide

Stop DSmail........................................................................ 22 Restart DSmail ..................................................................... 22

Chapter 4: Configuring DSmail 23

DSmail Configuration File ................................................................ 23 Configuration Sections ............................................................... 24 Configuration Parameters ............................................................ 24

Configure DSmail ....................................................................... 24 Single Sign-On ......................................................................... 25 Log4J Configuration File ................................................................. 25 Configure Logs ......................................................................... 26

Appendix A: XML Element Reference 27

XML Configuration Elements ............................................................. 27 Domain ............................................................................... 27

SSOConfiguration ................................................................... 28 LDAPConfiguration .................................................................. 28

IDOLConfiguration ...................................................................... 29 Component ........................................................................ 29 Encrypted.......................................................................... 33 Fields ............................................................................. 33 HTTPS ............................................................................. 34 TimeFrame......................................................................... 34

ServerConfiguration .................................................................... 35 abbreviatePrintFields ................................................................ 35 AllowedAuthentication ............................................................... 35 AllowedDocClass .................................................................... 36 alwaysProcessAttachmentFromDS ..................................................... 37 AutoRedirect ....................................................................... 37 AttachmentStrategy ................................................................. 37 convertTimeZones .................................................................. 38 DefaultContentType ................................................................. 38 DefaultDocumentsPerPage ........................................................... 39 defaultSearch ...................................................................... 39 DisableSSOForm .................................................................... 39 displayDocclassColumn .............................................................. 40 displayMessageTypeColumn .......................................................... 40 DomainOnly ........................................................................ 41 DownloadMessageName ............................................................. 41 DREContentField .................................................................... 42 EnableOutlookSupport ............................................................... 42

Contents


FastDate ........................................................................... 42 FolderPrefix ........................................................................ 43 FolderTreeSource ................................................................... 43 Gateway ........................................................................... 44 Help .............................................................................. 44 HomeURL .......................................................................... 45 HideBackgroundImage ............................................................... 45 IndexURL .......................................................................... 45 Locale ............................................................................. 46 LongDateFormat .................................................................... 46 maxRecipients ...................................................................... 46 MimeExt ........................................................................... 47 MimeType.......................................................................... 47 mobileRegex ....................................................................... 48 MSGSupportType ................................................................... 48 noResultsText ...................................................................... 49 ParametricRefinements .............................................................. 49 parametricRefinementMethod ......................................................... 50 PollTimeout ........................................................................ 50 queryWithRecipients................................................................. 51 ResultsSizeLimit .................................................................... 51 ShortDateFormat ................................................................... 51 ShowLogout ........................................................................ 52 ShowTotalHits ...................................................................... 52 SSOLogoutURL ..................................................................... 53 SupportFolder ...................................................................... 53 SupportTags ....................................................................... 54 saveTags .......................................................................... 55 TemporaryDirectory ................................................................. 55 theme ............................................................................. 56 TimeFrame......................................................................... 56 timeInMilliS ........................................................................ 57 useDSSecurityForFileSystem.......................................................... 58 useRawFolderNames ................................................................ 58

StatsServer............................................................................ 59 AccessRestriction ................................................................... 59 EventPort .......................................................................... 60 Host (xml config) ................................................................... 61 performanceStats ................................................................... 61 samplingDelaySeconds .............................................................. 62 ServicePort ........................................................................ 62


Chapter 1: About This Guide

This guide is for DSmail administrators. It is intended for readers who are familiar with concepts related to installing and administering applications in a Windows environment.

This section contains the following topics:

Documentation Updates (see page 9) Conventions (see page 9) Related Documentation (see page 12) Autonomy Product References (see page 12) Autonomy Customer Support (see page 12) Contact Autonomy (see page 13)

Documentation Updates The information in this guide is current as of DSmail version 7.5. The content was last modified 05 August 2011. You can retrieve the latest available product documentation from Autonomy’s Knowledge Base on the Customer Support Site:

https://customers.autonomy.com

A document in the Knowledge Base has a version number (for example, version 7.5) and may also have a revision number (for example, revision 3). The version number applies to the product that the document describes. The revision number applies to the document. The Knowledge Base contains the latest available revision of any document.

Conventions The following conventions are used in this document.

https://customers.autonomy.com/�



Notational Conventions

This guide uses the following notational conventions.

Convention Usage

Bold User-interface elements such as a menu item or button. For example:

Click Cancel to halt the operation.

Italics Document titles and new terms. For example:

■ For more information, refer to the IDOL Server Administration Guide.

■ An action command is a request, such as a query or indexing instruction, sent to IDOL Server.

monospace font File names, paths, and code. For example: The FileSystemConnector.cfg file is installed in C:\Autonomy\FileSystemConnector\.

monospace bold Data typed by the user. For example:

■ Type run at the command prompt.

■ In the User Name field, type Admin

monospace italics Replaceable strings in file paths and code. For example: user UserName

Command-line Syntax Conventions

This guide uses the following command-line syntax conventions.

Convention Usage

[ optional ] Brackets describe optional syntax. For example: [ -create ]

| Bars indicate "either | or" choices. For example: [ option1 ] | [ option2 ]

In this example, you must choose between option1 and option2.

Conventions


Convention Usage

{ required } Braces describe required syntax in which you have a choice and that at least one choice is required. For example: { [ option1 ] [ option2 ] }

In this example, you must choose option1, option2, or both options.

required Absence of braces or brackets indicates required syntax in which there is no choice; you must type the required syntax element.

variable <variable> Italics specify items to be replaced by actual values. For example: -merge filename1

(In some documents, angle brackets are used to denote these items.)

... Ellipses indicate repetition of the same pattern. For example: -merge filename1, filename2 [, filename3 ...]

where the ellipses specify filename4, and so on.

The use of punctuation—such as single and double quotes, commas, periods—indicates actual syntax; it is not part of the syntax definition.

Notices

This guide uses the following notices:

CAUTION A caution indicates an action can result in the loss of data.

IMPORTANT An important note provides information that is essential to completing a task.

NOTE A note provides information that emphasizes or supplements important points of the main text. A note supplies information that may apply only in special cases—for example, memory limitations, equipment configurations, or details that apply to specific versions of the software.



TIP A tip provides additional information that makes a task easier or more productive.

Related Documentation The following documents provide details on DSmail:

■ Autonomy DSmail Administration Guide

■ Autonomy DSmail Web User Guide

Autonomy Product References This document references the following Autonomy products:

■ Autonomy DSmail™ (DSmail)

Autonomy Customer Support Autonomy Customer Support provides prompt and accurate support to help you quickly and effectively resolve any issue you may encounter while using Autonomy products. Support services include access to the Customer Support Site (CSS) for online answers, expertise-based service by Autonomy support engineers, and software maintenance to ensure you have the most up-to-date technology.

To access the Customer Support Site, go to

https://customers.autonomy.com

The Customer Support Site includes:

■ Knowledge Base: The CSS contains an extensive library of end user documentation, FAQs, and technical articles that is easy to navigate and search.

■ Case Center: The Case Center is a central location to create, monitor, and manage all your cases that are open with technical support.

■ Download Center: Products and product updates can be downloaded and requested from the Download Center.

■ Resource Center: Other helpful resources appropriate for your product.

https://customers.autonomy.com/�

Contact Autonomy


To contact Autonomy Customer Support by e-mail or phone, go to

http://www.autonomy.com/content/Services/Support/index.en.html

Contact Autonomy For general information about Autonomy, contact one of the following locations:

Europe and Worldwide North and South America

E-mail: [email protected]

Telephone: +44 (0) 1223 448 000

Fax: +44 (0) 1223 448 001

Autonomy Corporation plc

Cambridge Business Park

Cowley Road, Cambridge, CB4 0WZ, UK

E-mail: [email protected]

Telephone: 1 415 243 9955

Fax: 1 415 243 9984

Autonomy, Inc.

One Market Plaza, Spear Tower, Suite 1900

San Francisco, CA. 94105, US

http://www.autonomy.com/content/Services/Support/index.en.html�

mailto:[email protected]�

mailto:[email protected]�


Chapter 2: Getting Started


About DSmail (see page 15) DSmail Workflow (see page 16) DSmail Architecture (see page 17) DSmail Administration (see page 17)

About DSmail DSmail Web is an easy-to-use web application, which searches and retrieves documents that are stored in Autonomy Digital Safe.

DSmail can be used to search all information that is stored in a Digital Safe repository. Digitial Safe security ensures that users can only access their own documents and e-mail. In addition, you can configure the DSmail user interface so that users can search different document types.

The DSmail server configuration file contains details of the Digital Safe repositories that it should retrieve information from. Users access the application using SSO authentication. Digital Safe then determines what information they can access in the repository.

You can use DSmail to search documents from multiple file-types, including:

■ e-mails or Lotus Notes mail files.

■ document types such as Microsoft Word or Adobe PDF files.

■ database entries.

The web application allows users to retrieve all documents that they are entitled to access.

DSmail integrates with Single Sign-On (SSO) authentication, which makes it easier for users to manage their passwords.

Chapter 2: Getting Started


DSmail Workflow The DSmail application sends queries to IDOL server. IDOL server returns a list of matching results. When users select a result document, DSmail retrieves the document from Digital Safe.

The following illustration outlines the DSmail workflow.

Query IDOL Server and Digital Safe Search

DSmail search is performed using IDOL server and Digital Safe Search. You can configure DSmail to use either search method, or a combination of the two. You can also configure time frames for which DSmail should search IDOL server or Digital Safe Search.

View Documents

DSmail allows you to view documents in near-native format. When you select an item from a results list, the result document is presented in the application preview panel. Different document types are rendered on-screen to appear as similar as possible to their original formats.

DSmail uses the IDOL server View component to convert documents into HTML format. The View component uses Autonomy KeyView filters to render the original document into HTML, which is presented to the user in the preview panel.

DSmail Architecture


Collect Statistics

In addition to search and retrieval operations, DSmail can communicate with a Statistics Server. The Statistics Server component monitors queries from DSmail to IDOL server or Digital Safe Search.

You can configure the Statistics Server:

■ to count and record the quantity of queries being sent.

■ to deny service to DSmail if it sends more than a specified number of queries within a specified time period. This allows you to limit the number of queries sent to Digital Safe.

DSmail Architecture The DSmail web application integrates with Autonomy Digital Safe. Each machine in the Digital Safe has a DSmail web server installation, which searches and retrieves documents from that Digital Safe.

Each series of Digital Safe machines has a KickStart server. When it is started, the KickStart server copies server confiugration changes to the other Digital Safe machines in the network. This process ensures that all child servers have identical configurations.

The other machines in the DSmail network are called Portal Buffers (PBJ) or Web Service Portals (WSP).

DSmail Administration DSmail is highly extensible and can be customized to suit your requirements. You can configure DSmail in different ways to determine how users interact with the web application and what information they can retrieve.

For example, you can configure:

■ the document types that users can search.

■ whether users can create tags for saved searches.

■ whether users can view hierarchical e-mail structures for navigation.

■ the date ranges that users can search within.


Chapter 3: Installing DSmail

This section describes how to install or upgrade DSmail for your Digital Safe. It also describes how to start and stop DSmail.


Installation (see page 19) Upgrade (see page 20) Run DSmail (see page 21)

Installation The DSmail web application installs as a .WAR file on your web server. You must ensure that you server meets the requirements to run the application before you install.

Requirements

This section lists the software and hardware requirements for running the DSmail web server and application.

Single Sing-On Requirements

You can use the following single sign-on implementations for DSmail.

■ SAML 2.0 (Security Assertion Markup Language)



Install DSmail Web

To install DSmail, copy the .WAR file to the correct place on your KickStart server.

To install DS Mail

1. Copy the ssearch.war file to the following directory on your DSmail KickStart server.

/var/www/html/build/code/latest/

2. Copy the ZmailConfiguration.xml configuration file to the following directory on your DS Mail KickStart server.

/var/www/html/build/properties/latest

3. Restart each PBJ and WSP

DSmail Directory Structure

The DSmail web application archive (.WAR) file, ssearch.war, is located in the following directory.

/var/www/html/build/code/latest/ssearch.war

This directory also contains the logging utility XML file, log4j.xml.

/var/www/html/build/code/latest/log4j.xml

The DSmail configuration file is located in the following directory.

/var/www/html/build/properties/latest/ZmailConfiguration.xml

Upgrade To upgrade an existing installation of DSmail to a new version, you must clear the cache. Then you must upgrade the web application archive (.WAR) file.

Run DSmail


Clear the Cache

To upgrade DSmail, you must first clear the JSP cache on all of the machines in your DSmail system.

To clear the DSmail JSP cache

1. Run the following commands on each PBJ or WSP.

■ Stop DSmail.

/opt/bin/dscontrol all stop

■ Delete the contents of the temp and work cache directories.

rm -rf /opt/jboss.8090/server/zantaz/tmp/*;rm -rf /opt/jboss.8090/server/zantaz/work/*;

■ If this is a test

rm -rf/var/log/jboss.8090/log.0/* ; rm -f /var/log/jboss.8090/log.0/zlogs/*;

environment, delete the contents of the log.0 and zlogs cache directories.

CAUTION Do not delete the contents of the log cache directories if this is a production environment.

2. Restart the PBJ.

/opt/bin/dscontrol all start

Update the Application

After you have cleared the cache, you can update the application on the KickStart server. This change will be copied to the other servers in your system.

To update the DSmail .WAR file

1. Copy the new ssearch.war file to the directory of the existing .war file on your DigitalSafe KickStart server.

Example location: /var/www/html/build/code/latest/

2. Restart each PBJ, WSP, and DSMP server.

Run DSmail You can start, stop, and restart DSmail using a command prompt.



Start DSmail

Use the following procedure to start DSmail.

To start DSmail

1. On the JBOSS application server, open a command prompt.

2. Send the following command: /opt/bin/dscontrol all start

Stop DSmail

Use the following procedure to stop DSmail when it is running.

To stop DSmail


2. Send the following command: /opt/bin/dscontrol all stop

Restart DSmail

Use the following procedure to stop and restart DSmail.

To restart DSmail


2. Send the following command: /opt/bin/dscontrol all restart


Chapter 4: Configuring DSmail


DSmail Configuration File (see page 23) Configure DSmail (see page 24) Single Sign-On (see page 25) Log4J Configuration File (see page 25) Configure Logs (see page 26)

DSmail Configuration File You configure and maintain DSmail using an XML configuration file, ZmailConfiguration.xml. The exact location of this file may vary by environment; refer to your DigitalSafe documentation.

Example location: /var/www/html/build/properties/latest/ZmailConfiguration.xml

This configuration file contains settings to determine how the DSmail application communicates with other components. It also contains settings to control DSmail functionality.

Each machine in the DigitalSafe contains a copy of the configuration file. You can edit configuration settings individually for a Portal Buffer (PBJ) machine. However, your changes are overwritten by the KickStart server when the system restarts.

To change configuration options globally, you must edit the configuration file on the KickStart machine.



Configuration Sections

Configuration options are split into four main sections. Each section has a parent XML element.

■ Domain. Identifies the document repository domain and set up LDAP and SSO security.

■ IDOLConfiguration. Determines whether IDOL information is encrypted, and configure the Query, FileSystem Connector, and View components.

■ ServerConfiguration. Customizes the DSmail user interface and supported document types.

■ StatsServer. Configures the Statistics Server to record statistics for DSmail.

Configuration Parameters

Within each configuration section, XML elements and attributes determine the configuration settings.

For example:

<Component Name="Query"> <Params>

<Param Name="TimeoutMS">900000</Param> <Param Name="anylanguage">true</Param>

</Params> <Port>9000</Port> <Host>localhost</Host>

</Component>

Configure DSmail To configure DSmail, you must edit the values in the configuration file on the PBJ.

To configure DSmail

1. Open the ZmailConfiguration.xml configuration file in a text editor.

2. Change the value of existing configuration options by editing the element attribute value or tag contents.

Single Sign-On


3. Add any new configuration options within the parent elements for the relevant section or sub-section.

The order of configuration options within a section does not matter. However, you must ensure that the configuration option occurs at the correct level in the XML hierarchy.

4. Save and close the configuration file.

5. Restart the PBJ to execute your changes.

Single Sign-On DSmail can be configured to users access to DSmail using their existing Single Sign-On (SSO) credentials. When a user logs into DSmail, DSmail forwards the user to the your SSO server. When the users' credentials are authenticated, the SSO server sends DSmail an encrypted token containing the user’s information. DSmail decrypts the token and logs the user into DSmail.

SSO is configured in the ZmailConfiguration.xml file by creating pointers to your SSO URL and your Security Assertion Markup Language (SAML) Certificate.

The following elements that must be configured for SSO.

■ <HomeURL>; under <ServerConfiguration>

■ <CertificateURL>; under <Domain>, <SSOConfiguration>

Log4J Configuration File DSmail uses the Log4J utility to create logs. The information that the logs contain depends on the log level set in the Log4j configuration file. For example, you can configure log4j to record only serious errors, or detailed information that can be used for troubleshooting.

You can change the log settings either for one PBJ or for the whole system.

To change settings only on the PBJ, edit the log4j.xml file for that PBJ. The log file is located in the following directory.

/var/log/jboss.L3Cache/build/code/latest/log4j.xml

NOTE If you edit log settings only on the PBJ, this change resets when the server is rebooted.



To change the default log settings, edit the log4j.xml file for the whole system. This log file is located in the following directory.

/var/www/html/build/code/latest/log4j.xml

Configure Logs To change the settings that determine how much information is logged by DSmail, edit the log4j.xml configuration file.

You can edit logging settings temporarily for one PBJ in the configuration file on the PBJ. These settings are overwritten when the KickStart server restarts.

To edit the settings globally, edit the configuration file on the KickStart server.

To change the log settings

1. Open the log4j.xml configuration file.

2. Locate the <category> tag. <category name="com.autonomy.zmail" additivity="false">

<priority value="DEBUG" /> <appender-ref ref="ZLogAppender"/>

</category>

3. In the <priority> tag, edit the value attribute.

For detailed logging information, set value to DEBUG. For example: <priority value="DEBUG" />

4. Save and close the configuration file.

5. Restart DSmail.


Appendix A: XML Element Reference

This section describes the XML elements and attributes used in the DSmail configuration file.


XML Configuration Elements (see page 27) Domain (see page 27) IDOLConfiguration (see page 29) ServerConfiguration (see page 35) StatsServer (see page 59)

XML Configuration Elements The XML configuration file consists of four main XML sections, or elements, each of which can contain numerous child elements.

■ Domain. Identifies the document repository domain and set up LDAP and SSO security.

■ IDOLConfiguration. Determines whether IDOL information is encrypted, and configure the Query, FileSystem Connector, and View components.

■ ServerConfiguration. Customizes the DSmail user interface and supported document types.

■ StatsServer. Configures the Statistics Server to record statistics for DSmail.

Domain The Domain element contains several child elements that can configure LDAP and/or SSO security as well as identify the document repository.



SSOConfiguration

The SSOConfiguration element identifies the location of the security certificate used for SSO authentication.

Child Element Description Required Default value

Possible values

CertificateURL The URL of the security certificate used for Single Sign-On authentication.

Only if using SSO

string

KeystoreURL The URL for the keystore. This parameter can be used for testing and when using internal logins.

No string

Example SSOConfiguration configuration

<SSOConfiguration> <CertificateURL>http://localhost/ssearch/customer.cer</CertificateURL> <keystoreURL>http://localhost:8084/ssearch/tgoetze.keystore</KeystoreURL> <IssuerName>domain1.ds.digitalsafe.net</IssuerName> <Recipient>http://10.1.34.85</Recipient> <MinutesValid>2</MinutesValid>

</SSOConfiguration>

LDAPConfiguration

The child elements that make up the LDAPConfiguration elements define the LDAP settings.

Child Element Description Required

Default value

Possible values

LDAPHost The hostname or IP address of the LDAP server.

No string

LDAPPort The port used for communication with the LDAP server.

No integer

LDAPManagerDomain The domain name of the LDAP server.

No string

LDAManagerPassword The password for the LDAP Manager.

No string

IDOLConfiguration


LDAPSearchBase The base criterion required to be sent to LDAP, so that you are querying the correct domain in LDAP

No string

LDAPAttributeMailboxID

The LDAP property that contains the user’s unique identifier.

No string

LDAPSSOSearchAttribute

The LDAP property that must be searched for the user’s email address.

No string

LDAPUserNameAttribute

The LDAP property that contains the user’s delegated mailboxes.

No string

Example LDAPConfiguration configuration

<LDAPConfiguration> <LDAPHost>10.1.41.101</LDAPHost> <LDAPPort>389</LDAPPort> <LDAPManagerDomain>cn=Admin,ou=zusers,o=testdomain2</LDAPManagerDomain> <LDAPManagerPasswrod>password123</LDAPManagerPasswrod> <LDAPSearchBase>ou=people,o=testdomain2</LDAPSearchBase> <LDAPAttribteMailboxId>msfwid</LDAPAttribteMailboxId> <LDAPSsoSearchAttribute>mail</LDAPSsoSearchAttribute> <LDAPUsernameAttribute>cn</LDAPUsernameAttribute>

</LDAPConfiguration>

IDOLConfiguration The IDOLConfiguration element includes configurations for encrypting communication with IDOL and for defining various IDOL components.

Component

The Component element configures any or all of the Query, FileSystem Connector (FSC), and View action attributes.

Each component action attribute must contain the Params element and include the Param Name attribute. Component child elements other than Host and Port are identified as attributes of the Param child element.



Use the following format.

<Component Name="Query"> <Params>

<Param Name="AnyLanguage">true</Param> </Params>

</Component>

Query

The Component Name attribute Query is configured to search the repository for messages. This can be an IDOL server, Content component, or a Distributed Action Handler (DAH) that distributes actions to a number of IDOL servers.

Child Element Description Required Default value

Possible values

Host The host machine of the IDOL or DAH server used for querying.

No string

Port The ACI port for the IDOL server or DAH used for querying.

No integer

Params An IDOL Query action parameter. Set the Param Name attribute to the name of a Query action parameter. Set the tag value to the value that the parameter takes in the query. You can create multiple Param elements. Refer to the IDOL server online help for details of Query action parameters.

No string

DSmail includes additional Param Name attributes for the Query attributes that are appended to the query sent to IDOL in their respective parameters.

Param Name Attribute Description Required Default value

Possible values

TEXTCRITERION Appends to “text” parameter No string

FIELDTEXTCRITERION Appends to “fieldText” parameter

No string

IDOLConfiguration


Example Query configuration

<Component Name="Query"> <Host>localhost</Host> <Port>9000</Port> <Params>

<Param Name="TimeoutMS">900000</Param> <Param Name="AnyLanguage">true</Param>

</Params> </Component>

Example Query configuration with Param Name attribute TEXTCRITERION

This example excludes the specified repositories from every search. It will append the criterion specified to the action=query&text=user-entered-criteria+AND+<TextCriterion>

<Component name="query"> <host>10.0.66.2</host> <port>17000</port> <params>

<param name="anylanguage">true</param> <param name="MatchAllTerms">true</param> <------ HERE <param name="Combine">DREREFERENCE</param> <param name="TimeoutMS">900000</param> <param name="TextCriterion">NOT (R0037937):_IN_REPOSITORIES AND NOT (R0037938):_IN_REPOSITORIES</param>

</params> </Component>

View

The Component Name attribute View defines the IDOL server View

component that converts email messages into HTML format for viewing with a web browser.


Default value

Possible values

Host The host machine of the IDOL server or Viewserver component used for document viewing.

No string

Port The ACI port for the IDOL server or Viewserver component that is used for document viewing

No integer



Example View configuration

<Component Name="View"> <Host>localhost</Host> <Port>9000</Port>

</Component>

FSC

The Component Name attribute FSC defines the FileSystem Connector that collects documents from user file systems to index into IDOL server.


Default value

Possible values

Host The host machine of the FileSystem Connector that collects documents from the file system and indexes into the IDOL server.

No string

Port The ACI port for the FileSystem Connector.

No integer

Example FSC configuration

<Component Name=FSC> <Host>localhost</Host> <Port>7002</Port>

</Component>

Parametric

The Component Name attribute Parametric defines the IDOL server parametric component that returns parametric field values for queries.


Default value

Possible values

Host The host machine of the IDOL server of Viewserver component used for document viewing.

No string

Port The ACI port for the IDOL server or Viewserver component that is used for document viewing.

No integer

IDOLConfiguration


Example Parametric configuration

<Component Name=Parametric> <Host>localhost</Host> <Port>7002</Port>

</Component>

Encrypted

Defines whether communication with IDOL is encrypted. Enter true to encrypt communication with IDOL, or false not to encrypt. The Encrypted element does not have any child elements.

Element Required Default value Possible values

Encrypted No true

false

Example Encrypted configuration

<Encrypted>true</Encrypted>

Fields

The document fields that contain that user’s e-mail addresses. You can specify the document fields that contain e-mail addresses for senders and recipients of e-mails, using the Received and Sent child elements.


Default value

Possible values

Received The name of the field that contains the e-mail addresses of users that received the e-mail.

No string

Sent The name of the field that contains the e-mail address of the user that sent the e-mail.

No string

Example Fields configuration

<Fields> <Received>_US_5F</Received> <Sent>_US_1T</Sent>

</Fields>



HTTPS

Defines whether TLS is enabled for your application. The HTTPS element does not have any child elements.

Element Required Default value

Possible Values

HTTPS No false true

false

Example HTTPS configuration

<HTTPS>false</HTTPS>

TimeFrame

The time frame for which DSmail queries IDOL server or Digital Safe Search for Digital Safe results. This is valid only if you are using a proxy gateway.

For systems with older documents stored on Digital Safe servers using Digital Safe Search for query, and more recent documents stored using IDOL server, the TimeFrame element allows you to specify when DSmail should send queries to IDOL server, and when it should send queries to Digital Safe Search.

Enter a number of months. For time frames that are more recent than the specified number of months ago, IDOL server is used to retrieve results. For older documents, Digital Safe Search is used. For example, if you use Digital Safe Search for documents that are more than a year old and IDOL server for newer documents, set TimeFrame to 13.

You can also set this to -1 to only query using IDOL server, and 0 to only query using Digital Safe Search.

The TimeFrame element does not have any child elements.


Possible Values

TimeFrame No integer

Example TimeFrame configuration

<TimeFrame>24</TimeFrame>

ServerConfiguration


ServerConfiguration The ServerConfiguration element contains general settings for the DSmail server.

abbreviatePrintFields

The number of characters that should be displayed of the results returned from IDOL.

If you have fields in results documents that contain large amounts of data, you may want to restrict the results so that it only contains a limited number of characters. This can improve performance.

Set abbreviatePrintFields to a positive integer to restrict the results to that number of characters. Set to 0 if you do not want to restrict the results.

TIP Recommended setting for abbreviatePrintFields is 128.


Possible Values

abbreviatePrintFields No 0 integer

Example abbreviatePrintFields configuration

<abbreviatePrintFields>128</abbreviatePrintFields>

AllowedAuthentication

The type of authentication that is used. Set the type of authentication in a Use attribute.

AllowedAuthentication is an empty element.

Attribute Description Required

Default value

Possible values

Use Defines the type of authentication to use.

No COMMUNITY

SSO

COMMUNITY



*If using Community authentication, you must configure the

Example AllowedAuthentication configuration

<AllowedAuthentication Use="COMMUNITY"/>

AllowedDocClass

Set to the document classes that you want to allow. This depends on your IDOL server and DigitalSafe environment. If you want to specify multiple document classes, use a comma delimited list (no space before or after commas). This will also display an icon next to each doc class in the Docclass field in the Basic Search pane.


Possible Values

AllowedDocClass No =EMAIL=

FILESYSTEM

DATABASE

MSMSG

SQLDB

Notes

NotesDXL

NotesFILE

The DSmail Notes docclasses map to the DigitalSafe docclasses as follows.

DSmail docclass DigitalSafe docclass

Notes MSMSG

NotesDXL DXL

NotesFILE FILE

Example AllowedDocClass configuration

<AllowedDocClass>=EMAIL=,FILESYSTEM</AllowedDocClass>

ServerConfiguration


alwaysProcessAttachmentFromDS

Specifies whether messages embedded within messages can be downloaded.


Possible Values

alwaysProcessAttachmentFromDS No false true

false

Example alwaysProcessAttachmentFromDS configuration

<alwaysProcessAttachmentFromDS>true</alwaysProcessAttachmentFromDS>

AutoRedirect

Specifies whether to automatically redirect uses to the web page specified by HomeURL when their browser session expires. If set to false, the user will see a page specifying that the session has expired.


Possible Values

AutoRedirect No true

false

Example AutoRedirect configuration

<AutoRedirect>true</AutoRedirect>

AttachmentStrategy

Specify the field and attachment option in the format FieldName:Option where FieldName is the field that contains information abut the attachment, and Option specifies how the attachment information is defined.

The following are the available Option values.

■ A. Attachment information is given alphabetically.

– AY. Document contains an attachment.

– AN. Document does not contain an attachment.

■ N. Attachment information is given numerically, as the number of attachments that are present.




Possible Values

AttachmentStrategy No string

Example AttachmentStrategy configuration

<AttachmentStrategy>_US_KL:N</AttachmentStrategy>

convertTimeZones

Specifies whether to add timezone support for Apache Lucene searches and to convert the time shown in the preview pane to the local timezone.


Possible Values

convertTimeZones No false true

false

Example convertTimeZones conffiguration

<convertTimeZones>true</convertTimeZones>

DefaultContentType

The default content type of the preview body for documents.


Possible Values

DefaultContentType No all valid content types for documents

Example DefaultContentType configuration

<DefaultContentType>text/html</DefaultContentType>

ServerConfiguration


DefaultDocumentsPerPage

The number of results documents to display in each results page.

IMPORTANT The larger the number of documents returned in each results page, the greater the impact on performance.


Possible Values

DefaultDocumentsPerPage

No integer

Example DefaultDocumentsPerPage configuration

<DefaultDocumentsPerPage>20</DefaultDocumentsPerPage>

defaultSearch

The default search pane (basic or advanced) that is expanded in the DSmail UI. If not specified, the basic search is expanded.


Possible Values

defaultSearch No basic

advanced

Example defaultSearch configuration

<defaultSearch>advanced</defaultSearch>

DisableSSOForm

Set to true if you want to disable the ability for users to log in to the application using single sign-on (SSO). This should be set to true only when you are using custom SSO creation code.

If you set DisableSSOForm to true, the login screen is disabled, and it expects SSO. This would then require that the SSO certificate and keystore are configured.




Possible Values

DisableSSOForm No false true

false

Example DisableSSOForm configuration

<DisableSSOForm>true</DisableSSOForm>

displayDocclassColumn

Specifies whether to add a column to the Search Results pane to display a representative icon for the various document types.

The following icons display when displayDocclassColumn is set to true.

■ Documents in Notes doc class (Domino Notes format)

■ Documents in MSMSF doc class (Microsoft Exchange format)

■ Documents in =EMAIL= doc class (RFC822 format)

■ Documents in FILESYSTEM doc class (sourced from a File System)

■ Documents in SQLDB doc class (xml sourced from a database, or sourced from a File System)


Possible Values

displayDocclassColumn No false true

false

Example displayDocclassColumn configuration

<displayDocclassColumn>true</displayDocclassColumn>

displayMessageTypeColumn

Specifies whether to adds a column to the Search Results pane to display a representative icon for the document type

If displayMessageTypeColumn is set to true, the Message Type column displays as the first column on the left in the Search Results pane. This column is not sortable and does not have a tooltip.

ServerConfiguration



Possible Values

displayMessageTypeColumn no false true

false

Example displayMessageTypeColumn configuration

<displayMessageTypeColumn>true</displayMessageTypeColumn>

DomainOnly

Set to the name of the domain that you want to use, if you want to limit the application to a single domain. Remove this element if you want to use multiple domains.


Possible Values

DomainOnly Yes string

Example DomainOnly configuration

<DomainOnly>Autonomy</DomainOnly>

DownloadMessageName

The e-mail message name that will appear when downloading a message. This is valid for e-mails only.


Possible Values

DownloadMessageName No message string

Example DownloadMessageName configuration

<DownloadMessageName>message</DownloadMessageName>



DREContentField

The IDOL field that contains the document’s default content. This is used in case the document preview fails.


Possible Values

DREContentField Yes string

Example DREContentField configuration

<DREContentField>DRECONTENT</DREContentField>

EnableOutlookSupport

Specifies whether to allow you to view DSmail embedded in the Microsoft Outlook Client.

EnableOutlookSupport can impact performance and is only required when DSmail is being used from within Outlook and there are more than one portal servicing DSmail users.


Possible Values

EnableOutlookSupport No false true

fasle

Example EnableOutlookSupport configuration

<EnableOutlookSupport>true</EnableOutlookSupport>

FastDate

Specifies whether to use the MinDate and MaxDate query parameters, which can improve performance for querying. Documents must be indexed with the date fields correctly identified to if using the MinData and MaxDate (FastDate set to true).

Set FastDate to false if you want to use the NRANGE field specifier for the document date to restrict the date when sending queries to IDOL server.

ServerConfiguration



Possible Values

FastDate No true true

false

Example FastDate configuration

<FastDate>false</FastDate>

FolderPrefix

The prefix for the folders when foldering is enabled. This is for folder security.

If FolderPrefix is set to EMAIL, the user’s logon e-mail address is used as the folder prefix. For example: [email protected]:/inbox/

If FolderPrefix is set to FWID, the user’s unique FWID number is used as the folder prefix. For example: 123459:/inbox/


Possible Values

FolderPrefix No EMAIL

FWID

FWID is the FIRMWIDE ID, a user's UID.

Example FolderPrefix configuration

<FolderPrefix>EMAIL</FolderPrefix>

FolderTreeSource

The source from which to retrieve folders. This should be listed in the format PARAMETRIC:FieldName where FieldName is the name of the document field where folder information is stored.


Possible Values

FolderTreeSource No string



Example FolderTreeSource configuration

<FolderTreeSource>PARAMETRIC:_US_HL</FolderTreeSource>

Gateway

The name of the gateway that the application should use.

■ com.autonomy.zmail.gw.impl.DSPortalGateway if you are using Digital Safe Search only.

■ com.autonomy.zmail.gw.impl.ProxyGateway if you are using both IDOL server and Digital Safe Search.

■ com.autonomy.zmail.gw.impl.IDOLGateway if you are using IDOL server only.


Possible Values

Gateway Yes com.autonomy.zmail.gw.impl.DSPortalGateway

com.autonomy.zmail.gw.impl.ProxyGateway

com.autonomy.zmail.gw.impl.IDOLGateway

Example Gateway configuration

<Gateway>com.autonomy.zmail.gw.impl.ProxyGateway</Gateway>

Help

The location of the help index file that should be opened when the Help link in the application is accessed.

The URL configured must to be within your company domain and served by the your company's hardware and services.


Possible Values

Help No fully qualified URL

Example Help configuration

<Help>http://domain.company.com/help/index.html</Help>

ServerConfiguration


HomeURL

The SSO creation URL on the SSO SAML (Security Assertion Markup Language) sever. This is also the web page that users see when their browser session expires.


Possible Values

HomeURL No string

Example HomeURL configuration

<HomeURL>https://cusotmer.domain.com/SAMLURL</HomeURL>

HideBackgroundImage

Specifies whether to hide the DSmail background image. This reduces the amount of data that needs to be transferred, which can improve performance for slow connections.


Possible Values

HideBackgroundImage No true

false

Example HideBackgroundImage configuration

<HideBackgroundImage>true</HideBackgroundImage>

IndexURL

The landing page that users are directed to after they have logged on to DSmail.


Possible Values

IndexURL No string

Example IndexURL configuration

<IndexURL>mail/index.jsp</IndexURL>



Locale

The region that the application users will be in. This specifies the language and, where required, a localization of the language.


Possible Values

Locale No en/US

Example Locale configuration

<Locale>en/US<Locale>

LongDateFormat

The date format that is used in the preview panel of the application. The DSmail LongDateFormat element uses Java SimpleDateFormat formatting.

Element Required Default value Possible Values

LongDateFormat No ddMMyyyy valid Java SimpleDateFormat formatting

Example LongDateFormat configuration

<LongDateFormat>EEE, d MMM yyyy HH:mm:ss Z</LongDateFormat>

maxRecipients

The maximum number of recipients that are pulled from the index for an IDOL-only search.

Set maxRecipients to a positive integer to restrict the number of recipients. Set to 0 to ignore.

IMPORTANT maxRecipients is applicable only when the queryWithRecipients element exists and is set to true. Recommended setting is 10 or fewer recipients to optimize performance.


Possible Values

maxRecipients No 0 (ignore) positive integer

ServerConfiguration


Example maxRecipients configuration

<maxRecipients>10</maxRecipients>

MimeExt

The filename extension that is assigned to the file when a user downloads the "originally archived message". This is valid for e-mails only.


Possible Values

MimeExt No eml valid e-mail file extension

Exmaple MimeExt configuration

<MimeExt>eml</MimeExt>

MimeType

The Mime type of the mail file that is downloaded. This is valid for e-mails only.


Possible Values

MimeType No all valid document content types

The MimeType value should match the content archived in your email docclass.

Example MimeType configuration

<MimeType>application/octet-stream</MimeType>



mobileRegex

Configures the regex(es) used to detect a mobile device and forwards the user to the mobile version of DSmail.The user has the option to switch back to the 'classic' (desktop) version by clicking the Classic view link at the bottom of the page.

The regex is a comma-separated list of two regex values. The first value is used in the User-Agent.matches call; the second value is used in the User-Agent.substring(0,4).matches call.

Element Required Default Value

Possible Values

mobileRegex No .*(android|avantgo|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\\/|plucker|pocket|psp|symbian|treo|up\\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino).*,1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\\\\|s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\\\\/|capi|ccwa|cdm\\\\\\\\\\u|g560|gene|gf\\\\\\.w|od)|gr(ad|un)|haie|hcit|hd\\\\i|ip)|hs\\\\|_|a|g|p|s|t)|tp)|hu(aw|tc)|i\\|\\\\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\\/)|klon|kpt |kwc\\g|\\/(k|l|u)|50|54|e\\\\/|\\\\\\/|ma(te|ui|xo)|mc(01|21|ca)|m\\\\|o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\\\\\\\\\\\\\\\\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\\\\\\/|se(c(\\\\\\\\\\\\)|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\\\\\\\\\\\\\\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\\\\)|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|xda(\\\\\\

MSGSupportType

The type of MSG supported, whether for Microsoft or Lotus Notes.

NOTE MSGSupportType is only applicable if the DOCCLASS is MSMSG.

ServerConfiguration



Possible Values

MSGSupportType No NotesDxl NotesDxl

MicrosoftMSG

Example MSGSupportType configuration

<MSGSupportType>MicrosoftMSG</MSGSupportType>

noResultsText

Defines the text that displays in the Search Results pane when the search query returns no results.


noResultsText No No Results Found string

Example noResultsText configuration

<noResultsText>No results found matching the defined criteria. Edit the criteria and try again.</noResultsText>

ParametricRefinements

The features that you want to use for parametric refinement. If you want to filter by multiple fields, use a comma delimited list (no spaces before or after the comma).

■ CONVERSATIONS. Filter by the e-mail subject lines.

■ CONTACTS. Filter by the recipients of an e-mail.

■ SHARED. Filter by the files that are attached to e-mails and shared.

IMPORTANT Refinements result in an impact on query performance; this impacts both DSmail portals as well as IDOL. To increase performance with this feature, configure ParametricRefinementMethod as IDOLResults.




ParemetricRefinements No CONVERSATIONS

CONTACTS

SHARED

Example ParametricRefinements configuration

<ParametricRefinements>CONVERSATIONS,CONTACTS</ParametricRefinements>

parametricRefinementMethod

Defines the refinement method to use in conjunction with ParametricRefinements.

CAUTION The value IDOLParametric will cause query performance to be impacted. 100% degradation in query performance is expected. Recommend setting is IDOLResults.


parametricRefinementMethod

No IDOLParametric IDOLParametric

IDOLResults

Example parametricRefinementMethod configuration

<arametricRefinementMethod>IDOLResults</parametricRefinementMethod>

PollTimeout

The number of seconds before timeout when polling for results with Digital Safe Search.


Possible Values

PollTimeout No 30 integer

Example PollTimeout configuration

<PollTimeout>600</PollTimeout>

ServerConfiguration


queryWithRecipients

queryWithRecipients assists in improving performance when a large number of recipients are associated with documents, and those recipients are contained within their own field value (instead of comma separated).

queryWithRecipients works in conjunction with maxRecipients. If recipients are contained within their own field, set queryWithRecipients to true and maxRecipients to 10 or less.

CAUTION If recipients associated with documents are comma delimited (separated by commas), set queryWithRecipients to false. Setting to true will negatively impact query performance

is recipients are comma delimited.


Possible Values

queryWithRecipients No true false

true

Example queryWithRecipients configuration

<queryWithRecipients>false</queryWithRecipients>

ResultsSizeLimit

The maximum number of documents that can be returned in a Digital Safe search.


Possible Values

ResultsSizeLimit No 2500 integer

Example ResultsSizeLimit configuration

<ResultsSizeLimit>500</ResultsSizeLimit>

ShortDateFormat

The date format that is used in the results list of the application. The DSmail ShortDateFormat elements uses Java SimpleDateFormat formatting.




Possible Values

ShortDateFormat No ddMMyyyy valid Java SimpleDateFormat formatting

Example LongDateFormat configuration

<ShortDateFormat>yyyy.MMM.dd hh:mm aa</ShortDateFormat>

ShowLogout

Specifies whether to include a logout button in the application.


Possible Values

ShowLogout No false true

false

Example ShowLogout configuration

<ShowLogout>true</ShowLogout>

ShowTotalHits

Specifies whether to to display (in the application) the total number of hits that are returned in a result list.

This applies for queries to IDOL server only. Setting ShowTotalHits to true also turns off the total results prediction, which can have a performance impact.

CAUTION Query performance will be highly impacted when ShowTotalHits is set to true. 100% degradation in query performance is expected. Recommend setting is false.


Possible Values

ShowTotalHits No false true

false

ServerConfiguration


Example ShowTotalHits configuration

<ShowTotalHits>false</ShowTotalHits>

SSOLogoutURL

The URL to which users are directed when they log out of the application.


Possible Values

SSOLogoutURL No fully qualified URL

Example SSOLogoutURL configuration

<SSOLogoutURL>http://domain.company.com/mail/login.html</SSOLogoutURL>

SupportFolder

Specifies whether to display the folder tree menu in the application. Folders appear as a panel in the application user interface.

The folder structure is recorded in the Digital Safe archive and depends on the folder structure for the e-mail system from which the e-mails were indexed. This is stored for each user, so if the same e-mail is stored in the Sent folder for one user, and the Inbox for another, these settings are recorded and the e-mail is returned in the correct folder for the different users.

IMPORTANT If SupportFolder is set to true, you must also configure the Component Name attribute Parametric (under the IDOLConfiguration element) and will impact DSmail UI performance.


SupportFolder No false true

false



If SupportFolder is set to true, the following sibling elements are required.

Sibling Element Required Default value Possible Values

folderPrefix Only when SupportFolder is true

string

fodlerTreeSource Only when SupportFolder is true

string

Example SupportFolder configuration with sibling elements

<SupportFolder>true</SupportFolder> <folderPrefix>EMAIL</folderPrefix> <folderTreeSource>PARAMETRIC:FIELD</folderTreeSource>

SupportTags

Specifies whether users can create tags in the application. This includes tags for saved searches. The use of tags requires that the Community server is installed, and the Community component is configured.

Users can create tags to mark groups of documents that fulfill certain criteria. For example, users can save a search using tags, and all documents that match the search criteria are tagged. Tags can also be created without saving a search.

IMPORTANT If SupportTags is set to true, the saveTags element must exist and also be set to true.


Possible Values

SupportTags No false true

false

ServerConfiguration


Example SupportTags configuration

<SupportTags>true</SupportTags>

Example Community component configuration

<Component name="community"> <port>9000</port> <host>localhost</host>

</Component>

saveTags

When set to true, saveTags triggers DSmail to persist tags created by users in the IDOL Community. When set to false, the tags are transient and will no longer exist after the portal is restarted.


Possible Values

saveTags Only when SupportTags is true

true

false

Example saveTags configuration

<saveTags>true</saveTags>

TemporaryDirectory

The location of the temporary directory that is used for downloading files for the purpose of rendering previews in the application.


Possible Values

TemporaryDirectory No complete path

Example TemporaryDirectory configuration

<TemporaryDirectory>/store/tmp_archive</TemporaryDirectory>



theme

Specifies the theme to use for the DSmail UI. The theme updates the stylesheets for the UI.


Possible Values

theme No all all

black

slate

slickness

tp

Example theme configuration

<theme>slate</theme>

TimeFrame

The timeframes to use in the basic search bar. This defines the different time segments that are displayed in the time frame selection box.

Attributes for the TimeFrame element specify the unit of time that is used for the time frame, and the way the time scale is calculated.


Default value

Possible values

Unit The unit of time used to specify the time segments.

No Month

Scale The scale to use for timeframes. Time is calculated in whole months (first day of the month to the last day of the previous month), or a month from the current date (sliding, from the current date to the same date in the previous month).

No Whole

Sliding

Option

You must set an Option element for each time frame option and define the From and To attributes. This determines the length of each time segment that you want to create. The value of the Option tag is the value that is displayed on the user interface for that time period.

ServerConfiguration


Define the Option elements in the order in which you want them to display in the time frame selection box in the application.


Possible Values

Option No string; plain text or i18n reference

The Option value can be plain text or the equivalent valid i18n reference (International reference). Defining these values using the i18n reference lets the entry be displayed in any language. DSmail looks up the Option value in the i18n language map and uses the string as a key and the string for the correct language is displayed in the dropdown list in the application. If the value is not found in the language map, the string is displayed as-is—this allows for the entry of plain text as well.


Default value

Possible values

From The start of the time segment. No integer

To The end of the time segment. No integer

Example TimeFrame configuration, including Option

<Timeframe unit="month" scale="whole"> <Option From="0" to="1">Last month</Option> <Option From="0" to="3">Last 3 months</Option> <Option From="3" to="6">3 to 6 months ago</Option> <Option From="6" to="12">6 to 12 months ago</Option>

</Timeframe>

timeInMilliS

Defines storing the time values for messages in the IDOL index in milliseconds instead of seconds. Set to true if you want time values to be specified in milliseconds. Set to false or remove completely to set the time value in seconds (the default application functionality).


Possible Values

timeInMilliS No false true

false



Example timeInMilliS configuration

<timeInMilliS>true</timeInMilliS>

useDSSecurityForFileSystem

Specifies the type of security to use when searching within the File System docclass.

Set useDSSecurityForFileSystem to true to restrict search results to documents matching the current Mailbox UID. Set to false to use an IDOL security string.


Possible Values

useDSSecurityForFileSystem

No false true

false

Example useDSSecurityForFileSystem configuration

<useDSSecurityForFileSystem>true</useDSSecurityForFileSystem>

useRawFolderNames

Specifies the type of capitalization used to display folder names in DSmail.

Set useRawFolderNames to true to honor the capitalization that exists in the index—the displayed capitalization mimics the stored data. Set to false to capitalize the first letter of each word in the folder name when displayed in the UI.


Possible Values

useRawFolderName No false true

false

Example useRawFolderName configuration

<useRawFolderName>true</useRawFolderName>

StatsServer


StatsServer The StatsServer element defines settings for the StatsServer, which collects information about DSmail usage.

AccessRestriction

The AccessRestriction element lets you deny access to specific functionality. You can create a policy, so that when the statistics field is at a specified threshold, it denies DSmail further access to the functionality defined in the restriction (for example Digital Safe search).

The AccessRestriction element is defined by one or more Restrict child elements.

Restrict

Restrict elements define a single restriction and are grouped together under the AccessRestriction element to form the complete restriction policy.

Attribute Description Required Default value

Possible values

Type Defines the restriction type. Currently, can only count the number of events that occur.

Yes; as part of Restrict

Count

The child elements for Restrict define the behavior of the restriction.

Child Elements Description Required Default value

Possible values

StatsName The name of the statistic. No string

StatsField The name of the event. No string

StatsPublish The field that events are published to.

No dsssearch

idolsearch

StatsThreshold The maximum query count that is allowed for this restriction within the specified StatsPeriod time period. If this parameter is set to 0, there is no threshold and access will not be denied.

No integer



StatsPeriod The time period that applies to the StatsThreshold.

No minute

hour

day

Example AccessRestriction configuration, with multiple Restrict elements

The following example creates a rule that denies access to Digital Safe search when it exceeds a query count of 100 queries per minute.

<AccessRestriction> <Restrict Type="COUNT">

<StatsName>DigitalSafe Search</StatsName> <StatsField>zmail/dssearch</StatsField> <StatsPublish>dssearch</StatsPublish> <StatsThreshold>100</StatsThreshold> <StatsPeriod>minute</StatsPeriod>

</Restrict> </AccessRestriction>

The following example collects statistics for IDOL search. The threshold is set to 0, so this does not deny service to the specified feature.

<AccessRestriction> <Restrict Type="COUNT">

<StatsName>IDOL Search</StatsName> <StatsField>zmail/idolsearch</StatsField> <StatsPublish>idolsearch</StatsPublish> <StatsThreshold>0</StatsThreshold> <StatsPeriod>minute</StatsPeriod>

</Restrict> </AccessRestriction>

EventPort

The event port for the StatsServer.


Possible Values

EventPort No integer

Example EventPort configuration

<EventPort>19871</EventPort>

StatsServer


Host (xml config)

The hostname or IP address of the machine where the StatsServer is located.


Possible Values

Host No string

Example Host configuration

<Host>server12</Host>

performanceStats

Performance stats collect the average speed of a query fro Apache Lucene or IDOL.

The child elements of performaceStats define the specific stats. You can have multiple performanceStats elements, each differentiated by its child elements.

Child Elements Description Required Default value Possible Values

displayName The stat name displayed in the UI.

Yes string

statsName Comma delimited list of the stats fields that make up the count of the queries and of the performance statistics.

Yes string

statsField Comma delimited list of the paths of the stats fields that make up the count of the queries and of the performance statistics.

Yes string

statsPublish The element name to publish the statistics to.

Yes string



Example performanceStats configuration including child elements

<performanceStats> <displayName>IDOL Performance</displayName> <statsName>IdolQueryPerfAvg,IdolQueryPerfCount</statsName> <statsField>zmail/IdolQueryPerfAvg,zmail/IdolQueryPerfCount</statsField> <statsPublish>idolsearchperf</statsPublish>

</performanceStats>

<performanceStats> <displayName>DS Performance</displayName> <statsName>DSQueryPerfAvg,DSQueryPerfCount</statsName> <statsField>zmail/DSQueryPerfAvg,zmail/DSQueryPerfCount</statsField> <statsPublish>dssearchperf</statsPublish>

</performanceStats>

samplingDelaySeconds

Defines the amount of time, in seconds, to delay when querying the stats server.


Possible Values

samplingDelaySeconds No 0 positive integer

Example samplingDelaySeconds configuration

<samplingDelaySeconds>5</samplingDelaySeconds>

ServicePort

The service port for the StatsServer.


Possible Values

ServicePort No integer

Example ServicePort configuration

<ServicePort>19870</ServicePort>