monitor embedded for toshiba embedded for toshiba 7.… · mfd/service status ta..b ... the monitor...
TRANSCRIPT
Monitor Embedded forToshiba
Product Manual
www.monitorbm.com
The software contains proprietary information of MonitorBusiness Machines Ltd. It is provided under a licenseagreement containing restrictions on use anddisclosure and is also protected by copyright law.Reverse engineering of the software is prohibited.
Information in this document is subject to changewithout notice. Companies, names, and data used inexamples herein are fictitious unless otherwise noted.No part of this document may be reproduced ortransmitted in any form or by any means, electronic ormechanical, for any purpose, without the express writtenpermission of Monitor Business Machines Ltd.
All rights reserved. No part of this work may bereproduced in any form or by any means - graphic,electronic, or mechanical, including photocopying,recording, taping, or information storage and retrievalsystems - without the written permission of thepublisher.
While every precaution has been taken in thepreparation of this document, the publisher and theauthor assume no responsibility for errors oromissions, or for damages resulting from the use ofinformation contained in this document or from the useof programs and source code that may accompany it. Inno event shall the publisher and the author be liable forany loss of profit or any other commercial damagecaused or alleged to have been caused directly orindirectly by this document.
Monitor Business Machines Ltd.31a Normanby Road,Mt Eden,Auckland 1024,NEW ZEALAND
Published: 10/07/2013
Monitor Embedded Solutions Product Manual
© 2013 Monitor Business Machines Ltd
The Monitor Logo and Supervisor™ are registeredtrademarks of Monitor Business Machines Ltd.
Any other products that are referred to in this documentmay be either trademarks and/or registered trademarksof the respective owners. The publisher and the authormake no claim to these trademarks.
iContents
Contents
Introduction to MES Framework 1
................................................................................................................................... 1What's in this Manual
Installation Guide 2
................................................................................................................................... 2List of Supported Devices
......................................................................................................................................................... 3Supported Card Readers
................................................................................................................................... 4Server Requirements
......................................................................................................................................................... 4MES Server Requirements
.................................................................................................................................................. 4System Requirements
.................................................................................................................................................. 5Softw are Requirements
.................................................................................................................................................. 5MES Server Ports
......................................................................................................................................................... 5Supervisor Net Requirements
.................................................................................................................................................. 6Supervisor Net License
.................................................................................................................................................. 6Supervisor Net Server Ports
................................................................................................................................... 6Installation
................................................................................................................................... 7Configuring an MFD for MES
......................................................................................................................................................... 8Step 1 - Service Mode Configuration
......................................................................................................................................................... 11Step 2 - Web Interface Configuration
.................................................................................................................................................. 11Directory Service
.................................................................................................................................................. 13Embedded Web Brow ser
.................................................................................................................................................. 14User Authentication
........................................................................................................................................... 16Department Setting
........................................................................................................................................... 16User Authentication Setting
........................................................................................................................................... 17Role Based Access Setting
........................................................................................................................................... 17PIN Code Authentication Setting
........................................................................................................................................... 18Card Authentication Setting
........................................................................................................................................... 18Email Authentication
........................................................................................................................................... 18Email Address Setting
.................................................................................................................................................. 19Print Data Converter
......................................................................................................................................................... 20Step 3 - Connect the MFD to MES
......................................................................................................................................................... 22What's Next
Administrator Guide 23
................................................................................................................................... 23Tools & Tips
......................................................................................................................................................... 23Security Measures
.................................................................................................................................................. 23Change the Admin Passw ord
.................................................................................................................................................. 23Enable Filtering
.................................................................................................................................................. 24Secure Cabling
......................................................................................................................................................... 24Energy Save
......................................................................................................................................................... 25MFD Counters
................................................................................................................................... 25Supervisor Net Configuration
................................................................................................................................... 27Using MES Administrator
......................................................................................................................................................... 28MES Configuration tab
.................................................................................................................................................. 28MES Service Configuration
........................................................................................................................................... 28Base System Port
........................................................................................................................................... 28MFD List Update Time
........................................................................................................................................... 28MES Logging Verbosity
........................................................................................................................................... 28Tomcat Logging Verbosity
........................................................................................................................................... 29UDP Logging Verbosity
........................................................................................................................................... 29Tomcat Shutdow n Time
........................................................................................................................................... 29MFD Session Shutdow n Time
Contentsii
........................................................................................................................................... 29Supervisor Net Host/IP
........................................................................................................................................... 29Supervisor Net Terminal Server Port
........................................................................................................................................... 29Supervisor Net Interface Server Port
........................................................................................................................................... 29HTTP Timeout Value
.................................................................................................................................................. 29SMTP Setup
.................................................................................................................................................. 29Embedded Solutions
........................................................................................................................................... 29Add Solution
........................................................................................................................................... 29Solution Menu
.................................................................................................................................................. 30Save
.................................................................................................................................................. 30Discard
......................................................................................................................................................... 30MFD Configuration tab
.................................................................................................................................................. 31Configuration Selection
.................................................................................................................................................. 31Solution Selection
.................................................................................................................................................. 32Edit Configuration
........................................................................................................................................... 32General tab
...................................................................................................................................... 32Login Options
...................................................................................................................................... 33Single Function Operation
...................................................................................................................................... 33Automatically Release Single Jobs
...................................................................................................................................... 33Single Price/Flat Rate Scan Jobs
...................................................................................................................................... 33Narration Text for Native Print Jobs
...................................................................................................................................... 33MFD Functions Button Text
...................................................................................................................................... 34Usage Screen Button Text
...................................................................................................................................... 34Passw ord Entry Text
...................................................................................................................................... 34Time Before MFD is 'Dirty' (mins)
...................................................................................................................................... 34Time Before Clearing Inactive Jobs (hours)
...................................................................................................................................... 34Use Uppercase Searching
...................................................................................................................................... 34Disable Logout With Pending Jobs
...................................................................................................................................... 34Allow Login With Paused Jobs
...................................................................................................................................... 34Automatically Disable Session Timeout
...................................................................................................................................... 34Number of Decimal Places
...................................................................................................................................... 34Separate Page Information
...................................................................................................................................... 34Auto Sense Auto Accept
...................................................................................................................................... 35Auto Accept Limit
...................................................................................................................................... 35Auto Accept Price Code
...................................................................................................................................... 35Allow Session Hold
...................................................................................................................................... 35Disable A3 Count Halving
...................................................................................................................................... 35Prompt For Colour Selection
...................................................................................................................................... 35Use Highest Price for Counts
...................................................................................................................................... 35Prompt for Print Release ID
...................................................................................................................................... 35Print Release ID Prompt
........................................................................................................................................... 35Card Setup tab
...................................................................................................................................... 35Card Track
...................................................................................................................................... 36Track 1 Field
...................................................................................................................................... 36Track 2 Field
...................................................................................................................................... 37Monitor Card Prefix
...................................................................................................................................... 37Allow Card Association
...................................................................................................................................... 37Use PIN
...................................................................................................................................... 37Allow Set No PIN
...................................................................................................................................... 37Disable PIN Change
...................................................................................................................................... 37Ignore Cards In Session
...................................................................................................................................... 37Display Card Processing
...................................................................................................................................... 37Card Prefix 2-4
...................................................................................................................................... 37Card Offset 2-4
...................................................................................................................................... 37Card Length 2-4
........................................................................................................................................... 37Restrictions tab
........................................................................................................................................... 37Themes tab
...................................................................................................................................... 37Disable Copy Row in table
iiiContents
...................................................................................................................................... 38Disable Print Row in table
...................................................................................................................................... 38Disable Scan Row in table
...................................................................................................................................... 38Disable Fax Row in table
...................................................................................................................................... 38Enable Entry Watermarks
...................................................................................................................................... 38Login Instructions Text Size
...................................................................................................................................... 38Login Instructions Font Family
...................................................................................................................................... 38Login Instructions Centred
...................................................................................................................................... 38Login Instructions Text
...................................................................................................................................... 38Site Branding
........................................................................................................................................... 38Debug tab
...................................................................................................................................... 38Verbosity
...................................................................................................................................... 39Enable UDP Debug Output
...................................................................................................................................... 39Enable Supervisor Packet Logging
........................................................................................................................................... 39Exit
......................................................................................................................................................... 39MFD/Service Status tab
.................................................................................................................................................. 39MES Service Status
.................................................................................................................................................. 40MFD List
........................................................................................................................................... 40Terminal ID
........................................................................................................................................... 40Terminal Name
........................................................................................................................................... 40MFD Unique ID #
........................................................................................................................................... 40MFD IP Address
........................................................................................................................................... 40MFD Status
........................................................................................................................................... 40Product
........................................................................................................................................... 40Configuration
........................................................................................................................................... 40Right-Click Menu
...................................................................................................................................... 41Restart Selected
...................................................................................................................................... 41Clear Selected Terminal IDs
...................................................................................................................................... 41Spy on Device
...................................................................................................................................... 41Simulate Card Data
......................................................................................................................................................... 41Role Based Access Control tab
......................................................................................................................................................... 41MES Administrator Logging tab
......................................................................................................................................................... 41Product Information tab
................................................................................................................................... 41MES Framework Logging
................................................................................................................................... 42Upgrading MES Framework
User Guide 43
................................................................................................................................... 43Login
................................................................................................................................... 45Enter Department
................................................................................................................................... 45Usage Screen
................................................................................................................................... 46Print Release
................................................................................................................................... 48Logout
Introduction to MES Framework1
Introduction to MES Framework
The Monitor Embedded Solutions (MES) Framework is a comprehensive server-basedembedded solution for Multi-Function Devices (MFDs). The solution is hosted on a centralserver rather than installed on each MFD, so installation and upgrades are performed in theone location, and each MFD running MES is automatically updated.
After authenticating at the MFD, the user can be presented with a range of options on theMFD's touch screen, including releasing print jobs and using the device's native functions.
The MES Framework is cross-platform, meaning it supports a range of MFD manufacturersand models, allowing sites with a mixed fleet of devices to present the same user interfaceacross all MFDs.
What's in this Manual
The Monitor Embedded for Toshiba Product Manual is a comprehensive guide to installing,configuring and using Monitor's embedded solution for Toshiba. The manual is separated intothree sections, which are detailed below:
Installation Guide:
- Supported Toshiba MFDs and card readers
- Installation requirements
- Installing the MES Framework
- Initial configuration required to run the MES solution on an MFD
Administration Guide:
- Recommended security measures to prevent users bypassing the MES solution
- Using MES Administrator
- MES logging information
- Upgrading MES Framework
User Guide
Please read this manual before proceeding with the MES Framework installation.
2Installation Guide
Installation Guide
There are two files that will be used during the installation and configuration of the MonitorEmbedded solution for Toshiba:
MES.exe - the MES Framework installation file
Print Data Converter.xml - installed on each MFD to enable secure print release
The following topics are covered in this section:
List of supported devices and card readers
Server requirements for the MES Framework installation
Installing MES Framework
Configuring an MFD to run the MES solution
List of Supported Devices
The Toshiba devices that are supported by the MES Framework are listed below.
To locate a device's firmware version, access the Toshiba TopAccess menu by web-browsingto the IP address of the MFD and log in as an Administrator. After logging in, go to theAdministration tab, then the Version tab. The first four and last four digits of the "CopierFirmware Version" is the device's firmware. E.g. if the Copier Firmware Version isT140HD0W3403, then the device's firmware is T140* 3403.
Supported devices from the LOIRE product family (B&W only)
Model Required Options Min. Firmware
e STUDIO 206L GS1020 (EWB); Print, Scan, Fax as required T160* 1603
e STUDIO 256, 256SE GS1020 (EWB); Print, Scan, Fax as required T160* 1603
e STUDIO 306, 306SE GS1020 (EWB); Print, Scan, Fax as required T160* 1603
e STUDIO 356, 356SE GS1020 (EWB); Print, Scan, Fax as required T160* 1603
e STUDIO 456, 456SE GS1020 (EWB); Print, Scan, Fax as required T160* 1603
Supported devices from the ALABAMA product family (B&W only):
Model Required Options Min. Firmware
e STUDIO 556, 556SE GS1020 (EWB); Print, Scan, Fax as required T190* 1603
e STUDIO 656, 656SE GS1020 (EWB); Print, Scan, Fax as required T190* 1603
e STUDIO 756, 756SE GS1020 (EWB); Print, Scan, Fax as required T190* 1603
e STUDIO 856, 856SE GS1020 (EWB); Print, Scan, Fax as required T190* 1603
Supported devices from the ST HELENS product family (A4 only):
Model Required Options Min. Firmware
eSTUDIO 287CS GS1020 (EWB); Fax as required T280* 2146
eSTUDIO 347CS GS1020 (EWB); Fax as required T280* 2146
Installation Guide3
eSTUDIO 407CS GS1020 (EWB); Fax as required T280* 2146
Supported devices from the WEISS product family:
Model Required Options Min. Firmware
eSTUDIO 2050C GS1020 (EWB); No Hard Disk Drive;
Fax as required
T210* 1518
eSTUDIO 2050C GS1020 (EWB); GE1220 (Hard Disk Drive);
Fax as required
T569* 1518
eSTUDIO 2550C GS1020 (EWB); No Hard Disk Drive;
Fax as required
T210* 1518
eSTUDIO 2550C GS1020 (EWB); GE1220 (Hard Disk Drive);
Fax as required
T569* 1518
Supported devices from the MASHERBRUM product family:
Model Required Options Min. Firmware
eSTUDIO 2040C, 2040CSE GS1020 (EWB); Fax as required T140* 3403
eSTUDIO 2540C, 2540CSE GS1020 (EWB); Fax as required T140* 3403
eSTUDIO 3040C, 3040CSE GS1020 (EWB); Fax as required T140* 3403
eSTUDIO 3540C, 3540CSE GS1020 (EWB); Fax as required T140* 3403
eSTUDIO 4540C, 4540CSE GS1020 (EWB); Fax as required T140* 3403
Supported devices from the BROAD PEAK product family:
Model Required Options Min. Firmware
eSTUDIO 5540C, 5540CSE GS1020 (EWB); Fax as required T130* 3403
eSTUDIO 6540C, 6540CSE GS1020 (EWB); Fax as required T130* 3403
eSTUDIO 6550C, 6550CSE GS1020 (EWB); Fax as required T130* 3403
Supported Card Readers
Toshiba MFDs support the following card readers for authentication:
Reader Card Technology Supported Frequency Part Number Code
Toshiba IDGate HID iCLASS HID iCLASS 13.56MHz KP2004 40002
Toshiba IDGate Mifare Mifare Classic 1k, 4k 13.56MHz KP2005 30001
Elatec HID Prox HID PROX 125kHz ART11229 90001
Elatec Multi 125 EM4102, EM4105, EM4200, EM4150,
EM4350, EM4450
FDX-B
HITAG 1, HITAG 2, HITAG S
MIRO
Q5
T5557, T5567, T5577
TITAN
UNIQUE
ZOODIAC
125kHz ART11241 90001
4Installation Guide
Elatec Inditag Indala
Flexpass125kHz ART12469 90001
Elatec Mifare ISO14443A
Mifare Classic 1k, 4k
Mifare DESfire
Mifare Mini
Mifare Plus S, X
Mifare Pro X
Mifare SmartMX
Mifare Ultralight/C
Legic Advant
SLE44R35, SLE66Rxx
13.56MHz ART11223 90001
Elatec Multi ISO Mifare Classic 1k, 4k
Mifare DESfire
Mifare Mini
Mifare Plus S, X
Mifare Pro X
Mifare SmartMX
Mifare Ultralight/C
Legic Advant
SLE44R35, SLE66Rxx
my-d move
ISO14443A, ISO14443B
Calypso, CEPAS
Moneo
SRI512, SRT512, SRI4K, SRIX4K
ISO15693
EM4033, EM4233, EM4135, ICODE SLI
Inside Picopass
HID iClass, Tag-it
Legic Advant, my-d
13.56MHz ART12442 90001
Elatec HID iCLASS HID iCLASS
ISO14443A, ISO14443B, ISO1569313.56MHz ART11235 90001
Elatec Legic Legic Prime
Legic Advant
ISO14443A, ISO15693
13.56MHz ART11247 90001
Magtek Dynamag ISO 7810, ISO 7811
AAMVAN/A PN-21073062 70001
Keyboard Emulation* 60001
*Support can be added manually for a card reader if it supports keyboard emulationmode. The Product and Vendor ID must be supplied to Toshiba so the codes can beinstalled to the MFD via USB. Please consult a Toshiba technician for moreinformation.
Note: If a factory reset is performed on the MFD, these codes will be lost and must bereinstalled.
Server Requirements
MES Server Requirements
Please ensure the following requirements are met on the server where the MES Frameworkwill 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 requiresa further 16MB of memory.
Installation Guide5
Please refer to the following table to determine the available memory that will be required:
Number of MFDs Required Memory
1-4 384MB
5 400MB
10 480MB
20 640MB
30 800MB
50 1120MB
75 1520MB
100 1920MB
It should also be taken into consideration what other applications are running on the server andwhat other loads are created within the server. It is recommended that the server where theMES Framework will be installed has a minimum of 4GB of RAM, however this is notnecessary for smaller installations. The MES Framework supports up to 100 MFDs perinstallation.
Please note that the MES Framework is not requiredto 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 beinstalled:
Microsoft .NET Framework 3.5 (will be installed as a part of the MES Framework installationif it is not already)
Java version 7 or later (it is recommended that you download and install the latest version ofJava)
The Java version installed on the sever must be 32 bit for 32bit 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
41000 41001-41099
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 MESsolution. Supervisor Net can be installed on the same server as the MES Framework, or on aremote server.
The following versions of Supervisor Net are compatible with the MES Framework:
6Installation Guide
Version 7.2.13 or later
Supervisor Net License
1 x TOS (Toshiba Embedded) Supervisor Net connection license is required per Toshiba 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 RegistrationDetails...
Supervisor Net Server Ports
If the MES Framework and Supervisor Net will not be installed on the same server, theSupervisor Net server must allow inbound TCP connections on the following ports:
10002 (Terminal Server Port)
8082 (Interface Server Port)
Installation
Before proceeding with the installation, please note the following installationrequirements:
The server requirements detailed earlier in this must be met
The logged in user performing the installation of the MES Framework must have fulladministrative 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:
Select the solution that will be installed, then enter the Server Name/IP Address whereSupervisor Net is installed (if the MES Framework will be installed on the same server asSupervisor Net, the default value of 127.0.0.1 can be used).
Now click Install if the installation path is correct, or Back to make any changes:
Installation Guide7
If Microsoft .NET Framework 3.5 is not currently installed, the MES Setup Wizardwill prompt to install it. Accept the terms of the license agreement and click Installto 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 beopened by double-clicking on the MES Administrator desktop shortcut.
Configuring an MFD for MES
To run the MES solution, the MFD must be configured in the following areas:
In Service Mode at the device
In the TopAccess menu which is accessed by web-browsing to the device's IP address
At the device's touch screen
8Installation Guide
Please read the following instructions carefully as each step is necessary to successfully runthe MES solution on a Toshiba MFD.
Step 1 - Service Mode Configuration
Some configuration must be performed at the device, in "Service Mode". The instructions forentering, configuring and exiting Service Mode are below. The configuration options that mustbe configured in Service Mode are found below the instructions.
Follow these instructions to enter Service Mode
1. Ensure the MFD is powered off at the main switch
2. Hold the '0' key and the '8' key together while powering on the device and hold for 10seconds
3. Wait for the device to enter Service Mode, this can take up to 30 seconds
4. When presented with Service Mode authentication, press OK on the touch screen (there isno need to enter a password)
Follow these instructions to edit a configuration in Service Mode
Each option must be configured individually by entering its unique code:
1. Enter the configuration option's 4 digit code. The code will appear up the top left of thescreen
2. Press the Start button to edit that configuration
3. If the configuration requires text to be entered, a keyboard will be displayed with the currentconfiguration in the text field. If the configuration should be changed, clear the text field andenter the new configuration on the keyboard
4. If the configuration requires a numeric value, the current configuration will be displayed twiceon the screen side by side. If the configuration should be changed, enter the newconfiguration by using the device's numeric hard keys. The new configuration should bedisplayed to the right of the old configuration
5. Press OK to save the configuration
6. To edit the next configuration, follow steps 1-5 again
Follow these instructions to exit Service Mode
1. Press and hold the power On/Off button next to the MFD's touch screen
2. Press the power On/Off button again to start the MFD
Each option that must be configured in Service Mode to run the MES solution on a ToshibaMFD is detailed in the table below. Use the instructions above as a guideline to makingconfiguration changes in Service Mode, however there are also specific instructions in thetable below for each option that must be configured. In some cases the default value will bethe same as the value that must be configured for the MES solution, so the configuration maynot need to be changed.
Installation Guide9
The following configuration is mandatory for the MES solution.
Name/Description Code Instructions
Custom Counter
Enable the CustomCounter
for scanning
6080 1. Enter code 6080
2. Press the Start button
3. Enter 1 as the configuration using thehard keys
4. Press OK on the touch screen
B&W Scan Weight 6081 1. Enter code 6081
2. Press the Start button
3. Enter subcode 0 (screen will display"0%")
4. Press the Start button
5. Enter 100 as the configuration using thehard keys
6. Press OK on the touch screen
Colour Scan Weight 6081 1. Enter code 6081
2. Press the Start button
3. Enter subcode 1 (screen will display"1%")
4. Press the Start button
5. Enter 100 as the configuration using thehard keys
6. Press OK on the touch screen
Quota Setting
Enable Quota Settingmenu
6086 1. Enter code 6086
2. Press the Start button
3. Enter 1 as the configuration using thehard keys
4. Press OK on the touch screen
Embedded WebBrowser
Enable the MFD'sEmbedded WebBrowser for the MESsolution
9132 1. Enter code 9132
2. Press the Start button
3. Enter 99 as the configuration using thehard keys
4. Press OK on the touch screen
LDAP Server Attribute
LDAP field that will beused to look up a user'scard number
9398 1. Enter code 9398
2. Press the Start button
3. Enter eBMUserCard as the configurationon the keyboard
4. Press OK on the touch screen
Extension Button Text
The button that returnsthe user from the MFD'snative functions menu tothe MES UsageSummary screen, e.g."Return" or "Acct Info"
9955 1. Enter code 9955
2. Press the Start button
3. Enter the desired text on the keyboard,to a maximum of 10 characters
4. Press OK on the touch screen
10Installation Guide
Scan to Me
Enable Scan to Mefunctionality
9980 1. Enter code 9980
2. Press the Start button
3. Enter 1 as the configuration using thehard keys
4. Press OK on the touch screen
Delete Print Jobs
1st of 2 configurations toallow users to deletetheir print jobs at theMFD
8726 1. Enter code 8726
2. Press the Start button
3. Enter 1 as the configuration using thehard keys
4. Press OK on the touch screen
Delete Print Jobs
2nd of 2 configurationsto allow users to deletetheir print jobs at theMFD
9236 1. Enter code 9236
2. Press the Start button
3. Enter 3 as the configuration using thehard keys
4. Press OK on the touch screen
Card authentication configuration (if applicable). This manual includes a list of supported card readers and their corresponding codes.
Name/Description Code Instructions
Card Reader
Select the card reader that willbe used for authentication
3500 1. Enter code 3500
2. Press the Start button
3. Enter the code for the card reader (use the linkabove for a list of supported card readers)
4. Press OK on the touch screen
Card Track
Select the track from whichcard data will be read
MES supports track 1 and 2
3501 1. Enter code 3501
2. Press the Start button
3. Do not use the A-F keys on the touch screen,instead enter either "1" or "2" using the hard keysfor the options below
1 = Track 1
2 = Track 2
4. Press OK on the touch screen
5. Re-enter the code (either "1" or "2")
6. Press OK on the touch screen
To exit Service Mode, press and hold the power On/Off button next to the MFD's touch screen.Press the power On/Off button again to start the MFD.
Installation Guide11
Step 2 - Web Interface Configuration
Further configuration changes must now be made, this time through the device's web interfaceconfiguration menu. To access the configuration menu, ensure the device is powered on andconnected to the network, and web-browse to the IP address of the MFD. Log in using theMFD's administrator credentials, which by default are:
User Name Password
admin 123456
The device's "TopAccess" menu should now be displayed. Please ensure the followingconfiguration changes are made.
Directory Service
Create a new directory service by clicking Administration >> Maintenance >> DirectoryService >> New as shown below:
Clicking New will display the Directory Service Properties page. The configuration requirementsfor this page are detailed below:
12Installation Guide
Configuration Value
Directory Service Name A name for the MES LDAP Server
Server IP Address The IP address of the server where MES Framework is installed
Port Number 41096
Authentication Simple Bind
Search Base OU = Primary
User Name UID=admin,OU=system
Password secret
Configure the Directory Service Name and the Server IP Address as required. The values in redabove must be configured exactly as they are shown in this table. The remaining options canbe left at the default value.
Click OK to create the new directory service.
Now ensure the newly created Directory Service is selected as the default server, as shownbelow:
Installation Guide13
Embedded Web Browser
The Embedded Web Browser configuration is the address from which the MFD will run theMES solution. This address can be copied to the clipboard by opening the MES Administratorinterface and right-clicking on the Monitor Embedded for Toshiba solution in the MESConfiguration tab, and selecting Copy UI URL To Clipboard as shown below:
In the Toshiba TopAccess menu, find the EWB menu by clicking Administration >> Setup >>EWB as shown below:
The address that was copied to the clipboard in MES Administrator can now be pasted intothe Embedded Web Browser Home Page field.
If the MES Framework server address is 192.168.0.1, then the Embedded Web Browser HomePage configuration would be:
http://192.168.0.1:41001/MonitorToshibaServer/Home.jsp
14Installation Guide
Click Save to save the Home Page settings.
User Authentication
There are two login prompts that can be configured for authentication at a Toshiba MFD. Theseprompts are both native to the Toshiba MFD and cannot be changed, so it is important tounderstand exactly how a user can authenticate a Supervisor Net account at these prompts.
By default, the MFD will display the following login prompt:
When authenticating at this prompt using the keyboard, a value must be entered inthe Password field. Therefore when authenticating a Supervisor Net account thatdoes not have a PIN, a default PIN of '1234' must be entered or the login will fail
The table below details how the default User Name/Password prompt can be used forauthentication with a Supervisor Net account:
Authentication Method Steps Required
Keyboard - Primary Number with PIN User Name = Primary Number, Password = PIN
Keyboard - Primary Number with no PIN User Name = Primary Number, Password = 1234
Keyboard - Primary ID with PIN User Name = Primary ID, Password = PIN
Keyboard - Primary ID with no PIN User Name = Primary ID, Password = 1234
Keyboard - External Account with Password Enter Account and Password
Card - Primary Number/ID with PIN Present Card and enter PIN when prompted
Card - Primary Number/ID with no PIN Present Card
Card - External Account with Password Present Card and enter Password when prompted
Card - Associate Card with External Account Present Card and enter Account and Password
If PIN Code Authentication is enabled (later in this manual), the MFD will display the followingprompt:
Installation Guide15
When authenticating at this prompt using the keyboard, only the numerichard keys on the MFD may be used. If the user's account is alphanumeric,they must present a card or press the ID/PASSWORD button to displaythe default User Name/Password prompt and use the popup keyboard
At this prompt, the user may authenticate using the options detailed in the table below, orthey can press the ID/PASSWORD button to display the default User Name/Password promptand authenticate using the available options at that prompt.
The table below details how the PIN prompt can be used for authentication with a SupervisorNet account.
Authentication Method Steps Required
Keyboard - Primary Number with PIN Enter Number and PIN using numeric hard keys
Keyboard - Primary Number with no PIN Enter Number using numeric hard keys
Keyboard - Primary ID with PIN Enter ID and PIN using numeric hard keys
Keyboard - Primary ID with no PIN Enter ID using numeric hard keys
Keyboard - External Account with Password Enter Account Number and Password when prompted
Card - Primary Number/ID with PIN Present Card and enter PIN when prompted
Card - Primary Number/ID with no PIN Present Card
Card - External Account with Password Present Card and enter Password when prompted
Card - Associate Card with External Account Present Card and enter Account and Password
Enabling PIN Code Authentication allows the user to authenticate at either of the availableToshiba prompts, however it may not be suitable to display the PIN prompt with its numericonly restriction for keyboard entry, so use the information provided to determine whether both
16Installation Guide
prompts should be enabled.
The User Authentication configuration is accessed by browsing to the Administration tab, thenselecting the Security tab as shown below:
Configure the following options from top to bottom of the page.
Department Setting
The Department settings should be disabled.
User Authentication Setting
Configure the dropdown menu options exactly as shown in the screenshot above, then click onthe LDAP Server 1 link in the user authentication table to display the LDAP Authentication
Installation Guide17
window, outlined in red.
For the LDAP Server1 configuration:
Select the Directory Service that was created earlier in this section, in this manual it iscalled "MES"
Select the LDAP Server option
Configure the Attribute type of 'User Name' as "cn"
These configuration changes will now be visible in the user authentication table.
Role Based Access Setting
On the same page, scroll down to the Role Based Access Setting options. Set the RoleBased Access using LDAP server to Enable and select the Directory Service that was createdearlier as the LDAP Server. In this manual it is "MES".
PIN Code Authentication Setting
If PIN Code Authentication will be used, ensure it is enabled with the correct Minimum PINCode Length configured, then click on the LDAP Server 1 link in the card authentication tableto display the PIN Code Authentication window, outlined in red.
For the LDAP Server1 configuration:
Select the Directory Service that was created earlier in this section, in this manual it iscalled "MES"
Select the LDAP Server option
Configure the Attribute type of 'User Name' as "cn", and the Attribute type of "PIN" as"eBMUserPIN"
18Installation Guide
These configuration changes will now be visible in the card authentication table.
Card Authentication Setting
Configure these settings for card authentication (if applicable).
Click on the LDAP Server 1 link in the card authentication table to display the LDAPAuthentication window, outlined in red.
For the LDAP Server1 configuration:
Select the Directory Service that was created earlier in this section, in this manual it iscalled "MES"
Select the LDAP Server option
Configure the Attribute type of 'User Name' as "cn"
These configuration changes will now be visible in the card authentication table.
Email Authentication
Email Authentication should be disabled.
Email Address Setting
On the same page, scroll down to the Email Address Setting options and configure them asshown below:
Installation Guide19
These settings must be configured exactly as shown in the screenshot above, exceptthe Domain Name which should be configured with the domain name for the site.
The remaining settings in the Security tab can be left disabled. Click Save at the top of thepage to save the settings.
Print Data Converter
A Print Data Converter script (written by Toshiba) must be imported to the MFD. This is anecessary step to ensure any print jobs released to the MFD through the Monitor Print systemdo not have any restrictions applied to them by the MFD itself. The Print Data Converter.xmlfile should be supplied with the MES.exe file used for the MES Framework installation.
To import the Print Data Converter script, browse to Administration >> Setup >> Print DataConverter and browse to select the Print Data Converter.xml file, then click Import as shownbelow:
The Print Data Converter.xml file should be listed in the table as shown below:
20Installation Guide
Ensure the Print Data Converter is set to "Enable", then click Save to apply the changes.
Step 3 - Connect the MFD to MES
The last step is to log in at the MFD and connect it to MES. Once connected, the MFD will bedisplayed in the MFD/Service Status tab in MES Administrator, and the terminal record thatwill be created in Supervisor Net can be given a name.
The configuration made in the User Authentication section will determine the prompt that isdisplayed on the MFD. This section contains information about the various authenticationoptions that are available to the user at the Toshiba login prompts.
To connect the MFD to MES, log in using a valid Supervisor Net account, e.g. the "007"Technician Account. Remember if PIN Code Authentication is disabled and a User Name andPassword must be entered, the default PIN of 1234 must be entered in the password fieldwhen authenticating an account with no PIN configured.
This will connect the MFD to the MES server, then the Terminal Naming screen should bedisplayed:
Installation Guide21
The name entered here will be the name of the terminal record created in Supervisor Net. It isrecommended that this be the model or location of the MFD, or something unique to identifythe MFD easily. To enter text, tap on the text field to display the popup keyboard. Press OKto proceed.
When the device has finished receiving its configuration from the MES Framework, thefollowing page should be displayed:
This is an important page to be aware of in the MES solution for Toshiba. This page wouldusually display the login prompt, however because authentication occurs at the native Toshibalogin prompt, this page should not display the Supervisor Net login prompt. The messagedisplayed above is pre-configured in the Themes tab of the MFD Configuration menu in MESAdministrator and can be changed. It has been configured this way because this page mustbe displayed briefly after a user logs in, and can be displayed in certain scenarios such as afailed authentication. If this page is left blank, it will not be obvious to a user how to return tothe Toshiba login page. It is recommended that this text includes a message instructing users
22Installation Guide
how to log out, like the one above. It may also be useful to configure a message explaininghow the device's native functions can be accessed by using the function hard keys.
To return to the Toshiba login page, press the ACCESS key on the MFD.
What's Next
The MFD is now running the MES solution and has received its configuration from SupervisorNet. Proceed to the Administrator Guide on the next page.
Administrator Guide23
Administrator Guide
The following topics are covered in this section:
Admin tools and tips including recommended security measures
Supervisor Net configuration information
Using the MES Administrator interface
How to upgrade MES Framework
Tools & Tips
Security Measures
It is recommended that certain steps are taken to ensure each MFD is secure so users areunable to bypass the Monitor Embedded solution.
Change the Admin Password
The MFD's admin password should be changed from the default of '123456'. To do this, browseto the MFD's TopAccess menu using its IP Address and click on the User Management tab. Inthe list of users, click on the link for the Admin user and type the new password in thepassword field, then click Save.
Enable Filtering
It is essential that filtering is enabled on the MFD to restrict from where users can print to thedevice. An IP Address range or individual MAC Addresses can be configured to allow or denyprinting to the MFD from those devices.
This configuration is set in the device's TopAccess menu by browsing to Administration >>Setup >> Network and clicking on the Filtering link as shown below:
To configure an IP Address range or MAC Address, click on the Filtering button:
24Administrator Guide
That will pop up a window where the configuration can be set. Ensure the Enable IP Filteringand/or Enable MAC Address Filtering options are enabled as required.
Once the Filtering configuration has been set, hit OK to return to the Network page,then hit Save to apply the changes.
Secure Cabling
Ensure that the power and network cables are securely connected to the MFD. Ideally a userwould not be able to pull the network cable or power off the device during a session, howeverthe MES solution will record any usage of the MFD in this situation.
Energy Save
There are various energy save configuration options in the Toshiba MFD's TopAccess menu.These options are found in the Setup tab of the Administration menu and are explained below.
Scroll down to find the Energy Save settings, which are explained below:
Auto Clear
Administrator Guide25
This is the session timeout setting that will log a user out of their session and back to thelogin page. The user will automatically be logged out if the session remains idle for theconfigured length of time. This setting must be configured instead of the Supervisor Netsession duration that is configured in the terminal setup record as the MES solution forToshiba solution cannot use the session duration configuration.
Auto Power Save
The length of time the device can remain idle before power save mode is enabled. This willdisplay a black screen that advises the user the device is in power save mode. The user mustpress Start or the Energy Saver button to display the login page again.
Sleep/Auto Shut Off
The length of time the device can remain idle before the device goes to sleep and displays ablack screen. The user must press the Energy Saver button to display the login page again.
Super Sleep
Enable/disable the device's deep sleep mode.
Click Save at the top of the page to save the changes.
MFD Counters
To view the total counts for the native functions and page sizes that can be used on the MFD,browse to the MFD's TopAccess menu and click on the Counter tab as shown below:
Supervisor Net Configuration
When a Toshiba MFD is connected to the MES Framework for the first time, a uniqueSupervisor Net terminal record is automatically created for that MFD. By default, these recordsare configured to use the "Toshiba Embedded" terminal setup record. To edit the ToshibaEmbedded terminal setup record, go to the Supervisor Net Terminal Setup Database andlocate the record and double click on it.
In the Pricing Model tab, the configuration for the default pricing model will be EmbeddedMetric, as shown below. This is correct for any site using metric paper sizing, however if thesite uses imperial paper sizing, this should be changed by clicking Find and selecting theEmbedded US/Imperial pricing model. The embedded metric/imperial pricing models containpricing for copying, scanning and faxing.
26Administrator Guide
In the same Toshiba Embedded terminal setup record, click on the Card Reader tab andcheck the following configuration options:
The Swipe Prompt must be enabled but left blank and EnableKeyboard Entry must be disabled. This is the default configuration forthe Toshiba Embedded terminal setup and should not be changed
Click Save to save any configuration changes that have been made.
To configure the pricing for the native functions of the MFD, go to the Pricing Model databaseand edit the pricing model that has was selected in the Toshiba Embedded terminal setuprecord (Embedded Metric or Embedded US/Imperial). In the Variable Rates tab, set the pricesthat will be charged for each size and colour for the MFD's native functions.
Administrator Guide27
In the example below, the Embedded Metric pricing model is being edited. All paper sizesshould have a "Count Price" configured, this value can bet set to zero if there is no charge forthat paper size. Edit a particular paper size's count price by double clicking on that row.
Click Save to save the configuration changes.
When a configuration change is made in Supervisor Net or MES Administrator thatmust be applied to an MFD running the MES solution, the affected MFDs mustreconnect to the MES Framework to receive their new configuration. To do this, selectthe MFD(s) in the MFD/Service Status tab in MES Administrator, then right-click andselect Restart Selected.
Using MES Administrator
MES Administrator is the user interface that contains all of the MES Framework configuration.It can be accessed using the desktop shortcut that is created during the MES Frameworkinstallation, from the Start Menu, or from the MES Framework installation directory.
This section contains all of the configuration options within MES Administrator and explainshow they can be used.
Below is an overview of the information and configuration options found in MES Administrator:
MES Service Configuration & Control
MES Framework port configuration, MES logging verbosity and Supervisor Net Server
28Administrator Guide
configuration, stop/start MES service.
SMTP Setup
Configure email settings for outgoing email from MFDs.
Embedded Solution(s)
Add one or more Monitor Embedded Solutions to the MES Framework.
MFD Configuration & Control
Create and edit multiple configuration templates and assign them to one or more MFDs,restart MFD connection to MES server.
Role Based Access Control
Restrict functionality available to different user groups.
Product Information & Logging
MES Framework version number and view simple MES Administrator logging.
MES Configuration tab
The Main/Configuration tab contains the global MES settings. Any changes to the settings inthis tab require the MES service to be restarted before the changes will take effect.
MES Service Configuration
Base System Port
The port number from which all ports of the MES Framework are based, including Tomcat andMFD connection ports. If the base port number is set to the default of 41000 thencommunication will occur on ports 41001 through 41099, therefore the firewall should beopened to allow communication on these ports.
If the MES service is running when this port is configuration is changed, the service willautomatically be restarted.
Please read the MES Server Ports section of this manual for information about configuring afirewall for the MES Framework.
MFD List Update Time
The frequency in milliseconds that the MES updates the list of MFDs running the MESsolution.
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 UDPmessages. For diagnostic purposes this should be set to debug.
Administrator Guide29
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 MESFramework.
MFD Session Shutdown Time
The time in seconds that an MFD has been idle before the MES Framework will remove theMFD 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 beauthenticated.
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 NetAdministrator. This should be left at the default value of 10002.
Supervisor Net Interface Server Port
The Interface (SOAP) Server Port that is configured in the Supervisor Net Settings inSupervisor Net Administrator. This should be left at the default value of 8082.
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 Toshiba solution. Scan to Email must beconfigured 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 MESFramework installation. When a solution is installed it is added to the list of installed solutionsas shown below:
By selecting and right-clicking on the Monitor Embedded for Toshiba solution, the following
30Administrator Guide
menu options are displayed:
Backup MFD Directory
Backs up to file the directory where the configuration, database and graphics for the solutionare stored.
Restore MFD Archive
Restore from file the directory where the configuration, database and graphics for the solutionare stored.
Copy UI URL To Clipboard
Copies the MES solution UI URL to the clipboard. This URL is configured as the EmbeddedWeb Browser Home Page on the MFD.
Perform MFD Maintenance
Select a device or devices to view pending jobs, clean databases or remove from the MESFramework.
Remove Solution
Completely removes the solution and the directory where the configuration, database andgraphics for the solution are stored.
Save
Saves the current MES Service Configuration and SMTP Setup that has been set in theConfiguration tab. The MES service must be restarted for any changes to take effect.
Discard
Discards any changes made to the MES Service Configuration and SMTP Setup in theConfiguration tab.
MFD Configuration tab
The MFD Configuration tab of MES Administrator contains all of the MES Frameworkconfiguration options that can be applied to one or more MFDs. When an MFD is configured torun Monitor's embedded solution for the first time, a Supervisor Net terminal record is createdautomatically and a unique ID is assigned to that record. Each terminal record is displayed inthe 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 in the following section of this manual,however note below the process for editing and applying a configuration to an MFD:
Administrator Guide31
1. Select the configuration template that will be applied to the MFD from the drop-down list andclick Edit
2. Click Continue to edit the configuration
3. Make the necessary configuration changes and click Exit then Save to save theconfiguration changes
4. To send the new configuration settings to the MFD(s), go to the MFD/Service Status tab inMES Administrator and select the MFDs to apply the changes to, then right-click and clickRestart Selected
When the MFD(s) have reconnected to the MES server, the configuration changes will havebeen successfully applied.
Configuration Selection
The drop-down menu contains the list of all configuration templates. The selected configurationis the configuration that will be affected when clicking Edit Configuration or DeleteConfiguration.
New Configuration
Creates a new configuration template. The initial settings for the new configuration will bebased 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 terminalrecords below. If All Solutions is ticked then any terminal records that are applicable to theMES Framework will be displayed in the list. If All Solutions is not selected then only terminalrecords associated with the selected Monitor embedded solution in the drop-down menu willbe displayed in the list.
Clicking Refresh will refresh the list of terminals.
In the example below, the Toshiba solution is selected therefore only Toshiba embeddedterminal records will be displayed in the list:
32Administrator Guide
The list of terminals displays the ID, Name, Setup Type of the terminal records that have beencreated 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 thatparticular terminal record.
To assign a configuration template to one or many terminal records, select or multi-select therecords 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 selectedterminals.
Edit Configuration
Clicking Edit Configuration will firstly display the list of embedded terminal records that havethis configuration assigned to them.
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 areno print jobs to list, the user will be advised of this and then the usage summary page isdisplayed.
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
Administrator Guide33
insufficient funds to print all of their jobs they will be notified of this and their jobs will not beprinted. 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 Toshiba solution.
Single Function Operation
If enabled, the user will automatically be logged out of their session when they have eitherfinished 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 theprint jobs, the are returned to the MES usage summary screen, and may continue to use theMFD.
Automatically Release Single Jobs
If enabled, any user with one print job waiting for release will have their print job automaticallyprinted out when they access the print release page. If the MES "Login Options" is set to PrintRelease and this option is enabled, when a user logs in with one print job waiting for release, itwill automatically be printed and the usage page will be displayed reflecting the cost of theprint job.
In either of these scenarios, if the user has more than one print job the print release page willbe displayed as normal.
Single Price/Flat Rate Scan Jobs
If enabled, MES will charge monochrome and colour scan jobs at a flat rate, regardless of thenumber of pages scanned.
This requires configuration in Supervisor Net Administrator in the "Embedded" Pricing Modelthat is used to charge for native functions on the device. Select the correct pricing model andclick Edit. Then in the Variable Rates tab, scroll down to the first two empty pricing lines andconfigure number 29 as the flat rate for black and white, and number 30 as the flat rate forcolour.
An example is below:
Number Name Code Count Price
29 Flat Rate Scan B&W 0.50
30 Flat Rate Scan Colour 1.00
Regardless of the number of pages scanned there will only be a single charge for thetransaction.
Narration Text for Native Print Jobs
Native print functions such as print from USB or print from network location are recorded inMES and Supervisor Net as "copy" transactions. Only print jobs sent to the MFD through theMonitor print system are recorded as "print" transactions in MES and Supervisor Net. Thisconfiguration allows text to be configured that will be recorded against the transaction inSupervisor Net, in the narration field of the transaction, to identify it as a native printtransaction rather than a native copy transaction.
MFD Functions Button Text
This option is not applicable to the Toshiba solution.
34Administrator Guide
Usage Screen Button Text
The text for the button that returns the user to the MES usage summary screen.
Password Entry Text
The text for the prompt when a user is entering an external account and password forauthentication.
Time Before MFD is 'Dirty' (mins)
When MES communication with an MFD fails, MES will continue to talk/listen to the MFD forthe configured amount of time to attempt to reestablish the connection. If no communicationoccurs within that time period, MES will close the connection with the MFD and the device willbe removed from the list of MFDs in the MFD/Service Status tab in MES Administrator. Thiscommunication 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 MESdatabase. This will not remove and pending jobs from the MFD itself, but is a useful tool forwhen MES does not receive a job finish notification from the MFD and the user's job remainspending 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. Secondaryaccounts.
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 displayedadvising them they must wait.
Allow Login With Paused Jobs
This feature is not applicable to the Toshiba solution.
Automatically Disable Session Timeout
This option must be enabled as the Toshiba solution should ignore the Supervisor Net sessiontimeout, and instead use the devices own internal session timeout.
Number of Decimal Places
The number of decimal places that are displayed for the user's balance and transaction costsat the Transaction Summary page.
Separate Page Information
When enabled separates the Colour and Black & White page count and cost at the MESusage summary screen.
Auto Sense Auto Accept
The terminal will automatically enter Auto Accept mode when it can no longer communicatewith the Supervisor Net server but can still detect a network connection. Auto Accept modelooks identical to normal terminal operation, and enables the device to be used in the event ofthe link to Supervisor Net being broken. As soon as the server is detected again, the terminal
Administrator Guide35
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. Theamount a user spends in multiple sessions is tracked, so the user cannot simply log out andlog back in once they've reached the limit.
Auto Accept Price Code
The price code that will be applied to all transactions while in Auto Accept mode. This isbecause the individual user's price code is not known while in Auto Accept mode.
Allow Session Hold
This feature is not applicable to the Toshiba solution and must not be enabled.
Disable A3 Count Halving
This feature is not applicable to the Toshiba solution.
Prompt For Colour Selection
This feature is not applicable to the Toshiba solution and must not be enabled.
Use Highest Price for Counts
When enabled, the user is limited to the number of copies their balance allows if the job wascharged 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 50cper page, with this feature enabled, if the user chooses to make black and white copies, theywill only be able to make the number of copies their balance allows if it was charged at thecolour 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 accountgoing 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 jobowner is the name associated with a print job based on the user that is logged in to theworkstation 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 isconfigurable to a maximum of 40 characters.
Card Setup tab
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 beingused. This setting must be changed to match the track being used by the magnetic cardreader. The options are either Track 1 or Track 2.
36Administrator Guide
Track 1 Field
Each track format contains multiple fields of information, you may only want to read theinformation from one of the fields on the card.
A typical Track 1 card number would look like:
B4368830104699549^OWNERS NAME 1̂24510167504100000000033900000
Track 1 cards can contain alpha-numeric characters. The different fields of information areseparated by carats ( ̂). Typically, a site would use the first field of information foridentification 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 theinformation from one of the fields on the card.
A typical Track 2 card number would look like:
4368830104699549=12451016750413390000
Track 2 cards contain only numeric and special characters. They usually have one or twofields 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
Administrator Guide37
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 thissituation, any card swiped which does not begin with this prefix will be rejected.
Allow Card Association
This feature is not applicable to the Toshiba solution.
Use PIN
Toshiba MFDs require a PIN to be entered at login, regardless of whether Use PIN is enabledor disabled, however to enable the Change PIN button to allow a user to change their PIN atthe MFD, Use PIN must be enabled.
Allow Set No PIN
Toshiba MFDs require a PIN to be entered at login, regardless of whether Use PIN is enabledor disabled, therefore this option is not applicable to the Toshiba solution.
Disable PIN Change
If enabled users will not be able to change their PIN at the MFD.
Ignore Cards In Session
This feature is not applicable to the Toshiba solution.
Display Card Processing
This feature is not applicable to the Toshiba solution.
Card Prefix 2-4
Defines an additional 3 prefixes for the MES solution to look for when deciding how much of anoffset or number length to use. As an example, a site may want staff cards starting with600599 to have a length of 10 and an offset of 1, however student cards starting with 4445 tohave 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 lengthand 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
This feature is not applicable to the Toshiba solution.
Themes tab
Disable Copy Row in table
Removes the Copy row from view at the usage summary page.
38Administrator Guide
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
This feature is not applicable to the Toshiba solution.
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.
Site Branding
A site may wish to brand the MES solution with their own logo. The logo will be visible at thetop of the screen to the left of the Monitor logo.
To add a logo, click Browse next to the field that is configured to use the SiteBranding.pngfile 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 anoption 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
Administrator Guide39
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 issuggested that this option is left enabled.
Enable Supervisor Packet Logging
This option allows logging of the Supervisor Net TCP communications per device. This isuseful for diagnostics but in most cases will never be enabled. It is suggested that this optionis left disabled.
Exit
Exits the Edit Configuration menu. If no changes have been made then it will exit at the firstclick. If configuration changes have been made a window is displayed with the option to saveor 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
Restart, start and stop the MES service. This will affect any MFDs connected to the MESserver.
40Administrator Guide
MFD List
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
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 ofMES 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/ServiceStatus tab:
Administrator Guide41
Restart Selected
Restarts the selected MFD's connection to the MES server. This is necessary to receive anynew configuration made in MES Administrator.
Clear Selected Terminal IDs
Removes the assigned terminal ID(s) from the selected MFD(s) so a new one can beassigned.
Spy on Device
Opens a window to view but not control the MFD's touch screen.
Simulate Card Data
This option is not applicable to the Toshiba solution.
Role Based Access Control tab
This feature allows an Administrator to restrict which of the device's native functionality isavailable to different user groups, based on the Supervisor Net price code that is assigned toeach group. Each option can be set to true or false to enable or disable that particular functionfor the user group.
To configure a price code group's Role Based Access Control (RBAC) settings, select theprice code and double-click on an item to change its value to true/false. Hover over aconfiguration option for an explanation of that function.
The options found in the RBAC tab only apply to the native functions of the MFD.They do not affect the release of print jobs at the MFD via the Monitor Print system
MES Administrator Logging tab
Contains basic MES Administrator logging. Full logging is recorded in the MES Framework logfiles found in the Monitor Business Machines\MES\home\logs directory.
Go to the MES Framework Logging section of this manual or more information regarding MESFramework log files.
Product Information tab
The Product Information tab contains the MES Framework version number and informationregarding the minimum required version of Supervisor Net.
MES Framework Logging
The MES Framework log files are located in the MES\home\logs directory. The default locationof this folder is C:\Program Files (x86)\Monitor Business Machines\MES\home\logs. There aretwo types of MES logging, these are explained below.
MES Service Log
Logging for any activity in the MES service, including information that is sent to and received
42Administrator Guide
from an MFD. This log contains information used for diagnosing any issues that may arise.
The MES Service Log creates a folder for each day, and within that folder the log is separatedinto hourly logs.
MES Administrator Log
Logging for activity within the MES Administrator interface only. There is one MESAdministrator log for each day.
Please note that to ensure diagnosis can be performed, fulldebug logging must be enabled in the Debug tab of the MFDConfiguration found in the MES Administrator interface
Upgrading MES Framework
To upgrade the MES Framework simply run the installation package, the process will takeless than a minute. The MES Administrator window will automatically close (if currently open)and the MES service will be stopped to perform the upgrade, then restarted when it iscomplete. Once the installation is complete there is no further action required.
User Guide43
User Guide
The following topics are covered in this section:
How to use Monitor's embedded solution
What configuration changes can be made in MES and Supervisor Net so that each step ofthe user experience can meet a site's requirements
Login
To log in at the MFD, the user may:
Present their card and enter their PIN
Press the User Name button to display the popup keyboard and enter their ID, and thentheir PIN by pressing the Password button
Toshiba MFDs require a PIN to be entered at login. If the user does not have aPIN configured in Supervisor Net, they must enter the default PIN number 1234
The Monitor Embedded Solution for Toshiba supports the following authentication methods:
Authentication Method Description
Primary Number By default the MES solution will authenticate against a user'sPrimary Number in Supervisor Net. There is no configurationrequired for this authentication method
Primary ID The MES solution can be configured to authenticate against auser's Primary ID instead of their Primary Number. Theconfiguration Use Primary ID for Login is found in the General tabof the MFD Configuration menu in MES Administrator
In the example below, the user "001" is logging in using the touch screen keyboard:
44User Guide
The LDAP field in the screenshot above relates to the Directory ServiceName that was configured earlier in this manual with the name "MES".This Directory Service must be selected when logging into the MFD
The following page will be displayed briefly after a user logs in:
By default this page is blank - the message displayed above is pre-configured in the Themestab of the MFD Configuration menu in MES Administrator and can be changed. The MESsolution must display this page briefly after logging in, and this page will also be displayedafter a user has been advised they have insufficient funds to log in. If this page is left blankwith no configured message, it will not be obvious to a user how to return to the Toshiba loginpage. It is recommended that the message is left as configured above.
User Guide45
Enter Department
If the user is configured to charge their transaction to a department or client code, the followingpage will be displayed after login:
1. Search by Name or Number
Allows the user to search for the department or client codes they have permission to use, byname or number. This feature is enabled in Supervisor Net Administrator by checking AllowSearch in the Secondary tab of the terminal setup record associated with the MFD.
2. Recently used codes
Allows the user to select the department or client code from a list of recently used codes. Thisfeature is enabled in Supervisor Net Administrator by checking Review Entries in theSecondary tab of the terminal setup record associated with the MFD.
3. Secondary entry prompt
The prompt that is displayed to the user to enter the department or client code that will beused in that session. This prompt is configured in Supervisor Net Administrator in the Secondary tab of the terminal setup record associated with the MFD.
Usage Screen
By default, the first page the user will see after a successful login is the MES Usage Screen,shown below:
46User Guide
1. Print Release
Retrieves the user's print jobs that are ready for release and displays them in a list. Tosuccessfully display print jobs and print to the MFD, the print queue must be configured in theMFD's Supervisor Net Terminal Record in the Print Release tab.
Refer to the Print Release section for more information on releasing print jobs in MES.
2. Change PIN
The user can change their PIN by entering their current PIN and then setting a new PIN.
3. List of functions
This table displays the number of pages and cost of the functions used in the user's currentsession. The Copy, Print, Scan and Fax rows can each be enabled and disabled so that one,some or all of the functions are displayed in this table. This configuration is found in theThemes tab of the MFD Configuration menu in MES Administrator.
4. Page & Cost Information
This table can be configured to separate the monochrome and colour pages that have beencharged to the user. In the example above, the Separate Page Information option has beendisabled in the General tab of the MFD Configuration menu in MES Administrator. If this optionis enabled, the page and cost information is separated into monochrome and colour amounts.
Access MFD Functions
To access the MFD's native functions the user simply presses the MFD's hard key for thefunction they wish to use e.g. Copy.
Print Release
A user can access their print jobs by pressing the Print Release button after login, or the MESsolution can be configured to display the Print Release page immediately after login.
User Guide47
To retrieve and display print jobs for release at the MFD, the Supervisor Net terminal recordthat is created for each MFD must be configured with the correct print queue in the PrintRelease tab.
The Print Release page is explained below:
1. Select All
Selects all print jobs in the list.
2. Select None
Unselects any selected print jobs in the list.
3. Usage Screen
Returns the user to the Usage Screen.
4. Previous/Next Page
If the user has more print jobs ready for release than can fit on one page, they can move to theprevious/next page by pressing these buttons.
5. Delete selected jobs
Deletes the selected print jobs. If no jobs are selected, the user is prompted to confirm theywish to delete all jobs.
6. Print selected jobs
Prints the selected print jobs. If no jobs are selected, the user is prompted to confirm theywish to print all jobs.
48User Guide
7. Total cost of selected jobs
The cost of any selected print jobs is displayed here.
Access MFD Functions
To access the MFD's native functions the user simply presses the MFD's hard key for thefunction they wish to use e.g. Copy.
Logout
To log out of the MFD and return to the Toshiba login page, the user may:
Press the ACCESS button on the MFD and select Yes to log out
Press the FC (Function Clear) button on the MFD twice and select Yes to log out
To log out of the MFD's native functions menu and return to the MES usage screen, the usermay:
Press the MENU button on the MFD, and selecting the small Usage Scrn button locatedalong the top of the MFD's touch screen (the text for this button will be different if it wasconfigured differently in the MFD Configuration section of this manual)
Monitor Business Machines Ltd.31a Normanby Road,
Mt Eden,Auckland 1024,
New Zealand.Phone: +64 9 623 5000
Web: www.monitorbm.com