WS 9.5 Installation Guide

User Manual:

Open the PDF directly: View PDF .
Page Count: 107

Download
Open PDF In Browser	View PDF

Workshare 9.5
Installation Guide

Workshare 9.5.4 | September 2018 | 9.5.800.4210

Workshare 9.5 Installation Guide

Table of Contents
Chapter 1: Installation Overview ......................................................................................6
Introducing this Guide ..................................................................................................... 7
System Requirements .................................................................................................... 7
Certified environments for Workshare 9.5 (32-bit version) ........................................... 7
Certified environments for Workshare 9.5 (64-bit version) ........................................... 9
Installation Guidelines................................................................................................... 11
Workshare Installation Files .......................................................................................... 12
Executables...............................................................................................................12
Update or full release? ...........................................................................................12
Prerequisite components ...........................................................................................13
Windows installer packages ......................................................................................14
Workshare PDF Publisher .........................................................................................15
Important Information.................................................................................................... 15
Workshare Configuration Assistant............................................................................ 15
Re-running the WCA ..............................................................................................15
Workshare Microsoft Office integration ...................................................................... 17
Workshare OCR functionality ....................................................................................17
Chapter 2: Installation on Single Workstation ................................................................. 18
Installing Workshare ..................................................................................................... 19
Uninstalling Workshare ................................................................................................. 22
Upgrading Workshare ................................................................................................... 22
Chapter 3: Licensing ......................................................................................................23
Licensing Workshare .................................................................................................... 24
How Workshare checks for licenses .......................................................................... 25
Standard Install............................................................................................................. 26
One-time log in ..........................................................................................................26
Prevent sign in dialog displaying ............................................................................ 28
Deployment with User Authenticated License ............................................................... 28

Workshare 9.5 Installation Guide

Create accounts for users .........................................................................................28
Create accounts without the Admin Console .......................................................... 31
Deployment with Enterprise License ............................................................................. 32
Registry location ........................................................................................................32
End user interaction ..................................................................................................32
Capturing of email .....................................................................................................33
Renewing a License ..................................................................................................... 33
Trial users .................................................................................................................34
Chapter 4: Configuration ................................................................................................35
Introducing the Workshare Configuration Manager ....................................................... 36
Administrator Mode and User Mode .......................................................................... 36
Default policy.............................................................................................................37
Accessing the Workshare Configuration Manager ........................................................ 38
Searching parameters ...............................................................................................40
Setting Parameters ....................................................................................................... 41
Recipient checking ....................................................................................................41
Deploying Configuration Settings .................................................................................. 42
Saving configuration files...........................................................................................43
Loading configuration files .........................................................................................46
Upgrading..................................................................................................................46
Registry Configuration .................................................................................................. 47
Small text removal .....................................................................................................47
Chapter 5: Integration ....................................................................................................48
Introduction ................................................................................................................... 49
Document Management Systems ..............................................................................49
DMS integration for Workshare 9.5 (32-bit version) ................................................ 49
DMS integration for Workshare 9.5 (64-bit version) ................................................ 50
Email systems ...........................................................................................................50
Document Management Systems Integration ............................................................... 51
iManage integration – configuring server integration ................................................. 51

Workshare 9.5 Installation Guide

Adding file types to the iManage server .................................................................. 51
Adding the Workshare comparison applications to the iManage server .................. 52
Adding Workshare as a class to iManage server .................................................... 54
Work 10 configuration ............................................................................................55
iManage integration – configuring client integration ................................................... 56
Launching applications within iManage .................................................................. 56
Creating Workshare comparison icons on the iManage desktop ............................ 58
iManage integration - configuring Workshare ............................................................ 59
OpenText integration .................................................................................................60
Adding application and file types to the server ....................................................... 60
Making Workshare compatible with OpenText eDOCS DM .................................... 63
Making the Workshare comparison icons appear on the desktop and within a user
profile .....................................................................................................................64
Worldox integration – configuring compare files ........................................................ 64
NetDocuments integration .........................................................................................66
SharePoint integration - server installation ................................................................ 68
SharePoint integration - client configuration .............................................................. 72
SharePoint site configuration..................................................................................72
Email Systems Integration ............................................................................................ 73
Setting up Microsoft Outlook .....................................................................................73
Setting Up IBM Notes ................................................................................................74
Resolving Email Addresses as Internal - Creating the Internal Domain List............ 74
Offline Mode ...........................................................................................................74
Issues with Custom Forms (Recipient Fields) ......................................................... 76
Chapter 6: Network Deployment ....................................................................................77
Overview ...................................................................................................................... 78
Installation file summary ............................................................................................78
Deploying via the Command Line ................................................................................. 80
Configuring modules during installation ..................................................................... 80
Registry ..................................................................................................................81

Workshare 9.5 Installation Guide

DisableFeatures.ini ................................................................................................82
Installation procedure with the install wizard .............................................................. 82
Deploying Workshare with the executable .............................................................. 82
Installation procedure using the MSI files directly ...................................................... 83
Example installations..............................................................................................83
Compulsory properties– Professional/Compare/Protect ......................................... 89
Optional properties – Professional/Compare/Protect .............................................. 90
Optional properties – desktop app .......................................................................... 92
Citrix Installation Guidelines.......................................................................................... 92
Enable specific users ................................................................................................93
Active Directory Deployment Guidelines ....................................................................... 94
Assigned/published to user methods ...................................................................... 94
Deploying Workshare using Active Directory ............................................................. 95
Appendix A. Additional Msiexec.exe Parameters and Switches ...................................... 100
Msiexec.exe Parameters and Switches ...................................................................... 101
Appendix B. Workshare Prerequisites ............................................................................ 105
Workshare Prerequisites ............................................................................................ 106
Summary .................................................................................................................106
Microsoft .NET Framework 4.5.2 ............................................................................. 106
Microsoft Visual C++ 2015 Redistributable Package (x86) ...................................... 106
Microsoft Visual C++ 2015 Redistributable Package (x64) ...................................... 106
Microsoft Visual Studio 2010 Tools for Office Runtime Setup .................................. 106

Installation Overview

Chapter 1:

Installation Overview

This chapter provides an overview of the installation of Workshare Professional,
Workshare Compare and Workshare Protect as well as a list of system requirements. It
includes the following sections:
•

Introducing this Guide, page 7, explains what this installation guide covers.

•

System Requirements, page 7, describes the system attributes required in order
to install and run Workshare Professional/Compare/Protect.

•

Installation Guidelines, page 11, describes the recommended installation and
deployment procedure for Workshare Professional/Compare/Protect.

•

Workshare Installation Files, page 12, describes the installation files and
prerequisites for Workshare Professional/Compare/Protect.

•

Important Information, page 15, provides important information that should be
read before installing, configuring and deploying Workshare Professional/
Compare/Protect.

Installation Overview

Introducing this Guide
This Installation Guide describes how to install, license and integrate Workshare 9.5 into
your environment. It covers the installation of the following:
•

File Comparison: Workshare enables users to compare multiple documents to
easily identify and review changes and then accept or reject them quickly and
accurately. Change notifications in Outlook alert users to changes in received
attachments and users can run a comparison with a single click. Word documents,
PowerPoint presentations and PDF files can be compared from a local location as
well as a DMS, CRM or Outlook.

•

File & Metadata Security: Workshare identifies and cleans metadata from
documents, removing the risk of unintentional data leakage. When sending emails,
users can remove hidden sensitive data, convert the documents to PDF or PDF/A
and even replace attachments with a link to Workshare’s secure online platform
where others can review them. Additionally, Workshare provides the ability to set
policies to automatically clean attachments based on specific criteria.

•

File Share & Sync: Workshare extends comparison and protection functionality
with online services. Comparisons as well as Office documents can be securely
saved and shared to Workshare’s secure online sharing platform, and attachments
can be replaced with a secure link to the document. Workshare also includes a
desktop sync app – an application that syncs content between your desktop and
Workshare’s secure online platform. At any time, you can access and review your
Workshare content as well as add files.

System Requirements
The recommended system requirements for Workshare 9.5 are:
•

Intel Core i3 @ 2.5GHz

•

AMD Athlon 64 X4

•

4GB RAM

Workshare 9.5 has a 32-bit version for 32-bit Microsoft Office environments and a 64-bit
version for 64-bit Office environments.

Certified environments for Workshare 9.5 (32-bit version)
Workshare 9.5 (32-bit version) has been tested and certified in a number of environments.
If your environment is not included in the following list, it may still be a compatible
environment. Contact Workshare Customer Support (support@workshare.com) for any
help.

Installation Overview

For details of which environments previous versions of Workshare Professional/Compare/
Protect were certified against, refer to previous versions of release notes on the
knowledge base.
Note: Unless otherwise stated, all environments are the English version with the en-us
language set.
Operating System:
•

Microsoft Windows 10 (32 bit and 64 bit)

•

Microsoft Windows 8.1 (32 bit and 64 bit) + Japanese

•

Microsoft Windows 7 SP1 (32 bit and 64 bit) + Chinese Simplified & French

Citrix:
•

With Microsoft Windows Server 2012 R2 or 2016 (64 bit)
 Citrix XenApp 7.5
 Citrix XenDesktop 7.5

Note: Check with your Citrix vendor about which Windows operating system supports
your version of Citrix.
Microsoft Office System:
•

Microsoft Office 2016 (32 bit) – including click-to-run

•

Microsoft Office 2013 SP1 (32 bit) + Japanese – including click-to-run

•

Microsoft Office 2010 SP2 (32 bit) + Chinese Simplified & French

Email System:
•

Microsoft Outlook 2016 (32 bit)

•

Microsoft Outlook 2013 SP1 (32 bit) + Japanese

•

Microsoft Outlook 2010 SP2 (32 bit) + Chinese Simplified & French

•

IBM Notes 9.0.1 FP7, FP8 and FP9
Note: Interactive Protect and the replace email attachment with link features of
Workshare are not supported in a Notes environment.

Browsers:
•

Microsoft Edge, latest version

•

Microsoft Internet Explorer 11

•

Google Chrome, latest version

•

Mozilla Firefox, latest version

Installation Overview

Microsoft SharePoint:
•

Microsoft SharePoint 2013 SP1

DMS Integration:
Note: Check with your DMS vendor about which Windows operating system supports
your DMS.
•

NetDocuments
ndOffice must be installed to use the Workshare NetDocuments integration.
Note: If you want Workshare to be available when using the NetDocuments Send
to application functionality, Microsoft Internet Explorer must be installed
(although it does not have to be the default browser).

•

iManage:
 Work 10
 FileSite/DeskSite 9.0 Update 6 and above

•

OpenText:
 eDOCS DM 16.2
 eDOCS DM 10
 eDOCS DM 5.3.1 COM only (Patch 6)

•

Worldox:
 GX4

Workshare will endeavor to support future service packs of certified environments.

Certified environments for Workshare 9.5 (64-bit version)
Workshare 9.5 (64-bit version) has been tested and certified in a number of environments.
If your environment is not included in the following list, it may still be a compatible
environment. Contact Workshare Customer Support (support@workshare.com) for any
help.
For details of which environments previous versions of Workshare Professional/
Compare/Protect were certified against, refer to previous versions of release notes on the
knowledge base.
Note: Unless otherwise stated, all environments are the English version with the en-us
language set.
Operating System:
•

Microsoft Windows 10 (64 bit)

Installation Overview

Citrix:
•

With Microsoft Windows Server 2012 R2 (64 bit)
 Citrix XenApp 7.5
 Citrix XenDesktop 7.5

Note: Check with your Citrix vendor about which Windows operating system supports
your version of Citrix.
Microsoft Office System:
•

Microsoft Office 2016 (64 bit) – including click-to-run

Email System:
•

Microsoft Outlook 2016 (64 bit)

Browsers:
•

Microsoft Edge, latest version

•

Microsoft Internet Explorer 11

•

Google Chrome, latest version

•

Mozilla Firefox, latest version

DMS Integration:
Note: Check with your DMS vendor about which Windows operating system supports
your DMS.
•

•

iManage:
 Work 10
 FileSite/DeskSite 9.3 (64 bit) and above

•

OpenText:
 eDOCS DM 16.2
 eDOCS DM 10 (64 bit)

Workshare will endeavor to support future service packs of certified environments.

Installation Overview

Installation Guidelines
This guide will take you through a typical Workshare installation. The general steps
involved are as follows:
1. For DMS users, configure your DMS server and client (described in Chapter 5:
Integration).
2. Install Workshare on a single workstation (described in Chapter 2: Installation).
3. Use the Workshare Configuration Manager (Administrator Mode) to configure
Workshare as you want it to work in your organization (described in Chapter 4:
Configuration).
4. Save the configuration to a deployment script (reg or adm file) (described in Saving
Configuration Files in Chapter 4: Configuration).
5. Deploy the configuration across your network using a deployment script so that
Workshare will be configured uniformly across your organization.
6. Deploy Workshare across your network (described in Chapter 6: Network
Deployment).
It is recommended that you follow the guidelines listed below when installing Workshare to
ensure a smooth and trouble-free installation:
•

Your system must meet the recommended requirements for Workshare shown on
page 7.

•

All important data should be backed up prior to installation.

•

Elevated/administrator privileges are required to install Workshare.

•

Workshare MSI files should not be directly edited. Changes can be applied via a
transform file (.mst) or other method of applying properties such as command line
parameters.

•

Transform files may be created via any third party software that supports Windows
Installer technology.

•

Workshare MSI files should not be repackaged. Certain custom actions that are
contained in the original MSI file may be missed and may also prevent future
upgrades.

•

Workshare MSI files should not be patched with in-house authored MSP files as
this may cause future upgrade issues and system instability.

•

Additional customer specific files and Registry keys may be deployed alongside
Workshare software as long as they do not interact or replace any files or Registry
keys belonging to the product.

•

No additional third party software should be bundled into any Workshare MSI.

If you have any queries about the installation of Workshare that are not dealt with in this
guide, please contact Workshare Customer Support.

Installation Overview

Workshare Installation Files
This section describes the Workshare executables, Windows Installer packages and
shared components.

Executables
A single, downloadable self-extracting executable will install Workshare and (where
necessary) the DMS integration. Workshare can be installed to work with your local file
system or with your DMS.
The installation executables are as follows:
Executable

Installs….

Workshare.Professional.Bundle.exe/
File Comparison, File & Metadata Security,
Workshare.Professional.Bundle.X64.exe File Share & Sync
Workshare.Compare.Bundle.exe/
Workshare.Compare.Bundle.X64.exe

File Comparison, File Share & Sync

Workshare.Protect.Bundle.exe/
Workshare.Protect.Bundle.X64.exe

File & Metadata Security, File Share & Sync

On a single workstation, the easiest way to install Workshare is to simply run the install
executable file and answer any questions asked. Where a manual installation per
computer is not feasible, you can deploy Workshare to multiple workstations using
methods described in Chapter 6: Network Deployment.

Update or full release?
The Workshare installation files will vary according to the type of release:
•

Fast track fixes: Individual fast track fixes will be sent to individual customers via an
MSP file.

•

Fix rollups: An update which contains a roll up of all fast tracks created within the
last 8-12 weeks will be sent to all customers via an MSP, EXE or MSI file.

•

Full product releases: Full product releases will be via MSI and EXE files only.

Installation Overview

Prerequisite components
The prerequisites for Workshare 9.5 depend on the version of the operating system and
the version of Microsoft Office. They are described in the following table. Prerequisites for
other versions of Workshare Professional/Compare/Protect may be slightly different.
Workshare 9.5 is a native x86 application. It normally requires the x86 prerequisites for
proper operation. The exception is the Microsoft .NET Framework which must have the
appropriate x86/x64 version installed.
Prerequisite

Version

Office

Notes

Microsoft .NET
Framework 4.5.2

4.5.51209.342
09

Windows 7, NA
Windows
Server 2012
R2

Microsoft Visual
C++ 2015
Redistributable
Package (x86)

14.0.24215

All
(including
x64
versions)

Microsoft Visual
C++ 2015
Redistributable
Package (x64)

14.0.24215

x64 OS
versions

The right-click handler is
written in x64 code and
requires this
prerequisite.

Microsoft Visual
Studio 2010 Tools
for Office Runtime
Setup

10.0.60724.0

All

Visual Studio is NOT
required.

Note: Microsoft .NET Framework should be installed first. The other prerequisite
components can be installed in any order.
For further information about each prerequisite, refer to Appendix C: Workshare
Prerequisites.

Installation Overview

Windows installer packages
If you need to extract the MSI and prerequisites from the executables, you can do so using
the /layout command. The Downloading Files and Prereqs dialog is displayed while the
prerequisites and MSIs are downloaded to the same location as the executable. The
prerequisite executables are put in a folder called redist.
The following files are extracted from the executables:
Executable

Contents Extracted

Workshare.Professional.Bundle.
exe

Workshare.Professional.msi
WorkshareCompareForPowerPoint.msi
Workshare.Desktop.msi
Redist folder including the prerequisite
executables (NDP452-KB2901907-x86-x64AllOS-ENU.exe, vc_redist_x64.exe,
vc_redist_x86.exe, vstor_redist.exe)

Workshare.Compare.Bundle.exe

WorkshareCompare.msi
WorkshareCompareForPowerPoint.msi
Workshare.Desktop.msi
Redist folder including the prerequisite
executables (NDP452-KB2901907-x86-x64AllOS-ENU.exe, vc_redist_x64.exe,
vc_redist_x86.exe, vstor_redist.exe)

Workshare.Protect.Bundle.exe

WorkshareProtect.msi
Workshare.Desktop.msi
Redist folder including the prerequisite
executables (NDP452-KB2901907-x86-x64AllOS-ENU.exe, vc_redist_x64.exe,
vc_redist_x86.exe, vstor_redist.exe)

Workshare.Professional.Bundle.
X64.exe

Workshare.Professional.X64.msi
WorkshareCompareForPowerPoint.X64.msi
Workshare.Desktop.msi
Redist folder including the prerequisite
executables (NDP452-KB2901907-x86-x64AllOS-ENU.exe, vc_redist_x64.exe,
vc_redist_x86.exe, vstor_redist.exe)

Installation Overview

Executable

Contents Extracted

Workshare.Compare.Bundle.X64
.exe

WorkshareCompare.X64.msi
WorkshareCompareForPowerPoint.X64.msi
Workshare.Desktop.msi
Redist folder including the prerequisite
executables (NDP452-KB2901907-x86-x64AllOS-ENU.exe, vc_redist_x64.exe,
vc_redist_x86.exe, vstor_redist.exe)

Workshare.Protect.Bundle.X64.
exe

WorkshareProtect.X64.msi
Workshare.Desktop.msi
Redist folder including the prerequisite
executables (NDP452-KB2901907-x86-x64AllOS-ENU.exe, vc_redist_x64.exe,
vc_redist_x86.exe, vstor_redist.exe)

If you install using an extracted MSI, you must first install all the prerequisite components
described above.

Workshare PDF Publisher
When Workshare is installed it creates a printer called Workshare PDF Publisher in the
user’s Printers folder. This is the printer that Workshare uses to convert documents to
PDF.

Important Information
Workshare Configuration Assistant
The Workshare Configuration Assistant (WCA) is a program that completes the installation
process. The WCA is not optional as it performs actions that are required to correctly
install the product. The install process automatically runs the WCA silently.

Re-running the WCA
Following installation, the WCA can be run as a separate executable for any of the
following reasons:
•

To update an installation, such as to make Workshare compatible with a new DMS

•

To install/uninstall specific Workshare features

Installation Overview

When re-run, the WCA provides information on the progress of the installation and, if
needed, messages about problems encountered. If a problem is encountered, the user
can access the online Workshare knowledge base which provides an extended description
and, where possible, a solution to resolve the problem.
The executable is named WMConfigAssistant.exe and is found in the Modules folder of
the installation directory. To be run, the WCA requires administration rights to the
workstation.
The WCA executable can be run from the command line, from within a DOS window or
using a batch (.bat) file. This should only be attempted by the network administrator or
other qualified personnel. The WCA can be run silently (without any user interface) and
quietly (with a reduced user interface).
The WCA is also available from the Start Menu: Start > Programs > Workshare >
Workshare Configuration Assistant.
To run the WCA from the command line, the following syntax should be used:
“C:\Program Files\Workshare\Modules\WMConfigAssistant.exe”
/INSTALL /SILENT /LOGFILE=”\\InstallMachine\Workshare\
Workshare.log”
Where the switches can be:
Switch

Value

SILENT

Indicates that the WCA is to be run silently, with no user interface.

QUIET

Indicates that the WCA is to be run with a reduced user interface.

LOGFILE

Name and location of the WCA log file. For example,
LOGFILE=”\\server\share\logfile.log”. The log file can either be stored
at a shared location or stored locally on the workstation.
If a location is not specified for the log file it will be written to the local
TEMP folder. By default, the log file is named WorkshareConfig.log.
The WCA log file will provide details of all the steps the WCA has taken
and can be passed to Workshare if any difficulties are encountered.
The log file is appended to, not overwritten, in order to retain all logged
information. Therefore, the latest details will be at the end of the log file.

NOTESINIF
ILE_PATH

Location of the notes.ini file. This should be specified in non-standard IBM
Notes environments to ensure that Workshare components are added
correctly to the INI file by the install.

Note: The command must be entered on one line. You can use INSTALL, UNINSTALL,
REINSTALL or REPAIR as the preceding switch. The use of “ “ should be used where
there is character spacing in file paths.

Installation Overview

Workshare Microsoft Office integration
Workshare can be installed with or without Microsoft Office integration. If you want to
change the integration of Workshare with Microsoft Office applications, go to the Control
Panel, select the Workshare product and click Change. This will re-display the installation
dialogs and you can change your integration settings.
By configuring Workshare to run without a Microsoft Office integration, for example, by
deselecting the Microsoft Word add-in, there will be no Workshare tab available in
Microsoft Word. In this case, the comparison functionality is only available from the
Workshare comparison application and the metadata removal functionality is only available
when sending emails.

Workshare OCR functionality
Workshare includes OCR technology to enable comparison of PDFs that have been
created directly from scanning. Where OCR has not been used and PDF files contain pure
images of text, Workshare applies OCR to the files before performing comparisons.

Installation on Single Workstation

Chapter 2: Installation on Single
Workstation
This chapter describes the procedure for installing Workshare on a single workstation. It
includes the following sections:
•

Installing Workshare, page 19, describes the step-by-step procedure required to
install Workshare on a single workstation.

•

Uninstalling Workshare, page 22, describes how to uninstall Workshare.

•

Upgrading Workshare, page 22, describes how to upgrade Workshare.

The procedure for installing Workshare across a network is described in Chapter 6:
Network Deployment.

Installation on Single Workstation

Installing Workshare
The following procedure explains how to install Workshare on a single workstation. Before
beginning the installation procedure, make sure that all other programs are closed and
disable any anti-virus software.
There is no need to uninstall previous versions of Workshare. With an upgrade, any
customized configuration settings are migrated from your existing installation to the new
Workshare 9.5 installation. When you are a doing a new install, the default configuration
settings are installed. Refer to Upgrading Workshare.
During the installation of Workshare, you can select which Workshare functionality to
install (file comparison, file & metadata security and file share & sync) and what Office
integrations you want. You can also select which DMS integration(s) (if any) to install OpenText, iManage, Worldox, SharePoint or NetDocuments.
To install Workshare:
1. Double-click the install executable. The Workshare installer is displayed.

Installation on Single Workstation

2. If you want to select particular functionality or integrations, click “or customize
your install”. If not, jump to step 6.

3. Select from the following as available and as required:
File Comparison: Enables you to compare documents.
File & Metadata Security: Enables you to clean metadata from documents.
File Share & Sync: Enables you to save and share files to Workshare online as
well as synchronize between Workshare online and your desktop.
Microsoft Outlook: Integrates Workshare within Microsoft Outlook.
Microsoft Word: Integrates Workshare within Microsoft Word.
Microsoft PowerPoint: Integrates Workshare within Microsoft PowerPoint.
Microsoft Excel: Integrates Workshare within Microsoft Excel.

Installation on Single Workstation

4. Click Next.

5. Select from the following as available and as required:
OpenText: Integrates Workshare within an OpenText DMS.
Microsoft SharePoint: Integrates Workshare within Microsoft SharePoint.
iManage: Integrates Workshare within an iManage DMS.
Worldox: Integrates Workshare with Worldox.
NetDocuments: Integrates Workshare with NetDocuments.
Note: Selecting a DMS here does not integrate Workshare’s online functionality
with the DMS. To integrate Workshare’s online functionality with a DMS, download
the relevant file from the Services tab of the Workshare Admin Console.
6. Click Install. Workshare creates the necessary folders and copies files. The
installation process may take a few minutes. (A progress bar indicates the progress
of the installation.) Once the installation is complete, you may be required to restart
your computer.
After install, the Workshare desktop app is launched with the Workshare login displayed
enabling you to license Workshare. Refer to Chapter 3: Licensing.
Note: Ensure that the system user has write access to the policy sets folder ProgramData/Workshare/PolicySets.

Installation on Single Workstation

Uninstalling Workshare
Workshare should be uninstalled using the Control Panel. Uninstalling Workshare will
uninstall all the Workshare elements installed during the installation process.
Note: The uninstall process will not uninstall any prerequisites installed.

Upgrading Workshare
If you are upgrading from Workshare Professional 7, 8 or 9, you should install Workshare
9.5 using either the full .exe or using the .msi files. There is no need to perform an uninstall
first.
Note: Upgrading from the 32-bit version of Workshare to the 64-bit version is not
supported. You must uninstall the 32-bit version of Workshare first and then install the
64-bit version. The same is true if you want to upgrade from 64-bit to 32-bit.
By default, any customized local configuration settings will be migrated to the new
installation. However, if you have changed the following configuration parameters in the
General > Administration category, the result may be different:
•

Backup and migrate the configuration for the Current Users: If selected, when
you are upgrading from an earlier version of Workshare all existing user settings
and options are transferred to the Workshare 9.5 installation. This is selected by
default.

•

Backup and migrate the default configuration for All Users: If selected, when
you are upgrading from an earlier version of Workshare all existing public settings
and options are transferred to the Workshare 9.5 installation. This parameter is
available in Administrator Mode only and is NOT selected by default.

If you are doing a new install, or if both these parameters are deselected, the default
configuration settings are installed.
Note: Lightspeed clean will be the default metadata cleaning method regardless of
whether you had it selected in previous installations.

For a full description of the Workshare functionality, refer to the relevant Workshare user
guide.

Licensing

Chapter 3:

Licensing

This chapter describes the licensing procedure for Workshare. It includes the following
sections:
•

Licensing Workshare, page 24, describes the process for licensing Workshare.

•

Standard Install, page 26, describes how to license Workshare when installing on
individual machines.

•

Deployment with User Authenticated License, page 28, describes how to
license Workshare with a User Authenticated license when rolling out to multiple
users.

•

Deployment with Enterprise License, page 32, describes how to license
Workshare with an Enterprise license when rolling out to multiple users.

•

Renewing a License, page 33, describes how to renew a Workshare license.

Note: You do NOT need to uninstall or remove any existing lic file. Workshare 9.5 will
ignore it.

Licensing

Licensing Workshare
The first step of any installation is to purchase your product. To do so:
1. Create a Workshare account on my.workshare.com
2. Purchase your product
3. Download the installation file
A license is created and assigned to your account. In order to license your product, select
the method most suited to your environment.
•

Standard Install: When you are installing Workshare on individual machines, user
authenticated licensing is recommended.

•

Deployment with User Authenticated License: When your users will be using
the online functionality (file share & sync) and you want an accurate view of license
usage as well as the ability to track and manage users centrally, user authenticated
licensing is recommended.

•

Deployment with Enterprise License: When your users won’t be using the online
functionality (file share & sync) or you have restrictive firewall settings or you
operate in a Citrix environment, enterprise licensing is recommended.

The steps in each method are outlined below:

Licensing

How Workshare checks for licenses
Workshare checks the Registry for a license. Workshare always checks
HKEY_CURRENT_USER (HKCU) for the license key first. If it finds it, Workshare will not
look in HKEY_LOCAL_MACHINE (HKLM).
The process for user authenticated licensing works like this:
•

When Workshare functionality is used, Workshare looks for the license in HKCU.

•

When it can’t find it in HKCU, Workshare checks HKLM.

•

When it can’t find it in HKLM, Workshare sends a request to my.workshare.com to
get the key.

•

The key is retrieved and put in HKCU.

The process for enterprise license deployments works like this:
•

When the enterprise license key is first deployed, it’s added to HKLM.

•

The first time Workshare functionality is used, Workshare looks for the license in
HKCU.

•

When it can’t find it in HKCU, Workshare checks HKLM.

•

When Workshare finds the key in HKLM, it copies the key into HKCU.

Licensing

Standard Install
When you are installing Workshare on individual machines, user authenticated licensing is
recommended. This is where users are required to have a Workshare account and sign in
to Workshare on a one-off basis to retrieve their license entitlements.

One-time log in
After installation, the user will log in to Workshare in order to retrieve their license
entitlements. They will be prompted to do so in either of the following ways:
•

When file share & sync is included in the installation, the Workshare desktop app is
launched and they are prompted to log in to Workshare in order to retrieve their
license entitlements.

If the user does not log in at this point or if file share & sync is not included in the
installation, then….

Licensing

•

The first time a user accesses Workshare functionality, for example, by clicking any
option in the Workshare tab, they are prompted to log in to Workshare in order to
retrieve their license entitlements.

The user must enter their Workshare credentials (email address and password) and click
Sign in. The license entitlements for your account are retrieved and shown in the My
Products tab of the Workshare Configuration Manager.
Users who do not yet have a Workshare account can click Create an account in the login
dialog. Workshare checks their email address and will automatically register them against
your corporate Workshare account and update their license entitlement.

Licensing

Prevent sign in dialog displaying
If you want to prevent the Workshare sign in dialog from appearing in order to get license
information, you can set the following Registry key
•

32-bit Workshare on 32-bit Windows: HKEY_LOCAL_MACHINE\Software\
Workshare\Options\9.05\General\GeneralAdmin
SuppressSignIntoWorkshare=true

•

32-bit Workshare on 64-bit Windows: HKEY_LOCAL_MACHINE\Software\
Wow6432Node\Workshare\Options\9.05\General\GeneralAdmin
SuppressSignIntoWorkshare =true

•

64-bit Workshare on 64-bit Windows: HKEY_LOCAL_MACHINE\Software\
Workshare\Options\9.05\General\GeneralAdmin
SuppressSignIntoWorkshare =true

If you set this key, you will need to license your users using an enterprise license. Refer to
Deployment with Enterprise License.
Note: Users will still be prompted to sign in if they are trying to share files or use other
Workshare online functionality, even if this key is set.

Deployment with User Authenticated License
When your users are using the Workshare file share & sync functionality and you want an
accurate view of license usage as well as the ability to track and manage users centrally,
user authenticated licensing is recommended. After you have deployed the product, your
users are required to have a Workshare account and sign in to Workshare on a one-off
basis to retrieve their license entitlements. To simplify this process, you can create
accounts for your users from the Workshare Admin Console.

Create accounts for users
When you are deploying Workshare across your network, you should first add your users
to your Workshare account. Users need a Workshare account so that they can log into
Workshare in order to validate their entitlement to Workshare products and receive their
license.
Adding users to your Workshare account is a simple process performed on the Workshare
Admin Console and you may add them individually or up to 100 at one time using a CSV
file. Users are people in your network using one of your Workshare licenses and all users
share the same domain name.
Note: Any user who is part of your domain will be assigned to your company account
even if they sign up for a personal account.

Licensing

Adding a user “invites” that user to your Workshare account and they receive an email
asking them to validate their account and create a password for it. Only when the invited
user validates their account are they considered a licensed user on your account.
Tip! A video describing this process can be found at
https://www.youtube.com/watch?v=x1lxAut6lsg&feature=youtu.be.
If you do not have access to the Admin Console, you can create accounts for your users
following the procedure in Create accounts without the Admin Console.
To add multiple users:
1. Create a CSV file containing the user account information (up to 100 users). Ensure
the file has the following mandatory headers: “email address” and “first name”. You
may also include the following headers: “last name”, “job title” and “phone number”.
2. Go to my.workshare.com and log in to your account.
3. Click your user name in the topbar and select Admin Console.
4. Select the User Management tab.
5. Click Add Bulk Users.

6. Click Choose File and browse to where you have saved your CSV file with all your
user details.
7. Select the file and click Open.

Licensing

8. In the Add Bulk Users window, click Import. The user details are added to your
account and a registration email is sent to all the email addresses specified, inviting
them to validate their Workshare account.
Your users will appear in the User Management tab.
To add a single user:
1. In the User Management tab of the Admin Console, select Add User.

2. In the E-mail field, enter an email address for the user – this must be from your
registered email domain.
3. In the First Name field, enter a name for the user.
4. Complete the other fields and add a picture for the user if required. The user will be
able to edit these personal settings when they have validated their account. The
user cannot change their registered email address.
Note: The default role for a user is that of User. If you want to create an
administrator user with access rights to the Admin Console, select Account
Admin from the Role dropdown list.
5. Click Add User. A registration email is sent to the email address specified and the
user is invited to validate their Workshare account.

Licensing

Create accounts without the Admin Console
If you do not have access to the Workshare Admin Console, you can create accounts for
your users using the following link:
http://workshare.force.com/knowledgebase/CustomerUploads.
To add users:
1. Click http://workshare.force.com/knowledgebase/CustomerUploads. This will
display the following page:

2. Create a CSV file containing the user account information (up to 100 users).
Ensure the file has the following mandatory headers: “email address” and “first
name”. You may also include the following headers: “last name”, “job title” and
“phone number”.
3. Click Choose File and browse to where you have saved your CSV file with all your
user details.
4. Select the file and click Open.

Licensing

5. Enter your Workshare login credentials in the Username and Password fields.
6. Click Import. The user details are added to your account and a registration email is
sent to all the email addresses specified, inviting them to validate their Workshare
account.

Deployment with Enterprise License
When your users won’t be using the Workshare file share & sync functionality or you have
restrictive firewall settings or you operate in a Citrix environment, enterprise licensing is
recommended. An enterprise license comes in the form of a Registry file that can be
deployed across your network.
Contact Workshare Customer Support to request an enterprise license. Workshare
Customer Support will send you a Registry file that you can install on your machine by
double-clicking. To install the license on your users’ machines, deploy the Registry file
across your network using your preferred method.
Note: You may receive several Registry files – use the one appropriate to your
environment.

Registry location
Installing the REG file adds the license (adding keys and values) to the Registry in the
following location:
32-bit Workshare on 32-bit Windows: HKEY_LOCAL_MACHINE\Software\
Workshare\Options\9.05\Internal\Subscription\Features
32-bit Workshare on 64-bit Windows: HKEY_LOCAL_MACHINE\Software\
Wow6432Node\Workshare\Options\9.05\Internal\Subscription\
Features
64-bit Workshare on 64-bit Windows: HKEY_LOCAL_MACHINE\Software\
Workshare\Options\9.05\Internal\Subscription\Features
Depending on the products purchased, one or both of the following keys are added –
Compare and Protect. Each one includes a Value named “Feature” with the content of the
license feature string set as the Value data.

End user interaction
After deployment, the license will be installed in the Registry on each of your user’s
machines and they can use the Workshare products. There will be no need for the end
user to log in to Workshare.

Licensing

Capturing of email
Enterprise licenses may capture a user’s email address. If you do not want Workshare to
capture the email addresses of your users at all, you should include the following switch
with your install script.
CAPTURE_EMAIL
When this parameter is set to CAPTURE_EMAIL=NO, the install sets or updates the
Workshare option in the Registry - SubscriptionCaptureEmail to False.
Note: This is an admin/HKLM only option in HKEY_LOCAL_MACHINE\SOFTWARE\
Wow6432Node\Workshare\Options\9.00\General\GeneralAdmin; it is not visible in the
Workshare Configuration Manager (Admin mode).
When the Registry option is False, Workshare does not send the user email address as
part of the validation call for licensing and as a result a Workshare account will not be
provisioned.

Renewing a License
When a user is in a licensed state, they will not receive any notifications that their license
is about to expire. Only you, the administrator, will receive an email that your renewal is
due.
Once the license expiry date has passed, users will be notified that the license has expired
and needs to be updated, but they can continue using the software for a period of time.
This notification is in the form of a banner in Outlook or Compare. It is displayed daily but
once dismissed by a user, it will not be displayed again until the next day.

If you want to stop users receiving these license notifications, you can set the following
Registry key.
•

32-bit Workshare on 32-bit Windows: HKEY_LOCAL_MACHINE\Software\
Workshare\Options\9.05\General\GeneralAdmin SuppressNag=true

•

32-bit Workshare on 64-bit Windows: HKEY_LOCAL_MACHINE\Software\
Wow6432Node\Workshare\Options\9.05\General\GeneralAdmin
SuppressNag=true

•

64-bit Workshare on 64-bit Windows: HKEY_LOCAL_MACHINE\Software\
Workshare\Options\9.05\General\GeneralAdmin SuppressNag=true

Once you have renewed your license, Workshare will automatically refresh your users'
licenses -- you don't need to redeploy a .REG file; your users don't have to sign in.

Licensing

Note: If you have renewed your license and this notice is shown again, click Refresh in
the My Products page of the Workshare Configuration Manager to update and validate
your renewed license.
If you have restrictive firewall settings or if you are using a proxy server, whitelist or add
the following domain name and port as an exception:
•

*.workshare.com

•

Port 443

Trial users
When you are running a trial of Workshare, you have a trial (evaluation) license. During
the trial, users will receive a daily message informing them that they are in a trial. This
message is in the form of a banner, similar to the following:

The message notifies the user of the date the trial will end and also provides a link to get a
license.
If you do not obtain a license before the end of the trial, users will be unable to use any
Workshare functionality once their trial ends.

Configuration

Chapter 4:

Configuration

This chapter describes how to use the Workshare Configuration Manager to configure
Workshare. It includes the following sections:
•

Introducing the Workshare Configuration Manager, page 36, provides an
overview of the Workshare Configuration Manager and how you can use it to
customize Workshare behavior to suit your organization’s requirements.

•

Accessing the Workshare Configuration Manager, page 38, describes how to
access the Workshare Configuration Manager and its parameters.

•

Setting Parameters, page 41, describes how to save configuration parameters to
a configuration file as well as deploy the configuration file to other Workshare
workstations.

•

Deploying Configuration Settings, page 42, describes how to save policy sets
and distribute them to other Workshare workstations.

•

Registry Configuration, page 47, describes additional configuration performed
directly in the Registry.

Configuration

Introducing the Workshare Configuration
Manager
The Workshare Configuration Manager is a separate configuration utility that enables you
to configure Workshare and the way it behaves as well as modify the configuration of the
default profile (via the parameters in the Protection category).
Note: A profile is a set of policies which contain parameters applied by Workshare when
determining content risk.

Administrator Mode and User Mode
The Workshare Configuration Manager has two modes as follows:
•

Administrator Mode: This mode should be used by administrators to make
changes to the default settings on the local machine. Settings made are saved in
HKEY_LOCAL_MACHINE in the Registry.

•

User Mode: This mode should be used by users to make changes to the
Workshare configuration to suit their own personal preferences on the local
machine. Other users could log in and they would not have the same configuration
settings. Settings made are personal to the user and saved in
HKEY_CURRENT_USER in the Registry.

When Workshare is first installed, the default configuration settings (factory defaults) are
included in the installation and the Registry is empty of any of the Workshare Configuration
Manager configuration settings. Once an administrator clicks Apply to Local Machine in
the Administrator Mode of the Workshare Configuration Manager, the Registry
(HKEY_LOCAL_MACHINE) is updated with any changes. Once an administrator clicks
Apply to Current User in the Administrator Mode of the Workshare Configuration
Manager, the Registry (HKEY_ CURRENT_USER) is updated with any changes.
Additionally, when a user clicks Apply in the User Mode of the Workshare Configuration
Manager, the Registry (HKEY_CURRENT_USER) is updated with any changes.
When determining what value to assign to each configuration parameter, or when
generating the default policy, Workshare looks in the following locations in the following
order:
1. HKEY_LOCAL_MACHINE just for the IgnoredUserOverrides key to see what
parameters have been locked by the administrator
2. HKEY_CURRENT_USER
3. HKEY_LOCAL_MACHINE
4. WMOption.dll which contains an XML file with the factory defaults

Configuration

It is important to remember that a user’s preferences will take precedence over the default
settings and the factory defaults. However, configuration parameters can be locked so that
a user is unable to change the value of any given parameter.
You can use Administrator Mode of the Workshare Configuration Manager to establish
global settings that standardize the use of Workshare across your organization. Once you
have finalized the configuration, you can save the settings as an ADM or REG file and
deploy to the Workshare workstations in your network. Refer to Deploying Configuration
Settings, page 42.
Note: An ADM file is a group policy template file that can be rolled out using Group
Policy. The ADM configuration file can be created using the Workshare Configuration
Manager.
The Workshare Configuration Manager can be installed as a standalone application if
required. This would enable you to establish a global set of configuration parameters and
deploy them company wide. As a standalone application, only the Administrator Mode of
the Workshare Configuration Manager is available.
The Workshare Configuration Manager – User Mode will only show those options which
are applicable to the modules which are currently configured for that user. The
Administrator Mode will show all options regardless of which product is installed and what
modules are configured.

Default policy
When Workshare is checking email attachments or open Microsoft Office documents for
content risk or metadata, it uses the default policy to determine if there is a risk.
Note: When Interactive Protect is configured, Workshare checks email attachments
against settings in the Registry.
The default policy is a set of parameters configured in the Protection category of the
Workshare Configuration Manager and saved in a file called
WorkshareClient.runtimepolicy file.
The WorkshareClient.runtimepolicy file is automatically generated from the Registry in the
following scenarios:
Action

Location of WorkshareClient.runtimepolicy

Workshare installation

ProgramData/Workshare/PolicySets/ClientProfiles/
Default

Re-running the Workshare
Configuration Assistant

ProgramData/Workshare/PolicySets/ClientProfiles/
Default

Configuration

Action

Location of WorkshareClient.runtimepolicy

Applying changes in
Administrator Mode of the
Workshare Configuration
Manager

ProgramData/Workshare/PolicySets/ClientProfiles/
Default

Applying changes in User Mode
of the Workshare Configuration
Manager

Users/[current user]/AppData/Roaming/Workshare/
PolicySets/ClientProfiles/Default

Changing Registry values in the
Registry which correspond to
the Protection category options

Users/[current user]/AppData/Roaming/Workshare/
PolicySets/ClientProfiles/Default

Note: If you do not want the default policy files to be automatically regenerated in these
scenarios, ensure the Enable automatic generation of default profile parameter
(Protection>Administration category) is NOT selected. If this option is set off BEFORE
the installation of Workshare, you must ensure you have created and placed your own
security policy in the Client Default folder in the ProgramData/Workshare/PolicySets/
ClientProfiles location.
When applying the default policy, Workshare will look first in the user location
(Users/[current user]/AppData/Roaming/Workshare/PolicySets/ClientProfiles/Default) and
if it does not find a WorkshareClient.runtimepolicy file there, it will look in the public
location (ProgramData/Workshare/PolicySets/ClientProfiles/Default).
Note: If you want to create additional security policies, you should use the Workshare
Policy Designer and save each .runtimepolicy in a separate directory in ProgramData/
Workshare/PolicySets/ClientProfiles.

Accessing the Workshare Configuration
Manager
The Workshare Configuration Manager – User Mode can be accessed from within
Microsoft Office or from the Start menu.
Note: When the Workshare Configuration Manager is installed as a standalone
application, only the Administrator Mode is available and it is accessed from the Start
menu.

Configuration

To access the Workshare Configuration Manager from Microsoft Office:
1. In Microsoft Office, click Options in the Workshare tab, Options group. The
Workshare Configuration Manager opens in User Mode.
2. To access Administrator Mode, click Launch Administrator Mode.
To access the Workshare Configuration Manager from the Start menu:
•

When the Workshare Configuration Manager is installed as part of Workshare
Professional/Compare/Protect, from the Start menu, select Workshare
Configuration (User Mode). The Workshare Configuration Manager opens in User
Mode. To access Administrator Mode, click Launch Administrator Mode.

•

When the Workshare Configuration Manager is installed as a standalone
application, from the Start menu, select Workshare Configuration. The
Workshare Configuration Manager opens in Administrator Mode.

To access the Workshare Configuration Manager from Workshare Compare:
1. Open Workshare Compare.
2. From the File menu, select Workshare Config Manager. The Workshare
Configuration Manager opens in User Mode.
3. To access Administrator Mode, click Launch Administrator Mode.
In Administrator Mode, the state of the options reflects the settings in
HKEY_LOCAL_MACHINE in the Registry.
Note: In order to access Administrator Mode, you must have local administrator rights. In
Windows Vista and above, when UAC (user access control) is enabled, the User Access
Control dialog is displayed when you click Launch Administrator Mode. If you do not
have administrator rights, you can enter a user name and password to elevate you to
administrator. If you do have administrator rights, you need to allow the Workshare
Configuration Administrator Console (Workshare Configuration Manager) to access this
computer. Click Yes and Administrator Mode is launched.

Configuration

The configuration parameters for Workshare are grouped into categories (such as
Protection, Comparison) and sub-categories (such as Administration, User Interface). In
User Mode, categories are available according to your installation. Click a sub-category to
display the parameters for that sub-category. The different sub-categories and their
parameters are described in the Workshare Configuration Options guide.

Searching parameters
If you know the name of a parameter (or part of its name) but not its location, you can
search the Workshare Configuration Manager using the search box on the top right.

Click the parameter in the results list and the relevant category and sub-category is
displayed in the Workshare Configuration Manager.

Configuration

Setting Parameters
Most parameters in the Workshare Configuration Manager are set by selecting or
deselecting a checkbox. There are also some that require you to enter a value in a text
box.
To specify parameters:
1. In the Workshare Configuration Manager, select a category and then a
sub-category.
2. Set a value for a parameter by selecting or deselecting the checkbox or by entering
a value in the text box.

3. Click the padlock icon to unlock/lock a parameter. When you lock a parameter, a
user is not able to change the setting.
Note: The
icon to the right of a parameter indicates that the parameter value
has been changed. In Administrator Mode, the green arrow
deployment icon is
shown when a parameter will be included in a deployment script.
4. Continue to select categories and sub-categories and specify parameters as
required.
5. Save your settings by clicking Apply to Local Machine. The Registry
(HKEY_LOCAL_MACHINE) is updated with any changes.
A confirmation message is displayed once the settings have been saved.
6. Click OK.
Note: The
icon is no longer displayed to the right of changed parameters but
the green arrow
deployment icon will remain.

Recipient checking
You can specify different metadata removal settings for email attachments sent internally
and externally. For example, you may want to remove all hidden data when sending
emails externally, but only remove track changes and hidden text when emailing internally.
Workshare determines whether a recipient is external or internal as follows.

Configuration

Workshare takes each recipient in the To, Cc and Bcc fields, and looks them up in the
configured address book(s). Usually this is the contacts list or local address book (on your
machine) and the global address book (on the server).
Note: To ensure that Workshare can integrate with the local and global address books
when users are offline, please refer to Chapter 4: Integration.
For each address there are three possible outcomes:
•

The address does not exist in any address book. This is then processed as
external.

•

The address is a distribution list. In this case, the address of each member of the
distribution list is checked.

•

The address exists in one of the address books. If so, Workshare does a further
check that checks the type of address. Either it will be an Exchange\Notes address
(meaning the address exists on the email server), or it will be an SMTP address
(meaning the email will be routed via the Internet). If it is a server address, it is
processed as internal. If it is an SMTP address, it is processed as external.

When deciding which metadata removal options to apply, each recipient is checked. If an
external recipient is found, external metadata removal settings are applied. Only if all
recipients are internal, are internal metadata removal settings applied.
Note: Using the Treat the specified addresses as internal (Outlook) parameter
(Protection > Administration category), you can specify external email addresses that
you would like to be treated as internal for the purpose of Workshare applying policies.

Deploying Configuration Settings
In Administrator Mode, you can save the configuration settings as an ADM or REG file.
This will enable you to distribute these settings to other machines without having to
manually set the options on each machine. You set the configuration parameters for
Workshare in a test installation or on any workstation with the Workshare Configuration
Manager installed, save the configuration settings in an ADM or REG file and then deploy
them to other Workshare workstations. This saves time and enables a consistency within
your organization.
Additionally, you can save the configuration settings as a WSO file (Workshare Options
file). A WSO file can be loaded in the Workshare Configuration Manager so you can
restore the settings at some point in the future. This enables you to keep a
work-in-progress or project file.
Finally, Workshare has created ADM files which contain all the options and their default
values. These files are very similar to the files created by the Workshare Configuration
Manager but contain placeholders for an unconfigured DMS server. Contact Workshare
Customer Support for these files.

Configuration

Saving configuration files
Configuration settings are saved in Administrator Mode of the Workshare Configuration
Manager.
To save configuration settings:
1. In Administrator Mode of the Workshare Configuration Manager, specify
configuration parameters as required. Refer to Setting Parameters.
2. Click the arrow on the Save button and select from the following:
 Save as Workshare Options: To save the settings in a WSO file which can be
loaded/opened in the Workshare Configuration Manager at a later time.
 Save Deployment Script: To save the settings in an ADM or REG file which
can be used to deploy to other workstations.
3. When selecting to save as a Workshare Options file, a Save As dialog is displayed.

4. Name the file as required, navigate to the save location and click Save. The
settings are saved in a WSO file which can be loaded in the Workshare
Configuration Manager at a later time.

Configuration

5. When selecting to save as a deployment script, the Deployment Script Settings
dialog is displayed.

6. From the Environment dropdown list, select your environment.
7. From the Registry Target dropdown list, select where in the Registry you want to
save the settings.
Note: Selecting HKCU will replace any personalized settings configured by an
individual user on this machine.
8. From the Generate Script dropdown list, select the type of file to generate. You
can create a script:
 For all options. The resulting ADM or REG file will contain all options. A REG
file will set options that have been marked with the deployment icon and
remove all other options by deleting them from the Registry. This will revert
them to the factory default on the target machine. The ADM file will contain all
the options and use the values defined by the administrator as the default
values. Typically, this is used for new deployments – it will generate a script
that will set options that have been changed from the factory defaults and revert
any unchanged options to the factory defaults on the target machine.

Configuration



For options with a deployment icon. The resulting ADM or REG file will only
contain those options indicated by a green deployment icon. No other options
will be deployed or changed. Typically, this is used when upgrading an existing
deployment – it will generate a script that will only set options that have been
changed (indicated by the green arrow icon) and will not modify any unchanged
options on the target machine.

9. In the Save Location field, click the browse button.

10. Name the file as required, navigate to the save location.
11. From the Save as type drop down list, select ADM File or Registry Script as the
file type.
12. Click Save.
13. Click Save in the Deployment Script Settings dialog. The settings are saved to the
specified ADM or REG file.
You can now deploy the REG file or use the ADM template to deploy settings to other
individual Workshare workstations.

Configuration

Loading configuration files
If you have saved the configuration settings as a Workshare Options (WSO) file, you can
open the saved WSO file in the Workshare Configuration Manager. You can then update
the settings on the local machine or continue developing a set of configuration parameters
for future deployment. The save and re-load functionality enables you to keep a work-inprogress or project file.
To load a configuration file into the Workshare Configuration Manager:
In Administrator Mode of the Workshare Configuration Manager, click the arrow on the
Load button and select from the following:
•

Load Workshare Options: Enables you to browse to a WSO file.

•

Load Defaults: Resets all the parameters to their factory default settings.

•

Load User Settings: Resets all the parameters to the settings specified in the
running user’s HKEY_CURRENT_USER Registry hive.
Note: When you provide user credentials to the UAC prompt then that user is the
running user.

The selected settings are displayed in the Workshare Configuration Manager.

Upgrading
By default, when you deploy Workshare to machines which have earlier versions of
Workshare Professional/Compare/Protect, all local settings and options are transferred. If
you don’t want to migrate the existing options and settings to the new installation, or you
want to include public settings too, you can change the following parameters in the
General > Administration category:
•

•

If you are doing a new install, or if both these parameters are deselected, the default
configuration settings are installed.

Configuration

Registry Configuration
This section describes configuration of Workshare that is done by making changes in the
Registry.
Important: If you use Registry Editor incorrectly, you may cause serious problems that
may require you to reinstall your operating system. Only system administrators should
attempt to make changes in the Registry.

Small text removal
When Workshare is configured to clean/delete small text (smaller than 5 points), it will
check content for half sizes as well as full sizes (4.5, 4, 3.5, 3, 2.5, 2, 1.5, 1, 0.5) and this
may slow down the cleaning process. If you want Workshare to just clean full point sizes
(4, 3, 2, 1), you need to create the Registry value HalfPointSmallTextSupport in the
Registry key SOFTWARE\Workshare\Options\9.05\Protect\ProtectAdmin with a string
value of true. Use HKEY_LOCAL_MACHINE to set an option machine-wide and
HKEY_CURRENT_USER to set an option for a user.

Integration

Chapter 5:

Integration

This chapter describes how to integrate Workshare with your email systems and DMS. It
includes the following sections:
•

Introduction, below, introduces integrating Workshare with your email systems
and DMSs.

•

Document Management Systems Integration, page 50, describes how to
integrate Workshare with your iManage, OpenText, Worldox, NetDocuments or
SharePoint DMS.

•

Email System Integration, page 73, describes how to integrate Workshare with
your email system.

Integration

Introduction
Document Management Systems
Workshare has been tested and certified in a number of DMS environments. If your
environment is not included in the following list, it may still be a compatible environment.
Contact Workshare Customer Support (support@workshare.com) for any help.
Note: Unless otherwise stated, all environments are the English version with the en-us
language set.

DMS integration for Workshare 9.5 (32-bit version)
Check with your DMS vendor about which Windows operating system supports your DMS.
•

•

iManage:
 Work 10
 FileSite/DeskSite 9.0 Update 6 and above

•

OpenText:
 eDOCS DM 16.2
 eDOCS DM 10
 eDOCS DM 5.3.1 COM only (Patch 6)

•

Worldox:
 GX4

Workshare will endeavor to support future service packs of certified environments.

Integration

DMS integration for Workshare 9.5 (64-bit version)
Check with your DMS vendor about which Windows operating system supports your DMS.
•

•

iManage:
 Work 10
 FileSite/DeskSite 9.3 (64 bit) and above

•

OpenText:
 eDOCS DM 16.2
 eDOCS DM 10 (64 bit)

Workshare will endeavor to support future service packs of certified environments.

Email systems
Workshare is certified with the following email systems:
•

Workshare 9.5 (32-bit version)
 Microsoft Outlook 2016 (32 bit)
 Microsoft Outlook 2013 SP1 (32 bit) + Japanese
 Microsoft Outlook 2010 SP2 (32 bit) + Chinese Simplified & French
 IBM Notes 9.0.1 FP7, FP8 and FP9
Note: Interactive Protect and the replace email attachment with link features of
Workshare are not supported in a Notes environment.

•

Workshare 9.5 (64-bit version)
 Microsoft Outlook 2016 (64 bit)

During installation, Workshare automatically detects your email system and configures
itself to work with that system. If you work with both IBM Notes and Microsoft Outlook,
Workshare is configured to work with IBM Notes.
Workshare will endeavor to support future service packs of certified environments.

Integration

Document Management Systems Integration
iManage integration – configuring server integration
In order to use Workshare with an iManage DMS, you must add the Workshare file types
and the Workshare comparison applications to the iManage server so that the DMS can
recognize and work with Workshare files. Additionally, it is necessary to add Workshare as
an iManage class.
Note: The following procedures show the process for a WorkSite server. The process
may vary slightly for a Work 10 server.

Adding file types to the iManage server
This step includes adding the Workshare Compare file type (WDF), the Workshare
Compare for PowerPoint file type (WCFP), the Combine in Workshare file type (WWB)
and, if it is not already added, the Microsoft Word file type (DOC) to the iManage server.
Note: This must be done for all iManage databases, regardless of whether the user has
permissions to a database or not.
To add file types to the iManage server:
1. From the Start menu on the iManage server, select Programs then iManage
Server and then Database Administration. The iManage Database Management
window is displayed.
2. Expand the tree on the left underneath the database to be integrated with
Workshare and select Type. A list of file types recognized by iManage is displayed
on the right side of the window.
3. From the Manage menu, select Add. The Add Type dialog is displayed.

Integration

4. Complete the fields as shown below and click OK.

5. Ensure that the Microsoft Word file type (DOC) appears in the list of recognized file
types. If it does not, complete the above steps to add it.

Adding the Workshare comparison applications to the iManage server
This step includes specifying the location of the Workshare comparison executable files as
well as identifying the file types used by Workshare Compare and Workshare Compare for
PowerPoint. This is done for each iManage database that will be used with the Workshare
comparison applications.
To add the Workshare comparison applications to the iManage server:
1. In the iManage Database Management window, expand the tree on the left
underneath the database to be integrated with Workshare and click App Setup. A
list of applications set up to work with iManage is displayed on the right side of the
window.
2. From the Manage menu, select Add. The Add App Setup Entry dialog is displayed.

Integration

3. Complete the fields as shown below:

Note: Ensure the path points to the location of the Workshare comparison
executable files. By default, this is C:\Program Files\Workshare\Modules\
DeltaVw.exe (Workshare Compare) and C:\Program Files\Workshare\
Compare For PowerPoint\DeckCompare.exe (Workshare Compare for
PowerPoint)
4. Click OK.

Integration

Adding Workshare as a class to iManage server
Adding Workshare files as a class (Compare class, PPT Compare class and Workshare
Combine class) in the iManage server enables you to classify Workshare documents
accordingly. This is done for each iManage database that will be used with Workshare.
If you do not want to add the suggested Workshare classes to your iManage server, you
can specify your own class for the Workshare files. The class that you specify must exist
on your server. Refer to the procedure, To specify your own class, page 55.
To add Workshare as a class:
1. In the iManage Database Management window, expand the tree on the left
underneath the database to be integrated with Workshare and select Class. A list
of file classes defined in iManage is displayed on the right side of the window.
2. From the Manage menu, select Add. The Add Class dialog is displayed.
3. Complete the fields as shown below and click OK.

Integration

To specify your own class:
Set the Alternate Class Name parameter in the Workshare Configuration Manager
(Integrations > iManage category). You set this parameter to specify the class that you
want to use and enable it by selecting the Use Alternate Class Name parameter. The
class MUST exist on your iManage server.

Work 10 configuration
In a Work 10 environment, the integration steps required may vary according to your
setup.
•

Work 10 server accessed through FileSite on desktop:
When accessing iManage files via FileSite, users will be able to right-click and
Compare with Workshare.

•

Work 10 server accessed through browser
When accessing iManage files via a browser, in order to start a comparison from
the context menu and compare with Workshare, the Workshare iManage
Integration Server (WIIS) must be installed (described in this knowledge article).

•

Work 10 server accessed from Office application
When the Work 10 for Office add-in is installed and users are accessing iManage
files from an Office application, additional configuration can be performed as
described below.

Note: In all scenarios, users can access Workshare Compare from the desktop shortcut
icon and browse to iManage files to compare.
The Work 10 integration into Office applications (Work 10 for Office add-in) provides an
iManage ribbon within the Office environment. There is a Compare option on the ribbon,
which defaults to the compare functionality provided by Microsoft Word. You can change
this so that the Compare button accesses Workshare comparison functionality.
To direct the iManage Compare button to Workshare:
Workshare provides a plugin called iManageOfficeAddin.zip for iManage Work 10 for
Office. It is located in the Modules subfolder in the Workshare installation folder. By
default, this is C:\Program Files\Workshare\Modules or C:\Program Files(x86)\Workshare\
Modules.
You must upload this plugin to your iManage Work 10 server, which will then push it out to
your Work 10 client machines. The plugin is uploaded from iManage Control Center. Refer
to iManage documentation at help.imanage.com for more details on uploading plugins for
iManage Work 10 for Office to the iManage Work server.

Integration

iManage integration – configuring client integration
There are several configuration procedures you may want to perform on an iManage client
when integrating with Workshare, as follows:
•

Launching applications within iManage

•

Creating Workshare comparison icons on the iManage desktop

Launching applications within iManage
This procedure is only relevant when the iManage server application location is different
from your local application locations. iManage would first use the local location of
Workshare Compare/Compare for PowerPoint before using the server location.
To launch Workshare Compare, Workshare Compare for PowerPoint, Microsoft Word and
Rich Text Format files from iManage you have to add application information to Local
Applications settings.
To add application information to Local Applications settings:
1. In the WorkSite ribbon in Outlook, select Options > Local Applications. The
Application Setup Information dialog is displayed.
2. Click the Add button. The Add Local Application dialog is displayed.

Integration

3. Complete the fields as shown below:

4. Click OK to save the changes.

Integration

Creating Workshare comparison icons on the iManage desktop
In order to launch Workshare Compare/Compare for PowerPoint via an icon within your
iManage desktop, follow the procedure below.
To create Workshare comparison icons:
1. Open iManage DeskSite.
2. Right-click the toolbar and select Customize. The Customize dialog is displayed.
3. Select the Commands tab.

4. Click and drag the Workshare Compare icon and Workshare Compare for
PowerPoint icon to the DeskSite toolbar.

Integration

iManage integration - configuring Workshare
On installation, Workshare automatically copies the iManage server settings specified for
the iManage client. Workshare again retrieves the iManage server settings at the
beginning of each DMS session to keep the list of servers up to date.
If you do not use iManage trusted login (so that each user has a unique user name and
password to access the iManage server), you must specify your iManage user name and
password in the Workshare Configuration Manager.
To specify/modify iManage server settings:
1. In Administrator Mode of the Workshare Configuration Manager, select the
Integrations > iManage category.

2. To add details of a new server, click Add. An entry is added to the list of iManage
servers in the Servers section.

3. In the Server Name field, enter the name of your iManage server. When using
Work 10, this must be the https address.
4. In the UserID and Password fields, enter the user login details that enable login to
the specified server. If you connect to your iManage server using your Windows
account, select the TrustedLogin checkbox only.

Integration

5. Select the AutoLogin checkbox to automatically connect to the server and
authenticate the user at startup. If you do not select this checkbox, the server can
be registered but will not be authenticated at startup. This may be useful in a multiserver environment when you want to save the overhead of authenticating all the
servers at startup.
Note: If a document ID is passed to a Workshare product for a document on a
server for which it has details (a registered server) but to which it is not connected,
then the Workshare product will automatically connect to that referenced server.
6. When the server is a Work 10 server, select the Work 10 Server checkbox.
7. Click Test to confirm connection to the specified server.
8. Add further servers as required.
To delete a server from the list, click Remove to the right of the server details. To modify
details of an existing server, edit the details in the Servers list.

OpenText integration
In order to use Workshare with an OpenText DMS, you must add the necessary
Workshare file types and identify Workshare Compare and Workshare Compare for
PowerPoint as applications in the DMS server so that the DMS can recognize and work
with Workshare files. Additionally, the Workshare Compare, Workshare Compare for
PowerPoint and the Microsoft Word applications must be made ‘compatible’ with the
OpenText DMS.
Note: The OpenText server integration procedures only need to be performed once per
OpenText server. The procedures can be performed from the server or client machine.

Adding application and file types to the server
This step includes adding the required file types used by Workshare - the Workshare
Compare WDF file type, the Workshare Compare for PowerPoint WCFP file type and the
Combine in Workshare WWB file type as well as specifying the location of the Workshare
comparison executable files. The procedure described below is performed from a DM5
client machine.
To add application and file types to the server:
1. Open Library Maintenance.
2. Click Applications and then click New. The Application Maintenance dialog is
displayed.

Integration

3. Complete the fields as shown below:

Note: For PDF Combine, enter application/dcwin as the MIME Type.
Note: To add the file type, click the browse button and click Add in the dialog
displayed. Enter WDF, WCFP or WWB in the Extension field and Workshare
Deltafile, PowerPoint Comparisons or Workshare Combine in the Description
field and click OK and then OK again.
4. Click OK. The specified application now appears in the list of applications.
5. Double-click the new DeltaView entry to display the Application Maintenance
dialog again.
6. Click the Launch Methods button.
7. Click the New button. The Application Launch Methods dialog is displayed.
8. In the Location field, enter the location of the Workshare Compare executable file.
By default, this is C:\Program Files\Workshare\Modules\DeltaVw.exe.

Integration

9. In the Command Line Parameters field, %FULLPATH /PathEncode=
powerDOCS.
Note: Do not forget to enter a space between FULLPATH and the forward slash.
10. From the Integration dropdown list, select ODMA Compliant.
11. Ensure the Enabled checkbox (top right) is selected.

12. Click OK, then Close and then OK.
13. Repeat steps 5-12 for the PPT Compare application and the Combine File entry.

Integration

Making Workshare compatible with OpenText eDOCS DM
In order for files created in Workshare to be retrieved from OpenText eDOCS DM,
Microsoft Word and Workshare Compare must be made "compatible applications" with the
OpenText eDOCS DM.
To make Microsoft Word a compatible application:
1. In the Library Maintenance window, double-click DeltaView.
2. Click Compatible Apps. The Compatible Applications dialog is displayed.
3. From the Non-Compatible Apps. list, select MS Word and click Add. Microsoft
Word is added to the Compatible Apps. list.

4. Click OK, and then OK again.
To make Workshare Compare a compatible application:
1. In the Library Maintenance window, double-click MS Word.
2. Click Compatible Apps. The Compatible Applications dialog is displayed.
3. From the Non-Compatible Apps. list, select DeltaView and click Add. Workshare
Compare is added to the Compatible Apps. list.
4. Click OK, and then OK again.

Integration

Making the Workshare comparison icons appear on the desktop and
within a user profile
This section describes how to place the Workshare Compare and Workshare Compare for
PowerPoint icons on the OpenText eDOCS DM desktop as well as within a user profile.
To add the Workshare comparison icons:
1. In the Library Maintenance window, double-click DeltaView.
2. Click Options. The Application Options dialog is displayed.

3. Select the Shows on Desktop and Valid on Profile checkboxes.
4. Click OK.
5. Repeat steps 1-4 for PPT Compare.
6. Click Close.

Worldox integration – configuring compare files
After installing Workshare, you can configure the Worldox Compare Files option (available
in the Worldox toolbar and the right-click menu) so that it works with Workshare.
To configure Compare Files in Worldox:
1. In Worldox, click Compare Files (in the toolbar or via the right-click menu).
2. Click Properties to the right of the Compare using field.

Integration

3. Click Add.

4. In the Compare Program Description field, enter a description such as
“Workshare Compare”.
5. Click Browse and browse to the Modules folder in the Workshare installation
folder.
6. Select Workshare.Worldox.Connector.exe and click OK.
7. In the Pass Parameters field, enter /original=%o /modified=%n.
8. Click OK.
9. Click Close.
Now you can run a comparison using Workshare Compare.

Once you have completed this configuration, right-clicking a file in Worldox or selecting a
file and clicking Compare Files, will display the above dialog with Workshare Compare
selected as the application to use for the comparison.

Integration

NetDocuments integration
In order to maximize the integration of Workshare in NetDocuments, you should add
Workshare as an application to your NetDocuments cabinets. Workshare will then be
available when using the NetDocuments Send to application functionality.
To add Workshare as an application:
1. Click your user name and select Admin in the top right of the NetDocuments
window.

2. From the Cabinets list, click the cabinet you want to add Workshare to.
3. Click Integrate external applications at the top of the page.

Integration

4. A list of available published applications is displayed and you can select the app
you want to be available in the Send to Application dialog.

5. Make sure Workshare Compare and Workshare PDF are selected in the Web
Applications section and that Workshare (Compare) is deselected in the Local
Applications section.
Note: Deselecting Workshare (Compare) is the Local Applications section
ensures there is not an additional unnecessary “Workshare” entry in the Send to
Application dialog.
6. Scroll down and click Save.
7. Scroll to the bottom of the cabinet page and click Submit.

Integration

Now when a user selects the Send to application option in NetDocuments, Workshare
Compare and Workshare PDF are listed as available applications.

SharePoint integration - server installation
In order to use Workshare with SharePoint, the Workshare Extension for SharePoint must
be installed on Microsoft Windows Server 2008 (or later) running Microsoft Windows
SharePoint Services 3.0 (or later).
Before beginning the installation procedure, make sure that all other programs are closed
and disable any anti-virus software.

Integration

To install Workshare Extension for SharePoint:
1. Locate the installation package Workshare.Connect.SharePoint.WebService
.x64/x86.msi and double-click to start the installation wizard. The installation
welcome screen is displayed.

2. Click Next.

Integration

3. Click Browse and locate your SharePoint ISS Virtual Directory.

4. Select the SharePoint virtual directory where Workshare Professional Extension for
SharePoint will be installed.

5. Locate the bin folder in your selected virtual directory and click OK.

Integration

6. Click Next.

7. Select the SharePoint ISAPI directory where the Workshare Extension for
SharePoint web services will be installed. By default, this is located at: C:\Program
Files\Common Files\Microsoft Shared\web server extensions\15\ISAPI\.

Integration

8. Click Next.

9. Click Next to begin installation or click Back button to change any installation
settings.
10. Once the installation has completed, click Finish.
Note: The installation will restart your IIS.

SharePoint integration - client configuration
The SharePoint Integration for Workshare is provided as part of the Workshare installation
package and requires a small amount of configuration on the client to specify SharePoint
sites and servers that will be accessed from Workshare.

SharePoint site configuration
When comparing documents, users can select documents from a SharePoint site. The
sites available for selection have to be configured in the Workshare Configuration
Manager.

Integration

To configure SharePoint sites:
1. In Administrator Mode of the Workshare Configuration Manager, select the
Integrations > Microsoft SharePoint category.
2. Click Add. An entry is added to the list of SharePoint sites in the Servers section.

3. In the text box, enter the complete URL for the SharePoint site location.
4. From the Metadata Cleaning Policy dropdown list, select how the site is to be
considered for policy application purposes. If you select Internal Cleaning Policy,
documents at the specified SharePoint site will be treated similarly to documents
emailed internally. If you select External Cleaning Policy, documents at the
specified SharePoint site will be treated similarly to documents emailed externally.
5. Click Test to confirm connection to the specified site.
To delete a site from the list, click Remove to the right of the site details. To modify details
of an existing site, edit the details in the Servers list.

Email Systems Integration
Workshare uses the mail server address book to determine if recipients are internal or
external, and applies particular settings as a result. Therefore, if you want to use
Workshare to protect your documents while working offline, you need to ensure your
machine is set up to enable recipients to be resolved correctly.
If a copy of your mail server address book is not available locally, all recipients are treated
as external. The following sections describe how to create a local copy of your mail server
address book in different email clients.

Setting up Microsoft Outlook
For Workshare to work correctly with Microsoft Outlook in offline mode, you simply need to
enable offline mode (as specified in the Microsoft Outlook documentation), and ensure that
you download the server address book.
To download the server address book:
1. From the Tools menu, select Send/Receive and then Download Address Book.
2. Select to download the address book.
3. Select to download full details.
4. Ensure the correct server address book is selected.

Integration

Setting Up IBM Notes
Resolving Email Addresses as Internal - Creating the Internal Domain
List
Workshare categorizes the routing of email messages as either Internal or External to
determine which policies to apply. Internal addresses are identified based on the
recipient’s domain. For Workshare to recognize the domain as internal, the internal domain
list need to be populated with the value of the recipient’s domain as it appears on the
person's detail page in the Domino directory.

To set the internal domains:
The Internal Domain List can be set in the Workshare Configuration Manager (Protection
> Administration category). If more than one domain is required then the values should
be separated with a semicolon (;), for example, "Domain 1;Domain 2". The value is not
case sensitive.

Offline Mode
For Workshare to work correctly with Notes in offline mode, you need to set up the client to
work offline (as specified in the Notes documentation), and set up the Mobile Directory
Catalog on the Domino server. You must then replicate the Mobile Directory Catalog on
the Notes client.

Integration

Setting Up the Mobile Directory Catalog on the Domino Server
This step involves creating the database (Mobile Directory Catalog), configuring the
database and then loading the database.
To create the Mobile Directory Catalog:
1. From the File menu, select Database and then New.
2. Next to Server, select the Dircat server you picked to aggregate the directory
catalog.
3. Next to Title, enter a title for the directory catalog (Mobile Directory Catalog).
4. Next to Filename, enter a file name for the catalog (‘MobileDC.nsf’).
5. Select Create full text index for searching.
6. Change ‘Template Server…’ to Domino server.
7. Select Show advanced templates.
8. Below Template server, select a server that stores the Directory Catalog template,
and then click OK.
9. Select the Directory Catalog (DIRCAT5.NTF) template.
10. Click OK.

To configure the Mobile Directory Catalog:
1. In the database you created (Mobile Directory Catalog), select Create and then
Configuration.
2. Complete the following fields in the Directory Catalog Configuration document:
 Change Directories to include to include the Domino Directories the Dircat task
aggregates (Names.nsf).
 Change Additional fields to include to include MailSystem.
3. Click Save and Close.

To load the Mobile Directory Catalog:
• From the Domino Server Administrator run the command Load Dircat database to

build the condensed Directory Catalog (Load DirCat MobileDC.nsf).

Integration

Replicating the Mobile Directory Catalog on the Notes Client
This step involves replicating the Mobile Directory Catalog on the Notes client and setting
up the client to use the Mobile Directory Catalog for name resolution.
To replicate the Mobile Directory Catalog:
1. From the File menu, select Database and then Open.
2. In the Open Database dialog, change the Server to the Domino server and the
Database to Mobile Directory Catalog and click Open.
3. While the Mobile Directory Catalog database is open, from the File menu, select
Replication and then New Replica.
4. Verify that the server is Local and the file name and title is for the Mobile Directory
Catalog (MobileDC.nsf) and click OK.
To set up the client to use the Mobile Directory Catalog for name resolution:
1. From the File menu, select Preferences and then User Preferences.
2. Select Mail and News.
3. Modify the Local Address Books and add the Mobile Directory Catalog to the
existing list (names.nsf, MobileDC.nsf).
4. Click OK.
Note: This step can only be completed if the Mobile Directory Catalog exists. See Setting
Up the Mobile Directory Catalog on the Domino Server, page 75.

Issues with Custom Forms (Recipient Fields)
If you work with custom forms and you modify recipients, you should be aware of which
address fields Workshare uses to resolve recipients as internal or external.
In order to determine the internal/external classification of a destination, only the following
fields relating to recipients are extracted from the form by the EM_MAILSENDNOTE event:
•

EnterSendTo

•

EnterCopyTo

•

EnterBlindCopyTo

If you use custom forms, you should note that the fields Recipients, SendTo, CopyTo
and BlindCopyTo are not resolved.

Network Deployment

Chapter 6:

Network Deployment

This chapter describes how to install and license Workshare across your network. It
includes the following sections:
•

Overview, page 78, introduces the options available for installing Workshare
across a network.

•

Deploying via the Command Line, page 80, describes the steps required to use
the command line to install and license Workshare across your network.

•

Citrix Installation Guidelines, page 92, describes how to install Workshare on
Citrix.

•

Active Directory Deployment Guidelines, page 94, describes how to deploy
Workshare using Active Directory.

Network Deployment

Overview
Deploying Workshare across your network means installing your Workshare products on
all workstations in your network. Workshare can be deployed across your network using
the Workshare command line installation or third party deployment products.
If you want to deploy specific configuration settings with Workshare, you must use a REG
file or an ADM template. Refer to Chapter 3: Configuration. It is recommended to deploy
the configuration settings prior to the Workshare installation.
If you are licensing using the user authenticated method, there is no need to include a
license file in the deployment. Users are prompted to log in to Workshare in order to
retrieve their license entitlements. They will be prompted in either of the following ways:
•

When file share & sync is included in the installation, the Workshare desktop app is
launched after install and users are prompted to log in;
or

•

The first time users’ access Workshare functionality, they are prompted to log in to
Workshare if they have not already done so.

If you are licensing using the enterprise method, you will need to obtain a Registry file from
Workshare Customer Support and you must deploy this to license your users. This
Registry file can be included in your deployment script.
The executables download prerequisites from the Internet if they are required. For
enterprise deployments, the prerequisites can be extracted from the executables using the
/layout command. Refer to Windows installer packages.

Installation file summary
The installation requires the following prerequisites:
Prerequisite

Version

Microsoft .NET
Framework 4.5.2

4.5.51209.342
09

Windows 7, NA
Windows
Server 2012
R2

Microsoft Visual
C++ 2015
Redistributable
Package (x86)

14.0.24215

All
(including
x64
versions)

Microsoft Visual
C++ 2015
Redistributable
Package (x64)

14.0.24215

x64 OS
versions

Office

Notes

The right-click handler is
written in x64 code and
requires this
prerequisite.

Network Deployment

Prerequisite

Version

Office

Notes

Microsoft Visual
Studio 2010 Tools
for Office Runtime
Setup

10.0.60724.0

All

Visual Studio is NOT
required.

Contents Extracted

Workshare.Professional.Bundle.
exe

Workshare.Compare.Bundle.exe

Workshare.Protect.Bundle.exe

WorkshareProtect.msi
Workshare.Desktop.msi
Redist folder including the prerequisite
executables (NDP452-KB2901907-x86-x64AllOS-ENU.exe, vc_redist_x64.exe,
vc_redist_x86.exe, vstor_redist.exe)

Workshare.Professional.Bundle.
X64.exe

Network Deployment

Executable

Contents Extracted

Workshare.Compare.Bundle.X64
.exe

Workshare.Protect.Bundle.X64.
exe

WorkshareProtect.X64.msi
Workshare.Desktop.msi
Redist folder including the prerequisite
executables (NDP452-KB2901907-x86-x64AllOS-ENU.exe, vc_redist_x64.exe,
vc_redist_x86.exe, vstor_redist.exe)

All Workshare products are installed on a per machine basis.

Deploying via the Command Line
You can use the executable file or the MSI files found within the executable file to install
Workshare from the command line.

Configuring modules during installation
In a Workshare Professional installation, the Compare (file comparison), Protect (file &
metadata security) and Connect (file share & sync) modules are installed by default and
additionally, Microsoft Office integration is installed by default. During the command line
install, you can customize the module selection by setting Registry values.
In a Workshare Compare installation, the Compare module is hard-coded into the
installation and Microsoft Office integration is installed by default. During the command line
install, you can customize the Connect, Office and DMS integration selection by setting
Registry values. You cannot customize the Compare module.
In a Workshare Protect installation, the Protect module is hard-coded into the installation
and the Connect, Office and DMS integrations are installed by default. During the
command line install, you can customize the Connect and Office integration selection by
setting Registry values. You cannot customize the Protect module selection.

Network Deployment

Registry
The Registry location HKEY_LOCAL_MACHINE\SOFTWARE\Workshare\Install contains
DWORD values which can define the module state.
Module

Registry Value

DWORD
Value

Available in

iManage

ProfInterwovenModule