sharepoint connector for ecopy sharescan, installation ...€¦  · web viewcloud pack connector...

55
Cloud Pack Connector for eCopy ShareScan ® Installation & Administration Guide http://www.paper-river.com

Upload: others

Post on 18-Jun-2020

33 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

Cloud Pack Connector for eCopy™ ShareScan®

Installation & Administration Guide

This software is designed, written and maintained by Paper River Consulting Ltd.By installing this software you accept that it is provided AS IS and the Author of the software makes NO WARRANTY or representation either express or implied with respect to any software its quality accuracy or fitness for a particular purpose.eCopy, the eCopy Logo and ShareScan are all trademarks of eCopy inc.Cloud Pack Connector ©2014 Paper River Consulting Ltd.All other terms and products are trademarks or registered trademarks of their respective owners and are hereby acknowledged.

http://www.paper-river.com

Page 2: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

Table of Contents1 Introduction 3

2 Supported Versions 4

Cloud Services 4

3 Pre-install checklist 5

4 Installation Procedure 6

5 Upgrade and Removal Procedure 13

6 Connector Licensing 14

7 Configuration 19

7.1 Configure tab 19

7.2 Token Settings tab 21

7.3 Email Server tab 23

7.4 Email Tokens tab 24

7.4.1 Changing the email content 25

7.5 PinCode Settings tab 26

7.6 Google Drive Options tab 28

7.7 OneDrive for Business tab 29

7.7a Working with OneDrive for Business Certificates 31

7.8 Favourites tab 35

7.9 Document / Scanning Settings 36

7.10 Saving and Using a Profile 37

8 Demonstration Mode 38

8.1 Using Demonstration Mode 40

Page 2 of 44

Page 3: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

1 Introduction

The Cloud Pack Connector for eCopy ShareScan allows documents to be scanned directly from a multifunction or dedicated scanner into a number of Cloud storage systems using the eCopy ShareScan 5 frontend.

By using this connector a user can authenticate with their existing Dropbox, Google Drive, Box, OneDrive or OneDrive for Business account, browse the folder structure and finally scan their document directly into the selected folder.The connector also allows a user to create a folder in OneDrive for Business directly from the MFD.OneDrive For Business and Box both support SSO and OAuth authentication

Page 3 of 44

Page 4: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

2 Supported VersionsCloud Services

Google Drive OneDrive Dropbox OneDrive for Business Box

ShareScan Version 5.4 and above

Page 4 of 44

Page 5: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

3 Pre-install checklist1 Please ensure that eCopy has been installed, licensed and configured correctly before

installing this connector.

2 Please install and configure the connector on the same computer as the ShareScan manager.

3 Microsoft .Net 3.5 and 4.5.1 must be installed on the ShareScan Manager Server.

4 The Cloud service being used must be reachable over the network from the ShareScan Manager Server.

5 For full functionality, the accompanying Cloud Pack token website or the Paper River Cloud hosted token website must be accessible from the ShareScan Manager Server.Note: OneDrive for Business and Box do not require a token or the token website when using the SSO logon methods

6 The service that the ShareScan Manager Service runs as must have write permissions to the folder where the cloud pack tokens will be stored.

7 Please ensure that the OneDrive for Business account in question has been setup and configured correctly. This is done automatically the first time you access the account online.

Page 5 of 44

Page 6: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

4 Installation ProcedureYou will need to install the connector onto the same machine as the eCopy ShareScan Manager.

1.) Run the installer EXE, and select how you want the connector configured:

Company Hosted Token Server:o Select this option if you have installed the accompanying Cloud Pack

token website locally within your organisationo Enter the URL for the website in the "Token Server URL" textbox. o Upon clicking “Install” the connection to the website will be tested,

alerting you if the connector was unable to connect.

Paper River Cloud Hosted Token Servero Select this option if you have registered to use the Paper River Cloud

Token website to host your user tokens.o Enter the Company ID you were assigned and the Company Password

you entered during registration.o Upon clicking “Install” the credentials entered will be tested against

the Paper River Cloud Hosted website.

Page 6 of 44

Page 7: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

Trial:o Select this option if you have registered for a trial using the Paper

River Cloud Token website.o Enter the Pin Code you used when registering for your trialo Upon clicking “Install” the connection to the website and pin code will

be tested, alerting you if the connector was unable to connect or could not find your Pin Code.

Page 7 of 44

Page 8: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

Configure Later:o Select this option if you want to use the connector in offline demo

mode and/or plan to configure the server settings later.

Finally click “Install”. This will result in a progress bar being displayed.

Page 8 of 44

Page 9: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

2.) In the new window that appears, select “Next” to proceed.

3.) On the following screen, please choose an install location or use the default one before selecting “Next”.

Page 9 of 44

Page 10: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

4.) Next, you must select a language for the connector administration panel controls. By clicking on the downwards facing arrow you may view the language options available. Having selected a language, click “Next”.

5.) Finally, you must confirm the installation by clicking “Install”. This will result in a progress bar being displayed.

Page 10 of 44

Page 11: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

6.) The Cloud Pack Connector for eCopy ShareScan will now be installed. Once the installation process has completed, an Installation Complete dialog will be displayed, which you can then close. This will return you to the previous window, which can also now be closed.

Page 11 of 44

Page 12: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.) Run the eCopy ShareScan Administration Console, and select the Connectors Configuration Screen. If the connector, entitled “Scan to Cloud Pack” does not appear in the left hand column, right click on the list of connectors, and select “Refresh Connectors”.

Page 12 of 44

Page 13: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

5 Upgrade and Removal ProcedureTo upgrade from a previous version of this connector or to remove it completely we advise the following procedure:

Use “Add or Remove Programs” in control panel to remove the Cloud Pack Connector. Alternatively, re-run the installation EXE file and choose “Uninstall”.

If upgrading to a new version of the connector, run the new installer after the computer has been rebooted.

Page 13 of 44

Page 14: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

6 Connector LicensingAfter running the installer, the connector needs to be licensed with Paper River Consulting. To do this, run the eCopy ShareScan Administration Console. Select the “Scan to Cloud Pack” connector. The last tab will be titled “License”, go to this tab.

When the connector has just been installed, and no license has been applied, the connector runs in Demo mode where calls to the cloud service are replaced with lookups to an xml file (See “Demonstration Mode” later in this document for more on this). When the connector is running in Demo mode, both “Allowed Devices” and “Expiry Date” will display the word “Demo”.

To activate the license, click the Activate License button. You will be presented with the License Activation screen. You have three options from this screen:

1. Fill in the required information, and activate online2. Fill in the required information, and activate by email (For servers without Internet

access)3. Use an activation file received by email to activate your license.

Page 14 of 44

Page 15: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

For Online and Email Activation, all fields must be populated, with the exception of P.O. Number if requesting a trial license. You will be unable to continue until all fields have been completed.

Trial Licenses are for 45 days. If you have previously requested a trial license for the current installation, you will be unable to request another one.

After clicking the Online Activation button, the connector will attempt to connect to our Licensing Server.

Page 15 of 44

Page 16: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

Once the license has been successfully activated, a close button will appear.

If it is unable to connect, an error message will be displayed, and along with the Close button, a button ‘Email Activation’ will also appear. You can use this button to be taken to the email activation screen where it instructs you how to email the license request to us.

After clicking ‘Email Activation’, either from the first screen, or if an online activation has failed, you will be taken to a screen with instructions to email the license request.

Page 16 of 44

Page 17: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

You will need to compose an email to the email address specified. Clicking on the “Generate License Request File” button will ask you where you want to save the license request file. Save it, and then attach this file to your email.

Once sent, the license activation file will be emailed back to you.

To use a license activation file, click on the “Apply Activation File” button. This will prompt you for the location of the activation file sent back to you by email. Select the correct file, and it will be applied.

Page 17 of 44

Page 18: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

Back on the main License tab, “Allowed Devices” shows how many devices are allowed by the license to be running with the connector enabled at any one time. “Expiry Date” will show the expiry date of a trial license. For a permanent license, it will say “Never”.

“Currently Licensed Devices” shows the current devices that are running the Cloud Pack connector that are licensed. To remove the license allocation for a particular device, select it from the list and click Remove. This will allow the license slot to be taken up by another device.

Licensing is done on a ‘first come, first served’ basis, per actual device, as they connect to the service manager. I.e. if you have 10 devices that are setup with the Cloud Pack connector to be served by a single licensed service manager, but only have a 9 device license, then the first 9 to use the connector will take up the license allocation. You can have as many Cloud Pack connector profiles as you wish.

Opening the Licensing Tab after devices have used the connector will refresh which devices are currently licensed.

Page 18 of 44

Page 19: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7 Configuration7.1 Configure tab

All basic administration can be done from the ‘Configure’ tab.

From this tab you can select the Cloud Service you want the connector to connect to and test the connection.

You can test that the connector can connect to the selected Cloud Service by entering a username, password and domain (optional) in the relevant text boxes provided, before clicking the “Test” button. The connector will then attempt to connect to the Cloud Service, indicating whether it was successful or not. If it was unsuccessful, a message box will display the error reported.

Please note, if you get an error message that says “Error connecting to GoogleDrive: No Token Found” or similar, this indicates that you can proceed to the next step in the documentation and begin filling in the token settings. After that is complete, you may retest the login details.

Page 19 of 44

Page 20: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

Logon modeThis can be set to either “Runtime” or “Default Logon”.

When set to runtime, upon entering the connector, it will first attempt to logon with any ShareScan Session Credentials. If there are none, or that fails, the connector will then display a logon screen for the user to enter their credentials manually.When set to Default Logon, on entering the connector, the credentials set in the username/password/domain textboxes in the administration console are used. If these fail, the logon screen is displayed to the user.This allows a generic scanning account to be set for all users to use whilst scanning.

Logon TypeThis can be set to Windows, which authenticates the user against the current Windows environment, or to Pin Code which allows the user to logon with a predefined Pin Code set in the Pin Code settings tab.

If the “Both” option is selected - the connector will first attempt to login using a Pin Code. Assuming this fails, the connector will then try using Windows authentication. This option allows different users to use both authentication methods in the same connector.

Note: For OneDrive for Business (When not using OAuth) the “Domain” textbox is changed to “Default Domain”.If the Default Domain value is set, then if the user attempts to logon with just a username (i.e. without the domain component), the connector will automatically add on this value.

Other OptionsWhen “Sort Folders Alphabetically” is checked, all folders will be displayed in name order on the destination screen in the connector

Note: The tabs shown may vary based upon the cloud service selected. Note: Any tabs relating to Tokens will not be shown if using SSO with Box or username/password authentication with OneDrive for Business

Page 20 of 44

Page 21: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.2 Token Settings tab

The Token Settings tab allows for the configuration of various Token based settings including where tokens are picked up from, where they are locally stored, and how the connector handles users who do not have a token.

If this is the first time that the Cloud Pack has been installed on the ShareScan server, the installer should have pre-populated the Token Server settings with the values entered during installation (assuming the “Configure Later” option was not selected).

The Token Storage Folder is the location where user tokens are stored in encrypted xml format, as downloaded from the token website or after splitting a token pack.

The Token Pack Folder is the location where the connector can find a downloaded token pack. This is an encrypted XML file downloaded from the token website containing multiple user tokens. Upon running the connector this pack will be split into individual tokens in the token storage folder.

If you have installed the accompanying Cloud Pack token website locally within your organisation, select “Use Local Token Server” and enter the URL for the website. Click “Test” to check the connector can contact the token website.

Page 21 of 44

Page 22: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

If you are using a trial or have registered with the Paper River Cloud Hosted Token website, select “Use Hosted Token Server”. Enter the Company Id you were assigned and the Company Password you set during registration. If using a trial, enter “trial” as the Company Id and the Pin Code you set as the Company Password. Click “Test” to check these settings.

If no token is stored, the connector can attempt to contact the token website to automatically download a token for the user.In order to enable this functionality, please ensure the option to “Automatically download tokens from site” is ticked/enabled.

If still no token is found for the user, the connector can be configured to do one or both of the following:

Email Username at Domain – If enabled, causes the connector to automatically send an email to an address beginning with the username specified. This email will contain instructions and a link the user can then follow in order to acquire a token.

Direct User to Website – If enabled, causes the connector to display a link to the token website upon failure to login. The user can then follow this link in order to acquire a token.

Please note, the ShareScan Manager Service must run under an account that has write permissions to the Token Storage and Token Pack folders. Otherwise you will get the same error as explained in the previous note under the Configure section.

Page 22 of 44

Page 23: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.3 Email Server tab

The Email Sever tab allows for the configuration of an SMTP server, to be used to email users with details about getting tokens for use with the Cloud Pack connector.

These email settings will also be used if you send an email from the Email Tokens tab.

Page 23 of 44

Page 24: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.4 Email Tokens tab

The Email Tokens tab is used for creating a list of email addresses to send a link to, allowing users to create a token and Pin Code themselves, thereby enabling access to the Cloud Pack.

Email addresses can be added to the list by entering the email address into the text box and clicking “Add”. Multiple addresses can be added at once by separating each address using a comma or new line.

Email addresses may also be imported into the list by selecting “Import Emails”. This button will open up a file browser dialog, allowing you to select a file containing email addresses separated by commas or new lines. These email addresses will then be added directly to the list.

Having selected the email addresses required from the list, clicking the “Send Email To List” button will result in an email being sent out to all selected users.

Once a user follows the link in the email and creates both a Pin Code and token for the cloud service, they can then walk up to any Cloud Pack connector connected to the ShareScan manager and login using their email address and the Pin Code they created. Alternatively, if the “Recipients use email address as username” option is unchecked when sending out an email, the users will log in to the token website and connector using their windows credentials.

The token and Pin Code are automatically downloaded from the web service when the user first attempts to log in.

Page 24 of 44

Page 25: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.4.1 Changing the email content

To change the content of the email sent from the CloudPack admin panel, you will need to modify a text file saved in the connector installation directory usually: C:\Program Files (x86)\Paper River Consulting\Cloud Pack Connector for ShareScan 5\PaperRiver.Workflow.CloudPack.ShareScan5

You will need to edit emailbody.txt in a program such as Notepad.

Use “[username]” to automatically populate the email addressUse ”[website]” to automatically populate the link the cloud pack website

Page 25 of 44

Page 26: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.5 PinCode Settings tab

Note: This option is not available for OneDrive for Business as it does not use pincodesThe PinCode Settings tab should allow for the management of PinCodes.

1. PinCode Storage Settingso Allow the folder for storing the PinCodes file to be set/selected.o Allow PinCode encryption to be enabled/disabled.

2. PinCodes Editor Settingso Allow the administrator to manage PinCodes by either editing or removing

PinCodes from the list.o Allow changes to be reset using the Reload button. This resets the PinCode

list so that it reflects the current PinCodes file.o Allow changes to the list to be saved and applied to the PinCodes file using

the Save button.o The Date Changed field records the time the pin was last modified locally.

This can be compared with that of the Pin on the website in order to help determine the current Pin Code.

Page 26 of 44

Page 27: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

Usernames in the PinCodes Editor are initially automatically populated from the available tokens available in token storage. If a token exists in storage but is not in the list, it is added for the user, along with the Pin Code the user set when first creating a token on the token website.

If a user attempts to login to the connector using an email address and Pin Code, and they do not already have a token stored locally or on the web service, their email address and Pin Code will automatically be added to the PinCodes tab.

Then, once the user has followed the link emailed to them and created themselves a token, they can go to a device and login using the email address and Pin Code they used.Pin Codes can be updated using the web service and automatically update the connector following logon.

Please note, the ShareScan Manager Service must run under an account that has write access to the Pin Codes file in order to update the Pin Codes during runtime.

Page 27 of 44

Page 28: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.6 Google Drive Options tab

Please note, the Google Drive Options tab will only show if the Google Drive Cloud Service is selected on the Configure tab.

1. Conversion Settingso Enabling “Convert uploaded files to Google format” will result in Google

attempting to automatically convert compatible uploaded files to the native Google Format.

Page 28 of 44

Page 29: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.7 OneDrive for Business tab

The OneDrive for Business tab only shows if the OneDrive for Business Cloud Service is selected on the Configure tab.

1. Site Settingso Allow the administrator to enter the URL to the company OneDrive site.

e.g. mycompany-my.sharepoint.como Authentication

OAuth Token Select this option to connect to OneDrive for Business in the

same way as all the other services. Requires the user to create a token through the PaperRiver Token website.

NOTE: Requires an application creating in Azure for the users to generate tokens against. See 7.7a Setting up OneDrive for Business with OAuth

Username/Password Allows users to login using their username/password or with

SSO if configured – see below for details

2. Admin Logono This allows the connector to login using admin credentials – checking this

requires admin credentials to be entered in the configure tab.

Page 29 of 44

Page 30: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

With this option enabled, only a users username is needed for them to use the OneDrive for Business connectorNote: Any folders created or documents uploaded will show a “Modified by” of the admin user account

Note: The admin account needs Site Collection Admin rights on all user accounts that will use the connector, otherwise they will not be able to see or upload to any of their folders.A postscript file (SetOneDriveAdmin.ps1) can be found in the connector installation directory to help automate the task of assigning an account collection admin rights to all users. The Following Prerequisites are required to run the script:

MS online services powershell:o https://www.microsoft.com/en-us/download/details.aspx?id=39267

Azure AD powershell:o http://go.microsoft.com/fwlink/p/?linkid=236297

SharePoint powershell:o https://www.microsoft.com/en-us/download/details.aspx?id=35588

3. Certificate Authenticationo Instead of using an admin account to upload to user accounts, the connector

can be authorised with OneDrive business through a certificate. Users can then be logged on in and scan to OneDrive using just their usernameNote: Any folders created or documents uploaded will show a “Modified by” of “SharePoint App”See 7.7b Working with OneDrive for Business Certificates for details on setting up an application in azure to work with the connector

4. Impersonation Optionso Enable this option to change the Author/ Modified user to match the logged

in user instead of showing SharePoint App/ Admin account nameNote: This will increase the version number of the file to 2.0

Page 30 of 44

Page 31: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.7a Setting up OneDrive for Business with OAuth

In order to use OneDrive for Business with OAuth, you must create an application in Azure with access to OneDrive for the users to authenticate against.

To do this:

1. Login to Azure Active Directory (https://aad.portal.azure.com) as an Office 365 administrator

2. Select "Azure Active Directory" form the left menu3. Select "App registrations"4. Add a new application registration5. Give it a name6. Change Application type to "Native"7. Enter "https://cloudpack.paper-river.co.uk/ODRedirectPage.htm" as Redirect URI8. Select the app registration you have just created9. Click "All Settings"10. Select "Required permissions" under "API ACCESS"11. Click Add12. "Select an API" -> "Office 265 SharePoint Online (Microsoft.SharePoint)"13. "Select permissions" -> Tick "Read and write items and lists in all site collections"14. Copy the Application ID for the app registration you have just created and add it as

the Client ID in the both the ShareScan connector and the CloudPack Token Website

Page 31 of 44

Page 32: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.7b Working with OneDrive for Business Certificates

In order to use a certificate with your OneDrive Business account, you will need to create a certificate and register it with an application in azure to grant the correct permissions to this app

To create a certificate you can use the makecert tool or run the following PowerShell script (Setting your own name, password and location at the top):

$certFriendlyName = "CloudPackConnector "$certPassword = "mySecurePassword"$certLocation = "C:\temp\myCert.pfx"

$securePassword = (ConvertTo-SecureString -String $certPassword -Force -AsPlainText)$certificate = New-SelfSignedCertificate -Type Custom -FriendlyName $certFriendlyName -Subject $certFriendlyName -KeyLength 2048 -KeyExportPolicy Exportable

Export-PfxCertificate -Cert "Cert:\localmachine\My\$($certificate.Thumbprint)" -FilePath $certLocation -Password $securePassword

$cer = New-Object System.Security.Cryptography.X509Certificates.X509Certificate2($certLocation, $certPassword)$bin = $cer.GetRawCertData()$base64Value = [System.Convert]::ToBase64String($bin)$base64Thumbprint = [System.Convert]::ToBase64String($cer.GetCertHash())$keyid = [System.Guid]::NewGuid().ToString()

Write-Host "Please store the following information" -ForegroundColor YellowWrite-Host "You can find the private certificate under $($certLocation)"Write-Host "KeyId: $($keyid)"Write-Host "Base64 value: $($base64Value)"Write-Host "Base64 thumbprint: $($base64Thumbprint)"

When running the script you may need to open PowerShell in Administrator so it has access.

Please remember to save the values for the “KeyId”, “Base64 value” and “Base64 thumbprint”. These are required later when setting up the Azure application

The location of the certificate and the password will need to be added into the ShareScan connector “Certificate Location” and “Certificate Password” fields in the OneDrive for Business tabNOTE: The certificate must be placed in a location that can be accessed by the account running the ShareScan Manager service

Page 32 of 44

Page 33: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

The next step is to create an Azure Active Directory application through the Azure portal and grant the necessary permissions to the application. A privileged user has to execute these steps:

1. Login to https://portal.azure.com with your Office 365 tenant admin credentials2. Go to the section "Azure Active Directory" and "App registrations" and create a new

app3. Specify a name and a unique URL (does not need to exist)

4. Store the ClientId of the application (ApplicationId). This needs to be added into the ShareScan connector in the Application ID field in the OneDrive for Business tab

Page 33 of 44

Page 34: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

5. Press on "Required permissions" and grant the "Read and write items in all site collections" permissions

The next step is to configure the newly created application to use the certificate values for the ShareScan connector:

6. Go to the Azure Active Directory application settings and press the manifest button

7. Locate the "keycredentials" and extend it with the section shown below:

Please remember to change the values in "keycredentials" with the following values:

Page 34 of 44

Page 35: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

"KeyId" -> use the "KeyId" value given when creating your certificate above

"customKeyIdentifier" -> use the “Base64 value“ given when creating your certificate above

"value" -> use the “Base 64 thumbprint” given when creating your certificate above

When updating the manifest file and reopening it, the "value" becomes empty: this is normal and does not mean that you haven't been able to update the settings. It is just empty for security reasons.

Finally you will require your Tenant ID to enter into the ShareScan Connector Tenant Id field in the OneDrive for Business tab.To get it, you can follow one of the following procedures:

Use the Azure AD portal To find your Office 365 tenant ID in the Azure AD portal

1. Log in to Azure AD as an administrator.(You can reach Azure AD from the Office 365 Admin centre by selecting Azure AD on the Admin centres list.)

2. In the Azure AD portal, click Active Directory.

3. In the Active Directory list, click the directory that you're using with your Office 365 tenant.

4. The tenant id for your Office 365 tenant is displayed as part of the URL: https://manage.windowsazure.com/tenantname#Workspaces/ActiveDirectoryExtension/Directory/<TenantID>/directoryQuickStart

Use Windows PowerShell You can use Windows PowerShell to find the tenant ID. You'll need the Microsoft Azure PowerShell module.

Page 35 of 44

Page 36: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

Open a Microsoft Azure PowerShell command window and run the following script, entering your Office 365 credentials when prompted:

Login-AzureRmAccount

Your tenant ID is listed in the output.

For further information on the steps shown above, please seehttp://www.nubo.eu/en/blog/2016/11/step-by-step-guide-on-how-to-create-a-deamon-application-for-office365/

Page 36 of 44

Page 37: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.8 Box tab

The Box tab only shows if the Box Cloud Service is selected on the Configure tab. Box can be used for Single Sign-On (requiring only a username) by ticking the “Use JWT for Single Sign-On”.When checked:

All tabs related to tokens will be hidden An application needs to be created in Box developer console and added in the Box

admin console – See 7.8a Setting up Box for SSO The JSON app settings file for the application needs to be downloaded from Box and

loaded into ShareScan using the “Load json File” button

Page 37 of 44

Page 38: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.8a Setting up Box for SSO

To use SSO with Box, an application needs to be created through the Box developer console and given permissions to the enterprise through the admin console.

To Create the App:1. Login to Box and go to “Dev Console”2. Select “Create New App”3. Select “Enterprise Integration”4. Select “OAuth 2.0 with JWT (Server Authentication)”5. Give your app a unique name and click “Create App”6. On the app configuration screen ensure the following settings are set:

a. Application Access: Enterpriseb. Note the Client ID – You will need this laterc. Application Scopes: Read and write all files, Manage users, Manage

enterprise propertiesd. Advanced Features: Perform Actions as Users, Generate User Access Tokens

7. Next to “Add and Manage Public Keys”, click “Generate a Public/Private Keypair”8. At the very bottom click “Download as JSON” – this file should be saved and then

loaded into the ShareScan admin console as described in 7.8

Once created, the app needs authorising to the enterprise through the Admin Console:1. Go back to the Box home and click “Admin Console”2. Select the settings cog and “Business Settings”3. Select the “Apps” tab4. Under “Custom Applications” click “Authorize New App”5. In the pop-up enter your Client ID created earlier6. Ensure the app has the following authorisations for all users:

a. Read and write all files and folders stored in Boxb. Manage groupsc. Manage enterprise propertiesd. Manage userse. Manage app usersf. Admin can make calls on behalf of Usersg. Generate tokens

Note: If you need to change the permissions on the app you created, you will need to re-authorise the app using the steps aboveNote: 2-Step verification is required on the admin account to authorise the app

Page 38 of 44

Page 39: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.9 Favourites tab

From the Favourites tab you may enable/disable the use of scanning favourites in the Cloud Pack Connector.

Use Scanning Favouriteso When the user is browsing in the connector for the destination they want to

save the document to, setting this option will display an extra Favourites button. It will also cause a button to be displayed next to the currently selected destination, allowing the user to add it to their favourites. Pressing the Favourites button, allows the user to browse through the destinations that they have added to their scanning favourites.

o This enables the user to save destinations they commonly scan to so they can select the destination much quicker.

o The scanning favourites exist outside of each cloud service, and are only for use at the eCopy Enabled Device.

Folder to Store User Favouriteso This option allows you to set where the files that record the users Favourites

should be stored. By default, they are stored in the Common Application Data folder, and can be accessed by any device using the same ShareScan Manager.

o If you wish to allow the favourites to be shared amongst devices and scanstations that use separate ShareScan Managers, then this value can be set to be a network share.

o N.B. If the same user logs onto more than one machine using eCopy at once, they may lose any favourites added / remove in that session, as the last session to log off will overwrite the stored favourites.

Page 39 of 44

Page 40: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.9 Document / Scanning Settings

Whilst any tab is selected, you should see a panel on the right hand side entitled ‘Settings’. This panel displays the common ShareScan settings for how a document should be scanned / what type of document should be produced, along with any document services. Please see the ShareScan administration guide for information on these settings.

Page 40 of 44

Page 41: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

7.10 Saving and Using a Profile

Finally, once you have finished modifying all settings, clicking the Save button will then prompt you for a name for the profile. You can leave it as the suggested name (overwriting it), or give the profile a new name.

You can create as many profiles as you want, allowing you to connect to multiple cloud services. Each profile is then represented as a different button on devices that are setup to include that profile.

Page 41 of 44

Page 42: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

<?xml version="1.0" encoding="utf-8" ?><CloudPackServer> <Users> <User name="John" password="password"/> <User name="Jane" password="password"/> <User name="davel" password="password"/> <User name="chrisg" password="password"/> </Users> <Destinations> <Folder name="My Personal Documents"/> <Folder name="Meeting Notes"> <Folder name="AGM"/> <Folder name="Shareholder Meeting"/> <Folder name="Supplier Meeting"/> <Folder name="Directors Meeting"/> </Folder> <Folder name="Sales Leads"> <Folder name="New"/> <Folder name="Ongoing"/> <Folder name="Potential"/> <Folder name="Advanced"/> </Folder> <Folder name="Team Documents"> <Folder name="Sales"/> <Folder name="Finance"/> <Folder name="Purchasing"/> <Folder name="Manufacturing"/> </Folder> </Destinations></CloudPackServer>

8 Demonstration ModeWhen unlicensed, the connector reverts to demonstration mode.

Whilst in demonstration mode the word “Demo” will appear in the “Allowed Devices” box on the Licensing screen. In the Upload result page of the connector, “Demo” is also appended to the Upload Successful message.

In this mode there is no communication with any cloud services. Whilst in Demonstration mode, the connector works by reading an xml file stored in

the Connector installation directory called “CloudPackDemo.xml”. This has been pre-populated with a Cloud Storage structure with Users and Folders. This file can be modified by a technical consultant to give a more customised demonstration to a potential customer if required.

NOTE: OneDrive for Business uses OneDriveBusinessServerDemo.xml The file has a structure similar to the following:

Page 42 of 44

Page 43: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

First, under the main “CloudPackServer” element, there is a “Users” element, which may itself contain any number of “User” child elements. Each “User” must have both “name” and “password” attributes. Users will then use these values to log into the connector whilst it is running in Demo Mode.

Next, there is the “Destinations” element under which a folder structure can be built using any number of “Folder” elements, with each one having any number of child “Folder” elements.

The “name” will be the value displayed in the connector as the destination name for the document.

Page 43 of 44

Page 44: SharePoint Connector for eCopy ShareScan, Installation ...€¦  · Web viewCloud Pack Connector for eCopy ™ ShareScan ®. Installation & Administration Guide. This software is

8.1 Using Demonstration Mode

There are currently four users that have already been created in the demo xml file. The usernames for these users are John, Jane, davel and chrisg. The password for all of these users is simply password.

When in Demonstration mode, the connector will appear to work just as it would when connected to a real cloud service account, except in a few places where the word “Demo” may have been added. No files are saved however.

Page 44 of 44