X1 Client Deployment Guide

Similar documents
BackupVault Desktop & Laptop Edition. USER MANUAL For Microsoft Windows

Server Edition USER MANUAL. For Microsoft Windows

EMC SourceOne Discovery Manager Version 6.7

EMC SourceOne TM Offline Access USER GUIDE. Version 6.8 P/N A01. EMC Corporation Corporate Headquarters: Hopkinton, MA

Colligo Manager for Outlook User Guide. User Guide

Silk Performance Manager Installation and Setup Help

EMC SourceOne Offline Access Version 6.8


User Guide. BlackBerry Workspaces for Windows. Version 5.5

Server Edition. V8 Peregrine User Manual. for Microsoft Windows

EMC SourceOne Offline Access Version 7.1

Colligo Engage Outlook App 7.1. Offline Mode - User Guide

Perceptive TransForm E-Forms Manager 8.x. Installation and Configuration Guide March 1, 2012

Sage 300 Construction and Real Estate (formerly Sage Timberline Office)

Sage 300 Construction and Real Estate (formerly Sage Timberline Office)

WebStudio User Guide. OpenL Tablets BRMS Release 5.18

IBM Endpoint Manager Version 9.0. Software Distribution User's Guide

Colligo Engage Outlook App 7.1. Offline Mode Administrator s Guide

Multi-NVR Manager. Quick Start Configuration Usage

Exclaimer Mail Archiver

SC-T35/SC-T45/SC-T46/SC-T47 ViewSonic Device Manager User Guide

Desktop & Laptop Edition

Colligo Manager 5.4 SP1. Administrator s Guide

The fastest way to get a signature. DocuSign Desktop Client. v3.0. User Guide

Tzunami Deployer Confluence Exporter Guide

Colligo Engage Outlook App 7.1. Connected Mode - User Guide

Tzunami Deployer Exchange Exporter Guide

VMware Mirage Web Manager Guide

LiveNX Upgrade Guide from v5.1.2 to v Windows

Deployment Guide Installing WhatsUp Gold Distributed Edition to Central and Remote Sites

Perceptive TransForm E-Forms Manager

Colligo Manager 5.4 SP3. User Guide

Colligo Contributor Pro 4.4 SP2. User Guide

Administrator s Guide

Tzunami Deployer Hummingbird DM Exporter Guide

Tzunami Deployer Hummingbird DM Exporter Guide

Sage Estimating (SQL) v17.11

Tzunami Deployer DocuShare Exporter Guide

SAP BusinessObjects Live Office User Guide SAP BusinessObjects Business Intelligence platform 4.1 Support Package 2

EMC SourceOne Discovery Manager Version 6.5

Client Installation and User's Guide

Repstor affinity. Installation and Configuration Guide(Generic)

Product Guide. McAfee GetSusp

Kernel for Exchange Server. Installation and Configuration Guide

Cisco TelePresence Management Suite Extension for Microsoft Exchange

Network Scanner Tool V3.3. User s Guide Version

Client Installation and User's Guide

PROMISE ARRAY MANAGEMENT ( PAM) USER MANUAL

Tzunami Deployer Confluence Exporter Guide

Enterprise Server Edition

License Manager Client

Enterprise Server Edition

RTX SDK INSTALL GUIDE

Copyright 2017 Softerra, Ltd. All rights reserved

StrikeRisk v5.0 Getting started

Perceptive Workgroup Search

DesignPro Tools for Xerox Elixir Technologies Corporation. All rights reserved.

Toolbar User Guide. Release 17.0

McAfee SiteAdvisor Enterprise 3.5.0

Full User Manual and Quick Start Guide

Symantec ediscovery Platform

Virtual Infrastructure Web Access Administrator s Guide ESX Server 3.0 and VirtualCenter 2.0

Installation Manual. Fleet Maintenance Software. Version 6.4

LiveNX Upgrade Guide from v5.2.0 to v5.2.1

Windows 2000 / XP / Vista User Guide

College of Pharmacy Windows 10

Kernel Office 365 Migrator for Lotus Notes

Copyright 2018 Lepide Software Private Limited. All rights reserved.

Server Edition USER MANUAL. For Mac OS X

Tzunami Deployer FileNet Exporter Guide Supports extraction of FileNet contents and migrate to Microsoft SharePoint using Tzunami Deployer.

Installation Guide Worksoft Certify

Crystal Enterprise. Overview. Contents. Installation FAQ: Crystal Enterprise 9 & 10

UC for Enterprise (UCE) NEC Centralized Authentication Service (NEC CAS)

ELM Server Exchange Edition ArchiveWeb version 5.5

Enterprise Vault.cloud CloudLink Google Account Synchronization Guide. CloudLink to 4.0.3

OpenText RightFax 10.6

Office 365: . Accessing and Logging In. Mail

INSTALL GUIDE BIOVIA INSIGHT 2.6

ForeScout Extended Module for Advanced Compliance

Content Author's Reference and Cookbook

StorageCraft File Backup and Recovery with Backup Analyzer

Wyse Converter for PCs 1.1 Release Notes

Contents. Batch & Import Guide. Batch Overview 2. Import 157. Batch and Import: The Big Picture 2 Batch Configuration 11 Batch Entry 131

easy to use. easy to own. INSTALLATION GUIDE

Blackbaud, Inc. This publication, or any part thereof, may not be reproduced or transmitted in any form or by any means, electronic, or

10ZiG Technology. Thin Desktop Quick Start Guide

Wyse Converter for PCs Release Notes

Print Station. Point-and-Click Printing WHITE PAPER

Update Guide

Colligo Contributor File Manager 4.3. User Guide

Virtual CD TS 1 Introduction... 3

Installation Guide - Windows

MapMarker Plus Desktop Installation Guide

Chapter 1: Introduction About the User Manual Intended Audience Conventions Used Revision History 4

Personality Migration Reference

PaperVision Message Manager. User Guide. PaperVision Message Manager Release 71

KYOCERA Net Viewer User Guide

Server Edition. V8 Peregrine User Manual. for Linux and Unix operating systems

Installation Guide Install Guide Centre Park Drive Publication Date: Feb 11, 2010

DISK DEFRAG Professional

Transcription:

X1 Client Deployment Guide

ii X1 Professional Client Deployment Guide Legal Notice No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any computer language, in any form or by any means, without the express written permission of X1, Inc. 2007 X1 Technologies, Inc. All Rights Reserved. Outside In Viewer and Content Access Technology 1991-2004 Stellent Chicago, Inc. All Rights Reserved. All trademarks referenced herein are property of their respective owners.

i Contents Preface Audience........................................................... iii Document Organization................................................ iii Obtaining Technical Support............................................ iv Document Conventions................................................ iv Chapter 1 Getting Started Overview............................................................1 Preparing to Install the X1 Professional Client................................1 Supported Operating Systems........................................1 Information You Will Need..........................................2 Uninstalling Previous Versions of the X1 Professional Client.....................2 Installing the X1 Deployment Manager.....................................3 Chapter 2 Customizing the X1 Professional Client User Interface Overview............................................................5 Opening the X1 Professional Client in Administration Mode.....................5 Customizing the X1 Professional Client User Interface..........................6 Customizing X1 Professional Client Settings.................................7 Adding Plugins to the X1 Professional Client................................10 Setting up remote sources for a Plugin.................................11 Creating Saved Searches................................................12 Closing the X1 Professional Client........................................13 Chapter 3 Deploying the X1 Professional Client Overview...........................................................15 Creating the Installer..................................................15 Testing the X1 Professional Client........................................18

ii X1 Professional Client Deployment Guide Distributing the Installer...............................................18 Scheduling Deployment............................................18 Distributing an EXE Installer........................................19 Distributing a Batch File and MSI Installer.............................19 Chapter 4 Managing Deployed X1 Professional Clients Using Group Policy Objects.............................................21 Appendix A Advanced Management Reference Performance Tuning...................................................23 Tuning Indexing.................................................23 Tuning Microsoft Outlook Real-Time Indexing.........................23 Antivirus Software and the X1 Professional Client............................24 Common User Problems...............................................24 Performing Complete Uninstalls.........................................25 Appendix B X1 Professional Client Reference MSIEXEC Command Line Options......................................29 Group Policy Settings Reference..........................................32

iii Preface The X1 Professional Client Deployment Guide provides the information you need to install, configure, deploy, and manage the X1 Professional Client. This chapter lists and describes general information and conventions found in this document in the following sections: Audience Document Organization Obtaining Technical Support Document Conventions Audience This document is intended for network administrators familiar with Microsoft Windows administration concepts. No specialized knowledge is required. Document Organization This document is organized into the following sections: Chapter 1, Getting Started Chapter 2, Customizing the X1 Professional Client User Interface Chapter 3, Deploying the X1 Professional Client Chapter 4, Managing Deployed X1 Professional Clients Appendix A, Advanced Management Reference Provides a conceptual overview and description of the X1 Professional Client Provides step-by-step instructions on customizing the X1 Professional Client user interface and settings. Provides step-by-step instructions on deploying the X1 Professional Client to end users. Provides step-by-step instructions on managing the X1 Professional Client after deployment. Provides technical specifications for the X1 Professional Client.

iv X1 Professional Client Deployment Guide Obtaining Technical Support Technical support and contact information are available from the following resources: To access support materials: http://www.x1.com/support/ To request assistance: http://www.x1.com/support/customer_care/ To fax X1: (626) 535-2701 To contact X1 by mail: X1 Technologies, Inc. 130 W. Union St. Pasadena, CA 91103 Document Conventions The following conventions are used in this document: Convention bold italic command hyperlink Caution This is Caution. Note This is Note. Usage Bold text is used to signify key elements of the User Interface, commonly during procedure steps: Click on the File menu. Italics denote concept terms and variables that should be substituted: The X1 Professional Client uses mountpoints to add data to the index. Searches are saved as searchname.x1 files, where searchname is the name of the search. Command formatting denotes text strings that are entered at the command line and path names: At the command prompt, type All. Navigate to the C:/Program Files/ directory. Hyperlinks connect to other sections of the document. They are displayed in blue when the document is viewed online. Important notes for dangerous or risky procedures are flagged with the Caution warning in red. Notes describe interesting details about a subject, or provide additional insight for complex procedures. Tip This is Tip. Tips describe shortcuts and handy alternatives to the information provided.

1 Chapter 1 Getting Started This chapter lists and describes the system prerequisites, installation steps, and configuration of the X1 Professional Client in the following sections: Overview Preparing to Install the X1 Professional Client Uninstalling Previous Versions of the X1 Professional Client Installing the X1 Deployment Manager Overview The X1 Professional Client is coupled with the X1 Deployment Manager to facilitate efficient, seamless customization and deployment of the X1 Professional Client across your organization. The X1 Deployment Manager allows you to customize X1 Professional Client features and settings and generate an MSI-compliant installer to deploy the X1 Professional Client to your users. After the X1 Professional Client is deployed, you will be able to manage the X1 Professional Clients installed on user computers using Microsoft s Group Policy Objects. Preparing to Install the X1 Professional Client Before installing the X1 Deployment Manager and customizing an X1 Professional Client installer, the system must meet the following preliminary requirements: No other X1 products, including the X1 Server or free evaluation copies of the X1 Professional Client, can be installed on the computer where you will install the X1 Deployment Manager. If there are currently any X1 products installed on the computer, or there have been in the past, see Uninstalling Previous Versions of the X1 Professional Client on page 2 for more information. You must have a user account with administrator privileges on the computer where the X1 Deployment Manager will be installed and customized. Supported Operating Systems Microsoft Windows XP Home Edition with Service Pack 1 and Service Pack 2.

2 X1 Professional Client Deployment Guide Microsoft Windows XP Professional Edition with Service Pack 1 and Service Pack 2. Windows Vista System Requirements A minimum of 128 MB RAM is required; 512 MB of RAM is recommended. 1 GB of free hard disk space is recommended. Note Actual memory and space used depends on the number of files and email messages indexed. X1 recommends having the email client your users use installed on the computer where the X1 Deployment Manager will be installed. This will ensure all email clientspecific settings are available in the X1 Professional Client during customization. The following email clients are supported: Lotus Notes and Domino 6.0.1 to 7.0 Microsoft Outlook XP, 2003 and 2007 Microsoft Outlook Express 6.0 Mozilla Thunderbird 1.5 and 2.0 Information You Will Need You will need a valid X1 Professional Client license key for installation. To obtain a license key, contact your X1 representative. Uninstalling Previous Versions of the X1 Professional Client If you have had any previous versions of the X1 Professional Client installed on the administration computer, including an evaluation copy, you must completely uninstall all versions before proceeding with installation. If the X1 Server is installed on the computer, use a different computer or see the X1 Server Administrator Guide for uninstall directions. Complete the procedure below to be sure all previous versions of the X1 Professional Client have been completely removed from the administration computer. Procedure Uninstall previous versions: 1 If the X1 Professional Client is running, close the X1 Professional Client. 2 Close all other programs that are running, including Microsoft Outlook. 3 From the Microsoft Windows Control Panel, navigate to Add/Remove Programs. 4 Select X1 and click Remove. 5 If a dialog box appears asking if you want to save your X1 Professional Client settings, select No. The X1 Professional Client is uninstalled. 6 After removal is complete, confirm the following directories have been removed:

Getting Started Installing the X1 Deployment Manager 3 C:\Documents and Settings\<username>\Local Settings\Application Data\X1 Desktop Search C:\Program Files\X1 Note These directory paths are default locations. If different directories were specified during installation, then the default location will not apply. 7 If the directories have not been removed, delete them manually. If an error message appears or you are unable to delete the directories, continue with this procedure with the directories still present. 8 Open the Microsoft Windows registry by going to the Microsoft Windows Start menu and clicking Run. Type Regedit in the Run text field to open the registry, then delete the following registry settings: HKEY_LOCAL_MACHINE\Software\X1 Desktop Search HKEY_CURRENT_USER\Software\X1 Desktop Search 9 Close the registry window. 10 Restart your computer, then verify that the directories listed above have been deleted. Uninstallation is complete. Installing the X1 Deployment Manager After you have uninstalled any older versions of the X1 Professional Client, install the X1 Deployment Manager from the MSI given to you by your X1 representative. Running the MSI will install both the X1 Deployment Manager and the X1 Professional Client. After install, launch the X1 Deployment Manager from the Start menu, X1 Deployment Manager group.

4 X1 Professional Client Deployment Guide

5 Chapter 2 Customizing the X1 Professional Client User Interface This chapter explains how to start, work with, and customize the X1 Professional Client in the following sections: Overview Opening the X1 Professional Client in Administration Mode Customizing the X1 Professional Client User Interface Customizing X1 Professional Client Settings Creating Saved Searches Adding Plugins to the X1 Professional Client Closing the X1 Professional Client Overview To customize the X1 Professional Client, you will close the X1 Professional Client if it is running, then use the X1 Deployment Manager to reopen the X1 Professional Client in Administration Mode. In Administration Mode, the UI and settings in the X1 Professional Client become modifiable and you can customize the X1 Professional Client for your user needs. Opening the X1 Professional Client in Administration Mode To start customization, stop the X1 Professional Client and reopen it in Administration Mode as described in the following procedure. Procedure Opening the X1 Professional Client in Administration Mode 1 If the X1 Professional Client is running, click on File and select Exit to close the X1 Professional Client. 2 Go to the Windows Start menu and point to X1 Deployment Manager > X1 Deployment Manager. The X1 Deployment Manager opens.

6 X1 Professional Client Deployment Guide 3 In Screen 1 of the X1 Deployment Manager, provide your license key and click Next. 4 In Screen 2 of the X1 Deployment Manager, the X1 Deployment Manager will open the X1 Professional Client in Administration Mode automatically for you. 5 The X1 Professional Client opens in Administration Mode and you can begin customization. The X1 Deployment Manager will continue running while you perform your customizations. Customizing the X1 Professional Client is described in detail in the next section; you don t need to perform any further steps in the X1 Deployment Manager yet. Customizing the X1 Professional Client User Interface After the X1 Deployment Manager has opened the X1 Professional Client in Administration Mode, move the X1 Deployment Manager interface to the side and switch to the X1 Professional Client. The first step in customizing the X1 Professional Client is modifying the user interface (UI). Procedures for customizing the X1 Professional Client menus and toolbars are given below. UI elements that can be modified will be identified with a wide black border when selected, as shown in Figure 2.1. Caution Any changes you make to menus are saved automatically when the change is made. Changes cannot be reversed. Before customizing the UI, you may want to create a outline of the UI elements you plan to remove to avoid errors. Figure 2.1 Modifiable Menu Items in the User Interface

Customizing the X1 Professional Client User Interface Customizing X1 Professional Client Settings 7 Procedure Customize menus and tabs 1 In the View menu, click on Toolbars and point to Customize. The Customize dialog box appears. Once the Customize dialog box appears, customization is enabled and you can begin modifying menus and tabs. Leave the Customize dialog box open until you have completed customization. 2 Click on any item in the menu bar, such as Files. The title of the submenu and any actions in the menu are outlined in black when they are selected with the mouse, indicating they can be customized. The Actions menu will only have actions available if a item is selected in the Results pane; you can still customize actions through the Actions toolbar. 3 Customize elements as needed: Reorder: Click and drag the element to a new position. Add: In the Customize dialog box, click on the Commands tab and drag command buttons out of the commands list to a menu. Remove: Click and drag the element out of the main console into another area, such as your Desktop, then release the mouse button. After you have customized menus and tabs, customize the toolbars. Procedure Customize Toolbars 1 In the Customize dialog box, click on the Toolbars tab. The Toolbars tab displays the toolbars that can be modified, and also lets you create new toolbars for your users. 2 To have the Actions toolbar displayed for your users, select Actions in the toolbar list. To hide the Actions toolbar from your users, clear Actions in the toolbar list. 3 To add actions to the Actions toolbar for your users, click on the Commands tab and select a search type, such as Email. Drag command buttons out of the commands list to the Actions toolbar in the main console. 4 To create a custom toolbar for your users, from the Toolbars tab, click New and type a name for the custom toolbar in the Add Toolbar dialog box, then click on the Commands tab and drag command buttons to the new toolbar. 5 To remove a button from a toolbar permanently, click on the expand chevron at the end of the toolbar and selecting Add or Remove Buttons, then click to clear the buttons you want to remove. Note If the expand chevron is not visible, go to Tools > Toolbars and clear Lock Toolbars. 6 When you have completed customization of the toolbars you want your users to have, click Close in the customization dialog box. User interface customization is complete. The next step is customizing settings. Customizing X1 Professional Client Settings Settings in the X1 Professional Client can be set to one of three states: available, dimmed, or hidden. When the X1 Professional Client is open in Administration Mode, a state

8 X1 Professional Client Deployment Guide button appears next to each setting. An example of X1 Professional Client with the state buttons appearing next to settings in the Options dialog box is shown in Figure 2.2. In this step, you will set the state of each setting (available, dimmed, or hidden) and also configure defaults for each X1 Professional Client setting. Figure 2.2 Customizing File Settings Setting availability is covered in the next procedure. Availability buttons control how the setting appears to end users: Available: The setting will be visible ( ) and changeable by end users. You might want to apply this level of availability to settings such as Keyboard Shortcuts, which users are likely to want to view and customize. : Dimmed: Setting will be visible, but dimmed ( ) and unchangeable to end users. You might want to apply this level of availability to settings you want users to be able to see, so they know how the setting is configured, but you do not want them to be able to change, such as index settings. : Invisible: Setting will be invisible ( ) to end users. You might want to apply this level of availability to settings you do not want users to know about, such as the Check for new version at startup setting. Procedure Customize setting availability 1 If the Customize Toolbars dialog box is still open from customizing the UI, close it. 2 In the Tools menu, click on Options.

Customizing the X1 Professional Client User Interface Customizing X1 Professional Client Settings 9 The Options dialog box appears, displaying an availability button next to each setting. 3 Change the availability for each setting by clicking on the availability button next to the setting: Available: Setting will be visible and available to end users. : Dimmed: Setting will be visible, but dimmed and unavailable to end users. : Invisible: Setting will be invisible to end users. 4 After you have customized setting availability, click OK in the Options dialog box. Your availability settings have been saved. The next procedure describes how to customize settings and define specific data types and network data to include in user indexes. You can also manage settings through Group Policy Objects; see Using Group Policy Objects on page 21 for more information. Procedure Customize data types included in the index 1 In the Tools menu, click on Options. The Options dialog box appears. 2 Configure the data type index settings: Email: Select the email program in the navigation tree. In the settings pane under Schedule Indexing, configure index options for email. To exclude email from the index completely, select Never - do not index. Contacts: Select the contacts program in the navigation tree. In the settings pane under Schedule Indexing, configure index options for contacts. To exclude contacts from the index completely, select Never - do not index. Tasks: Select the tasks program in the navigation tree. In the settings pane under Schedule Indexing, configure index options for tasks. To exclude tasks from the index completely, select Never - do not index. Calendar: Select the calendar program in the navigation tree. In the settings pane under Schedule Indexing, configure index options for calendar data. To exclude calendar data from the index completely, select Never - do not index. Files: Select Files in the navigation tree. In the settings pane under Schedule Indexing, configure index options for files. To exclude files from the index completely, select Never - do not index. 3 Click OK. Procedure Specify network data included in the index Note If your deployment scenario includes a large number of users, large amounts of network information, or network information that changes frequently, do not add network paths as outlined in this procedure. For optimum performance, installing the X1 Server will yield maximum results. 1 In the Tools menu, click on Options. The Options dialog box appears. 2 In the options navigation tree, select Files.

10 X1 Professional Client Deployment Guide 3 In the Files settings pane, click on More Indexing Options. The Indexing Options dialog box appears. 4 In the Add Network path text field, type the path of the network directory you want end users to be able to include in their indexes, or click Browse to navigate to the network directory. 5 Specify the types of files you want end users to be able to include from the network directory in the settings pane. 6 Click OK to add the network path and close the Indexing Options dialog box. Customization is complete. Adding Plugins to the X1 Professional Client You can provide additional functionality to your users by installing and configuring an X1 Professional Client plugin during customization. A plugin can add a set of custom actions that will appear in the Actions toolbar after the plugin is installed, custom preview functionality for specific file types, or access to remote datasources. Plugins are available from your X1 sales representative. Each plugin comes with full documentation on how to install and configure the plugin. Refer to the following procedure on installing plugins to get started. Procedure Installing a plugin 1 Click the Tools menu. 2 Click Options. The Options dialog box opens. 3 Click Plugin Manager in the Options tree control. 4 To install a new plugin, click the Install New Plugin button. The Open dialog box appears. 5 Navigate to the location of the plugin on your computer. All plugins end with the.xli extension. The default location for plugins is C:/Program Files/X1/extensions. 6 Click Open. A message appears asking you if it is OK to install the plugin. 7 Click OK. 8 The plugin is installed and appears in the plugin list. 9 In the Enable column, click to select the enable option. The plugin is installed and enabled. If the plugin you have installed connects to a remote datasource, you will need to configure access to the remote source before the plugin is ready to use.

Customizing the X1 Professional Client User Interface Adding Plugins to the X1 Professional Client 11 Setting up remote sources for a Plugin For plugins that connect to a remote source, you will need to configure the source after you have installed plugins and configured any plugin options. Note: If the remote source requires a username and password, set up an account for yourself on the remote source before starting this procedure. You will supply your own username and password temporarily in this procedure so the X1 Professional Client can verify the connection, then you will remove them. Users will have to supply their own username and password to access the remote datasource when the X1 Professional Client is deployed. Procedure Configure remote source for a plugin 1 Before beginning, confirm you have an account on the remote source if one is required. 2 In the X1 Professional Client, click the Tools menu and select Select Sources. The Select Sources dialog box opens. 3 Click Add. The Add Source dialog box opens. 4 In the Choose Connection Type dropdown list, select the plugin you want to configure. The fields in the Add Source dialog box will change to the specific fields for the plugin. 5 Complete the fields for the plugin. Refer to the documentation that came with the plugin for specific details about completing this step. Note: If a username and password is required for the remote source, supply your own username and password in this step. You will remove them in a later step. 6 Click OK. 7 If you provided your own username and password in Step 5, select the plugin you just configured and click Edit, then delete your username and password and close the Edit dialog box. Caution Make sure to clear your username and password in this step to avoid creating a security risk. 8 Click OK again to close the Select Source dialog box. The remote source has been configured. To make changes to the remote source configuration you just made, open the Select Sources dialog box again and select the plugin, then click Edit. To remove the remote source you just configured, open the Select Source dialog box again and select Remove. After you have configured the remote sources for the plugin, you are ready to create searches for your users that incorporate the remote source.

12 X1 Professional Client Deployment Guide Creating Saved Searches You will probably want to create at least one saved search for your users that is specially designed for what they are most likely to search for. If the plugins you are providing connect to a remote source, this is especially true. Saved searches are similiar to the standard searches that come with the X1 Professional Client and are accessed via search tabs, such as Email. A custom saved search that you create can federate (mix) the type of searches you think your users are most likely to need, making it easy for them to maximize their use of the X1 Professional Client. There are two ways to create a saved search; through Tools > Select Sources if a plugin is involved, or by performing a search yourself and then saving it when you are satisfied with the results. Both options are documented below. Procedure Creating a saved search with the option of including plugin sources 1 If the Select Sources dialog box isn t open, open it by clicking on the Tools menu and selecting Select Sources. 2 Click Create Search. The Federation dialog box appears. 3 To include only local sources in the saved search, leave out any plugin sources and select one or more local sources you want to federate together. If you have installed a plugin with a remote source and want to include the remote source in the saved search, select the remote source plugin from the list of sources. If you want the saved search to return results only from the remote source, don t select any other sources. If you want to federate (mix) search results with local sources, such as Email, select one or more local sources, then click OK. The Column Layout dialog box appears. 4 Select the columns that should appear when a user selects the saved search. The columns listed in the Selected Columns list are the columns that will appear; move columns into the Selected Columns list using the arrow buttons. 5 If you would like to give a custom name to your saved search, type it in the name field. You can also provide a description that will appear when the mouse hovers over the saved search. 6 Click OK. The saved search is created. It will appear in the All Searches pane of the X1 Professional Client main console, with the name you specified. Procedure Creating a saved search after performing a search 1 In the X1 Professional Client, search for the type of data end users will be looking for by selecting a data type and entering search terms in the Search text field to narrow results. 2 Refine the search results by typing terms in the column headers. 3 When you are satisfied with the results of the search, go to the File menu and select Save Search As. The Save As dialog box appears.

Customizing the X1 Professional Client User Interface Closing the X1 Professional Client 13 4 Select a location to save the search and create a name for your search that will be meaningful to your users. 5 Click OK. The search has been saved. It appears in the list of searches in the Searches menu, and is listed in the Searches pane. Continue creating and saving searches until you created a collection of searches for your users. Closing the X1 Professional Client After you have completed customization, the next step is to shut down the X1 Professional Client and return to the X1 Deployment Manager to begin creating the custom installer. Procedure Closing the X1 Professional Client 1 In the X1 Professional Client, click on File and select Exit. The X1 Professional Client closes. 2 Verify that the X1 icon is no longer present in the system tray. You are ready to create the installer for your custom X1 Professional Client.

14 X1 Professional Client Deployment Guide

15 Chapter 3 Deploying the X1 Professional Client This chapter provides detailed directions on deploying the X1 Professional Client in the following sections: Overview Creating the Installer Testing the X1 Professional Client Distributing the Installer Overview After you have completed customization, you will create a custom installer, test the X1 Professional Client, and distribute the X1 Professional Client to your users. You can create either an executable (.exe) file installer or a batch file and MSI script. This chapter describes the two installer options and how to create distribute them to your users. Creating the Installer Choose the type of installer you want to create: Option A: Creating an Executable This option creates an.exe file, a common format familiar to most users. Once the.exe is created, custom installer settings can be changed by running the X1 Deployment Manager again. The executable option will create a self-contained installer, but it does not support command line options or distribution methods that require an MSI script. Option B: Creating a Batch File and MSI Installer This option creates a collection of files that includes a batch file and an MSI file. Any changes can be made directly to the batch file, without the need to run the X1 Deployment Manager again. Command line options are supported.

16 X1 Professional Client Deployment Guide Note Users will be unable to initiate installation of the X1 Professional Client from a batch file on the network. If users need to initiate installation over the network, create an.exe installer instead. The problem of install failure from a network path is a known limitation of cmd.exe and is not related to X1 software. For more information on this limitation, refer to http://support.microsoft.com/?kbid=156276. Both options are covered in the following procedure. Procedure Creating the installer 1 Verify that the X1 Professional Client was completely shut down after customization was completed. 2 The X1 Deployment Manager should still be open on your desktop. If not, start it again and click Next. 3 Specify the directory where the X1 Professional Client will be installed on end user machines. Type the path, or click Browse to navigate to the directory on your computer. The directory you specify must be a path that can be generalized to any end user computer. To check if the pathname you have typed can be generalized, click the generalize button (! ) to toggle between names and values. 4 Specify the Application Data directory default location on end user machines. 5 Click Next. 6 Specify the Yahoo! functionality you want to provide to your end users (to learn more about the Yahoo! toolbar before deciding, go to http://toolbar.yahoo.com/): Offer Yahoo! Toolbar?: Select this option to include the Yahoo! toolbar option in the X1 Professional Client installer. Clear this option to exclude the Yahoo! toolbar from the final installer, then skip to the next step in this procedure. Install Yahoo! Toolbar: Select this option to have the Yahoo! toolbar installed automatically for your end users with the X1 Professional Client. Clearing this option means the Yahoo! toolbar will be offered to your end users, and they can choose whether to install it or not. Make Yahoo! my Home Page: Selecting this option will set your end user s home page in their browser to http://www.yahoo.com. Make Yahoo! my browser s default search engine: Selecting this option will set Yahoo! as the default search engine for the end user s browser. 7 Click Next. 8 Specify installer options in the Installer Options section: Run X1 after Install: Selecting this option means the X1 Professional Client will start automatically after installation is complete on the end user computer. Clearing this option means the end user will need to start the X1 Professional Client themselves after installation is complete. Install Desktop Icon: Selecting this option means a shortcut will be placed on the end user's desktop that will start the X1 Professional Client. Clearing this option means no shortcut will be placed on the desktop. Install X1 for all users: Selecting this option means the X1 Professional Client will be available to each user with a login account on a computer with multiple

Deploying the X1 Professional Client Creating the Installer 17 accounts. Clearing this option means the X1 Professional Client will be available only to the specific user who installs it, and not to other users with accounts on the same computer. Disable report pings during install: Clear this option to disable reports sent to X1 during client installation. Create Batch + MSI X1 Installer: Select this option to create a batch + MSI installer. Clear this option to create an exe installer. 9 Specify application options in the Application Options section. These options will reinforce the default settings you defined during customization. Allow indexing of network shares: Selecting this option means that the X1 Professional Client will allow the end user to index the contents of any network directories the end user has permission to access. Clearing this option means that no content from network directories will be included in the index. Caution Carefully consider the potential impact on network load when selecting this option. If in doubt, clear this option to prevent potential performance impacts. Allow server searches: Selecting this option allows end users to add and search servers. Clearing this option prevents them from searching any servers that are available to the X1 Professional Client. Allow indexing uncached Exchange email: Allow email that is not cached on Exchange to be included in the index. Allow Exchange Global Address List indexing: Selecting this option means that Global Address List contacts will be included in end user indexes. Clearing this option means that contacts in a Global Address List will not be included in end user indexes. You may wish to consider potential performance impacts before allowing end users to include Outlook/Exchange Global Address List contacts in their indexes. Upload usage/crash reports to X1: Select this option to allow reports about usage and crashes to be uploaded to X1. Check for upgrades from X1: Select this option to trigger an automatic check for new versions of the X1 Professional Client. Force Lotus auto sign-in: Selecting this option requires end users to provide their Lotus credentials each time they log in. It dims the Automatic sign in option that is normally available. Use alternate Help file: Selecting this option means the standard X1 Help file will be exchanged for a customized version you have created. Type the path of the file or click Browse to navigate to the file. The new Help file must be named Help.CHM. Clearing this option means the standard X1 Help file will appear to end users from the Help menu in the main console. 10 Click Next. The.exe installer is created. A message appears saying the installer is complete and provides a link to the directory where the installer was created. 11 Click Exit. A dialog appears asking if you want to save changes.

18 X1 Professional Client Deployment Guide 12 To save the settings you specified in the Deployment Manager for the next use, click Yes. If you do not want your settings saved, click No. If you selected the exe installer option, the installer is created on your Desktop. To view and test your installer, click on the installer icon on your Desktop. If you selected the batch + MSI file option, the installer will be a folder on your desktop containing an MSI file, a subfolder named SettingsToDeploy, and a deployment batch file named deploy.bat.you can customize the deploy.bat file at any time without running the X1 Deployment Manager again, using MSIEXEC command line options. See MSIEXEC Command Line Options on page 27 for a detailed reference of the available options. Your customized version of the X1 Professional Client is ready for distribution to your end users. Testing the X1 Professional Client Before deploying the X1 Professional Client, place the new custom installer on a computer, install the X1 Professional Client to test the installer, then open the X1 Professional Client and verify that the customized user interface, settings, and Saved Searches you created function as planned. After you have completed testing, you are ready to distribute the installer to your users. Distributing the Installer After you have created your installer, you may wish to create a file that will check user computers for a version of the X1 Professional Client earlier than 5.2.3 and uninstall the older version. Versions later than 5.5 can be upgraded with settings and indexes saved for use in the new version. Scheduling Deployment From a performance perspective, you must consider the impact on your enterprise resources when you deploy the X1 Professional Clients. Upon installation, the X1 Professional Client will initially index local files and email. Network bandwidth is a factor if you set up your X1 Professional Clients to index files that reside on network share drives, or if your X1 Professional Clients need to connect to the Exchange Server to fetch email to index. Initial email indexing impacts both your network bandwidth, and may also potentially impact Microsoft Exchange Server performance. You may want to avoid network impact during initial index creating by rolling out the X1 Professional Client to groups of users during the night, when no other scheduled processes are occurring. This will allow you to manage bandwidth and Microsoft Exchange Server resources in a manageable, predictable way. Decide how many users to have in each deployment group based on what content will be indexed over the network and the amount of bandwidth that is available. The X1 Professional Client can be installed via scripts, Group Policies, or your organization s software distribution program, such as Microsoft SMS or Altiris.

Deploying the X1 Professional Client Distributing the Installer 19 Distributing an EXE Installer For user-driven self install, place the installer on the network and notify users of the location. Distributing a Batch File and MSI Installer Create a bundle that includes all directories and files created by the X1 Deployment Manager and distribute it to your users. Caution The Settings to Deploy folder MUST be bundled together with the MSI installer for deployment. Be sure the bundle you create includes all necessary files before deploying the X1 Professional Client. Use the following tips when setting up installation from a network share: Do not use a Universal Naming Convention (UNC) path. Instead, map the path to a drive letter. Install using a Microsoft Windows Shortcut: a b c Modify the registry as described in the Microsoft Knowledge Base article KB156276 at http://support.microsoft.com/?kbid=156276. Create a Windows Shortcut for the BAT file, then set the shortcut Start in directory value, under Properties, to the UNC path where the BAT file is located. Install from the shortcut, which can be run inside cmd.exe.

20 X1 Professional Client Deployment Guide

21 Chapter 4 Managing Deployed X1 Professional Clients This chapter explains how to manage and upgrade deployed X1 Professional Clients in the following sections: Using Group Policy Objects Using Group Policy Objects The X1 Professional Client includes an administrative template (.adm file) that defines policies for the X1 Professional Client. To change policy settings, open the file in a Group Policy editor, make modifications, and save the file. After you have made changes, the administratative template is applied to the distributed X1 Professional Clients through registry changes on computers where the X1 Professional Client is installed, using Active Directory functionality, or via a script or software management software such as Altiris. For a complete reference of all available policies, see Appendix B, Group Policy Settings Reference, on page 32.

22 X1 Professional Client Deployment Guide

23 Appendix A Advanced Management Reference This Appendix includes details on performance guidelines and technical references for the following advanced management areas: Performance Tuning Antivirus Software and the X1 Professional Client Performing Complete Uninstalls Performance Tuning This section contains a discussion and tips on how to tune the X1 Professional Client for optimum performance. Tuning Indexing You can streamline performance by setting a low maximum file size for items the X1 Professional Client includes in the index. The default maximum file size is 60 MB; above this size, only file attributes are included in the index. The maximum file size can be tailored for your organization. The best way to define a maximum file size is to review the sizes of files that are used most frequently in your organization and determine a meaningful maximum that will balance performance requirements with user needs. In general, the more content the X1 Professional Client includes in the index, the greater impact on performance. You can improve performance by limiting content indexing to specific file types, such as Microsoft Office files, or limit content indexing only to directories containing files that are especially relevant to your users. Content indexing can also be turned off completely. Tuning Microsoft Outlook Real-Time Indexing The default setting of the X1 Professional Client is to enable real-time indexing for Microsoft Outlook and local files. Real-time indexing of local files is always recommended to ensure search results are timely and accurately reflect any changes. However, there can be performance impacts when real-time indexing is enabled for Microsoft Outlook. Microsoft Outlook real-time indexing can be enabled to scan the following folders in realtime:

24 X1 Professional Client Deployment Guide Inbox Deleted Items Drafts Sent Items Note Subfolders under these folders will not be indexed in real-time. If a user receives a large volume of email per day, you may want to minimize performance impact by disabling real-time indexing of Microsoft Outlook and rely on scheduled updates instead. If performance does not improve significantly, then you may wish to disable real-time indexing for Microsoft Outlook completely and rely on scheduled updates instead. Antivirus Software and the X1 Professional Client Many organizations utilize antivirus software that scans directories and files for potentially harmful elements. Typically, antivirus scanning software includes an exclusion lists that directs the antivirus software not to scan any directories or files listed in the exclusion list. If you choose to add X1 directories to an antivirus scanner exclusion list, you may want to start with the directories described below. Caution X1 does not recommend adding any directories or files to antivirus scanner exclusion lists. For optimum antivirus scanning performance, all directories and files should be scanned. The X1 Professional Client data directory, where the index is stored: %userprofile%\local Settings\Application Data\X1 Desktop Search Note If the end user has changed the location for the index from the default directory given above, you will need to find out the new location. The data directory is constantly updated and contains no executable files, making it a candidate for an antivirus scanner exclusion list. Excluding the data directory could help reduce false positives and improve performance. The X1 Professional Client temporary directories, where transient file and archive files, such as ZIP files, may occur: %userprofile%\local Settings\Temp\X1 %userprofile%\local Settings\Temp\X1Server These temporary directories are another option to consider for exclusion from antivirus scanning. While the X1 Professional Client does play multimedia files, it will never execute any file located in the temp directory. Common User Problems Some common user problems are detailed below. If users frequently request information on these problems, you may want to distribute an FAQ containing answers to common issues, or refer them to the Help file in the X1 Professional Client.

Advanced Management Reference Performing Complete Uninstalls 25 Table A.1 Problem User unable to find an item Dual Monitor problems Backup issues Outlook PST files Exchange profile "Error -- click to try again" Solution The three primary sources of search confusion are: Index options: This is often due to an incomplete indexing process, such as an index which has been manually stopped by the user. Incomplete folder selection is also a common cause of this problem. Search usage: Many users may not understand how to search the index initially. Refer them to the Help included with the X1 Professional Client for detailed instructions and concepts. Unsupported document type: Users may not realize that choosing the Index Everything option will still not include unsupported file types. The X1 Professional Client does not support dual-monitor deployment scenarios. Advise the user to use the X1 Professional Client on the primary monitor. There are known conflicts with backup software. We recommend shutting X1 down completely before running any backup tasks, particularly with Outlook PST files. PST files can only be successfully accessed by one connection. Users should either index their PST files through Outlook or through X1, but not both. The X1 Professional Client only supports the default Exchange profile (as defined under Start > Control Panels > Mail > Show Profiles). The X1 Professional Client will not recognize changes to this profile. If a user changes their default Exchange profile, they will need to clear and rebuild their index. This error sometimes appears if the scanner was unable to complete a scan on a file. Users should manually restart indexing until this message no longer appears. Performing Complete Uninstalls In some deployment environments, pieces of the X1 Professional Client may be left behind after uninstall. This may occur when:

26 X1 Professional Client Deployment Guide The user uninstalling the X1 Professional Client is different than the user that originally installed the X1 Professional Client. The X1 Professional Client was used by multiple users on the same computer. The X1 Professional Client was installed via an automated system. An administrator installed the X1 Professional Client for a user. If you want to remove all pieces of the X1 Professional Client under these scenarios, you can perform a complete uninstall. This procedure is not required for upgrades. It is only necessary in situations where you need to remove all pieces of the X1 Professional Client. Procedure Perform a complete uninstall 1 Log in to the computer where the X1 Professional Client is installed. 2 Open the Add/Remove Programs dialog box and select the X1 Professional Client to start uninstallation. 3 During uninstallation, when prompted to save settings select No, do not save settings. 4 After uninstallation is complete, open the registry on the computer by bringing up a command prompt and typing regedit. 5 Navigate to the following registry entry: HKEY_CURRENT_USER / SOFTWARE / X1 Desktop Search 6 Locate the DataPath registry entry. 7 Write down the path shown in the Value column for the DataPath registry entry. This is the location of the X1 Professional Client index. The user may have changed the location of the index from the default location, so it is important to note the location of the index before proceeding. 8 In the navigation tree of the registry editor, select the X1 Professional Client directory and delete it. 9 Navigate to the following registry entry: HKEY_LOCAL_MACHINE / SOFTWARE / X1 Desktop Search 10 In the navigation tree of the registry editor, select the X1 Professional Client directory and delete it. 11 Navigate to the following registry entry: HKEY_USER / SOFTWARE / X1 Desktop Search 12 In the navigation tree of the registry editor, select the X1 Professional Client directory and delete it. 13 Close the registry editor. 14 In Windows Explorer, locate and delete the following directories: %userprofile%\local Settings\Application Data\X1 Desktop Search %userprofile%\local Settings\Temp\X1 %userprofile%\local Settings\Temp\X1Server Where %userprofile% is the profile for each user on the computer.

Advanced Management Reference Performing Complete Uninstalls 27 All elements of the X1 Professional Client have now been removed Uninstallation is complete.

28 X1 Professional Client Deployment Guide

29 Appendix B X1 Professional Client Reference This Appendix includes command line options, Group Policy, and Registry Key references in the following sections: MSIEXEC Command Line Options Group Policy Settings Reference MSIEXEC Command Line Options Some of the commonly used MSIEXEC command line options are listed below. Table B.1 MSIEXEC Command Line Options for the Installer Command msiexec.exe /i x1_xxx.msi msiexec.exe /x x1_xxx.msi msiexec.exe /i x1_xxx.msi /qn msiexec.exe /x x1_xxx.msi /qn msiexec.exe /i x1_xxx.msi /l*vx logfile.txt msiexec.exe /i x1_xxx.msi /qn / l*vx logfile.txt Function Standard installation. Installer screens will appear and end user will be prompted to answer install questions. Standard uninstallation. Uninstaller screens will appear and end user will be prompted to answer uninstall questions. Silent installation. No installer screens appear and no settings are specified by the end user. Silent uninstallation. No installer screens appear and no settings are specified by the end user. Standard installation, with the creation of a log file. Installer screens will appear and end user will be prompted to answer install questions. A log file will be created of the install process. Silent installation, with the creation of a log file. No installer screens appear and no settings are specified by the end user. A log file will be created of the install process. Standard MSI properties The following standard MSI properties are available. Table B.2 MSIEXEC Standard Properties