Monitor Embedded for Sharp OSA

Transcription

1 Monitor Embedded for Sharp OSA Product Manual

2 Monitor Embedded Solutions Framework 2014 Monitor Business Machines Ltd The software contains proprietary information of Monitor Business Machines Ltd. It is provided under a license agreement containing restrictions on use and disclosure and is also protected by copyright law. Reverse engineering of the software is prohibited. Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Monitor Business Machines Ltd. The Monitor Logo and Supervisor are registered trademarks of Monitor Business Machines Ltd. Any other 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. All rights reserved. No part 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. 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. Monitor Business Machines Ltd. 31a Normanby Road, Mt Eden, Auckland 1024, New Zealand Published: 9/01/2014

3 Contents Overview 1 Introduction to MES Framework... 1 Installation Guide 2 System Requirements... 2 MES Server Requirements... 2 System Requirements... 2 Softw are Requirements... 2 MES Server Ports... 3 Supervisor Net Requirements... 3 Supervisor Net License... 3 Supervisor Net Server... Ports 3 Installing MES Framework... 3 Configuring an MFD for MES Recommended Security Measures Secure Cabling Change the Admin Passw... ord 10 Enable Filtering MES Administrator MES Configuration tab MES Service Configuration Base System Port MFD List Update... Time 12 MES Logging Verbosity Tomcat Logging Verbosity UDP Logging Verbosity Tomcat Shutdow... n Time 12 MFD Session Shutdow... n Time 12 Supervisor Net Host/IP Supervisor Net Terminal... Server Port 12 Supervisor Net Interface... Server Port 12 HTTP Timeout Value SMTP Setup Embedded Solutions Add Solution Solution Menu Save Discard MFD Configuration tab Configuration Selection Solution Selection Edit Configuration General tab Login Options Single Function... Operation 16 Automatically... Release Single Jobs 16 MFD Functions... When No Print Jobs 17 Single Price/Flat... Rate Scan Jobs 17 Narration Text... for Native Print Jobs 17 Contents i

4 MFD Functions... Button Text 17 Usage Screen... Button Text 17 Passw ord Entry... Text 17 Time (mins) Before... MFD is Considered Offline 18 Time Before Clearing... Inactive Jobs (hours) 18 Use Uppercase... Searching 18 Disable Logout... With Pending Jobs 18 Allow Login With... Paused Jobs 18 Automatically... Disable Session Timeout 18 Number of Decimal... Places 18 Separate Page... Information 18 Auto Sense Auto... Accept 18 Auto Accept... Limit 18 Auto Accept... Price Code 19 Allow Session... Hold 19 Session Hold... Times (mins) 19 Disable A3 Count... Halving 19 Prompt For Colour... Selection 19 Use Highest Price... for Counts 19 Prompt for Print... Release ID 19 Print Release... ID Prompt 19 Card Setup tab Card Track Track 1 Field Track 2 Field Monitor Card... Prefix 21 Allow Card Association Use PIN Allow Set No... PIN 21 Disable PIN Change Ignore Cards... In Session 22 Display Card... Processing 22 Card Prefix Card Offset Card Length Restrictions tab Themes tab Disable Copy... Row in table 22 Disable Print Row... in table 22 Disable Scan... Row in table 22 Disable Fax Row... in table 22 Enable Entry... Watermarks 22 Primary Entry... Watermark 23 PIN Entry Watermark Secondary Entry... Watermark 23 Auxiliary Entry... Watermark 23 Login Instructions... Text Size 23 Login Instructions... Font Family 23 Login Instructions... Centred 23 Login Instructions... Text 23 Session Instructions... Text 23 Site Branding Debug tab Verbosity Enable UDP Debug... Output 24 Enable Supervisor... Packet Logging 24 Exit ii Contents

5 MFD/Service Status tab MES Service Status MFD List Terminal ID Terminal Name MFD Unique ID # MFD IP Address MFD Status Product Configuration Right-Click Menu Restart Selected Clear Selected... Terminal IDs 26 Enable/Disable... Sharp OSA Key Filtering 26 Charge Scan... Per Destination 26 Charge Scan... Once Only 26 Spy on Device Simulate Card... Data 27 Role Based Access Control... tab 27 Product Information tab Admin Tools Accessing the MFD's... System Menu 27 Remote Access to an... MFD 27 MFD Counters Upgrading MES Framework Contents iii

6 Overview The Monitor Embedded for Sharp Product Manual is a comprehensive guide to installing and configuring Monitor's embedded solution for Sharp. The following topics are covered in this manual: Introduction to MES Framework List of Supported MFDs and card readers Installation Guide o Installation requirements o Installing the MES Framework o Configuration required to run the MES solution on an MFD o Recommended security measures to prevent users bypassing the MES solution o Using MES Administrator o Useful Admin tools for managing the MES solution o Upgrading MES Framework Please read this manual before proceeding with the MES Framework installation. Introduction to MES Framework The Monitor Embedded Solutions (MES) Framework is a comprehensive embedded solution for Multi-Function Devices (MFDs). After authenticating at the MFD, users can be presented with a range of options on the MFD's touch screen, including releasing print jobs and using the device's native functions. The solution is server-based; each MFD is configured to run the solution from the one location, and when upgrades are performed on the server, any MFD running the MES solution is automatically updated. The MES Framework supports a range of MFD manufacturers and models, allowing sites with a mixed fleet of MFDs to present the same user interface across all devices. 1 Overview

7 Installation Guide This section details the steps necessary to install the MES Framework software and configure an MFD to run the Monitor Embedded Solution. The following topics are covered: Server requirements for the MES Framework installation Installing MES Framework Configuring an MFD to run the MES solution System Requirements MES Server Requirements Please ensure the following requirements are met on the server where the MES Framework will be installed. System Requirements A minimum of 384MB of available memory is required for any MES Framework installation. This is sufficient memory to run the MES solution on 1-4 MFDs. Each additional MFD requires a further 16MB of memory. Please refer to the following table to determine the available memory that will be required: Number of MFDs Required Memory MB 5 400MB MB MB MB MB MB MB It should also be taken into consideration what other applications are running on the server and what other loads are created within the server. It is recommended that the server where the MES Framework will be installed has a minimum of 4GB of RAM, however this is not necessary for smaller installations. The MES Framework supports up to 100 MFDs per installation. Please note that the MES Framework is not required to be installed on the same server as Supervisor Net Software Requirements The following software is required to be installed on the server where MES Framework will be installed: Microsoft.NET Framework 3.5 (will be installed as a part of the MES Framework installation if it is not already) Java version 7 or later (it is recommended that you download and install the latest version of Installation Guide 2

8 Java) The Java version installed on the sever must be 32 bit for 32 bit operating systems and 64 bit for 64 bit operating systems MES Server Ports The MES server must allow inbound connections on the following ports: UDP TCP The MES Framework installation will automatically open these ports on a Windows firewall. Supervisor Net Requirements The MES Framework requires Supervisor Net to license and configure MFDs running the MES solution. Supervisor Net can be installed on the same server as the MES Framework, or on a remote server. The following versions of Supervisor Net are compatible with the MES Framework: Version or later Supervisor Net License 1 x SHA (Sharp Embedded) Supervisor Net connection license is required per Sharp MFD. This license is obtained as a part of the installation and registration of Supervisor Net. Licenses can be viewed in the Help menu of Supervisor Net Administrator under Registration Details... Supervisor Net Server Ports If the MES Framework and Supervisor Net will not be installed on the same server, the Supervisor Net server must allow inbound TCP connections on the following ports: (Terminal Server Port) 8082 (Interface Server Port) Installing MES Framework Before proceeding with the installation, please note the following installation requirements: The server requirements detailed earlier in this manual must be met The logged in user performing the installation of the MES Framework must have full administrative rights to the server Supervisor Net is installed on the network To begin the installation of the MES Framework, run the MES.exe file. Select the installation path and proceed to the following screen: 3 Installation Guide

9 Select the solution that will be installed, then enter the Server Name/IP Address where Supervisor Net is installed (if the MES Framework will be installed on the same server as Supervisor Net, the default value of can be used). Now click Install if the installation path is correct, or Back to make any changes: Installation Guide 4

10 If Microsoft.NET Framework 3.5 is not currently installed, the MES Setup Wizard will prompt to install it. Accept the terms of the license agreement and click Install to continue. An internet connection is required to download the necessary files When the installation is complete the following screen is displayed: Select Run MES Administrator to open the MES Administrator interface, otherwise it can be opened by double-clicking on the MES Administrator desktop shortcut. Configuring an MFD for MES To run the MES solution, each MFD must be configured through its web interface. To do this, ensure the MFD is powered on and connected to the network, then web-browse to the IP address of the MFD. Log in using the MFD's administrator credentials, which by default are: User Name Password admin admin The example below is the login page for a Sharp MX-C311 MFD: 5 Installation Guide

11 Locate the External Accounting Application Settings by selecting Application Settings >> External Application Settings >> External Accounting Application Settings on the left side of the page: Enable External Account Control and check the Set Authentication Server (Server 1) box, then configure the fields detailed below: Installation Guide 6

12 Server 1 This must be set to Enable. Application Name A name for the external application - this will not be visible elsewhere. Address for Application UI This address can be copied from MES Administrator by right-clicking on the Monitor Embedded for Sharp OSA solution in the MES Configuration tab and selecting Copy UI URL To Clipboard as shown below: This address can now be pasted into the Address for Application UI field. If the MES Framework server address is , the Address for Application UI would be: Address for Web Service This address can be copied from MES Administrator by right-clicking on the Monitor Embedded for Sharp OSA solution in the MES Configuration tab and selecting Copy Web Services URL To Clipboard as shown below: This address can now be pasted into the Address for Web Service field. In the example above, the MES Framework server address is , therefore the Address for Web Service is as follows: Click Submit then Reboot Now to save the settings and restart the MFD. When the MFD has restarted it will connect to the server where the MES Framework is installed. The following page should be displayed: 7 Installation Guide

13 The name entered here will be the name of the terminal record created in Supervisor Net. It is recommended that this is the model or location of the MFD, or something unique to easily identify the MFD. To enter text, tap on the text field to display the popup keyboard. Press OK to proceed. The connection to the MES server will be restarted and the MFD will receive its configuration. The default Supervisor Net login prompt will be displayed: The MFD is now configured to run the MES solution. The next step is to configure the MES Installation Guide 8

14 solution to meet the site's requirements. Proceed to the on the next page. 9 Installation Guide

15 Recommended Security Measures It is recommended that certain steps are taken to ensure each MFD is secure so users are unable to bypass the Monitor Embedded solution. Please read the following suggestions. Secure Cabling Ensure that the power and network cables are securely connected to the MFD. Ideally a user would not be able to pull the network cable or power off the device during a session, however the MES solution will account for any usage of the MFD in this situation. Change the Admin Password The MFD's admin password should be changed from the default of 'admin'. To do this, webbrowse to the MFD's IP address and click on the Security Setting link on the left side of the page, then change the Administrator password and click Submit. Enable Filtering It is recommended that filtering is enabled on the MFD to restrict the locations from which a user can print to the device. An IP address range or individual MAC addresses can be configured to allow or deny printing to the MFD from those devices. This configuration is set in the device's web interface in the Security Settings by clicking on the Filter Setting link as shown below: 10

16 The filter can be enabled to allow or deny by IP address range or MAC address. Click Submit to save any changes. MES Administrator The MES Administrator interface can be accessed from the desktop shortcut that is created during the MES Framework installation, the Start Menu, or from the MES Framework installation directory. MES Administrator is where the MES Framework configuration can be set and deployed to any MFD running the MES solution, and contains many other features that are explained in this section. MES Configuration tab The MES Configuration tab contains the global MES settings. Any changes to the settings in this tab require the MES service to be restarted before the changes will take effect. 11

17 MES Service Configuration Base System Port The port number from which all ports of the MES Framework are based, including Tomcat and MFD connection ports. If the base port number is set to the default of then communication will occur on ports through 41099, therefore the firewall should be opened to allow communication on these ports. If the MES service is running when this port is configuration is changed, the service will automatically be restarted. Please read the MES Server Ports section of this manual for information about configuring a firewall for the MES Framework. MFD List Update Time The frequency in milliseconds that the MES updates the list of MFDs running the MES solution. MES Logging Verbosity The MES logging verbosity is the level at which the MES service records its internal logging. Tomcat Logging Verbosity The Tomcat logging verbosity is the level at which the servlets log information via UDP messages. For diagnostic purposes this should be set to debug. UDP Logging Verbosity The UDP logging verbosity is the level at which logging will be written to the MES service logs. For diagnostic purposes this should be set to debug. Tomcat Shutdown Time The time in seconds before the Tomcat is forcibly shutdown (terminated) by the MES Framework. MFD Session Shutdown Time The time in seconds that an MFD has been idle before the MES Framework will remove the MFD from the active devices list. The next communication from the device will start a new "session". This does not affect what the user will see on the device or how quickly an account will be authenticated. Supervisor Net Host/IP The host name or IP address of the server where Supervisor Net is installed. Supervisor Net Terminal Server Port The Terminal Server Port that is configured in the Supervisor Net Settings in Supervisor Net Administrator. This should be left at the default value of Supervisor Net Interface Server Port The Interface (SOAP) Server Port that is configured in the Supervisor Net Settings in Supervisor Net Administrator. This should be left at the default value of

18 HTTP Timeout Value The time in seconds before an HTTP request times out and is therefore abandoned. SMTP Setup MES SMTP Configuration is not applicable to the Sharp solution. Scan to must be configured on the MFD itself. Embedded Solutions Add Solution Click to install an embedded solution to the MES Framework. Solution Menu One or more of Monitor's embedded solutions can be installed and running on the same MES Framework installation. When a solution is installed it is added to the list of installed solutions as shown below: By selecting and right-clicking on the Monitor Embedded for Sharp OSA solution, the following menu options are displayed: Backup MFD Directory (available when MES the service is stopped) Backs up to file the directory where the configuration, database and graphics for the solution are stored. Restore MFD Archive (available when MES the service is stopped) Restore from file the directory where the configuration, database and graphics for the solution are stored. Copy UI URL To Clipboard Used during installation to copy the MES server application UI URL to the clipboard. 13

19 Copy Web Services URL To Clipboard Used during installation to copy the MES server web services URL to the clipboard. Modify OSA Model List Displays the list of supported Sharp OSA models. New models can be added and existing models modified or deleted. Perform MFD Maintenance Select a device or devices to view pending jobs, clean databases or remove from the MES Framework. Save Discard Remove Solution Completely removes the solution and the directory where the configuration, database and graphics for the solution are stored. Saves the current MES Service Configuration and SMTP Setup that has been set in the Configuration tab. The MES service must be restarted for any changes to take effect. Discards any changes made to the MES Service Configuration and SMTP Setup in the Configuration tab. MFD Configuration tab The MFD Configuration tab of MES Administrator contains all of the MES configuration options that can be applied to an MFD running the MES solution. When an MFD is configured to run Monitor's embedded solution for the first time, a Supervisor Net terminal record is created automatically and a unique ID is assigned to that record. Each terminal record is displayed in the MFD Configuration tab and it is here that the MES configuration is applied to each record. Each aspect of the MFD Configuration tab is detailed later in this section, however please note the process for editing and applying a configuration to an MFD: 1. Select the configuration template that will be applied to the MFD from the drop-down list and click Edit 2. Click Continue to edit the configuration 3. Make the necessary configuration changes and click Exit then Save to save the configuration changes 4. To send the new configuration settings to the MFD(s), go to the MFD/Service Status tab and select the affected MFDs from the list, then right-click and click Restart Selected When the MFD(s) have reconnected to the MES server, the configuration changes will have been successfully applied. 14

20 Configuration Selection The drop-down menu contains the list of all configuration templates. The selected configuration is the configuration that will be affected when clicking Edit Configuration or Delete Configuration. New Configuration Creates a new configuration template. The initial settings for the new configuration will be based on the "default" configuration template. Edit Configuration Edits the selected configuration template in the drop-down menu. Delete Configuration Deletes the selected configuration template in the drop-down menu. Solution Selection Determines which solution the MES will display terminal records for in the list of terminal records below. If All Solutions is ticked then any terminal records that are applicable to the MES Framework will be displayed in the list. If All Solutions is not selected then only terminal records associated with the selected Monitor embedded solution in the drop-down menu will be displayed in the list. Clicking Refresh will refresh the list of terminals. In the example below, the Sharp OSA solution is selected therefore only Sharp embedded terminal records will be displayed in the list: The list of terminals displays the ID, Name, Setup Type of the terminal records that have been created in Supervisor Net to allow the connection between the MFD and the MES Framework. The Configuration field shows the MFD configuration template that has been assigned to that particular terminal record. To assign a configuration template to one or many terminal records, select or multi-select the records from the Terminal Records list and right-click to select Apply Configuration to Selected. This will apply the configuration that is currently selected in the drop down list to the selected terminals. Edit Configuration Clicking Edit Configuration will firstly display the list of embedded terminal records that have this configuration assigned to them. 15

21 The following options are available: Exit Exits the Edit Configuration menu. Save As Saves the current configuration to a new configuration template. Continue Continue to the Edit Configuration menu to edit the currently selected configuration template. General tab Login Options The action after login. The following options are available: Normal Login The Usage Summary page is displayed after login. Print Release The Print Release page is displayed after login, all the user's print jobs are listed. If there are no print jobs to list, the user will be advised of this and then the usage summary page is displayed. MFD Functions The MFD's native functions are displayed after login. Print Release All All the user's jobs are released after login if they have sufficient funds to do so. If the user has insufficient funds to print all of their jobs they will be notified of this and their jobs will not be printed. They may still proceed to the print release page to view/print/delete their jobs. Disable Print Release After Entering MFD Functions This feature is not applicable to the Sharp OSA solution. Single Function Operation If enabled, the user will automatically be logged out of their session when they have either finished using the device's native functions, or have released all of their print jobs. If disabled, when the user has finished using the device's native functions or released all of the print jobs, the are returned to the MES usage summary screen, and may continue to use the MFD. Automatically Release Single Jobs If enabled, any user with one print job waiting for release will have their print job automatically printed out when they access the print release page. If the MES "Login Options" is set to Print Release and this option is enabled, when a user logs in with one print job waiting for release, it will automatically be printed and the usage page will be displayed reflecting the cost of the 16

22 print job. In either of these scenarios, if the user has more than one print job the print release page will be displayed as normal. MFD Functions When No Print Jobs Enter topic text here. Single Price/Flat Rate Scan Jobs If enabled, MES will charge monochrome and colour scan jobs at a flat rate, regardless of the number of pages scanned. This requires configuration in Supervisor Net Administrator in the "Embedded" Pricing Model that is used to charge for native functions on the device. Select the correct pricing model and click Edit. Then in the Variable Rates tab, scroll down to the first two empty pricing lines and configure number 29 as the flat rate for black and white, and number 30 as the flat rate for colour. An example is below: Number Name Code Count Price 29 Flat Rate Scan B&W Flat Rate Scan Colour 1.00 Regardless of the number of pages scanned there will only be a single charge for the transaction. Narration Text for Native Print Jobs Native print functions such as print from USB or print from network location are recorded in MES and Supervisor Net as "copy" transactions. Only print jobs sent to the MFD through the Monitor print system are recorded as "print" transactions in MES and Supervisor Net. This configuration allows text to be configured that will be recorded against the transaction in Supervisor Net, in the narration field of the transaction, to identify it as a native print transaction rather than a native copy transaction. MFD Functions Button Text The text on the button that is pressed to access the MFD's native functions. It is configurable to a maximum of 16 characters. Usage Screen Button Text The text for the button that returns the user to the MES usage summary screen, which is the default screen displayed after login. This button will not be displayed if the Login Option is set to Print Release. Password Entry Text The text for the prompt when a user is entering an external account and password for authentication. If this field is left blank the default value is Password >>. 17

23 Time (mins) Before MFD is Considered Offline When MES communication with an MFD fails, MES will continue to talk/listen to the MFD for the configured amount of time to attempt to reestablish the connection. If no communication occurs within that time period, MES will close the connection with the MFD and the device will be removed from the list of MFDs in the MFD/Service Status tab in MES Administrator. This communication failure will usually occur when the device loses power or network connection, however it can also occur when the device is in its native "sleep" mode. Time Before Clearing Inactive Jobs (hours) The amount of time a copy/scan job can remain pending before it is cleared out of the MES database. This will not remove and pending jobs from the MFD itself, but is a useful tool for when MES does not receive a job finish notification from the MFD and the user's job remains pending in MES, preventing them from logging in at another MFD. Use Uppercase Searching Forces any user-entered data to uppercase for searching in Supervisor Net, e.g. Secondary accounts. Disable Logout With Pending Jobs When enabled, a user may not log out of their session before their jobs have finished printing/ sending. If they attempt to logout before their jobs have finished, a message is displayed advising them they must wait. Allow Login With Paused Jobs This feature is not applicable to the Sharp solution. Automatically Disable Session Timeout Disables the session timeout that is configured in the terminal setup record in Supervisor Net. A logged in user will never be logged out automatically after a period of time, they must log out manually from the MFD. Number of Decimal Places The number of decimal places that are displayed for the user's balance and transaction costs at the Transaction Summary page. Separate Page Information When enabled separates the Colour and Black & White page count and cost at the MES usage summary screen. Auto Sense Auto Accept The terminal will automatically enter Auto Accept mode when it can no longer communicate with the Supervisor Net server but can still detect a network connection. Auto Accept mode looks identical to normal terminal operation, and enables the device to be used in the event of the link to Supervisor Net being broken. As soon as the server is detected again, the terminal will exit Auto Accept mode and unload any transactions that have occurred during the outage. Auto Accept Limit Specifies the limit each user can spend when the terminal is in Auto Accept mode. The amount a user spends in multiple sessions is tracked, so the user cannot simply log out and log back in once they've reached the limit. 18

24 Auto Accept Price Code The price code that will be applied to all transactions while in Auto Accept mode. This is because the individual user's price code is not known while in Auto Accept mode. Allow Session Hold This enables a user to press the Session Hold button while logged in to the MFD and place that session on hold. This will prevent someone else using the device while they are away. To exit the session hold and resume their session, the user can either swipe their card at the MFD or press the logout button and enter their credentials. Session hold can be configured to last up to 10 minutes before it will end the user's session and allow someone else to use the device. Session Hold Times (mins) The number of minutes the device will remain on hold before it ends the user's session and unload their transaction. Disable A3 Count Halving Enabling this feature disables A3 count halving on the device. This is for devices that do not double the pulse counts for A3 sheets, which was necessary when external hardware terminals were attached to MFDs and required double pulse counts to correctly read the paper size as A3. If it appears fewer pages are being counted than has actually been printed it may be necessary to enable this option. Prompt For Colour Selection After login the user is prompted whether they wish to perform jobs with colour content. This function will enable the user to log in and perform black and white jobs, even if they don't have enough money for colour jobs. If they choose No at this menu, they will not be able to perform colour jobs once they log into the MFD. Use Highest Price for Counts When enabled, the user is limited to the number of copies their balance allows if the job was charged at the highest price set in the associated pricing model. For example, if an A4 black and white job costs 10c per page, and an A4 colour job costs 50c per page, with this feature enabled, if the user chooses to make black and white copies, they will only be able to make the number of copies their balance allows if it was charged at the colour price, as this is the higher price. This is a safety measure for sites that do not want to allow the possibility of a user's account going into negative. Prompt for Print Release ID Prompts the user to enter the print job owner to retrieve print jobs for that user. The print job owner is the name associated with a print job based on the user that is logged in to the workstation from which the print job was printed. Print Release ID Prompt The prompt that is displayed to the user when Prompt For Print Release ID is enabled. It is configurable to a maximum of 40 characters. 19

25 Card Setup tab For security reasons, the MES solution requires that the reader used for authentication is configured with start and end sentinels. The card reader must be configured to use a semicolon as the start sentinel and a question mark as the end sentinel, as shown below: Start Sentinel End Sentinel ;? The configuration options found in the Card Setup tab are explained below. Card Track The MES solution will interpret data differently depending on which magnetic track is being used. This setting must be changed to match the track being used by the magnetic card reader. The options are either Track 1 or Track 2. Track 1 Field Each track format contains multiple fields of information, you may only want to read the information from one of the fields on the card. A typical Track 1 card number would look like: B ^OWNERS NAME^ Track 1 cards can contain alpha-numeric characters. The different fields of information are separated by carats ( ^ ). Typically, a site would use the first field of information for identification purposes. Track 1 options: Entire Track 1 Data The MES solution will read the contents of the entire track Track 1 FORMAT/PAN Only the first field of information is read Track 1 NAME Only the second field of information is read Track 1 ADDITIONAL Only the third field of information is read Track 2 Field Each track format contains multiple fields of information, you may only want to read the information from one of the fields on the card. A typical Track 2 card number would look like: = Track 2 cards contain only numeric and special characters. They usually have one or two 20

26 fields of information, separated by an equals = character. Track 2 options: Entire Track 2 Data The MES solution will read the contents of the entire track Track 2 PAN Only the first field of information is read Track 2 ADDITIONAL Only the second field of information is read Monitor Card Prefix Any card beginning with this prefix will be considered a Monitor Card. A site can be configured to only accept Monitor Cards in the terminal setup record. In this situation, any card swiped which does not begin with this prefix will be rejected. Allow Card Association With this feature enabled, a user with an active network account can associate a new or replacement card with a new or existing Supervisor Net account simply by swiping/presenting the card and entering their network login and password. This feature is useful in two scenarios. Firstly, if a user has been given a replacement card, they can swipe the new card at the MFD and enter their network login and password to associate the new card number with their Supervisor Net account. The new card number will replace their existing number in the Supervisor Net database, so at their next login they can swipe their new card as normal. Their original card will no longer be valid so if it has been lost or stolen it cannot be used to access the user's account. The second scenario is when a new user already has a network login and a card but they do not have a Supervisor Net account. They can use the card association feature to create a new account in Supervisor Net, without the need of an administrator to manually add them to the database. This feature requires Supervisor Net to be configured for LDAP authentication. This configuration is found in Supervisor Net Administrator in the Supervisor Net Settings menu, under the "LDAP" tab. Use PIN This option determines whether a PIN may be required at login. If Use PIN is enabled, the user's PIN setting in Supervisor Net primary record will determine whether they are prompted to enter a PIN at login. If Use PIN is disabled, the user will never be prompted to enter a PIN at login, regardless of their PIN setting in Supervisor Net. Allow Set No PIN If it is detected that the user must enter a new PIN number at login (as configured in their user record in Supervisor Net), turning this option on gives the user the ability to not set a new PIN at this time by entering a blank PIN number. Once the user has set a blank PIN, they will not be prompted again to enter a PIN. 21

27 Disable PIN Change If enabled users will not be able to change their PIN at the MFD. Ignore Cards In Session Enabling this option will force the MES solution to ignore any cards swiped whilst in a session. When it is disabled, a card swipe will end the current user's session. Display Card Processing Displays a message advising the user their card data is being processed. Card Prefix 2-4 Defines an additional 3 prefixes for the MES solution to look for when deciding how much of an offset or number length to use. As an example, a site may want staff cards starting with to have a length of 10 and an offset of 1, however student cards starting with 4445 to have a length of 20 and an offset of 4. Up to 4 number lengths and offsets in total may be defined, including the system wide length and offset, as defined in Supervisor Net. Card Offset 2-4 The offset to apply to the cards matching the prefixes 2-4. Card Length 2-4 The card length to process matching the prefixes 2-4. Restrictions tab The Restrictions tab contains the definitions of which price codes (1-10) can and cannot perform colour copies. If a price code is ticked, any user with that price code will not be able to perform colour copies. Themes tab Disable Copy Row in table Removes the Copy row from view at the usage summary page. Disable Print Row in table Removes the Print row from view at the usage summary page. Disable Scan Row in table Removes the Scan row from view at the usage summary page. Disable Fax Row in table Removes the Fax row from view at the usage summary page. Enable Entry Watermarks Enables the option to configure instructions within the text field at a prompt. The instructions are displayed in the text field and are replaced by any text entered by the user. An example is below: 22

28 Primary Entry Watermark Instructions that are displayed in the primary number entry field e.g. Tap here to enter your user code. PIN Entry Watermark Instructions that are displayed in the PIN entry field e.g. Tap here to enter your PIN. Secondary Entry Watermark Instructions that are displayed in the secondary number entry field e.g. Tap here to enter your department code. Auxiliary Entry Watermark Instructions that are displayed in the auxiliary number entry field e.g. tap here to enter your auxiliary code. Login Instructions Text Size The font size of the configured login instructions. Login Instructions Font Family The font type of the configured login instructions. Login Instructions Centred Centre-aligns the configured login instructions. Login Instructions Text Instructions that are displayed at the login page on the MFD. Session Instructions Text This feature is not applicable to the Sharp OSA solution. Site Branding A site may wish to brand the MES solution with their own logo. The logo will be visible at the top of the screen to the left of the Monitor logo. 23

29 To add a logo, click Browse next to the field that is configured to use the SiteBranding.png file as shown below: Browse and select the logo image file that will be used. Please note that the logo image file that will be used must be: A 24 bit PNG file 390 x 40 in dimension Debug tab Verbosity The debug Verbosity menu contains a list of possible logging options. The higher in the list an option is, the more information that is recorded in the logging. Full debugging information The maximum amount of diagnostic information is recorded. This includes special debugging messages intended for diagnosing unusual conditions requiring input from a Monitor developer. Messages and above Records fatal errors, standard errors, warning messages and more verbose messages. Warnings and above Records fatal errors, errors and warnings. Errors and above Records non fatal (standard) errors and fatal errors. Fatal errors and above Only records errors resulting in the MES solution no longer being able to continue. Debug information OFF Disables debug logging. Enable UDP Debug Output UDP debug output is necessary to enable log messages to be logged at the MES service. Without this option NO logging information will be written to the MES service logs. It is suggested that this option is left enabled. Enable Supervisor Packet Logging This option allows logging of the Supervisor Net TCP communications per device. This is useful for diagnostics but in most cases will never be enabled. It is suggested that this option is left disabled. 24

30 Exit Exits the Edit Configuration menu. If no changes have been made then it will exit at the first click. If configuration changes have been made a window is displayed with the option to save or discard the changes. To apply any changes made, the MFD(s) must be restarted in MES Administrator in the MFD/ Service Status tab by right-clicking on the device(s) and clicking Restart Selected. MFD/Service Status tab MES Service Status MFD List Restart, start and stop the MES service. This will affect any MFDs connected to the MES server. Terminal ID The Supervisor Net terminal ID that has been assigned to the MFD. Terminal Name The name of the Supervisor Net terminal record that is associated with the MFD. MFD Unique ID # The ID of the MFD which includes the model number of the device. MFD IP Address The IP address of the MFD. MFD Status - Connected to Supervisor Net with a valid terminal ID - Connecting to Supervisor Net - Out of Service; invalid terminal ID or cannot connect to Supervisor Net - A user is in session on this device 25

31 Product The name of the Monitor Embedded Solution controlling the device. Configuration The MFD configuration that has been assigned to the device in the MFD Configuration tab of MES Administrator. The default setting is "Default". Right-Click Menu Access the following menu by right-clicking on one or more MFDs listed in the MFD/Service Status tab: Restart Selected Restarts the selected MFD's connection to the MES server. When a configuration change is made in MES or Supervisor Net, use this option to reconnect the affected MFDs to MES to apply the new configuration. Clear Selected Terminal IDs Removes the assigned terminal ID(s) from the selected MFD(s) so a new one can be assigned. Enable/Disable Sharp OSA Key Filtering Some OSA4 devices have an external keyboard and can been configured to prefer the external keyboard for input. In this scenario the user will see that each button they press on the keyboard will be entered twice on the screen, e.g. entering 1234 will show as The Sharp OSA key filtering must be enabled to correctly submit any data that is entered using the keyboard. This option is disabled by default. Charge Scan Per Destination Select this option to charge by the number of recipients when using the scan to function. Charge Scan Once Only Select this option to charge one flat rate when scanning to multiple addresses. 26

32 Spy on Device Opens a window to view the current MES page that is being displayed on the MFD's touch screen. It will not display any of the device's native pages. Simulate Card Data Simulates a card being presented at the MFD. Any data entered here will be authenticated at the device as if a card was a presented. Role Based Access Control tab This feature is not applicable to the Sharp OSA solution. Product Information tab Admin Tools The Product Information tab contains the MES Framework version number and information regarding the minimum required version of Supervisor Net. Accessing the MFD's System Menu The MFD's system menu can be accessed using a web browser or at the device's touch screen. To log in using a web browser: Browse to the MFD's IP address and enter the Administrator user's credentials. To log in at the MFD: Press the SYSTEM SETTINGS hard key and enter the Administrator user's credentials. Remote Access to an MFD VNC applications can be used to remotely access and operate an MFD. This can be achieved by entering the IP address of the MFD in the VNC application, however the MFD will display a prompt on its touch screen asking to allow or deny the remote access. Each MFD can be configured to automatically allow VNC connections from a particular IP address, and will therefore not display the prompt asking to allow or deny the access, giving the remote user control of the MFD immediately. To configure the IP address to allow automatic VNC connection to an MFD, browse to the MFD's IP address and log in using the Administrator user's credentials. Locate the Remote Operation Settings by selecting System Settings >> Operation Settings: 27

33 Configure the options as shown above, where the Hostname or IP Address of PC is the server from which the VNC application will be run. MFD Counters Click Submit to save the settings. To view the device's internal counters, log in at the MFD and press the MFD Functions button. When the device's native functions are available, press and hold the COPY button to display the counters: Upgrading MES Framework The MES Framework can be upgraded or downgraded by simply running the new MES Framework installation package. The MES Administrator window will automatically close (if currently open) and the MES service will be stopped to perform the upgrade, then restarted 28

34 when it is complete. Once the installation is complete there is no further action required. 29

35 Monitor Business Machines Ltd. 31a Normanby Road, Mt Eden, Auckland 1024, New Zealand. Phone: Web: