Xerox ConnectKey for SharePoint Installation Guide

Version 1.3 March 2015 702P03534

Xerox

ConnectKey®

for SharePoint®

Installation Guide

Microsoft® and Microsoft SharePoint® are registered trademarks of Microsoft Corporation.

All trademarks used herein are the property of their respective owners.

Contents

1 Xerox® ConnectKey™ for SharePoint® Installation Prerequisites ......... 1-1

Glossary of Terms ................................................................................................................................................ 1-1

Installation Prerequisites .................................................................................................................................. 1-1

Hardware ..................................................................................................................................................... 1-1

Software ....................................................................................................................................................... 1-2

Loading the .Net Framework Language Pack ............................................................................ 1-2

Network Requirements .......................................................................................................................... 1-2

SharePoint Requirements .................................................................................................................... 1-3

Supported multifunction printers ..................................................................................................... 1-3

Other Considerations ............................................................................................................................. 1-3

Port Requirements ................................................................................................................................... 1-4

Where to Obtain the Software and Documentation .............................................................. 1-5

2 Installing Xerox® ConnectKey™ for SharePoint® ........................................ 2-1

Running ConnectKey Process Designer for the First Time ................................................... 2-8

3 Upgrading ................................................................................................................ 3-1

Before you begin ...................................................................................................................................... 3-1

Removal of previous software ........................................................................................................... 3-1

Installation of ConnectKey for SharePoint software .............................................................. 3-2

Reinstalling ConnectKey Web Services.......................................................................................... 3-2

Licensing ..................................................................................................................................................... 3-2

Loading your existingConfiguration Files .................................................................................... 3-2

4 Licensing .................................................................................................................... 4-1

Upgrading from a Trial License to a Production License ...................................................... 4-1

Completing the licensing process .................................................................................................... 4-2

5 Installing ConnectKey Web Service for SharePoint .................................. 5-1

Connection methods that do not require ConnectKey Web Services ............................. 5-1

Connection methods that require ConnectKey Web Services ............................................ 5-2

Prerequisites ........................................................................................................................................................... 5-3

Installation Steps ................................................................................................................................................. 5-3

6 Next Steps: Deploying ConnectKey for SharePoint .................................. 6-1

Steps to a Successful Deployment ............................................................................................................... 6-1

7 Basic Troubleshooting .......................................................................................... 7-1

Software will not download ............................................................................................................................ 7-1

Software installation will not complete ..................................................................................................... 7-1

Licensing ................................................................................................................................................................... 7-2

Where to go for help ........................................................................................................................................... 7-2

Xerox ConnectKey for SharePoint iii

Installation Guide

Contents

iv Xerox ConnectKey for SharePoint Installation Guide

1 Xerox® ConnectKey™

for SharePoint

Installation

Prerequisites

Glossary of Terms

Term/Abbreviation

AutoStore (AS)

User

Server

Impersonation

MFP (Multifunction Printer)

ConnectKey for SharePoint is powered by AutoStore™ imaging technology from Notable Solutions, Inc.

Refers to the administrative user who will run the installation and license the server.

Refers to the Windows Operating System Based computer that ConnectKey for SharePoint is installed on. It does not necessarily refer to a server class computer.

Refers to the process of storing documents in SharePoint with the user name of the scanning user stored in the “modified by” column.

Any references to devices, multifunction devices, MFDs, printers, and MFPs should all be treated synonymously.

Description

Installation Prerequisites

Hardware

• A Windows operating system computer with at least 2 GHz Processor is recommended

• Minimum 2 GB of RAM (4 GB or greater recommended)

• Minimum of 10 GB of (free and available) hard disk space

• Network Interface Card

Xerox ConnectKey for SharePoint 1-1

Installation Guide

Xerox ConnectKey for SharePoint Installation Prerequisites

Software

The following Windows Operating Systems are supported:

• Windows 2008 Standard/Enterprise (32 bit only) – with the latest service pack

• Windows 2008 Standard/Enterprise R2 SP1 (64 bit)

• Windows 2012 Foundation/Essentials/Standard/Datacenter

• Windows 7 (32 bit)

• Windows 7 (64 bit)

• Windows 7 Professional (32 bit / 64 bit) SP1

• Windows 8 (32 bit)

• Windows 8 (64 bit)

• Windows 2003 (32 bit only) Standard\Enterprise – with the latest service pack

• Windows 2003 R2 (64 bit) Standard\Enterprise – with the latest service pack

Microsoft.Net Framework 3.51 SP1 and 4.0 are required.

To obtain .Net Framework 3.5.1 and 4.0 for Windows 7 Operating Systems please go to

http://www.microsoft.com, click on Downloads, then click on Download Center, and search for .Net

Framework 3.5.1., and .Net Framework 4.0. Download each of the packages, follow the installation instructions provided.

Loading the .Net Framework Language Pack

The ConnectKey Process Designer will present the user with various system messages, including Microsoft .Net Errors. In order for system messages to appear in the correct language, the user will need to load the respective .Net Framework Language Pack.

For more information, please refer to the following site: http://www.microsoft.com/en-

us/download/details.aspx?id=23067.

Note

The .Net Framework Language Pack is required regardless of the native language of the Operating System.

Network Requirements

• Communication between all multifunction printers and the ConnectKey for SharePoint server should be validated in advance of the software installation with a ping test.

• A Microsoft Windows Network is required.

• Internet connectivity is required to download, update, and license your software.

 If your ConnectKey for SharePoint server does not have internet access please contact Xerox

Support for alternatives.

• Customer will be responsible to create domain service account (username and password) with local administration rights to be used to run the ConnectKey for SharePoint service on the ConnectKey for SharePoint server, with read/write access to any network drives and/or SharePoint 2007/2010/2013 destination locations that may be used for file output, and LDAP (Active Directory) query permissions.

1-2 Xerox ConnectKey for SharePoint Installation Guide

Xerox ConnectKey for SharePoint Installation Prerequisites

• For non-domain accounts where files will be routed locally to the ConnectKey for SharePoint server, it is possible to use a local account. However, a domain account with read privileges is required to query the AD server when Authentication is used.

• ConnectKey for SharePoint is not supported in a Windows Distributed File System (DFS) environment.

• Windows Domains: Users, ConnectKey Server, MFDs, SharePoint servers, and network shares must all reside within the same domain for the following features to be supported:

 Folder browsing  SharePoint browsing  Impersonation  Routing to My Sites  Enforcement of user permissions for scanning to folders  Scanning to network resources (folders or SharePoint Servers)

SharePoint Requirements

• For the most robust functionality, it is strongly recommended that the ConnectKey Web Services extension be installed on the production SharePoint Server. This provides the most features when routing to SharePoint 2007 and SharePoint 2010. Please refer to the “Installing ConnectKey Web Service for SharePoint” section below for more details.

 These options are also referred to as SharePoint 2007 (ConnectKey Web Services) and

SharePoint 2010 (ConnectKey Web Services).

• It is possible to integrate with SharePoint 2010 and SharePoint 2013 without installing the ConnectKey Web Services on your SharePoint server. This configuration adds limitations when scanning to SharePoint 2010 and SharePoint 2013. Please refer to the “Installing ConnectKey Web Service for SharePoint” section below for more details on the limitations.

 This option is also referred to as SharePoint 2010 (Microsoft Web Services) and SharePoint

2013 (Microsoft Web Services).

Please refer to the “Installing ConnectKey Web Services for SharePoint” section below for more information on the SharePoint connectors as well as requirements and limitations for each connector.

Supported multifunction printers

All multifunction printers must be Xerox EIP Capable printers. For exact models, please refer to the Compatible Products list found at:

http://www.xerox.com/connectkeysharepoint

Other Considerations

• Antivirus software and firewalls must be configured not to auto-scan files on access or to block communication between the ConnectKey for SharePoint computer and the multifunction printers, SharePoint, network folders, active directory, LDAP, or email server. If antivirus software or firewalls are interfering with Xerox ConnectKey for SharePoint software and cannot be configured for compatibility with ConnectKey for SharePoint, they must be disabled.

Xerox ConnectKey for SharePoint 1-3

Installation Guide

Xerox ConnectKey for SharePoint Installation Prerequisites

• As a best practice, it is recommended that whenever possible, MS Windows service packs and updates should be applied after compatibility with ConnectKey for SharePoint has been confirmed.

• Xerox ConnectKey for SharePoint cannot be installed on a server that has an installation of AutoStore or Smart Document Travel.

Deployment Architecture

Port Requirements

The following ports are identified for use in the Xerox ConnectKey for SharePoint solution. These ports are required to be open and available for the effective operation of the software solution. Even though it is possible to modify some of the services to operate on different ports, please consider these ports as necessary for any proposed deployments of the Xerox ConnectKey for SharePoint solution delivery.

Type

TCP 3241* HTTP/HTTPS Communication between multifunction printers and

FTP 3280* FTP Communication between multifunction printers and

TCP 80 SharePoint Default Port Communication between ConnectKey for SharePoint

TCP 25* SMTP Mail Relay Communication between ConnectKey for SharePoint

TCP 389 LDAP Query Port Communication between ConnectKey for SharePoint

Port Communication Type

Description

ConnectKey for SharePoint Server

Server and SharePoint

Server and SMTP Server

Server and LDAP Server

* Configurable

1-4 Xerox ConnectKey for SharePoint Installation Guide

Xerox ConnectKey for SharePoint Installation Prerequisites

Where to Obtain the Software and Documentation

Preparing to install Xerox ConnectKey for SharePoint begins by obtaining the software and associated documentation.

If you haven’t already downloaded the software, please navigate to the following address to download the software:

http://www.xerox.com/connectkeysharepointlicense

1. If you don’t already have an account, select the “New User? Create Account” link to Register.

2. After your account has been created, you will receive an email from

Xerox.ConnectKey@nsius.com

required to enter your email and password, and then click on “Login”.

3. After registering, select Product Download.

4. On the Downloads page, select the Xerox ConnectKey for SharePoint product and save the installation file.

5. In addition to downloading the software, download the following documentation:

• Xerox ConnectKey for SharePoint Administrator Guide

• Xerox ConnectKey for SharePoint Quick Start User Guide

. Please open the email and click on the activation link. You will be

Xerox ConnectKey for SharePoint 1-5

Installation Guide

2 Installing Xerox®

ConnectKey™ for

SharePoint

1. Locate the software installation file and run it. Right-click and choose Run as administrator if

you are installing on Windows 2008, Windows 2012, Windows 7, or Windows 8.

Note

A restart may be required during or after the process.

If prompted to allow the program to make changes to the computer, click Yes.

Xerox ConnectKey for SharePoint 2-1

Installation Guide

+ 25 hidden pages