iManage

WorkSite Web

Components Server
Installation Guide
Version 9.0
Document Revision 3
June 2014

Copyright Notice

Notice
This documentation is a proprietary product of HP 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 HP Autonomy. While reasonable efforts
have been made to ensure the accuracy of the information contained herein, HP 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 1995-2014 Hewlett-Packard Development Company, L.P.
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.
HP Autonomy, Inc., One Market Plaza, Spear Tower, Suite 1900, San Francisco, CA. 94105, US.

Acknowledgements
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.

June 2014

Contents

Figures .......................................................................................................................... 7
Tables ............................................................................................................................ 9
About This Book ......................................................................................................11
Documentation Updates............................................................................................11
Conventions ..............................................................................................................13
Notational Conventions ......................................................................................13
Command-line Syntax Conventions ...................................................................14
Notices ..............................................................................................................15
Related Documentation.............................................................................................16
HP Autonomy Product References ...........................................................................16
HP Autonomy Customer Support ..............................................................................16
Contact HP Autonomy ..............................................................................................17
Document Revision History .......................................................................................18

Chapter 1
Introduction .............................................................................................................. 19
Overview ..................................................................................................................19
WorkSite Web Architecture ......................................................................................19
WorkSite Web Applications ......................................................................................23
WorkDocs ..........................................................................................................23
WorkSite Web ....................................................................................................23
Document Management and Collaboration Features ..................................24
Portal Capability ..........................................................................................25
WorkSite for SharePoint ....................................................................................25
Feature Comparison ................................................................................................26
Installation Checklist ................................................................................................27

WorkSite Web Components Server Installation Guide

Contents

Chapter 2
System Requirements .......................................................................................... 29
Overview ................................................................................................................. 29
Plan your Installation ............................................................................................... 30
Hardware Requirements ................................................................................... 30
Software Requirements ..................................................................................... 30
WorkSite Web Components Server ............................................................ 30
Client Machines .......................................................................................... 31

Chapter 3
Before You Install .................................................................................................. 33
Overview ................................................................................................................. 34
Install and Configure SQL or Oracle Server ............................................................ 34
Install and Configure WorkSite Server 9.0 ............................................................... 34
Designate a Web Database .............................................................................. 35
Add Users and Create Groups and Roles on WebDB ....................................... 35
Secure the WebDB ........................................................................................... 39
Hide the WebDB ............................................................................................... 39
Preliminary Steps Before Installing WorkSite Web Components Server .................. 40
Windows Server 2008 R2 and Windows Server 2008 (IIS 7 or 7.5) .................. 40
Backward Compatibility with IIS 6 ............................................................... 40
Windows Server 2012 and Windows Server 2012 R2 (IIS 8.0) ......................... 42
Before Installing WorkSite Web for SharePoint ....................................................... 46
Complete the System Information Checklist ............................................................ 47

Chapter 4
Install WorkSite Web ............................................................................................ 49
Overview ................................................................................................................. 49
Install or Upgrade WorkSite Web Components Server ............................................ 50
New Installations ............................................................................................... 50
Existing Installations ......................................................................................... 50
Customized Installations ................................................................................... 52
Install WorkSite Web Components Server ........................................................ 52
Silent Installation ............................................................................................... 54
Repair or Remove the Installation ........................................................................... 54
Initial Log in to WorkSite Web .................................................................................. 55
Log in to WorkSite Web .................................................................................... 55
Log in to WorkSite Web for SharePoint ............................................................. 56

WorkSite Web Components Server Installation Guide

Contents

Chapter 5
Configure WorkSite Web ..................................................................................... 59
Overview ..................................................................................................................59
Access the Manage Options ....................................................................................60
Configuration Options ..............................................................................................61
User Profiles and Groups ..................................................................................61
Send Notifications ..............................................................................................61
Hide Security Settings from External Users .......................................................61
Localization and Regional Settings ....................................................................62
Support for English and a Regional Language ............................................62
Set Date Format in Regional Languages .....................................................63
WorkSite Session Timeout Interval ....................................................................63
Trusted Login .....................................................................................................64
Update Client-Side Settings for Trusted Login .............................................64

Chapter 6
Install and Configure Optional Features ....................................................... 65
Overview ..................................................................................................................65
Install and Configure SMTP .....................................................................................66
Install SSL Support ..................................................................................................66
Verify SSL Support ............................................................................................67
Troubleshooting .................................................................................................67
Configure Single Sign-On (SSO) ..............................................................................67
Configure Single Sign-On Using ADFS 1.0 or 2.0 ....................................................69
Install Integration Mode ............................................................................................70
Register the IWL Protocol ..................................................................................71
Optional Verification Steps ..........................................................................72
Multi-Browser Support ..............................................................................................72
Select an Upload or Download Control ..............................................................72
Enable APA Integration in WorkSite Web ................................................................73

Appendix A
Troubleshooting ......................................................................................................75
Overview ..................................................................................................................75
Confirm WorkSite Web Settings in IIS ......................................................................76
WorkSite Properties ...........................................................................................76
Disable Anonymous Access in Firefox Browser .................................................78
Allow ASP.NET 2.0 Web Service Extension ............................................................79
WorkSite Web Directory Permissions .......................................................................79

WorkSite Web Components Server Installation Guide

Contents

Appendix B
System Information Checklist............................................................................ 81
Obtain System Information for Installation ............................................................... 81

Appendix C
WorkSite Web Configuration Checklist .......................................................... 83
Set User Options ..................................................................................................... 83
Global Options ......................................................................................................... 84
User Interface Options ...................................................................................... 85
WorkSpace Notification Options ........................................................................ 85
User Notification Options .................................................................................. 85
Event Notification Options ................................................................................. 86
Task Notification Options .................................................................................. 86
Application Settings Options ............................................................................. 87
User Settings Options ....................................................................................... 87
Document Settings Options .............................................................................. 88
Event Categories Options ................................................................................. 89
Web Access Management Options ................................................................... 89
HTML Export Settings Options .......................................................................... 89
Integration with WorkSite Mobility Web for all Mobile Devices .......................... 89
Integration with WorkSite for Mobility iOS App (IWL Link) for IOS Devices . 90
Additional Options ............................................................................................. 90

Appendix D
ActiveX Control for WorkSite Web ................................................................... 93
ActiveX Control Installation ...................................................................................... 93
Manual Installation ............................................................................................ 93
Silent Installation ............................................................................................... 94

WorkSite Web Components Server Installation Guide

Figures

Figure 1

WorkSite Components............................................................................................... 20

Figure 2

Model of WorkSite n-tier architecture ........................................................................ 22

Figure 3

WorkSite Database Management (DbAdmin) window............................................... 37

Figure 4

DbAdmin Group Management dialog box.................................................................. 38

Figure 5

Role Setup dialog box in DbAdmin ............................................................................ 39

Figure 6

Add Role Services .................................................................................................... 41

Figure 7

Enable IIS 6 metabase compatibility ......................................................................... 42

Figure 8

Windows Server 2012 Server Manager .................................................................... 43

Figure 9

IIS Configuration ........................................................................................................ 44

Figure 10 Server Roles (image continues on next page)........................................................... 45

Figure 11

Server Roles (continued) ........................................................................................... 46

Figure 12 Server Options........................................................................................................... 68

Figure 13 WorkSite Properties dialog boxVirtual Directory .................................................... 77
Figure 14 Authentication Methods dialog box............................................................................ 78

WorkSite Web Components Server Installation Guide

Figures

WorkSite Web Components Server Installation Guide

Tables

Table 1

WorkSite Web product line ......................................................................................... 23

Table 2

Features available in the WorkSite Web products ...................................................... 26

Table 3

Task listSystem requirements ................................................................................. 28

Table 4

Task listSystem requirements ................................................................................. 29

Table 5

Task listPrerequisites .............................................................................................. 33

Table 6

Task listInstalling or upgrading................................................................................ 49

Table 7

Quick referenceUpgrade procedure ........................................................................ 51

Table 8

Task listConfiguring WorkSite Web ......................................................................... 59

Table 9

Security external flag value......................................................................................... 62

Table 10

Task listPost installation .......................................................................................... 65

Table 11

Troubleshooting SSL installation ................................................................................ 67

Table 12

Integration and Document Operations ........................................................................ 71

Table 13

System Information required for WorkSite Web installation........................................ 81

Table 14

Set user options .......................................................................................................... 83

Table 15

Global optionsUser Interface options ...................................................................... 85

Table 16

Global optionsWorkSpace Notification Options....................................................... 85

Table 17

Global optionsUser Notification Options.................................................................. 85

Table 18

Global optionsEvent Notification Options ................................................................ 86

Table 19

Global optionsTask Notification Options ................................................................. 86

Table 20

Global optionsApplication Settings Options ............................................................ 87

Table 21

Global optionsUser Settings Options ...................................................................... 87

Table 22

Global optionsDocument Settings Options.............................................................. 88

Table 23

Global optionsEvent Categories Options ................................................................ 89

Table 24

Global optionsWeb Access Management Options .................................................. 89

Table 25

Global optionsHTML Export Settings Options......................................................... 89

Table 26

Additional configuration options .................................................................................. 91

WorkSite Web Components Server Installation Guide

Tables

10

WorkSite Web Components Server Installation Guide

About This Book

This guide describes how to install and configure WorkSite Web Components
Server and optional features, such as instructions for configuring Microsoft
Simple Mail Transfer Protocol (SMTP) and Secure Sockets Layer (SSL) support.
It includes an overview of the WorkSite Web architecture and WorkSite Web
applications. It also contains system requirements, steps that you need to
complete before installing WorkSite Web Components Server, and checklists to
ensure that you install WorkSite Web successfully.

Documentation Updates

Conventions

Related Documentation

HP Autonomy Product References

Contact HP Autonomy

Contact HP Autonomy

Document Revision History

Documentation Updates
The information in this guide is current as of WorkSite Web Components Server
version 9.0 Update 3. The content was last modified June 2014. You can retrieve
the latest available product documentation from the WorkSite Customer Support
Site: https://worksitesupport.autonomy.com
Documents have 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 support site contains the latest available revision of any document.
HP Autonomy recommends that you periodically check the Knowledge Base for
revisions to documents for the products your enterprise is using.

WorkSite Web Components Server Installation Guide

11

About This Book

To access HP Autonomy documentation

1. Go to the HP Autonomy Customer Support site:
https://customers.autonomy.com/
2. Click Login.
3. Type the login credentials that you were given, and then click Login.
The Customer Support Site opens.
4. Click Knowledge Base.
The Knowledge Base Search page opens.
5. Search or browse the Knowledge Base.
To search the knowledge base:
a. In the Search box, type a search term or phrase and click Search.
Documents that match the query display in a results list.
To browse the knowledge base:
a. Select one or more of the categories in the Browse list. You can browse
by:

Repository. Filters the list by Documentation produced by technical

publications, or Solutions to Technical Support cases.

Product Family. Filters the list by product suite or division. For

example, you could retrieve documents related to the iManage, IDOL,
Virage or KeyView product suites.

Product. Filters the list by product. For example, you could retrieve
documents related to IDOL Server, Virage Videologger, or KeyView
Filter.

Version. Filters the list by product or component version number.

Type. Filters the list by document type. For example, you could
retrieve Guides, Help, Packages (ZIP files), or Release Notes.

Format. Filters the list by document format. For example, you could
retrieve documents in PDF or HTML format. Guides are typically
provided in both PDF and HTML format.

6. To open a document, click its title in the results list.

To download a PDF version of a guide, open the PDF version, click the
Download icon
in the PDF reader, and save the PDF to another location.

12

WorkSite Web Components Server Installation Guide

Conventions

To download a documentation ZIP package, click Get Documentation

Package under the document title in the results list. Alternatively, browse to
the desired ZIP package by selecting either the Packages document Type or
the ZIP document Format from the Browse list.
HP Autonomy welcomes your comments.
To send feedback on HP Autonomy documentation
send email to [email protected]

provide:
full document title with version and revision number
location: heading, a snippet of text or screen capture
your comments
your contact information in the event we need clarification

Conventions
The following conventions are used in this document.

Notational Conventions
This guide uses the following 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, see the IDOL Server
Administration Guide.
An action command is a request, such as a query or
indexing instruction, sent to IDOL Server.

WorkSite Web Components Server Installation Guide

13

About This Book

Convention

Usage

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.

{ 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.

14

WorkSite Web Components Server Installation Guide

Conventions

Convention

Usage

required

Absence of braces or brackets indicates required

syntax in which there is no choice; you must type the
required syntax element.

variable

Italics specify items to be replaced by actual values. For

example:

<variable>

-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 punctuationsuch 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 casesfor example,
memory limitations, equipment configurations, or details that
apply to specific versions of the software.

WorkSite Web Components Server Installation Guide

15

About This Book

TIP A tip provides additional information that makes a task

easier or more productive.

Related Documentation
The following documents provide more details on WorkSite Web Components
Server:

WorkSite Web Application Integration Toolkit

WorkSite Web Connector Developers Guide

WorkSite Web Customization Guide

WorkSite Web for SharePoint Users Guide

WorkSite Web Online Help

HP Autonomy Product References

This document references the following HP Autonomy products:

WorkSite Web Components Server

WorkSite Server

WorkSite Web for SharePoint

HP Autonomy Customer Support

HP Autonomy Customer Support provides prompt and accurate support to help
you quickly and effectively resolve any issue you may encounter while using HP
Autonomy products. Support services include access to the Customer Support
Site (CSS) for online answers, expertise-based service by HP 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

16

WorkSite Web Components Server Installation Guide

Contact HP Autonomy

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.

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

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

Contact HP Autonomy
For general information about HP Autonomy, contact one of the following
locations:
Europe and Worldwide

North and South America

E-mail: [email protected]

E-mail: [email protected]

Telephone: +44 (0) 1223 448 000

Fax:
+44 (0) 1223 448 001

Telephone: +1.415.243.9955
Fax:
+1.415.243.9984

HP Autonomy Corporation plc

Cambridge Business Park
Cowley Rd.
Cambridge CB4 0WZ
United Kingdom

HP Autonomy, Inc.
One Market Plaza
Spear Tower, Suite 1900
San Francisco CA 94105
USA

WorkSite Web Components Server Installation Guide

17

About This Book

Document Revision History

Document Revision

Release Date

Notes

15 September 2011

Updated Chapter 4 to clarify language selection on the

first screen of the installation wizard.

August 2013

9.0 Update 2 Release. Add instructions for enabling APA

Alerts on document menu in WorkSite Web.
Add instructions for installing WorkSite Web Components
Server on Windows 2012 server with IIS 8.

May 2014

Support for trusted authentication using ADFS 2.0.

.NET Framework 2.0 or later required.
If installing WorkSite Web for SharePoint, SharePoint
2013 requires .NET Runtime 4.0.
Added Manage options for Integrating with WorkSite
Mobility apps (Appendix C)
Added a Note to Before Installing WorkSite Web for
SharePoint Integration

18

WorkSite Web Components Server Installation Guide


Introduction
CHAPTER 1

Overview
WorkSite Web is a document management and collaboration system that can be
accessed from the Internet or corporate intranet and extranet. The WorkSite
Server supports a suite of WorkSite Web Component applications to provide
enterprises with a robust and highly secure platform for developing collaborative
Web-based applications that link employees, customers, suppliers, and partners.
This chapter provides the following information:

WorkSite Web Architecture

WorkSite Web Applications

Feature Comparison

Installation Checklist

WorkSite Web Architecture

WorkSite Web is deployed as an application in the Microsoft .NET Framework
running on the Microsoft Internet Information Server. It employs .NET technology
and the Component Object Model (COM) to produce a powerful
knowledge-management system with a user-friendly interface. All application
code is written in C# and ASP.NET. XML is used in a limited way for storing task

WorkSite Web Components Server Installation Guide

19

Chapter 1 Introduction

and event searches in the WorkSite repository. On the client, implementation is

handled through client-side JavaScript, DHTML controls, ActiveX controls, and
applets.
The use of these technologies ensures that WorkSite can be smoothly integrated
with existing intranets. WorkSite is accessed through a client web browser. Users
log in to WorkSite through the WorkSite Web user interface. The front-end
features of the applicationthe user interface and dynamic web pagesare
assembled at runtime using COM objects and XML.
Communication between WorkSite Web and the WorkSite middle-tier server is
encapsulated in the WorkSite COM components. WorkSite has leveraged the .Net
framework to develop a web application that is highly extensible and
customizable. The workspaces and tabs that display information to the user are
server-side objects. Activities performed by users in the applications are
accomplished using ASP and COM. ActiveX Data Objects are used on the client
side to facilitate file uploads and downloads and to create components of the user
interface.
Figure 1 illustrates how the client and server components of WorkSite
communicate with each other. The configuration you use when you set up your
WorkSite system will be based on the existing technologies and hardware in your
environment and the combination of WorkSite products you install.
Figure 1 WorkSite Components

The following list briefly describes the function of each component:

Data Tier
Database Server. Contains WorkSite databases that store WorkSite
document metadata.

20

WorkSite Web Components Server Installation Guide

WorkSite Web Architecture

File Server. Stores WorkSite documents.

IDOL Indexer. Indexes document content and metadata and fields full-text
search requests.

Middle Tier
WorkSite Server
Rules Engine. The Rules Engine handles user notifications for change

events related to WorkSite documents and folders.

SMTP server. (Optional) You can specify a mail server if you want to send

notifications as e-mail messages.

WorkSite Server supports an online application that provides enterprises with
a robust and highly secure platform for developing collaborative Web-based
applications that link employees, customers, suppliers and partners.
WorkSite Server allows you to:
Construct highly scaleable and customizable repositories that organize

and store critical business documents like contracts, product

specifications, legal briefs and business reports.
Share documents over the web among employees, customers, suppliers

and partners in a tightly secured environment.

Create highly scaleable repositories for best practices and knowledge

management.
Create collaborative web-based project management applications that

bring customers and suppliers together seamlessly and efficiently.

Develop collaborative portals or central worksites that bring together all

relevant enterprise information and enable secured collaboration among

team members using the Internet, intranet or extranet.
Facilitate the exchange of business-critical information by managing the

entire lifecycle of e-mail, voicemail, discussions, and associated business

processes.
For more information on the WorkSite Server, refer to the WorkSite Server
Administrators Guide.
Client Applications
WorkSite Web Components Server

IIS

WorkSite Web Applications. For more information, see WorkSite Web

Applications on page 23.

WorkSite Web Components Server Installation Guide

21

Chapter 1 Introduction

Microsoft Windows Server Internet Information Services (IIS) and all WorkSite
client applications are installed on the WorkSite Web Components Server.
You can install two or more servers on the same machine depending on various
factors, such as the size of your WorkSite system, the quantity of data, and the
desired level of efficiency. For more information, refer to the WorkSite Server
Installation Guide.
This section provides information about configuring your servers for the
installation of WorkSite. Figure 2 illustrates a model of WorkSite n-tier architecture
with arrows indicating communication between the middle-tier server and the SQL
or Oracle servers and the Web Components Server.
Figure 2 Model of WorkSite n-tier architecture

WorkSite requires the following servers:

Database Server. This server hosts the WorkSite databases, including the
WorkSite Web Configuration Database. It is part of the data layer, along with
the IDOL Indexer, and file server.

WorkSite Middle-tier Server.This server hosts the DMS Service, as well as

an e-mail Notification Engine that connects to an SMTP server. Install the
WorkSite Server software on this machine.
NOTE WorkSite Web 9.0 requires WorkSite middle-tier
server version 9.0. If you are upgrading to WorkSite Web
9.0, you must also upgrade the WorkSite Server to version
9.0

22

WorkSite Web Components Server. This server hosts the Microsoft Internet
Information Server (IIS) and the WorkSite Web application. It forms the
application layer, which can be accessed directly by users through their

WorkSite Web Components Server Installation Guide

WorkSite Web Applications

browsers. Install the WorkSite Product Suite, or WorkDocs and selected

add-on modules on this machine.

WorkSite Web Applications

With the WorkSite 8.2 release, the WorkSite Web product line was realigned to
include three new products that provide you with full WorkSite document
management capabilities: WorkDocs, WorkSite Web, and WorkSite Web for
SharePoint. With the WorkSite 8.5 and 9.0 releases, read-only versions of the
WorkSite web products are also available. The read-only product versions are
view and open client. You can view the content and see properties but you cannot
take action, such as modifying the content or saving a new document.
Table 1 WorkSite Web product line
Product

Consists of

WorkDocs
WorkDocs Embed

WorkDocs ReadOnly

WorkSite Web

WorkDocs, connectors, and collaboration items

WorkSite Web ReadOnly

Read-only WorkSite Web

WorkSite for SharePoint

WorkDocs + SharePoint integration

WorkSite Embed for

SharePoint

WorkDocs Read-only + SharePoint integration

WorkDocs
WorkDocs is a web-based document management client. It can be used as an
independent web-based document management client or as a remote access
solution for desktop users. The product now offers a tree that replicates the user
experience of the desktop client. Provides remote access to WorkSite repositories
and full document management functionality.

WorkSite Web
WorkSite Web is a collaborative document management system. This is a product
that can be used as a platform for intranet and extranet. It provides a combination
of rich document management, collaboration, and the ability to have a flexible
user interface. WorkSite Web is a combination of the WorkDocs, and other
functionality. A collaborative web portal with full WorkSite document management
functionality.

WorkSite Web Components Server Installation Guide

23

Chapter 1 Introduction

Document Management and Collaboration Features

WorkSite Web provides powerful and secure document management functionality
over the Internet, intranet, and extranet. It does away with information barriers,
allowing access to critical information, such as documents, faxes, forms, records,
e-mail, voice-mail, Web content, images and multimedia.
WorkSite Web has the following document management capabilities:

Matter-centric navigation in which the WorkSpace functions as an electronic

version of a client-matter case file.

Unlimited folder hierarchies for organizing data.

Search and retrieval functionality that includes profile and full-text searches,
quick searches, and saved search folders.

Checkin/Checkout controls that manage the document editing process and

track document location to prevent simultaneous edits by multiple users.

Automatic re-filing when a document is moved to a new folder.

Version control and revision management for creating and storing multiple
revisions.

Document history that displays a documents activity in chronological order.

Security features for granting and restricting document access rights to users
or groups.

Combined Worklist that displays the last 40 documents accessed from

multiple databases, along with their profile and history.

WorkSite Web also provides a collaborative workspace for dispersed teams. You
can use WorkSite to manage complex activities like mergers and acquisitions,
manufacturing and IT outsourcing across geographic boundaries. WorkSites
collaboration features combined with document management help get everyone
on the same page with the right project information. Teams can coordinate project
documents and activities in a secure space accessible only to authorized users.
WorkSite offers the following collaboration features:

24

Collaborative tools, including discussion threads, calendars, task lists, and

notes accessible through the WorkSpace.

Intuitive WorkSpace creation using a Web service for rapid project

mobilization.

Ability to search for messages, tasks, and events across teams to facilitate
project management and team interaction.

Automatic notification to keep all team members current on project activities.

WorkSite Web Components Server Installation Guide

WorkSite Web Applications

Synchronization with Outlook and PDA calendar events and tasks.

Portal Capability
HP Autonomy iManage connectors can turn a WorkSite workspace into a single
point of access to information from a variety of sources. Data aggregation and
seamless integration with Web sites and other applications is accomplished by
adding WorkSite connectors to a workspace. WorkSite administrators can create
unlimited new connectors in addition to the HP Autonomy iManage connectors
that are shipped with the WorkSite Web application. For more information about
connectors, see the WorkSite Web Connectors Developers Guide.

WorkSite for SharePoint

NOTE WorkSite for SharePoint must be installed on the
SharePoint server.

WorkSite for SharePoint enables you to:

Expose WorkSite repositories through the SharePoint user interface.

Utilize the document management capability of other WorkSite client

applications. This functionality is exposed through a set of web parts.

Integrate WorkSite content into your SharePoint intranet or extranet. WorkSite

for SharePoint integrates WorkSite document management functionality with
Microsoft SharePoint.

Publish documents from your SharePoint repository to WorkSite

Work with WorkSite documents with all document management functionality

within your Microsoft SharePoint Portal and SharePoint Services. IWOV Web
Parts put My Matters, Document Worklist, Matter Worklist and saved searches
on a SharePoint workspace. IWOV Web Parts can be shared or dropped on a
workspace with other Web Parts to enable users to get the most out of both
applications.
NOTE WorkSite for SharePoint requires Microsoft Office
SharePoint Portal Server 2007, 2010 or 2013. For detailed
instructions for installing WorkSite for SharePoint, see the
WorkSite for SharePoint User Guide.

WorkSite Web Components Server Installation Guide

25

Chapter 1 Introduction

Feature Comparison
Table 2 lists the supported operations in each WorkSite Web product.
You can combine any of the read-only product versions with WorkDocs, WorkSite
Web, and WorkSite for SharePoint.
Table 2 Features available in the WorkSite Web products

Operations

WorkDocs

WorkDocs
Embed

WorkSite
Web

WorkSite
Web
ReadOnly

WorkSite
for
SharePoint

Workspace
Operations

Folder
Operations

Add
Operations

WorkSite
Embed for
SharePoint

Document Operations
View

View as
HTML

Checkout

Import New
Version

Set up
Relation

Download

Only
Integrated
Download
Allowed

Only
Integrated
Checkout
Allowed

Only
Integrated
Download
Allowed

Publish to
SharePoint

Publish to
WorkSite

Versions

26

Only
Integrated
Checkout
Allowed

Only
Integrated
Checkout
Allowed

Only
Integrated
Download
Allowed

WorkSite Web Components Server Installation Guide

Installation Checklist

Table 2 Features available in the WorkSite Web products (continued)

WorkDocs

WorkDocs
Embed

WorkSite
Web

WorkSite
Web
ReadOnly

Related
Documents

Where Used

History

Create
Shortcut

Copy

Move

Refile

Send URL

Send
Document

Add to My
Favorites

Remove from
folder

Delete

Declare as
Record

Operations

WorkSite
for
SharePoint

WorkSite
Embed for
SharePoint

Installation Checklist
The following is a checklist of tasks, covered in the order that you will perform
them, for installing WorkSite Web. The checklist appears throughout the WorkSite
Web installation chapters, indicating where you are in the process.

WorkSite Web Components Server Installation Guide

27

Chapter 1 Introduction

Table 3 Task listSystem requirements

Task

Application

Check for required hardware and software

Various Systems

Install and configure SQL or Oracle server

SQL or Oracle server

Install and configure WorkSite Server 9.0

WorkSite Server

Record information required for WorkSite Web

Server Components installation

Various Systems

Install and configure WorkSite Web Components

Server

WorkSite Web Server

Post-installation procedures

WorkSite Web Server

WorkSite Web Server configuration options

WorkSite Web Server

Additional installation and configuration options

WorkSite Web Server

When the installation is complete, see WorkSite Web Configuration Checklist on

page 83 for a checklist of tasks to configure and launch your WorkSite Web site.

28

WorkSite Web Components Server Installation Guide

CHAPTER 2

System Requirements
Table 4 Task listSystem requirements
Task

Application

Check for required hardware and software

Various Systems

Install and configure SQL or Oracle server

SQL or Oracle server

Install and configure WorkSite Server 9.0

WorkSite Server

Record information required for WorkSite Web

Server Components installation

Various Systems

Install and configure WorkSite Web Components

Server

WorkSite Web Server

WorkSite Web Server configuration options

WorkSite Web Server

Additional installation and configuration options

WorkSite Web Server

Overview
This chapter provides information about the system requirements for client
machines and the machine on which you want to install the WorkSite Web
Components Server.

WorkSite Web Components Server Installation Guide

29

Chapter 2 System Requirements

Hardware Requirements

Software Requirements

Plan your Installation

You need to plan installation depending on the scenario, such as number of users,
whether you want to install at a single site or multiple sites, required memory, and
more. You also need to ensure that you have the systems have the appropriate
software installed.

Hardware Requirements
The hardware requirements will vary depending on your plan for the WorkSite
Web installation. For information about the required hardware for Client PCs and
to install WorkSite Web Components Server, see the WorkSite Server Design
Guide.

Software Requirements
WorkSite Web Components Server
The WorkSite Web Components Server runs on IIS with .NET Framework 2.0 or
later installed. You must install the IIS and related software on the machine where
the WorkSite Web Components Server will be running.
You need to install the following software on this machine.

A compatible version of Microsoft Windows 2012 or 2008 Server:

Windows 2012 R2 (64-bit) and Windows 2012 (64-bit) with IIS 8.0
Windows 2008 R2 and Windows 2008 (64-bit and 32-bit) with IIS 7.5 or 7.0
NOTE With the WorkSite Web 9.0 Update 3 release,
only 64-bit is supported.

30

Microsoft Internet Information Server (IIS) 8.0, 7.5, 7.0 or 6.0.

WorkSite Web Components Server Installation Guide

Plan your Installation

Microsoft Internet Information Service (IIS) must be installed on the WorkSite

Web Components Server machine.
NOTE For IIS 7.5 and 7.0, you must perform the steps in Preliminary
Steps Before Installing WorkSite Web Components Server on page 40
before installing WorkSite Web. For IIS 8.0 on a Windows 2012 Server
machine, see the prerequisites for installing WorkSite Web Server on a
Windows Server 2012 and Windows Server 2012 R2 (IIS 8.0) on
page 42.

(Optional) Microsoft Management Console (MMC) for Secure Sockets Layer

(SSL) implementation. See Install SSL Support on page 66.

Localized Operating System

This is required for installations running non-English editions of the WorkSite
Web Components Server.
NOTE For WorkSite Web Integration with SharePoint, you need to install
either MOSS 2007 or 2010, or WSS 3.0 on the machine where WorkSite
Web Components Server will run. WorkSite Web Integration supports
SharePoint 2013 with .NET Runtime 4.0. See the Microsoft SharePoint
documentation for information on installing and configuring SharePoint.

For information about supported platforms and compatible software, see the
WorkSite 9.0 Supported Platforms document.

Client Machines

Browser:
Microsoft Internet Explorer 8, 9, 10, and 11
FireFox latest version
Google Chrome latest version
Safari latest version

The following Java Virtual Machines (JVMs) are supported on client

workstations:
SUN JVM 1.7

Java applets are used by the application during file upload/download.

JVM is not required on client workstations, if the option to use ActiveX or
FileControl controls for file upload/download is enabled instead of using Java
applets. This option can be configured from Global Options in the application by
any member of the administrators group (NRTADMIN).

WorkSite Web Components Server Installation Guide

31

Chapter 2 System Requirements

FileControl uses the browsers native File Upload/Download control. If you use the
FileControl option, neither ActiveX nor Applet is required.

32

WorkSite Web Components Server Installation Guide


Before You Install
CHAPTER 3

Table 5 Task listPrerequisites

Task

Application

Check for required hardware and software

Various Systems

Install and configure SQL or Oracle server

SQL or Oracle server

Install and configure WorkSite Server 9.0

WorkSite Server

Record information required for WorkSite Web

Server Components installation

Various Systems

Install and configure WorkSite Web Components

Server

WorkSite Web Server

WorkSite Web Components Server configuration

options

WorkSite Web Server

Additional installation and configuration options

WorkSite Web Server

When the installation is complete, see WorkSite Web Configuration Checklist on

page 83 for a checklist of tasks required to launch your WorkSite Web site.

WorkSite Web Components Server Installation Guide

33

Chapter 3 Before You Install

Overview
This chapter provides information about the prerequisites to installing WorkSite
Web Component Server:

Install and Configure SQL or Oracle Server

Install and Configure WorkSite Server 9.0

Preliminary Steps Before Installing WorkSite Web Components Server

Click Next and Install.

Install and Configure SQL or Oracle Server

Install and configure SQL or Oracle server to create databases. You must create
at least one database as WorkSite Web requires a Web database.
1. Create a new, blank SQL or Oracle database. Hereafter, we refer to this newly
created database as WebDB.
2. Create a new System ODBC DSN for the newly created databases. For
detailed steps, see the Creating an ODBC System Data Source topic in the
WorkSite Server Installation Guide.

Install and Configure WorkSite Server 9.0

Before you begin the installation process for WorkSite Web, you must install and
configure WorkSite Server 9.0 to communicate with WorkSite libraries on
database server.
NOTE WorkSite Web Components Server 9.0.x requires
WorkSite Server 9.0.

1. Install and configure WorkSite Server 9.0. For information about installing and
configuring WorkSite Server 9.0, see the WorkSite Server Installation Guide.
2. Register the database using the DbAdmin tool to create WorkSite related
tables or schema. For detailed steps, see the Registering WorkSite Databases
topic in the WorkSite Server Administrators Guide.
Complete the following steps on the WorkSite Server:

34

WorkSite Web Components Server Installation Guide

Install and Configure WorkSite Server 9.0

1. Designate a Web Database on page 35.

2. Add Users and Create Groups and Roles on WebDB on page 35.
3. (Optional) Securing and Hiding WebDB. See Secure the WebDB on page 39
and Hide the WebDB on page 39 respectively.

Designate a Web Database

You must select a database to serve as the WorkSite Web Configuration
Database (WebDB). See the WorkSite Server Administrators Guide for
information about configuring your database server and setting up database
tables.
The Web database stores the WorkSite Web settings. You can designate a single
database as primary and Web database. For information about primary and Web
databases, see the Configuring WorkSite Server Service Database Properties
topic in the WorkSite Server Administrators Guide.
CAUTION If you choose to store content and WorkSite
workspaces in the same database, you need to put policies
in place to ensure that workspaces are not deleted or
archived by an Administrator.

Add WebDB to WorkSite Server Service. For detailed steps, see the
Configuring WorkSite Server Service Database Properties topic in the
WorkSite Server Administrators Guide.
NOTE In the Designate database as section, you must
click Web Content to designate WebDB as a Web database
in the WorkSite Server Service. The Web settings are stored
in the Web database.

NOTE Click Hidden if you do not want to display the Web

Content database. For more information, see Hide the
WebDB on page 39.

Add Users and Create Groups and Roles on WebDB

All users on the WorkSite Web Configuration Database (WebDB) must be enabled
for login. Users who need to perform user, group, and role administration must be
a member of the appropriate group on the database and must have the Use
WorkSite Administration privilege enabled in their role on all databases. For
information about enabling privileges, see the WorkSite Server Administrators
Guide. The following administrative groups are supported on WorkSite Web:

WorkSite Web Components Server Installation Guide

35

Chapter 3 Before You Install

INTERNAL_ADMIN. Allowed to create internal or external users, groups, and

roles, and configure group and role membership

INTERNAL_USERADMIN. Allowed to create internal or external users, but

not allowed to configure group/role membership

EXTERNAL_ADMIN. Allowed to create external users, groups and roles and

configure external group and role membership

EXTERNAL_USERADMIN. Allowed to create external users, but not allowed

to configure group/role membership

NRTADMIN. Allowed to perform all administrative functions

There must be a minimum of one administrator on the WebDB. If necessary,
add one user to the NRTADMIN Group on the WebDB.
NOTE An administrator can create new users, groups, and
roles using DBAdmin or WorkSite Web. After WorkSite Web
is installed, administrators can add users and create groups
and roles from WorkSite Web. For more information, see the
topic WorkSite Administration in the WorkSite Web Online
Help.

For more information about supported administrative groups, see the

Administrative Groups topic in the WorkSite Web Online Help.
1. Add users to the new WebDB. You can add users in the following ways:
Add virtual users. For detailed steps, see the Adding Virtual Users topic

in the WorkSite Server Administrators Guide.

Add LDAP Directory Users. For detailed steps, see the Adding LDAP

Directory Users topic in the WorkSite Server Administrators Guide.

Use Directory Service Synchronization (DSS) service. For more

information, see the Directory Service Synchronization Service chapter in

the WorkSite Server Administrators Guide.
2. Create groups.
NOTE You must create at least one group named
NRTADMIN so that you can login to WorkSite Web.

a. In WorkSite Database Management window, click the Group node.

NOTE The WorkSite DbAdmin program is available on the
WorkSite Server.

36

WorkSite Web Components Server Installation Guide

Install and Configure WorkSite Server 9.0

b. Click Manage > Add. The Add New Groups dialog box appears.
c. On the Virtual Group tab, in the Group box, type the group name, such
as NRTADMIN.
d. Click Add. The new group appears on the WorkSite Database
Management window.
3. Add users to groups.
a. Add at least one user to User on the WebDB. Select User from the DbAdmin
window (see Figure 3).
Figure 3 WorkSite Database Management (DbAdmin) window

The WebDB is expanded under the WorkSite Databases node to show the
groups that have access.
b. Add at least one administrative user to the NRTADMIN Group on the
WebDB. Select Group from the DbAdmin window (see Figure 3).
c. From the Manage menu on the DbAdmin window, select Add to create an
NRTADMIN group. Highlight the NRTADMIN group and select Group
Management to add a new administrator to the group using the Group
Management dialog box.

WorkSite Web Components Server Installation Guide

37

Chapter 3 Before You Install

Figure 4 DbAdmin Group Management dialog box

d. Highlight a group and use the Add or Remove buttons to add or remove
users.
NOTE Users in the NRTADMIN group receive all privileges.

For more information, see the Assigning Users to Groups topic in the WorkSite
Server Administrators Guide.
4. Setup roles. For information about creating roles, see the Roles topic in the
WorkSite Server Administrators Guide.
5. Assigning users to a role. For information about assigning users to a role, see
the Roles topic in the WorkSite Server Administrators Guide. Ensure that
administrators (NRTADMIN) are assigned the privileges indicated in Figure 5.

38

WorkSite Web Components Server Installation Guide

Install and Configure WorkSite Server 9.0

Figure 5 Role Setup dialog box in DbAdmin

Secure the WebDB

All WorkSite users must be users on the WebDB. To secure the database, you
can limit access to the Cache and Temp directories for users who are not part of
the NRTADMIN group. The Cache and Temp directories are on the SQL server
and the NRTADMIN is in the database.
When setting up roles for non-administrative users, you can assign these users
No Import or Read-only permissions.

Hide the WebDB

You can hide the WebDB from non-administrative users. After making the WebDB
a separate database, you can then hide it from non-administrative users by
selecting the Hidden check box on the Database Properties dialog box in the
WorkSite Service Manager application. When the WebDB is hidden, only

WorkSite Web Components Server Installation Guide

39

Chapter 3 Before You Install

members of the NRTADMIN group can access the WebDB from drop-down lists
when creating workspaces and other content. This prevents other users from
adding content to the WebDB.
You can hide the WebDB from non administrative users in the following ways:

Assign these users No Import or Read-only Access.

Select the Hidden box in the WorkSite Service Manager application.

Preliminary Steps Before Installing WorkSite Web

Components Server
Windows Server 2008 R2 and Windows Server 2008 (IIS 7 or 7.5)
Backward Compatibility with IIS 6
IMPORTANT The WorkSite Web installer requires backward compatibility
with IIS 6. Follow the steps below before attempting to install WorkSite Web.

If you are installing WorkSite Web on Windows Server 2008 or 2008 R2 (IIS 7 or
7.5), you must configure the following setting for backward compatibility with IIS 6:
1. From the Start menu, click Control Panel, then Programs and Features to
open the Programs and Features Control Panel.
2. Click Turn Windows features on or off. The Server Manager window opens.
3. Click Roles.
4. Locate the Web Server (IIS) Role, and click Add Role Services, as shown:

40

WorkSite Web Components Server Installation Guide

Preliminary Steps Before Installing WorkSite Web

Components Server

Figure 6 Add Role Services

The Add Role Services dialog opens.

5. Select the IIS 6 Metabase Compatibility option as shown.

WorkSite Web Components Server Installation Guide

41

Chapter 3 Before You Install

Figure 7 Enable IIS 6 metabase compatibility

6. Click Next.

Windows Server 2012 and Windows Server 2012 R2 (IIS 8.0)

Before installing the WorkSite Web Components Server, you must ensure that the
Web Server (IIS) role and related roles and services are set up on Windows
Server 2012/2012 R2.
To configure IIS for WorkSite Web on Windows Server 2012/2012 R2
1. Launch Server Manager.

42

WorkSite Web Components Server Installation Guide

Preliminary Steps Before Installing WorkSite Web

Components Server

Figure 8 Windows Server 2012 Server Manager

2. Click Add roles and features.

WorkSite Web Components Server Installation Guide

43

Chapter 3 Before You Install

Figure 9 IIS Configuration

3. Click Next until you reach the Server Roles section as shown in Figure 10.

44

WorkSite Web Components Server Installation Guide

Preliminary Steps Before Installing WorkSite Web

Components Server

Figure 10 Server Roles (image continues on next page)

WorkSite Web Components Server Installation Guide

45

Chapter 3 Before You Install

Figure 11 Server Roles (continued)

4. Check all the highlighted features.

5. Click Next and Install.

Before Installing WorkSite Web for SharePoint

If you are installing WorkSite Web for SharePoint, in addition to the above
mentioned steps, complete the following:
1. Install and configure MOSS 2007, 2010 or 2013, or WSS 3.0 on the machine
where you want to install WorkSite Web for SharePoint Integration. See
Microsoft product documentation for additional information.
2. Using SharePoint Central Administration, create a new Web application on a
port.
NOTE WorkSite Web for SharePoint must be installed (as a virtual
directory) at the same port where you create this SharePoint Web
application.

46

WorkSite Web Components Server Installation Guide

Complete the System Information Checklist

3. Create a Site Collection for the new Web Application

a. Specify a Title, Primary and Secondary Administrators, and Template for
the new Site Collection.
b. Create the Site Collection at the root level (http://servername:
portnumber). The default Site Collection settings already specify the root
level.
CAUTION Some SharePoint Site Collection templates use the same
javascript variable name as WorkSite Web: page. If you select a SharePoint
Site Collection template that uses the page javascript object (for example,
Blog template), replace all occurrences of the page object with webpage in
the template default.aspx file to avoid javascript conflicts.
The default location for SharePoint Site Collection templates is:
C:\Program Files\Common Files\Microsoft Shared\Web
Server Extensions\12\TEMPLATE\Sitetemplates

NOTE When WorkSite for SharePoint Integration is

installed, it creates an application pool WorkSite. If this
differs from the identity of the application pool for the
SharePoint application, change the identity of application
pool WorkSite to the identity of the application pool for the
SharePoint application.

Complete the System Information Checklist

Record information required for the installation. See Appendix C.

WorkSite Web Components Server Installation Guide

47

Chapter 3 Before You Install

48

WorkSite Web Components Server Installation Guide

CHAPTER 4

Install WorkSite Web

Table 6 Task listInstalling or upgrading
Task

Application

Check for required hardware and software

Various Systems

Install and configure SQL or Oracle server

SQL or Oracle server

Install and configure WorkSite Server 9.0

WorkSite Server

Record information required for WorkSite Web

Server Components installation

Various Systems

Install and configure WorkSite Web Component

Server

WorkSite Web Server

WorkSite Web Server configuration options

WorkSite Web Server

Additional installation and configuration options

WorkSite Web Server

Overview
This chapter describes how to install WorkSite Web. It also provides information
about how to upgrade to WorkSite Web 9.0 from earlier versions.

Install or Upgrade WorkSite Web Components Server

WorkSite Web Components Server Installation Guide

49

Chapter 4 Install WorkSite Web

Repair or Remove the Installation

Install or Upgrade WorkSite Web Components Server

The instructions for installing the WorkSite Web Components Server depend on
the type of installation that you need to perform:

New Installations

Existing Installations

Customized Installations

Silent Installation
NOTE To ensure proper functionality of trusted login
authentication, do not run WorkSite Web on a Web server
that is also an Active Directory domain controller.

After completing this process, you can perform the post installation tasks and log
in to WorkSite Web (see Log in to WorkSite Web on page 55).

New Installations
Follow the installation instructions provided in the Install WorkSite Web
Components Server on page 52, and Install Integration Mode on page 70.
NOTE Close all running applications before beginning the
installation process.

Existing Installations
WorkSite Web 9.0 or later requires a full product install. You need to uninstall the
current version of WorkSite Web and install WorkSite Web 9.0 or later.
NOTE When a new build is installed, clear the cache for IE
(delete files and cookies). Any changes made on JavaScript
or.js files are reflected only when you clear the cache.

CAUTION HP Autonomy recommends that you back up

your existing databases and customizations before
proceeding with the installation of WorkSite Web 9.0.

50

WorkSite Web Components Server Installation Guide

Install or Upgrade WorkSite Web Components Server

All upgrades to a later version of the WorkSite Web Components Server require a
full installation. Table 7 describes special upgrade steps you may need to perform
based on the version of WorkSite Web that you are currently running.
Table 7 Quick referenceUpgrade procedure
Base WorkSite Web
Version

Upgrade Procedure

If you are running 8.2

SP1 Patch 1 or later
WorkSite Web versions

1. Uninstall the current version of WorkSite Web.

If you are running 8.2

SP1 WorkSite Web
version

1. Run UninstallFix\UninstallFix.exe to apply the WorkSite Web 8.2 SP1

Uninstall Fix. You can download this file from https://
customers.autonomy.com. You need to apply the Uninstall Fix before you
attempt to uninstall or upgrade WorkSite Web. This fix is required due to a
bug in the uninstall process for the previous release.

2. Run setup.exe to initiate the WorkSite Web Components Server

installation. For additional instructions, see Install WorkSite Web
Components Server on page 52.

2. Uninstall the current version of WorkSite Web.

3. Run setup.exe to initiate the WorkSite Web Components Server 9.0
installation. For additional instructions, see Install WorkSite Web
Components Server on page 52.
If you are running 8.0 and
later WorkSite Web
versions

1. Uninstall the current version of WorkSite Web.

If you are running 4.4 and

later WorkSite Web
versions

1. Upgrade to WorkSite Web 8.0.

2. Run setup.exe to initiate the WorkSite Web Components Server

installation. For additional instructions, see Install WorkSite Web
Components Server on page 52.

2. Run the page updater utility provided by HP Autonomy. This process converts
your pages to workspaces and allows you to save your customizations from
the earlier version.
3. Follow the upgrade instructions for upgrading from WorkSite Web 8.0 to 9.0
(see Table 7).

If you are running

WorkSite Web versions
earlier than 4.4

1. First upgrade your application to WorkSite 4.4.

2. Follow the upgrade instructions for upgrading from WorkSite Web 4.4 to 9.0
(see Table 7).

NOTE User settings are preserved during upgrade. The

options.xml file stores all the Global Options and User
Options. If this file is modified then it is not uninstalled during
the uninstall process, nor is it overwritten during the new
installation.

WorkSite Web Components Server Installation Guide

51

Chapter 4 Install WorkSite Web

Customized Installations
The upgrade process may impact customized systems or application interfaces
that you have developed and integrated with the WorkSite software. WorkSite
Web 9.0 has been designed so that applications built on the WorkSite Web 9.0
API are compatible with it.

Install WorkSite Web Components Server

1. Double-click setup.exe to launch the installation wizard.
The installer automatically detects the appropriate language for the wizard
screens based on the operating system language settings. Click OK.
NOTE The installer will prompt you to select the language for WorkSite
Web later. Refer to Step 10.

2. Click Next on the Welcome page of the installation wizard.

3. Accept the License Agreement. Click Next.
4. On the Authentication Mode page, select one of the following options for
trusted login:
Classic: Trusted login authentication method previously used by WorkSite
Kerberos: Trusted login authentication using Kerberos technology
NOTE Also, see Updating Client-Side Settings for Trusted Login on
page 50 for additional configuration steps to use trusted login.

5. Click Next to display the Customer Information page.

6. Enter your name and organization in the User Name and Organization boxes
respectively.
7. Enter the required product key in the Product Key box. Click Next. The Verify
Product page appears.
A WorkSite Web product is installed based on the product key you enter.
8. Ensure that the product you are installing the correct WorkSite Web product.
Click Next.
9. Select an installation folder. (To select a different installation folder, click
Change.) Click Next to view the next page.
10. Complete the following tasks:

52

WorkSite Web Components Server Installation Guide

Install or Upgrade WorkSite Web Components Server

In the Choose the Language box, select the language in which you want

the WorkSite Web application to display its options.

NOTE If you are installing WorkSite Web for SharePoint, you can
select any language regardless of the SharePoint server language.

In the Name or IP address of WorkSite Middle Tier (DMS) Server box,

enter the name or IP address of the WorkSite middle tier server.

In the Name or IP address of SMTP Server box, enter the name or IP

address of the SMTP server.

In the Virtual Server box, select the virtual server for the WorkSite Web

application from the drop-down box.

This option is available for IIS 6.0 installations, which may have
multiple servers on a single web server machine. Select Default Web
Site if you do not have anything specific.

If you are installing WorkSite Web for SharePoint, select the Web
application that you created earlier (see Before Installing WorkSite
Web for SharePoint on page 46). WorkSite Web for SharePoint must
be installed at the same port where you created the SharePoint Web
application.

In the Virtual Directory box, enter the name of the virtual directory for the

WorkSite component you have selected. The default option is WorkSite.

NOTE If this installation fails, you must delete the virtual directory
through the IIS Manager before attempting another installation. (To
access the IIS Manager, see Confirming WorkSite Web Settings on the
IIS on page 46.)

11. Click Next to display the TCP/IP Ports page.

12. Perform one of the following tasks:
Use the default ports on the WorkSite Server. By default, the Service Port

is 1080, and the File I/O Port is 1081. Click Next.

Enter values for the Service Port and File I/O Port on the WorkSite Server.

You must define these ports through the WorkSite Service Manager. See
the WorkSite Server Administrators Guide. Click Next.
13. On the Ready to Install the Program page, click Install.

WorkSite Web Components Server Installation Guide

53

Chapter 4 Install WorkSite Web

14. Click Finish when the installation is complete.

NOTE See Install and Configure SMTP on page 66 for instructions on
setting up the Simple Mail Transfer Protocol (SMTP) for your e-mail
system. In addition, see Install SSL Support on page 66 for
instructions on configuring SSL support on your WorkSite Web
Component Server machine.

Silent Installation
1. Copy the entire folder which contains the setup.exe file, which you want to
install, to a local drive.
2. At the command prompt, navigate to the location where you have placed the
build and type:
setup.exe/v/"l*v log.log".
The UI screens appear as usual except that it has reduced the effort of clicking
setup.exe.

Repair or Remove the Installation

After installing WorkSite 9.0, you may run the setup.exe file and use the
WorkSite InstallShield Wizard to repair or remove WorkSite Web Components 9.0.
The following wizard screens appear:
1. Double-click setup.exe. The Welcome page appears.
2. Click Next on the Welcome page of the installation wizard.
3. The Program Maintenance screen appears.
Click Repair to repair installation errors in the program. This option fixes

missing or corrupt files, shortcuts, and registry entries.

Click Remove to remove WorkSite Web Components Server 9.0 from your

computer.
The WorkSite InstallShield Wizard provides the dialog boxes and guides you
to perform the selected procedure.

54

WorkSite Web Components Server Installation Guide

Initial Log in to WorkSite Web

Initial Log in to WorkSite Web

This procedure allows you to open the WorkSite Web application from your
WorkSite Web Components Server.
IMPORTANT The Administrator must be the first user to login to WorkSite
Web. To log into WorkSite Web with administrative rights, you must be a
member of the NRTADMIN group.

The procedure for login is different for WorkSite Web for SharePoint as compared
to other applications. Based on the WorkSite Web product you have installed,
follow one of these procedures:

Log in to WorkSite Web

Log in to WorkSite Web for SharePoint

Log in to WorkSite Web

1. Point your browser to the following URL to open the WorkSite application:
http://[machine_name]/[virtual_directory_name]/default.aspx

where:
machine_name is the name of the WorkSite Web Component Server
machine
virtual_directory_name is the name of the WorkSite Web virtual
directory
NOTE Change http:// to https:// if Secure Sockets
Layer (SSL) support is enabled. For information about
enabling SSL support, see Install SSL Support on
page 66.

2. If the installation is successful, the WorkSite Web Login page opens.

3. Log in to WorkSite using a WorkSite Administrator (NRTAdmin) account.
4. On the WorkSite toolbar, click Manage, then click Global Options.
The Global Options page opens.
5. Click Finish. This step is necessary to populate the options.xml configuration
file.
If the installation is not successful, see Appendix A to ensure that appropriate
settings and permissions are granted.

WorkSite Web Components Server Installation Guide

55

Chapter 4 Install WorkSite Web

For information about trusted login, see Trusted Login on page 64.

Log in to WorkSite Web for SharePoint

1. In SharePoint 2007, activate WorkSite Integration through SharePoint Central
Administration with the following steps (skip to Step 2 for SharePoint 2010 or
2013):
a. In the side bar, click Application Management. The Application
Management page appears.
b. In the SharePoint Web application features section, click Manage Web
application features. The Manage Web Application Features page
appears.
c. Click the Activate button associated with WorkSite Integration. The status
for WorkSite Integration now displays as Active and the Deactivate button
is available.
2. In SharePoint 2010 or 2013, features are activated during installation. If the
installation did not complete successfully, it may be necessary to activate the
WorkSite integration through SharePoint Central Administration with the
following steps:
a. In the working pane under Application Management, click Manage web
applications.
b. Select the Web Application under which you installed WorkSite Web for
SharePoint.
c. Click Manage Features in the ribbon bar.
d. Click the Activate button for WorkSite Integration.
3. Open Options.xml file.
NOTE If you used the default installation path for WorkSite,
this file is located under \ProgramFiles\Autonomy\
WorkSite\Web\Data.

4. Use the Find feature on the Edit menu to locate the string trusted-login.
5. Set trusted-login.enabled to 0 to disable trusted login. Save the
changes.
6. Point your browser to the following URL to open the WorkSite application:
http://[machine_name]:[port_number]/[virtual_directory_name]

where:
machine_name is the name of the WorkSite Web Component Server
machine.

56

WorkSite Web Components Server Installation Guide

Initial Log in to WorkSite Web

port_number is the Port at which you created a SharePoint Web application

and installed WorkSite Web for SharePoint.
virtual_directory_name is the name of the WorkSite Web virtual directory.
NOTE Change http:// to https:// if Secure Sockets
Layer (SSL) support is enabled. For information about
enabling SSL support, see Install SSL Support on
page 66.

If the installation is successful, the WorkSite Web application, the WorkSite

Web Login page appears.
If the installation is not successful, see Appendix A to ensure that appropriate
settings and permissions are granted.
7. Login as an administrator (member of NRTADMIN group).
8. In the Options.xml file, set trusted-login.enabled to 1 to enable trusted
login.
All users can now login to WorkSite Web Integration with SharePoint.
9. To access WorkSite Web Integration with SharePoint, point your browser to
the following URL to access WorkSite Web integration with SharePoint:
http://[machine_name]:[port_number]/default.aspx

where:
machine_name is the name of the WorkSite Web Component Server
machine.
port_number is the port at which you created a Web application and
installed WorkSite Web for SharePoint.
NOTE To access WorkSite Web using your Windows
credentials in Firefox browser, you must clear the Enable
anonymous access check box in the Directory Security
tab. For detailed steps, see Disable Anonymous Access in
Firefox Browser on page 78.

10. Add IWOV Web parts to the SharePoint page. See the Adding a Web Part to a
WorkSpace topic in the WorkSite Web for Microsoft SharePoint Users Guide.

WorkSite Web Components Server Installation Guide

57

Chapter 4 Install WorkSite Web

58

WorkSite Web Components Server Installation Guide


Configure WorkSite Web
CHAPTER 5

Table 8 Task listConfiguring WorkSite Web

Task

Application

Check for required hardware and software

Various Systems

Install and configure SQL or Oracle server

SQL or Oracle server

Install and configure WorkSite Server 9.0

WorkSite Server

Record information required for WorkSite Web

Server Components installation

Various Systems

Install and configure WorkSite Web Component

Server

WorkSite Web Server

WorkSite Web Server configuration options

WorkSite Web Server

Additional installation and configuration options

WorkSite Web Server

Overview
When you have completed configuring WorkSite Web as described in this chapter,
it is time to launch your WorkSite Web site.

WorkSite Web Components Server Installation Guide

59

Chapter 5 Configure WorkSite Web

Access the Manage Options

WorkSite administrative tasks are performed using options accessed from the
Manage button on the toolbar. For instructions on using these options, select the
WorkSite Administration topic in the WorkSite Online Help table of contents, or
click the Help link on the Manage page. To log into WorkSite with administrative
rights, you must be a member of the NRTADMIN group.
You can configure some or all of the following options depending on the privileges
of your administrative group.
WorkSite provides built-in default solutions for templates, profiles, and views. You
can elect to use the default configurations when you launch the Web site, and
then edit the templates or add customized templates at a later time. You can
select the defaults provided by WorkSite Web or create the following:

Start WorkSpace Templates (each role is assigned a Start workspace)

WorkSpace Templates (each role may be assigned a WorkSpace Template)

Navigation Menus

Layout Templates

WorkSpace Profiles (each role is assigned a WorkSpace Profile)

WorkSpace Search Profiles (each role is assigned a WorkSpace Search

Profile)

Document Profiles (each role is assigned a Document Profile per database)

Document Search Profiles (each role is assigned a Document Search Profile)

Document Views

WorkSpace Views

Connectors

Global Options

User Options

Custom Attributes

Integration with WorkSite Mobility apps

Appendix C provides a checklist of Startup Tasks. You can print this checklist and
use it as a reference. If you perform all the startup tasks systematically, you will
gain a practical understanding of the capabilities and duties of a WorkSite Web
administrator.

60

WorkSite Web Components Server Installation Guide

Configuration Options

Configuration Options
User Profiles and Groups
There are various administrative tasks that must be performed before WorkSite
can be made available to users. The administrator must do the following:

Create a user profile for everyone who will be logging into WorkSite.

Create roles that define user permissions and assign a role to each user.

Create User Groups with assigned roles, and add users to the groups.

Create an ADMIN group of users with administrative rights.

Send Notifications
For notifications, you need to enable the Rules Engine in the WorkSite Service
Manager. Set up the SMTP server in the Rules Engine Properties dialog box. For
more information, see the WorkSite Server Administrators Guide.
There are two types of notifications:

Rules Engine. Sends notifications to users about updates or edits to the

documents. It also monitors and queues changes to collaborative items and
folders.

WorkSite Web Server Components. Send notifications about updates to

WorkSpaces and Users.

Hide Security Settings from External Users

You can hide Security information on Add and Edit dialog boxes from external
users by changing the value for the security-external flag in the Options.xml file.
After you change this option, external users will not see the Security settings,
regardless of their security access level on a specific folder or document. When
this feature is enabled, the Security settings are hidden even from the owner of a
folder, workspace, or document who has logged in as an external user.
1. Log into your WorkSite Web Component Server.
2. Navigate to Options.xml file.
NOTE If you used the default installation path for WorkSite,
this file is located under \Program Files\Autonomy\
WorkSite\Web\Data.

3. Use the Find feature on the Edit menu to locate the string security external.

WorkSite Web Components Server Installation Guide

61

Chapter 5 Configure WorkSite Web

<security external="0" new-user-password-expired="0"

ip-check="0" show-login-username="1"
document-security-on-move="leave">
<trusted-login enabled="0" userid=""/>
</security>

4. Verify that security external flag is 0. See the following table:

Table 9 Security external flag value
If flag is set to...

Then external users...

Cannot see the Security panel

Can see the Security panel

Localization and Regional Settings

Support for English and a Regional Language
In addition to English, WorkSite Web supports viewing files in one additional
language such as Russian or Chinese. To enable WorkSite Web to process file
names in regional language, you need to change settings on the client and server.
Also, the WorkSite Server and database must be set to the regional language
locale.
Settings on the WorkSite Web Component Server
1. Install the multi language unicode interface (MUI) for the language that you
want to support.
2. Restart the system.
Settings on the Client Machine and WorkSite Web Component Server
Make the following configuration settings on WorkSite Web server machine and
every client machine.
1. Navigate through Start > Control Panel > Regional And Language
Options. The Regional and Language options dialog box appears.
2. In the Regional Options tab, from the drop down select the language that you
want to support. For example, Russian or Chinese.
3. Select the Advanced tab.
4. From the drop down, select the language to match the non-Unicode programs
that you want to support. Select the same language which you selected in
Step 2.
5. Restart the system.

62

WorkSite Web Components Server Installation Guide

Configuration Options

Set Date Format in Regional Languages

The English version of WorkSite Web supports two regional localizations, U.S.
English and U.K. English. This setting controls date formats and other localization
options. During installation, the installer sets this option with the language
selected in the installation wizard.
1. Log into your WorkSite Web Component Server.
2. Navigate to Options.xml file.
NOTE If you used the default installation path for WorkSite,
this file is located under \Program Files\Autonomy\
WorkSite\Web\Data.

3. Use the Find feature on the Edit menu to locate the string
Language-supported.
4. Set the Language-supported flag to one of the following options:
en-us (U.S. English)
en-gb (U.K. English)

In addition, the Regional settings can be configured from the Regional Settings
control panel of the operating system:

French: This option is set to fr-fr during installation. In the regional setting on
the machine, HP Autonomy recommends using the European date format (dd/
mm/yyyy).

German: This option is set to de-de during installation. HP Autonomy

recommends setting the date format as dd.mm.yyyy. A four-digit date format
for year is required.

WorkSite Session Timeout Interval

The Session Timeout parameter determines how long a WorkSite user can be
inactive before being logged out by the system. This feature provides protection
when users leave their workstation during a WorkSite session. The default value
is 20 minutes. Changing the Session Timeout interval requires editing the
Microsoft Internet Information Server (IIS) configuration.
To edit the IIS configuration:
1. Navigate to the WorkSite Properties dialog box.
2. Click Configuration to open the Application Configuration dialog box.
3. On the Options tab, modify the value in the Session timeout box. The default
value is 20 minutes.

WorkSite Web Components Server Installation Guide

63

Chapter 5 Configure WorkSite Web

4. Click OK to confirm the Session timeout modification.

5. Click Apply, and then click OK to confirm all settings for the WorkSite
Properties virtual directory configuration.

Trusted Login
Update Client-Side Settings for Trusted Login
You can specify the client authentication method as either Classic or Kerberos by
changing a registry key value. By default, the client is configured for the Classic
mode. Classic mode is the method of trusted login authentication previously used
by WorkSite.
In the following key in the registry:
HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\8.0\Common\Options

Set the following DWORD value:

Name: Authentication Method
Value:
0 = Classic (This mode is selected by default.)
1 = Kerberos
You also need to modify settings on the WorkSite Server, see the topic Kerberos
Authentication on Trusted Login in the WorkSite Server Administrators Guide.

64

WorkSite Web Components Server Installation Guide

CHAPTER 6

Install and Configure

Optional Features
Table 10 Task listPost installation
Task

Application

Check for required hardware and software

Various Systems

Install and configure SQL or Oracle server

SQL or Oracle server

Install and configure WorkSite Server 9.0

WorkSite Server

Record information required for WorkSite Web

Server Components installation

Various Systems

Install and configure WorkSite Web Component

Server

WorkSite Web Server

WorkSite Web Server configuration options

WorkSite Web Server

Additional installation and configuration options

WorkSite Web Server

Overview
This chapter provides information about adding the following optional features to

WorkSite Web Components Server Installation Guide

65

Chapter 6 Install and Configure Optional Features

the WorkSite Web. Depending on your requirement you can additionally install
and configure the following:

Install and Configure SMTP (Internet Mail Service and configuring SMTP)

Install SSL Support (Secure Sockets Layer support)

Configure Single Sign-On (SSO)

Install Integration Mode

Multi-Browser Support

Enable APA Integration in WorkSite Web

Install and Configure SMTP

You need to install and configure Microsoft Simple Mail Transfer Protocol (SMTP)
Service on the WorkSite Web Component Server to enable e-mail notifications.
For information about system requirements and installation and configuration
procedure, see the Microsoft SMTP Service documentation.

Install SSL Support

Install Secure Sockets Layer (SSL) support on your WorkSite Web Component
Server machine to set up WorkSite as a secure server. The SSL protocol allows
an SSL-enabled server to authenticate itself to an SSL-enabled client. You need
to create an encrypted key (or digital signature) that is certified by an SSL
Certificate Authority to allow both client and server machines to establish an
encrypted connection.
Installing SSL support requires the following steps:
Step 1: Create a certificate request or key
Step 2: Submit request to a certification authority and download the certificate
Step 3: Install the certificate
For information about system requirements, installing a certificate, and
configuration procedure, see the Microsoft SSL Support documentation.

66

WorkSite Web Components Server Installation Guide

Configure Single Sign-On (SSO)

Verify SSL Support

Verify SSL support by accessing the Web site from a client machine. If SSL is
enabled:

You can access the IIS server from a browser by typing https://<machine
name> in the Address field.

You cannot access the IIS server from a browser by typing http://<machine
name> in the Address field.

Troubleshooting
After completing the installation, if SSL is not working check for the errors shown
in the table below.
Table 11 Troubleshooting SSL installation
If this is the problem...

You can correct it by...

The common name entered in the

Key Creation or Web Server
Certificate wizard does not match the
machine name.

Deleting the certificate and recreating the

certificate request. Be sure to enter the name of
the machine hosting the WorkSite Web
Component Server.

The SSL port has not been defined.

Checking the SSL port on the Default Web Site

Properties dialog box. The default SSL port is
443. If the SSL Port field is grayed out, you
must assign a port before reinstalling the
certificate request.

Configure Single Sign-On (SSO)

This section provides information on how to configure Single Sign-On with
SiteMinder and WorkSite Web.
1. Login to WorkSite Web as an administrative user (user must be a member of
the NRTADMIN group in the WorkSite database).
2. On the toolbar, click Manage > Global Options.
3. Click the Web Access Management option to view the web access
management options.
4. Click On.
5. In the User Name header box, enter the SiteMinder header variable that
WorkSite Web application will use for authentication. In the example given

WorkSite Web Components Server Installation Guide

67

Chapter 6 Install and Configure Optional Features

below, the SiteMinder header variable sm_user will be read by our application
to authenticate the user.
6. In the External Application URL box, enter the URL to which users will be
redirected in order for them to be first authenticated against the Siteminder
Server before accessing the WorkSite Web application.
7. Launch the Impersonation Password utility. The
ImpersonationPassword.exe file is located in the WorkSite\Web\bin
directory.
8. Specify the impersonation password and click Save.
The impersonation password will be used by IIS to login to the WorkSite
Server to configure the SiteMinder integration.
9. On the WorkSite DMS Server, go to the WorkSite Service Manager, highlight
the WorkSite service, select Properties > Service Properties and specify the
same impersonation password that you entered in Step 8.
10. Restart WorkSite Web service after making this change.
Figure 12 Server Options

After all the steps have been successfully executed, you should be able to launch
a browser session, hit the WorkSite base URL protected by SiteMinder and test
single sign-on.

68

WorkSite Web Components Server Installation Guide

Configure Single Sign-On Using ADFS 1.0 or 2.0

Configure Single Sign-On Using ADFS 1.0 or 2.0

This section provides information on how to configure Single Sign-On Using
ADFS 1.0 or 2.0 on WorkSite Web.
Locate and open the file web.config in a text editor.
Make the following changes in web.config.
1. Remove/comment the line marked in red below and uncomment the lines
marked in blue.
<httpModules>
<clear />
<add name="ErrorHandler"
type="iManage.WorkSite.Web.ErrorHandlerModule,
iManage.WorkSite.Web" />
<add name="Session"
type="System.Web.SessionState.SessionStateModule" />

Remove

<add name=WorkSiteAuthentication
type=iManage.WorkSite.Web.AuthenticationModule,
iManage.WorkSite.Web />

Uncomment

<!--ADFS Web Agent Authentication Module -->

<!--

Change
Version=1.0.0.0
to Version=2.0.0.0
if necessary

<add name=Identity Federation Services Application

Authentication Module
type=System.Web.Security.SingleSignOn.WebSsoAuthenticationModu
le System.Web.Security.SingleSignOn,
Version=1.0.0.0,
Culture=neutral
PublicKeyToken=31bf365Gad364e35,
Custom=null />
<add name=WorksiteAuthentication
type=iManage.WorkSite.SSOAuthenticationModule,
iManage.WorkSite.Web >

-->
</httpModules>

2. Set the <returnurl> to the root of WorkSite Web application. This URL
value must match the Application URL value that is specified in the
Properties page of the claims-aware application (which is located under
Federation Service\Trust Policy\Applications in the Active Directory
Federation Services snap-in) of the resource partner.

WorkSite Web Components Server Installation Guide

69

Chapter 6 Install and Configure Optional Features

3. Set <path> as the path of the virtual directory of WorkSite Web. This value is
case-sensitive and should exactly match the casing of the WorkSite Web
virtual directory name.
4. Replace myresourcefederationserver in <fs>https://
myresourcefederationserver/adfs/fs/
federationserverservice.asmx</fs> with a valid resource federation
server name.
<!-- Configuration for ADFS Web Agent -->
<websso>
<authenticationrequired />
<eventloglevel>255</eventloglevel>
<auditsuccess>2</auditsuccess>
<urls>
<returnurl>https://localhost/worksite/</returnurl>
</urls>
<cookies writecookies="true">
<path>/worksite</path>
<lifetime>240</lifetime>
</cookies>
<fs>https://myresourcefederationserver/adfs/fs/
federationserverservice.asmx</fs>
</websso>
<!-- end ADFS -->

5. Save web.config.

Install Integration Mode

This section includes instructions for installing the optional feature called the
Integration Mode.
Integration Mode simplifies the process of document management for users
working with both WorkSite Web and the Desktop Clients. When this option is
enabled, users of WorkSite Web can perform multiple document management
tasks using the same dialogs as those displayed in WorkSite Desktop Clients.
The IWL protocol must be registered with the browser on the client machine.
Select document management operations are then be performed using
Integration Mode. See Register the IWL Protocol on page 71.

70

WorkSite Web Components Server Installation Guide

Install Integration Mode

In Integration Mode, the View as HTML and the View options in the Document
action menu are renamed to View and Open respectively. Table 12 lists document
operations that are available in Integration Mode as compared to those in Normal
Mode.
Table 12 Integration and Document Operations
Integration Mode

Normal Mode

View

View As HTML

Open

View

Checkout

Checkout

Checkin

Checkin

History

History

Unlock

Unlock

Properties

Properties

Register the IWL Protocol

To use the Integration Mode with WorkSite Web, you must register the IWL
protocol with the browser on each client machine. For additional information about
this feature, see the DeskSite, FileSite, and OffSite Release Notes.
NOTE DeskSite/FileSite 8.2 SP1 Patch 5 automatically
registers the IWL protocol as part of the installation. Manual
registration is only necessary on machines running Desktop
client versions prior to 8.2 SP1 Patch 5.

1. Download the zip file from the following location:

ftp://ftp.imanage.com/Software/Released/WorkSite_Web/
IwlProtocol.zip

2. Extract the IwlProtocol.exe file and save it to the WorkSite installation

directory on the client machine. See the following example:
C:\Program Files\Autonomy\WorkSite

3. Run the executable to register the IWL protocol. You will not see any
confirmation message displayed.
You need to repeat this process on each client machine.

WorkSite Web Components Server Installation Guide

71

Chapter 6 Install and Configure Optional Features

Optional Verification Steps

You can optionally perform these verification steps to confirm that IWL protocol is
configured properly on the client machine.
Registry Key Setting
To confirm that the IWL protocol has been registered successfully, check for the
presence of the IWL registry key.
1. On the Start menu, click Run, and enter regedit.
2. Locate the IWL registry key under the HKEY_CLASSES_ROOT node:
[HKEY_CLASSES_ROOT\iwl]

Multi-Browser Support
WorkSite Web supports Internet Explorer 8, 9, 10 and 11, and the latest versions
of Firefox, Google Chrome and Safari. The availability of certain features depends
on whether Applet or ActiveX is used as the upload/download control and are only
available if WorkSite Web is configured to use them.
Due to security concerns, when Active X or Applet is disabled for use with
browser, you can use the HTML file upload control to upload or download files.

Select an Upload or Download Control

1. Click Manage on the toolbar, and then click Global Options to open the
Global Options wizard.
2. On the Document Settings tab, under Upload/Download Control, select one
of the following:
File Control
ActiveX
Applet

The default value is ActiveX.

3. Click Finish to save your changes and close the Global Options Wizard.
NOTE To ensure that all WorkSite Web functionalities are
available, use IE browser and ActiveX as the upload or
download control.

72

WorkSite Web Components Server Installation Guide

Enable APA Integration in WorkSite Web

The following WorkSite Web functionalities that are available with ActiveX and
Applet control, but not available with File Control options:

Upload or download progress bar will not appear

During checkout, the checkout path will not be pre populated with the last
checkout path

During checkin, the document path will not be pre populated

Functionality to open the file automatically after downloading it will not be

supported

Multiple operations will not be supported for View, Checkin, Checkout, and
Download

The following WorkSite Web functionalities that are available with ActiveX control,
but not available with Applet or File Control options:

Integrated Checkout option: Allows DeskSite to check in the file instead of

having the user check it in through the WorkSite Web interface.

OLE Linking functionality: Provides checkout/checkin support for documents

that contain OLE links.
OLE links are Microsoft Office documents that are embedded or linked inside
other Microsoft Office documents. When you import an Office document that
contains links to other documents, OLE linking functionality allows you to
choose whether to import the links as well.
NOTE Firefox uses either FileControl or Applet as the
upload or download control, so functionalities that are
available with ActiveX control only are not available in
Firefox.

Enable APA Integration in WorkSite Web

When APA Alerts integration is enabled inside WorkSite Web, a new action menu
item called Alerts will appear in the document's action menu.
To configure APA Alerts Integration in WorkSite Web:
The following new node lo-integration will appear inside the file options.xml
when the administrative user goes to Manage --> Global Options and clicks
Finish on the Global Options Dialog:
<lo-integration
enabled="1"

WorkSite Web Components Server Installation Guide

73

Chapter 6 Install and Configure Optional Features

key="demo"
DMSAgent="WorkSite DMS"
sso-admin=""
sso-url="http://apacloud9.verity.com/xmlserver/jsp/
WorkSiteLogon.jsp?userID={userid}&amp;key={key}"
portal-url="http://apacloud9.verity.com/portal"
service-url="http://apacloud9.verity.com/services" />

where
enabled: Enable / Disable APA Alerts integration. Default value is 0 (disabled)
key: key to login into APA
DMSAgent: APA DMS Agent Name
sso-admin: If a userid for sso-admin is provided, then this userid is used to
get a session from the APA server instead of the WorkSite Web logged in
userid.
sso-url: APA server URL used to get the session id using the WorkSite Web
logged in userid and key. Should be of the form: http://&lt;APA Server Name>/
xmlserver/jsp/WorkSiteLogon.jsp?userID={userid}&amp;key={key}
portal-url: APA portal URL. Used to show the APA alerts dialog. Should be of
the form: http://&lt;APA Server Name>/portal
service-url: Currently not being used in WorkSite Web integration.

74

WorkSite Web Components Server Installation Guide


Troubleshooting

APPENDIX A

Overview
In case the WorkSite Web installation is not successfully completed, you may
need to verify the following after installing the WorkSite Web software on the web
server machine. These steps include additional IIS configuration settings in
addition to applying necessary directory permissions on the Web server machine.
Verify that:

IIS is configured for WorkSite Web. See Confirm WorkSite Web Settings in
IIS on page 76.
Enable Anonymous Access check box is cleared. This applies to Firefox

only. See Disable Anonymous Access in Firefox Browser on page 78.

ASP.NET 2.0, the ASP.NET v2.0.##### Web Service Extension is allowed to

run on the WorkSite Web Components Server. See Allow ASP.NET 2.0 Web
Service Extension on page 79.

Proper permissions are set. See WorkSite Web Directory Permissions on

page 79.

WorkSite Web Components Server Installation Guide

75

Appendix A Troubleshooting

Confirm WorkSite Web Settings in IIS

To ensure proper installation and functioning of your WorkSite application(s), you
may want to verify or change the configuration settings. To verify or edit the IIS
configuration settings on your WorkSite Web Component Server, access the
Properties dialog box on your WorkSite virtual directory.

WorkSite Properties
1. Navigate to the Internet Information Services window: Start | Settings |
Control Panel | Administrative Tools. Click Internet Information Services
(IIS) Manager to display the Internet Information Services window.
2. Click the server node > Web Sites > Default Web Site > Virtual
directory.
If you used the default value during the installation procedure, WorkSite is the
name of your virtual directory.
3. Right-click the Virtual directory to display the shortcut menu.
4. Click Properties in the shortcut menu to display the WorkSite Properties
dialog box. See Figure 13.

76

WorkSite Web Components Server Installation Guide

Confirm WorkSite Web Settings in IIS

Figure 13 WorkSite Properties dialog boxVirtual Directory

5. On the Virtual directory tab, in the Execute Permissions box, select Scripts
and Executables to enable scripts on the IIS.
CAUTION We do not recommend that you select the Write
check box in combination with selecting Scripts only or
Scripts and Executables from the Execute Permissions
drop-down box under Application Settings. This could
create a security risk.

6. Click Apply, and then click OK to confirm all settings for the WorkSite
Properties virtual directory configuration.

WorkSite Web Components Server Installation Guide

77

Appendix A Troubleshooting

Disable Anonymous Access in Firefox Browser

NOTE This applies to Mozilla Firefox browser only.

Clear the Enable Anonymous Access check box in the security panel of the
worksite virtual directory to access WorkSite Web with SharePoint using your
windows credentials. You will be prompted to enter the windows credentials and
when you provide the credentials, Firefox will display an error message saying the
username does not exist.
1. In the WorkSite Properties dialog box, on the Directory Security tab, under
Authentication and access control, click Edit. The Authentication Methods
dialog box appears.
2. Clear the Enable anonymous access check box.
Figure 14 Authentication Methods dialog box

78

WorkSite Web Components Server Installation Guide

Allow ASP.NET 2.0 Web Service Extension

3. Click Ok, and then Apply to accept the change.

Allow ASP.NET 2.0 Web Service Extension

Since WorkSite Web 9.0 requires ASP.NET 2.0, the ASP.NET v2.0.##### Web
Service Extension must be set to Allowed.
1. Navigate to the Internet Information Services window: Start | Settings |
Control Panel | Administrative Tools.
2. Click Internet Information Services (IIS) Manager to display the Internet
Information Services window.
3. Click the server node > Web Service Extensions. The Web Service
Extensions information appears.
4. If the Status field for this Web Service Extension is set to Prohibited, click to
select the ASP.NET v2.0.##### Web Service Extension, and then click
Allow.

WorkSite Web Directory Permissions

The following minimum NTFS permissions are required for the anonymous
access account, IUSR_MACHINENAME, the working process account used for
.NET applications, NETWORK SERVICE for Windows Server 2008, the Domain
Users group, and the IUSR group in order for Trusted Login to function properly
with WorkSite Web.
Using the default installation path, the following subdirectories requiring the
appropriate NTFS permissions to be configured are located in C:\Program
Files\Autonomy\WorkSite\Web. The root directory, Web, should be set for
Read access for the IUSR_MACHINENAME and NETWORK SERVICE accounts
along with the Domain Users group. NTFS permissions for each of the
subdirectories and their contents should be configured as listed below in Windows
Server 2008 for the local IUSR_MACHINENAME and NETWORK SERVICE
accounts and the Domain Users group:
bin: Read & Execute
connectors: Read & Execute + Write
connectorsadmin: Read
data: Read + Write
help: Read
htmleditor: Read
icons: Read

WorkSite Web Components Server Installation Guide

79

Appendix A Troubleshooting

images: Read
includes: Read
KeyView: Read & Execute
login-images: Read
lsa-images: Read
Samples: Read
scripts: Read
Services: Read
temp: Read & Execute + Write & Modify
themes: Read
Updater: Read

80

WorkSite Web Components Server Installation Guide


System Information Checklist

APPENDIX B

Obtain System Information for Installation

Print Table 13 and use it to record information about your system. This information
will be required for the WorkSite Web installation process. Preparing this
information in advance will speed up the installation and reduce the possibility of
errors.
Table 13 System Information required for WorkSite Web installation
Required Information

Your Information

Needed for Installation

SQL Server Name

WebDB Name [Database]
WebDB System Administrators User ID
[Database]
WebDB System Administrators
Password [Database]
WorkSite Middle Tier (DMS) Server
Name or IP Address

Yes

Data Source Name (DSN) used on the

WorkSite middle-tier server to reference
the database
Web Component Server Name

WorkSite Web Components Server Installation Guide

81

Appendix B System Information Checklist

Table 13 System Information required for WorkSite Web installation (continued)

Required Information
The name of the Virtual Server for the
WorkSite Web application.

Your Information

Needed for Installation

Yes
Note: For WorkSite Web for
SharePoint, it is mandatory
to provide the name of the
Web application that you
create. For more
information, see Click Next
and Install. on page 46.

Name or IP Address of SMTP Server

Virtual Directory Name of WorkSite
directory on the Web Component
Server for IIS Service Manager (Default
value is WorkSite.)
Administrative User (member of
NRTADMIN Group) Password [from
WorkSite]

82

Service Port address for the WorkSite

middle-tier server (Default = 1080)

Yes

File Port address for the WorkSite

middle-tier server (Default = 1081)

Yes

WorkSite Web Components Server Installation Guide


WorkSite Web Configuration
Checklist
APPENDIX C

Use the tables below to record your settings. If you choose to use the WorkSite
Web default setting, leave the Your Setting column blank and put a check mark in
the Default column.

Set User Options

Set the user options for your WorkSite Administration group. User options are set
on a per user basis. When set, User Options are stored in the resource.xml
file.
NOTE Some user options must be enabled by a WorkSite
Administrator on the Administrative Options dialog box in
order to appear on the User Options dialog box. For more
information, refer to the WorkSite Web Online Help.

Table 14 Set user options

Option

Your Setting

Default

Max Rows for Searches

250

Max Rows for Folders

250

Maximum Matter Worklist items

10

WorkSite Web Components Server Installation Guide

83

Appendix C WorkSite Web Configuration Checklist

Table 14 Set user options (continued)

Option

Your Setting

Default

Enable 508 Compliance

Off

Send Link through E-mail Client

On

Language

English

Show Multi-Operation Menus

Off

Quick Search Database

Preferred Database

Change Password
My Home WorkSpace
Start Working Day At

8 AM

End Working Day At

5 PM

Day View Grid Interval

30 minute

Default Action when Clicking on a

Document

View

Items to Display in Browse Dialog

Checked-out Documents
Document Worklist
Matter Worklist
My Matters
My Favorites
WorkSite Explorer

Global Options
A WorkSite Web Administrator can set global options that affect the appearance
of the WorkSite Web application and determine which functions are enabled. For
more information, see Global Options in the WorkSite Web Online Help.
NOTE The Global Options described in this section are
included by default in the WorkSite web application.

84

WorkSite Web Components Server Installation Guide

Global Options

User Interface Options

Table 15 Global optionsUser Interface options
Option

Your Setting

Default

Theme

default

Logo Alternative Text

iManage WorkSite Logo

Location of Action Menu

Rightmost Column

NOTE Logo image and Alternating Row Color are set by

modifying the CSS Style Sheet. Refer to the WorkSite Web
CSS Customization Guide.

WorkSpace Notification Options

Table 16 Global optionsWorkSpace Notification Options
Option

Your Setting

Default

Enable Notification

Off

Message Format

HTML

Username
E-mail Address
Image
URL
Default Message

User Notification Options

Table 17 Global optionsUser Notification Options
Option

Your Setting

Enable Notification

Default
Off

E-mail Address
Reply to
CC

WorkSite Web Components Server Installation Guide

85

Appendix C WorkSite Web Configuration Checklist

Table 17 Global optionsUser Notification Options

Option

Your Setting

Default

BCC
Subject
Default Message

Event Notification Options

Table 18 Global optionsEvent Notification Options
Option

Your Setting

Default

Enable Notification

Off

Message Format

HTML

Image

header.jpg

URL
Default Message

Task Notification Options

Table 19 Global optionsTask Notification Options
Option

Your Setting

Default

Enable Notification

Off

Message Format

HTML

Image

header.jpg

URL
Default Message

86

WorkSite Web Components Server Installation Guide

Global Options

Application Settings Options

Table 20 Global optionsApplication Settings Options
Option

Your Setting

Default

Add Wildcard Characters to

Description Searches

On

Send Link Through E-mail Client

On

Email attachment file name

Default Filename

Server Type

Development

Global Max Rows for Searches

250

Global Max Rows for Folders

250

Lookup Dialog Max Rows

Default Value

Enable SharePoint Integration

Off

Enable Secure Cookies

Off

WorkSite Server Timeout (in

seconds)

30

Show Start Workspaces in

Searches

Off

Auto Close Refile Dialog on

Complete

Off

Temporary file path

<blank>

Cache Timeout in minutes

30

User Settings Options

Table 21 Global optionsUser Settings Options
Option

Your Setting

Default

Auto Trusted Login

Off

Trusted Login

On

Allow User IDs in Free Format

Off

Enforce Role-based Start

WorkSpace

On

WorkSite Web Components Server Installation Guide

87

Appendix C WorkSite Web Configuration Checklist

Table 21 Global optionsUser Settings Options

Option

Your Setting

Default

Allow User to Control Sidebar

Display

Off

Expand Items in Portal View by

Default

On

Allow User to Control Integration

Mode

Off

Document Settings Options

Table 22 Global optionsDocument Settings Options
Option

Your Setting

Default

Default Checkin Mode

Replace Original

Security When Checking In as a

New Document

Same

Filename

Default Filename

Upload/Download Control

ActiveX

Document Class Security

Override

Off

Display Prompt for

Document Class Security

Off

Version Editing

Modify all versions

Quick Search Database

Preferred database

Favorites View

88

Integration Mode

Off

Show Security to Read and Read/

Write Users

Off

WorkSite Web Components Server Installation Guide

Global Options

Event Categories Options

Table 23 Global optionsEvent Categories Options
Option

Your Setting

Default

Add
Delete

Web Access Management Options

Table 24 Global optionsWeb Access Management Options
Option

Your Setting

Enable

Default
Off

User Name Header

External Application URL

HTML Export Settings Options

Table 25 Global optionsHTML Export Settings Options
Option

Your Setting

Default

Browser

bmp gif htm html jpg jpeg xml txt

HTML Viewer

doc docx dxl mpp msg notes pdf ppt

pptx vst wpf wpd xls xlsx

Integration with WorkSite Mobility Web for all Mobile Devices

In version 9.0 Update 3, WorkSite Web offers support for opening email
attachments sent from WorkSite Web in the WorkSite Mobility Web on iPhones,
iPads or other mobile devices. A new option has been added to the Manage
menu in WorkSite Web: Mobile URL.
WorkSite Mobility Web is the users Mobility web site. When the Mobile URL
option is entered in the Manage menu in WorkSite Web, a WorkSite Web user
can use the Send Link function to send an email with a document attached, and
the mobile user can open the attachment in WorkSite Mobility Web on any mobile
device.
Your WorkSite Administrator can format the Mobile URL that will enable users to
open, export or view documents in WorkSite Mobility Web from any mobile device.

WorkSite Web Components Server Installation Guide

89

Appendix C WorkSite Web Configuration Checklist

Integration with WorkSite for Mobility iOS App (IWL Link) for IOS
Devices
In version 9.0 Update 3, WorkSite Web offers support for opening email
attachments sent from WorkSite Web in the WorkSite for Mobility iOS App on
iPhones and iPads. A new option has been added to the Manage menu:
WorkSite App Protocol.
The WorkSite App Protocol (IWL) is the protocol used by the WorkSite for Mobility
IOS app to open a workspace, tab, folder, or document link natively from an iPad
or iPhone. When this option is entered in the Manage menu in WorkSite Web, a
WorkSite Web user can use the Send Link function to send an email with a
document attached, and the mobile user can open the attachment in the WorkSite
for Mobility iOS application on an iPhone or iPad.
Your WorkSite Administrator can format the IWL link that will enable users to
open, export or view document links from an iPhone or iPad running the WorkSite
for Mobility iOS app.
Commands
iwl:dms=<worksiteservername>&lib=<odbcconnectionname>&num=<docnum>&ver=
<version>&latest=<0 or 1>&command=opencmd
iwl:dms=<worksiteservername>&lib=<odbcconnectionname>&num=<docnum>&ver=
<version>&latest=<0 or 1>&command=exportcmd
iwl:dms=<worksiteservername>&lib=<odbcconnectionname>&num=<docnum>&ver=
<version>&latest=<0 or 1>&command=Viewcmd
iwl:dms=<worksiteservername>&lib=<odbcconnectionname>&folder=<prj_id_of_fol
der>

Examples
iwl:dms=DMS1&lib=imanage&num=400&ver=1&latest=0&command=opencmd
iwl:dms=DMS1&lib=imanage&num=400&ver=2&latest=1&command=opencmd
iwl:dms=DMS1&lib=imanage&folder=351

Additional Options
These options include Create Users, Groups, Roles, Templates, Profiles, and
Views.

90

WorkSite Web Components Server Installation Guide

Additional Options

For more information, refer to WorkSite Web Online Help.

Table 26 Additional configuration options
Manage Option

List Names

Default

Create Users
Create Groups
Add Users to Groups
(including ADMIN groups)
Create Roles
Assign Roles to Users and
Groups
Create Start WorkSpace
Template
Create WorkSpace Templates
Create Navigation Menus
Create Layout Templates
Create WorkSpace Profiles
Create WorkSpace Search
Profiles
Create Document Profiles
Create Document Search
Profiles
Create Document Views
Create WorkSpace Views
Add and/or Migrate Connectors
Set Custom Attributes

WorkSite Web Components Server Installation Guide

91

Appendix C WorkSite Web Configuration Checklist

92

WorkSite Web Components Server Installation Guide


ActiveX Control for WorkSite
Web
APPENDIX D

WorkSite Web requires an ActiveX control for functions such as login, and Action
menu command performance. Users may experience intermittent error messages
and limited WorkSite Web functionality without the ActiveX control installed and
enabled in the client web browser. In secured client workstation environments,
administrators must manage the ActiveX control installation.

ActiveX Control Installation

A separate installation package allows you to manage the ActiveX control
installation for client machines. Obtain the ActiveX control for WorkSite Web
installation zip file from the HP Autonomy support site. Deploy the ActiveX control
MSI installation to client workstations manually or as a silent installation with an
automated software distribution tool.

Manual Installation
Complete the following steps for a manual installation of the ActiveX control for
WorkSite Web.
1. Extract the iManage ActiveX Control for WorkSite Web
Components 9.0.msi file from the downloaded zip file.
2. Double-click the MSI file to begin the installation process.

WorkSite Web Components Server Installation Guide

93

Appendix D ActiveX Control for WorkSite Web

3. Click Next on the installation Welcome dialog.

4. Review the License Agreement and select the option to accept the terms of
the agreement in order to continue.
5. Click Next.
6. Click Next on the Destination Folder dialog.
7. Click Install.
8. Click Finish to close the installation wizard upon completion.

Silent Installation
For an automated distribution of the ActiveX control for WorkSite Web, use the
following silent command line parameters with iManage ActiveX Control
for WorkSite Web Components 9.0.msi.
msiexec /i <path to MSI>\iManage ActiveX Control for
WorkSite Web Components 9.0.msi /qn

94

WorkSite Web Components Server Installation Guide

Index
Symbols
.NET Framework 19, 30

A
ActiveX Control 93
Installation 93
Administrative Groups 35
Administrative Options 84

C
Component Object Model (COM) 19

security external flag 61, 62, 63

Session Timeout 63
Simple Mail Transfer Protocol (SMTP) 66

U
User Options 83

W
Web Component Server 22
WorkSite Installation Information 81
WorkSite Middle-Tier Server 22
WorkSite Web Component Server 22
WorkSite Web Configuration Database 35
WorkSite's Technical Components 19

email notification 66

I
IIS Configuration 76
Internet Information Server 19

L
Localization 62

M
Middle-Tier Server 22

R
Required Password Change 62

S
Secure Socket Layer (SSL) 66

WorkSite Web Components Server Installation Guide

95

Index

96

WorkSite Web Components Server Installation Guide