SharePoint Connector for eCopy ShareScan, Functional ...



center240665Cloud Pack Connector for eCopy? ShareScan?Functional Specificationcenter5379085This 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.Table of Contents TOC \o "1-3" \h \z \u 1 Introduction PAGEREF _Toc484077040 \h 32 Supported Versions PAGEREF _Toc484077041 \h 4Cloud Services PAGEREF _Toc484077042 \h 4ShareScan PAGEREF _Toc484077043 \h 43 Pre-install checklist PAGEREF _Toc484077044 \h 54 Connector Use PAGEREF _Toc484077045 \h 64.1 Scanning Screen PAGEREF _Toc484077046 \h 64.2 Logon Screen PAGEREF _Toc484077047 \h 74.3 Destination Screen - Dropbox or OneDrive PAGEREF _Toc484077048 \h 94.4 Destination Screen - Google Drive PAGEREF _Toc484077049 \h 114.5 Destination Screen – OneDrive for Business PAGEREF _Toc484077050 \h 134.6 Redirect Screen PAGEREF _Toc484077051 \h 155 Administrator Use PAGEREF _Toc484077052 \h 165.1 Configuration tab PAGEREF _Toc484077053 \h 165.2 Token Settings tab PAGEREF _Toc484077054 \h 175.3 Email Server tab PAGEREF _Toc484077055 \h 195.4 Email Tokens tab PAGEREF _Toc484077056 \h 205.5 PinCode Settings tab PAGEREF _Toc484077057 \h 215.6 Google Drive Options tab PAGEREF _Toc484077058 \h 225.7 OneDrive for Business tab PAGEREF _Toc484077059 \h 235.8 Favourites tab PAGEREF _Toc484077060 \h 255.9 License tab PAGEREF _Toc484077061 \h 261 IntroductionThe 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 authentication2 Supported VersionsCloud ServicesGoogle DriveOneDriveDropboxOneDrive for BusinessBox ShareScanVersion 5.4 and above3 Pre-install checklistPlease ensure that eCopy has been installed, licensed and configured correctly before installing this connector.Please install and configure the connector on the same computer as the ShareScan manager.Microsoft .Net 3.5 and 4.5.1 must be installed on the ShareScan Manager Server.The Cloud service being used must be reachable over the network from the ShareScan Manager Server.For full functionality, the accompanying Cloud Pack token website or the Paper River Cloud hosted token website must be accessible from the ShareScan Manager ServerNote: OneDrive for Business and Box do not require a token or the token website when using the SSO logon methodsThe service that ShareScan Manager Service runs as must have write permissions to the folder where the cloud pack tokens will be stored.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.4 Connector Use4.1 Scanning ScreenAll standard eCopy settings and features supported.4.2 Logon ScreenDefault LogonAdministrator can set a default logon that will be used each time the connector is used.No further credentials are required from the user.The user is not shown a logon screen.Connector Logon (OneDrive, Google Drive, Dropbox, Box, OneDrive For Business with OAuth)The user must enter their logon credentials.UsernamePasswordDomain (can be optionally hidden by administrator)Logon Type (can be optionally hidden by administrator)The user is shown the logon screen as soon as they enter the connectorLogon Type "Both" tries PinCode first, then Windows (assuming PinCode fails)If no PinCode for a user, attempts to check website for PinCode and tokenIf no token, and username is an email - can set PinCode and email user ready for when they have a token (requires email server settings to be configured)If no token and username not an email - can email user with a link to get token (requires email server settings to be configured)Can show a web address for user to get token on screenConnector Logon (OneDrive for Business)The user must enter their logon credentials.UsernamePasswordThe user is shown the logon screen as soon as they enter the connectorConnector Logon (OneDrive for Business, Box when using SSO)The user must enter their logon credentials.UsernameThe user is shown the logon screen as soon as they enter the connectorSession LogonShareScan is setup for Session LogonWhen the user enters the connector, it attempts to logon with the credentials gathered from the session logonIf the session credentials fail, show a logon screen (Refer to Logon point 2)4.3 Destination Screen – Dropbox, OneDrive or OneDrive For Business (OAuth)After Logon, the user is presented with the destination screen.The user is shown a list of possible Destinations.The user cannot continue until a Destination is selected.The user can navigate through the folder structure by selecting folders from the list or using the folder up button to step back up a level in the folder structure.If the administrator has enabled the use of Scanning Favourites:Display a button toggle set to the left of the children list box.The “Scan Favs” button is shown in the toggle setAllow the user to change the toggled option.The toggled option defaults to “My Home”Changing the toggled option will alter the destinations the user will be able to browse. E.g. scanning favourites, all etc.If the administrator has enabled the use of Scanning Favourites:When a destination is selected, a button is displayed to the right of the chosen destination text box.If the chosen destination has not yet been added to the users scanning favourites.The button will indicate to the user that if they press it, the destination will be added to their scanning favourites.If the user presses the button, the destination will be added to their Scanning Favourites.If the chosen destination has already been added to the users scanning favourites.The button will indicate to the user that if they press it, the destination will be removed from their scanning favourites.If the user presses the button, the destination will be removed from their Scanning Favourites.If the user selects ‘My Home’, the screen allows them to browse through the main folder structure of the Cloud Service like they would through its web interface.If the user selects ‘Scan Favs’, the screen allows them to browse through the folders that the user has previously added to their scanning favourites within the eCopy Connector.4.4 Destination Screen - Google DriveAfter Logon, the user is presented with the destination screen.The user is shown a list of possible Destinations.The user cannot continue until a Destination is selected.The user can navigate through the folder structure by selecting folders from the list or using the folder up button to step back up a level in the folder structure.The “Shared” button is shown to allow the user to browse folders shared with them in Google.If the administrator has enabled the use of Scanning Favourites:The “Scan Favs” button is shown in the toggle setAllow the user to change the toggled option.The toggled option defaults to “My Home”Changing the toggled option will alter the destinations the user will be able to Changing the toggled option will alter the destinations the user will be able to browse. E.g. scanning favourites, shared, all etc.If the administrator has enabled the use of Scanning Favourites:When a destination is selected, a button is displayed to the right of the chosen destination text box.If the chosen destination has not yet been added to the users scanning favourites.The button will indicate to the user that if they press it, the destination will be added to their scanning favourites.If the user presses the button, the destination will be added to their Scanning Favourites.If the chosen destination has already been added to the users scanning favourites.The button will indicate to the user that if they press it, the destination will be removed from their scanning favourites.If the user presses the button, the destination will be removed from their Scanning Favourites.If the user selects ‘My Home’, the screen allows them to browse through their own personal Google Drive folders, just as they would through the Google Drive web interface.If the user selects ‘Shared’, the screen allows them to browse through the shared Google Drive folders that they have permissions to access, just as they would through the Google Drive web interface.If the user selects ‘Scan Favs’, the screen allows them to browse through the folders that the user has previously added to their scanning favourites within the eCopy Connector.If the administrator has configured the connector to Convert uploaded files to Google format, upon sending the scan to Google the document will be converted to the Google format if it is compatible.4.5 Destination Screen - BoxAfter Logon, the user is presented with the destination screen.The user is shown a list of possible Destinations.The user cannot continue until a Destination is selected.The user can navigate through the folder structure by selecting folders from the list or using the folder up button to step back up a level in the folder structure.The “Box Favourites” button is shown to allow the user to browse folders they have saved as favourites within BoxIf the administrator has enabled the use of Scanning Favourites:The “Scan Favs” button is shown in the toggle setAllow the user to change the toggled option.The toggled option defaults to “My Home”Changing the toggled option will alter the destinations the user will be able to Changing the toggled option will alter the destinations the user will be able to browse. E.g. scanning favourites, shared, all etc.If the administrator has enabled the use of Scanning Favourites:When a destination is selected, a button is displayed to the right of the chosen destination text box.If the chosen destination has not yet been added to the users scanning favourites.The button will indicate to the user that if they press it, the destination will be added to their scanning favourites.If the user presses the button, the destination will be added to their Scanning Favourites.If the chosen destination has already been added to the users scanning favourites.The button will indicate to the user that if they press it, the destination will be removed from their scanning favourites.If the user presses the button, the destination will be removed from their Scanning Favourites.If the user selects ‘My Home’, the screen allows them to browse through Box folders just as they would through the Box web interface.If the user selects ‘Box Favourites, the screen allows them to browse folders they have saved as favourites within Box just as they would through the Box web interface.If the user selects ‘Scan Favs’, the screen allows them to browse through the folders that the user has previously added to their scanning favourites within the eCopy Connector.4.6 Destination Screen – OneDrive for Business (Non-OAuth)After Logon, the user is presented with the destination screen.The user is shown a list of possible Destinations.The user can navigate through the folder structure by selecting folders from the list or using the folder up button to step back up a level in the folder structure.If the administrator has enabled the use of Scanning Favourites:Display a button toggle set to the left of the children list box.The ‘Scan Favs’ button is shown in the toggle setAllow the user to change the toggled option.The toggled option defaults to ‘My Home’Changing the toggled option will alter the destinations the user will be able to browse. E.g. scanning favourites, all etc.If the administrator has enabled the use of Scanning Favourites:When a destination is selected, a button is displayed to the right of the chosen destination text box.If the chosen destination has not yet been added to the users scanning favourites.The button will indicate to the user that if they press it, the destination will be added to their scanning favourites.If the user presses the button, the destination will be added to their Scanning Favourites.If the chosen destination has already been added to the users scanning favourites.The button will indicate to the user that if they press it, the destination will be removed from their scanning favourites.If the user presses the button, the destination will be removed from their Scanning Favourites.If the user selects ‘My Home’, the screen allows them to browse through the main folder structure of OneDrive like they would through its web interface.If the user selects ‘Scan Favs’, the screen allows them to browse through the folders that the user has previously added to their scanning favourites within the eCopy Connector.The user can also create a new folder in the current selected directory by typing the name in the “New Folder” textbox and pressing the create folder button next to it4.7 Redirect ScreenAfter a document is sent, the user is taken to the redirect screen.If the user chooses to scan another document using the same settings, they should be taken back to the scanning screen.If the user is in the Redirect screen of another connector, and chooses to send the document to the Cloud Pack connector, they should be taken to the Logon screen (if required, i.e. if No default logon and no session logon), or the scanning screen. They should then be able to proceed through the connector as normal.5 Administrator Use5.1 Configuration tabThe Configuration tab should allow for basic configuration, allowing the connector to connect easily and quickly to the selected cloud service.Cloud ServiceAllow the administrator to select which cloud service they want users to connect to from this ShareScan profile.Please note, different tabs and logon settings may be shown based upon which cloud service is selected.Logon SettingsAllow the administrator to choose either Runtime logon (require Session credentials, or user credentials) or Default Logon.Allow the administrator to test the connection to the cloud service.Allow the administrator to enter credentials to be used for Test and Default Logon:UsernamePasswordDomain (optional)TypeOther OptionsAllow the administrator to specify that folders are shown sorted by name5.2 Token Settings tabThe 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.Token StorageToken Storage Folder – where individual user tokens are stored in encrypted XML format.Token Pack Folder – where a collection of user tokens can be downloaded to, before being split into individual tokens.The ShareScan Manager service must run under an account with write access to these folders.These folders can be shared by multiple ShareScan Manager instances in order to provide a central repository of tokens.Token Server SettingsSelect whether to use a locally installed token server or an externally hosted token server.Enter the URL for a local token server.Enter a Company ID and Company password if registered with a hosted token server.Set whether the connector should download the tokens automatically from the server when usedCan configure the connector to send an email to the username with a specific domain appended. This email will instruct the user on how they can get tokens for the selected cloud service, should they not already have a token.Can configure the connector to show a message directing users to a webpage where they can get tokens for the selected cloud service, should they not already have a token.5.3 Email Server tabThe 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.Email Server SettingsSet SMTP client hostSelect whether to use SSLSet the authentication credentials to use with the SMTP hostSet the email FROM address (Please note, some email providers do not allow the setting of an email FROM address) Set email subject5.4 Email Tokens tabThe Email Tokens tab supports the management of an email address list. From this tab, users can be sent an email containing a link which they can follow to get a token, in order to allow them access to the Cloud Pack connector using their email address as their username.Email AddressesCan add email addresses. Multiple addresses can be added at once by separating each address using a comma or new line.Clicking 'Add' will add all specified email addresses to the list below.'Import Emails' opens 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.Remove CheckedRemoves any checked email addresses from the list.Send Email To ListThis will send an email with a link to get a token to all emails that have been checked in the list.If “Recipients use email address as username” is ticked, users who follow the link in the email will be logged in to the token website using their email addressSelect All / Deselect AllThese buttons check or uncheck all of the email addresses in the list5.5 PinCode Settings tabThe PinCode Settings tab enables the management of PinCodes.PinCode Storage SettingsAllow the folder for storing the PinCodes file to be set/selected.Allow PinCode encryption to be enabled/disabled.PinCodes Editor SettingsAllow the administrator to manage PinCodes.Allow changes to be reset using the Reload button. This resets the PinCode list so that it reflects the current PinCodes file.Allow changes to the list to be saved and applied to the PinCodes file using the Save button.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. PinCodes should automatically populate from downloaded tokens for any new users not yet addedPinCodes are automatically added and updated for users signing in using PinCode with tokens on website5.6 Google Drive Options tabThe Google Drive Options tab only shows if the Google Drive Cloud Service is selected on the Configure tab.Conversion SettingsAllow the administrator to enable/disable the automatic conversion of uploaded files to the native Google format.5.7 OneDrive for Business tabThe OneDrive for Business tab only shows if the OneDrive for Business Cloud Service is selected on the Configure tab. All tabs related to tokens will be hidden as these are not used when logging in to OneDrive for business.Site SettingsAllow the administrator to enter the URL to the company OneDrive site.e.g. mycompany-my.Allow the administrator to set the Authentication method:OAuth Token – Used in conjunction with the PaperRiver Token WebsiteRequires an application to be added in AzureUsername/Password – Allow users to log on using their OneDrive business username/password or with SSOAdmin LogonAllow the connector to login using admin credentials – checking this requires admin credentials to be entered in the configure tab.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 accountCertificate LogonAllow the connector to login using a certificateWith 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 “Sharepoint App”Note: Instructions for setting up a certificate and getting the Tenant ID/Application ID can be found in the installation and administration guide.Impersonation OptionsEnable 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.05.8 Box tabThe Box tab only shows if the Box Cloud Service is selected on the Configure tab. Use JWT for Single Sign-OnIf checked:All tabs related to tokens will be hiddenAn application needs to be created in Box developer console and added in the Box admin console The JSON app settings file for the application needs to be downloaded from Box and loaded into ShareScan using the “Load json File” button5.9 Favourites tabFavourites OptionsAllow the administrator to enable/disable Scanning FavouritesAllow the administrator to choose where to save the Scanning Favourites5.9 License tabThe Licensing tab allows the administrator to control the licensing of the connector.Be able to activate a licenseOnline activationEmail activationTo see when a trial license expires.To see how many devices the current license is for.To see what devices have taken a license slot.To remove a license allocation from a device, so that it can be moved to a different device. ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download