Technical Guide DocuPRO Embedded Client for Xerox

Transcription

1 DocuPRO Embedded Client for Xerox Technical Guide DocuPRO Embedded Client for Xerox Product Version: 7.4 Version of this manual: Inepro B.V. All rights reserved

2

3 DocuPRO Embedded Client for Xerox The most efficient embedded solution Congratulations on selecting an Inepro Solution. We are certain you will be pleased with your purchase of one of the finest solutions of the market. We want to help you get the best result out of your Inepro Solution and to operate in an efficient manner. This manual contains information on how to do that; please read it carefully. Due to continuous product improvements this manual is subject to changes without notice. We strongly recommend you read the license agreement to fully understand its coverage and your responsibilities of ownership. Your Inepro buisiness partner is dedicated to your satisfaction and will be pleased to answer your questions and your concerns. Best wishes, Inepro BV.

4 DocuPRO Embedded Client for Xerox All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. This product has been developed using Xerox Corporation proprietary embedded architecture or other proprietary Xerox products. This document includes information which has been provided by Xerox Corporation, and such information is Xerox Corporation or its licensors. Copying in whole or in part of the Xerox information without permission of Xerox is prohibited, except to the limited extent permitted by mandatory applicable law. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Version created: March 2015 in Nieuw-Vennep, The Netherlands Publisher Inepro B.V. Managing Editor K. de Graaf Technical Editors R. Post Cover Design H. Wagenaar K. de Graaf Team Coordinator R. Groen Production Inepro B.V.

5 Table of Contents Introduction Requirements Networking/Firewall Configuration Installation 1 Internet... Information Services 8 2 DocuPRO... Embedded Client Configuration 1 Configure... IIS 16 2 Auto configure... MFP s 18 3 Mandatory... MFP Settings 23 System... Timeout 23 Confirmation... / Error Reports 24 Conceal... all job names 25 Secure... Access 26 Web... Services 27 4 Check... MFP Settings 28 Network... Accounting 28 Enable... SSL 29 Lock... All Applications 30 Set... Default Application 31 Secure... Access 31 Business Server Settings Notes Version Inepro B.V

6

7 Introduction I Part

8 Introduction Introduction Extensible Interface Platform (EIP) is a platform on which developers can create an application that can drive the copier, scan and print functions. DocuPRO embedded client for Xerox can release print jobs, copy and scan, and will register and optionally enforce payment for those functions. The DocuPRO embedded client for Xerox system has a number of basic functions: Print Copy Scan The main focus of the system is a payment and accounting system for the basic machine functions and provide a print release option for the Inepro DocuPRO system. In order for this to work the system prevents the machines to be used freely until a user is logged in. It also records all the transactions a user does until the user logs out and store these to a central server 2 - DocuPRO Embedded Client for Xerox

9 Requirements II Part

10 Requirements Requirements The Xerox MFP s must have the Xerox Secure Access authentication method and the Network Accounting method installed. You may need to contact Xerox to enable these functionalities. Ensure that the Xerox MFP s are connected to the network. Have the network addresses of the Xerox MFP s available. It is recommended that the MFP s are configured with a static IP. Have the network address available of the system running the Inepro Business Server. Windows Server with IIS 7. Ensure your DocuPRO Embedded Client for Xerox version is or higher. Ensure your Xerox EIP (Extensible Interface Platform) version is 2.0 or higher 4 - DocuPRO Embedded Client for Xerox

11 Networking/Firewall Configuration III Part

12 Networking/Firewall Configuration Networking/Firewall Configuration Ensure that your networking/firewall configuration allows port for inbound TCP connections from the Xerox MFP s. Make a rule, select port. Click. Enter the port number (10056) and click 'Next'. Choose 'Allow Connection' and click Repeat this for these ports: 443 TCP Outbound TCP Inbound TCP Outbound TCP Outbound 6 - DocuPRO Embedded Client for Xerox

13 Installation IV Part

14 Installation Internet Information Services Internet Internet Services is needed to host the DocuPRO Embedded Client for Xerox. Version IIS 7 or higher is required! Install IIS as follows: Open the Server Manager (in Windows Server 2012 or higher). Select at least Web Server (IIS) as server role, continue the installation by clicking 8 - DocuPRO Embedded Client for Xerox.

15 Tick the ASP.NET 4.5 box and continue the installation by clicking. Tick the Application development box, and tick all boxes except the CGI box. DO Version

16 Installation NOT click yet. Also tick the boxes as shown in the image above 'IIS Management Tools', 'IIS 6 Metabase Compatibility' and 'IIS 6 WMI Compatibility' and continue the installation by clicking 10 - DocuPRO Embedded Client for Xerox.

17 Finish the installation by clicking the button Version

18 Installation DocuPRO Embedded Client for Xerox Start DocuPROEmbeddedClientForXerox.exe to begin the installation process. Follow the instructions on screen to begin installing DocuPRO Embedded Client for Xerox. You will be prompted to install.net 4.0 or IIS if they are not installed already. Continue the installation by clicking 12 - DocuPRO Embedded Client for Xerox.

19 Agree with the conditions and by clicking to continue the installation. Version

20 Installation Confirm the installation by clicking Finish the installation by clicking 14 - DocuPRO Embedded Client for Xerox.

21 Configuration V Part

22 Configuration Configure IIS 1. Open the IIS manager 2. Go to Sites -> Inepro Web Site 3. Go to Edit Site -> Bindings Click Edit Select a valid SSL certificate on port 10056, if no certificate is available one should be created, see below. Create SSL Certificate 1. Open ISS Manager 2. Go to Home 3. Select Server certificates 16 - DocuPRO Embedded Client for Xerox

23 4. Create Self-Signed Certificate Assign a clear description and click OK Version

24 Configuration Auto configure MFP s Folders and permissions 1. Check if the folder %IneproDataPath% (<Disk Drive>\ProgramData\Inepro) exists (this is often C:\ProgramData\Inepro), if not, create this folder, and the sub folders 'log' and 'xerox'. 2. Give permissions to the 'log' and 'xerox' folder by right-clicking the folder %IneproDataPath% (<Disk Drive>\ProgramData\Inepro), choose 'properties' and select the 'Security' tab. 3. Add an existing user, named 'ISS_IUSRS', give this user full permission rights DocuPRO Embedded Client for Xerox

25 Configure MFP's 1. Browse to or click this shortcut on the desktop:. 2. Fill in the Business server IP or host name and log in with your Inepro Manager staff authentication (username and password). A Inepro authentication must have been created in the Inepro Manager, please refer to the Inepro Back Office Manager for instruction on creating authentication accounts in the Inepro Back Office Manager. 3. Click login to continue. 4. At this page configurations can be made. It will also enabe configuration of the MFP s automatically and will install the DocuPRO embedded client for Xerox application on the devices. Version

26 Configuration 5. Specify the preferred language that should be displayed on the machines. 6. Fill out the Application server IP or hostname (this is the server that has IIS running). 7. Fill out the IP or Hostname where the Inepro business server is installed and if SSL is enabled. (This is enabled by default). 8. List all Xerox MFP IP s which should have the DocuPRO embedded client for Xerox application installed, separated by comma. (Example , , etc. ). 9. Fill out the admin username and password of the MFP s. If this differs per device it must be configured separately. 10.Fill out the title and message that are shown at the authentication screen at the MFP. 11.If needed the 'Advanced' window can be opened to toggle the advanced configuration settings: 20 - DocuPRO Embedded Client for Xerox

27 12.When everything is ready click 'Configure'. 13.Now all the MFP s will almost completely be configured automatically. Some settings must be set manually, this will be done in the MFP configuration section 23. See Check MFP Settings 28 to validate the essential settings. 14.If everything went well the previous screen should be seen. If errors are shown ( ), please configure the afflicted MFP's manually using the MFP web interface as shown in Check MFP Settings 28. Version

28 Configuration 15.Please check the MFP. The MFP s should now have the following lock screen or something similar depending on the device 22 - DocuPRO Embedded Client for Xerox

29 Mandatory MFP Settings These steps must be followed to ensure a correct installation of the MFP for the DocuPRO embedded client for Xerox. The specific steps, screen layouts and button/label names can differ between device models. However the general process is the same for all supported devices. The following options need to be configured: System Timeout Confirmation / Error reports must be disabled Conceal all job names Secure Access Web Services Login to the web browser admin panel via the MFP IP adress and then go to the properties tab System Timeout Set System Timeout to the maximum setting At the 'services' section: - Got to 'Security > System Timeout' Set Touch User Interface System Timeout at the maximum setting (usually 60 minutes). This is done to insure that the setting is in effect managed by the Inepro Business Server, (setting CustomerLogoffTimeout). This is set by default at 120 seconds (2 minutes). See section CustomerLogoffTimeout at the Business Server Settings 34 Version

30 Configuration Turn Off Confirmation / Error Reports Services At the 'services' section: - Printing > General Set Print Banner Sheets to No and Print Error Sheets to Disable. - Work flow Scanning > General Settings Set Confirmation Sheet to Off DocuPRO Embedded Client for Xerox

31 - > Setup > General Set Confirmation Sheet to Off. Conceal all job names Services At the 'services' section: - Printing > Secure Print Tick 'Conceal all job names'. Version

32 Configuration Secure Access At Login/Permissions/ Accounting Login Methods - Make sure Xerox Secure Access is selected. If not click the edit button and select it from the list. When enabled click Xerox Secure Access Setup and in the next screen click Manually Override Settings DocuPRO Embedded Client for Xerox

33 Make sure: The Path is /ixeroxembedded/service.asmx - The IP of the server where the embedded is installed is correct and the port is At Device Log In Methods Xerox Secure Access Device + alternate on-screen authentication method is selected. - This will enable the user to login manually at the device's touch panel. At Accounting Information (Requires Network Accounting) Automatically apply Accounting Codes from the server is selected Web Services At Printing Printing Web Services - Make sure all services are enabled Version

34 Configuration Check MFP Settings Please follow these steps to validate that everything during the automatic configuration went ok. If there where errors during the automatic configuration please also follow these steps. The specific steps, screen layouts and button/label names can differ between device models. However the general process is the same for all supported devices. The following options need to be configured: A Certificate must be present SSL must be enabled Network Accounting must be enabled All applications must be locked The default application should be Inepro DocuPRO Secure Access must be enabled with the correct information Login to the web browser admin panel via the MFP IP adress and then go to the properties tab Network Accounting At Login/Permissions/ Accounting Accounting Method - Make sure Network Accounting is selected. If not click the edit button and select it from the list DocuPRO Embedded Client for Xerox

35 Make sure the Accounting Workflow for Copy and Scan jobs is selected to Pre-Authorization and Capture Usage and the rest Capture Usage. And the Job Limits Settings is the correct url: Enable SSL At Connectivity Setup - HTTP Make sure a certificate is present and Force Traffic over SSL is checked to Yes Version

36 Configuration Lock All Applications At Login/Permissions/ Accounting User Permissions - Click edit at User Permission Roles Click edit at Non-Logged-In-User Click the Services & Tools tab Make sure the Restrict access to all Services and Tools option is checked 30 - DocuPRO Embedded Client for Xerox

37 Set Default Application At General Setup Entry Screen Defaults Make sure Inepro DocuPRO is selected at Services and at Default Walkup Screen Secure Access See Secure Access settings in MFP Configuration 23 Version

38

39 Business Server Settings VI Part

40 Business Server Settings Business Server Settings Here a list of setting relevant to the DocuPRO Embedded Client for Xerox can be found. VT Value Type 1 Boolean, TRUE or FALSE 2 String, alphanumeric, like 1234abc!@#$ 3 Integer 4 Full URL of the object in question 5 List item, value is selected from a pre-defined list Settings relevant to the DocuPRO Embedded Client for Xerox: Setting AllowCustomerPasswordChange Description Allows the user to change his password at the setting screen. Allow modifications of print jobs (color, amount, cost centre, etc). Not fully supported yet, use supported drivers only! Allow to register a blank card to the logged in customer at the settings screen. Only supported for Inepro USB reader! PRINT_COPY_SCAN, PRINTRELEASE, PRINT_COPY, COPY. Show or, if there is only one option, go to the selected option and disable the rest. If there are print jobs go straight to the print screen. VT 1 Default TRUE 1 FALSE 1 FALSE 5 PRINT_COPY _SCAN 1 TRUE VT 1 Default FALSE 5 SHORTNAME 5 SELECT , TRUE <EMPTY> DebugLoggingEnabled DisablePriceInfo Description Deletes all active jobs when logging off SHORTNAME, CODE. Show the cost centre longname + code instead of only the longname. SELECT, SEARCH. When SEARCH is selected show the keyboard instead of the cost centre list screen. Number of currency decimals after the separator. Separator in currency., $, etc. for/after currency. Prefix or postfix the currency symbol. The idle time (in seconds) a user has before he/she will be logged out. Default = 120 sec. Pull print, Scan to me, Copy. Go straight to the print, copy or scan screen. Enables comprehensive logging in order to debug. Do not show the price at the terminal interface 1 1 FALSE FALSE Setting EnableColorScan EnablePrintJobPreviews EnablePrint EnableCopy EnableScan EnableScanToFolder EnableScanToMail FTPScanPort FTPScanServer Description Show (auto)color scan option. Show print jobs previews on print details screen. Enable print functionality. Enable copy functionality. Enable scan functionality. Enable ScanToFolder option. Enable ScanTo option. ScanToX port. Default (empty) is port 21. ScanToX IP. Default (empty) is business server IP. VT Default TRUE TRUE TRUE TRUE TRUE TRUE TRUE <EMPTY> <EMPTY> AllowJobPropertyModification AllowTagRegistration ApplicationMode AutomaticFunctionSelection Setting CancelWaitingJobsWhileError CostcenterEntryField CostcenterSelectMode CurrencyDecimals CurrencyDecimalSeparator CurrencySymbol CurrencySymbolPrefix CustomerLogoffTimeout DefaultApplication 34 - DocuPRO Embedded Client for Xerox

41 Setting LogOffAfterPrint LogOffAfterAction MaskedLoginUsername MaxCostcentersInSelection MFPAdminPassword MFPAdminUserName MinBalance MinimumPasswordLength Setting PrintingMode PurseSelection SecondTerminalLanguage SupportTagHoldMode Setting TerminalLanguage ThirdTerminalLanguage Usecost centres UseCustomerLanguage Description Logoff customer after a printjob is released. Logoff customer after a print-, copy- or scan job is finished. If using a manual login name, the user name is masked with asterisks (*). Maximum number of cost centres in the list, else go to the keyboard search screen first. MFP admin password to login as admin at the device. MFP admin username to login as admin at the device. Minimum balance to be allowed to print, copy or scan. Minimum password length to change password or create a new tag registration. VT Default FALSE FALSE FALSE Admin Description SIMPLE, ADVANCED, DIRECT_IPREADER_RELEASE ADVANCED = normal. SIMPLE = print all when print is pressed. DIRECT_IPREADER_RELEASE (business server does this for us) release all print jobs when logging in. PERSONAL_ONLY, BUDGET_ONLY, PREFER_PERSONAL, PREFER_BUDGET, PERSONAL_AND_ASK, BUDGET_AND_ASK, USE_ALL_PURSES. Second language option in Settings screen. Logoff customer when tag is removed. VT Default 5 ADVANCED 5 PERSONAL AND ASK 5 1 <EMPTY> FALSE Description Language of terminal; if UseCustomerLanguage is not TRUE and the manager language is set to Auto. Also language option in Settings screen. Third language option in Settings screen Must use cost centres. If customer doesn't have any, don't allow budget. Use the customer language, if the user has a language and the manager language is set to Auto. VT Default 5 EN 5 <EMPTY> 1 FALSE 1 TRUE Refer to the Inepro Business Server manual for detailed explanation of the functions. Activate Settings Use the 'Force Business Server to use new settings' button to use the new settings Version

42

43 Notes VII Part

44 Notes Notes This area is meant for the reader's notes: 38 - DocuPRO Embedded Client for Xerox

45 Version

46 Notes 40 - DocuPRO Embedded Client for Xerox

47 Version

48