IDPort User Guide.

Transcription

1 IDPort User Guide

2 ID Port User Guide 2012 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. 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. Level 3, Grafton Road, Auckland, NEW ZEALAND Published: 12/04/2012 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.

3 Contents Introduction 1 System Overview 2 Important Notes and Warnings... 3 Download Firmware... 3 Download Burner... 3 Installation 4 System Requirements Procedure Upgrading 13 Print Manager Configuration Basic Interface 15 Top Left Controls Left Panel Right Panel Devices Tab IO Ports Tab Serial Ports Tab Track Options Scan Tab Card Processing Diagnostics Tab Basic Setup 24 System Configuration 31 Global Options Weigand Formats Options Find Servers Start Demo Server IO Port Configuration Serial Port Configuration Track Options Group Membership IDPort Terminal Tools IDPort Controls Edit Status Statistics Send Setup Download Firmware Download Burner Diagnostic Status Reset Clear Statistics Contents i

4 IDPort Update Add New Devices IDPort Factory Reset Setting the IDPort to use static... IP details 51 Supervisor Net Configuration IDPort Terminal Set up General - IDPort Mac... Address 53 Print Release - IDPort... Print Queue 53 Windows Firewall ii Contents 55

5 Introduction This document describes how to install and use the Monitor IDPort software to be used in conjunction with the IDPort network reader device. Introduction 1

6 System Overview The following diagram shows the overall system structure: The IDPort server is a Windows service which communicates with one or more IDPort devices, and passes on information received from them, such as card swipes, to other applications, such as Supervisor Net. When the IDPort reader receives input on any of the attached card reader devices, it reopens a connection to the IDPort server, sends the raw bit stream input to the server, and closes the connection. The server attempts to extract a card number from the bit stream and pre-process it. If successful, it sends the processed card number to all applications listening to it (As configured in the External Server URLs). If the card could not be read, it sends a bad card swipe message to the application(s). The IDPort server-side software uses the.net 3.5 framework, and this is therefore a prerequisite for using the system. The.NET framework installer is included with the installation package. The installer looks for the framework on the target machine, and if it is not found attempts to run the framework installer. Internet access is required for the.net framework installer. 2 System Overview

7 Important Notes and Warnings These notes contain information about updating IDPort terminals. There is a significant difference between Download firmware and Download burner, even though they use the same file. Download Firmware The firmware is the program which runs the IDPort. If the firmware update is interrupted, the IDPort will recover. The 'Version' in the 'Devices' page in the IDPort Configuration utility should show CRC Error if the unit has been rebooted. To recover from this, just run the Download Firmware utility again. Download Burner The burner is what boots the IDPort and starts the firmware. This is similar to the BIOS in a PC. As with a PC, you will not need to update this unless there is a problem with the IDPort and this has been clearly communicated as requiring a burner update. You will need to make sure that this process is not interrupted. If the burner update is interrupted, you will NOT be able to recover from this. The terminal must be returned to Monitor for the firmware to be re-loaded using a special tool. If this happens when you are updating the burner to 1 or more groups, this problem may happen to every ID Port in the group(s) selected. While the firmware may get updates, and while they use the same file, the burner portion does not often get an update. The burner usually only changes when the hardware changes, not the firmware. System Overview 3

8 Installation The installation package is provided as a single executable, IDPortSetup.exe. This contains the.net framework 3.5 installer, the IDPort server application, the IDPort configuration utililty, MS SQL Server Compact, and various support libraries. By default the software is installed into the directory C:\mbm\IDPort, although this can be changed during the installation process. System Requirements Windows XP, 2003 Server, Vista, 7 or 2008 Server (x86 and X64 platforms) with the latest service packs installed Supervisor Net Microsoft.Net framework v3.5 (installer included) Microsoft SQL Server Compact 3.5 SP1 (Installer and configuration included) 4 Installation

9 Procedure The following shows the Install procedure for the first time on a clean machine. This machine has Microsoft.Net 3.5 SP1 already installed so it wont install that. If you are running Server 2008R2, you will need to enable.net 3.5 via the server configuration tool. 1. Run IDPortSetup.exe and click Next Installation 5

10 2. Read and accept the license agreement, then click Next 3. Select the install directory and click Next - At this stage the install directory cannot have a space in it. 6 Installation

11 4. Choose a start menu folder and click Next 5. Select if the menu items and/or desktop icons are to be created then click Next Installation 7

12 6. The following screen will then show the options you have requested. Click Back to go back and change them, Install to install the IDPort software 7. Setup will then install the IDPort software and servers required 8 Installation

13 8. After the files are installed, if you do not have Microsoft.Net 3.5 or Microsoft SQL Server Compact they will now be installed automatically. As MS.Net framework is already installed, this will only show the MS SQL Server Compact install. If you have a 64bit version of Windows, the 64bit version of Microsoft SQL Server Compact will install directly after the 32bit version. 9. Click Next to begin the install process Installation 9

14 10.Read and accept the license agreement, then click Next 11.Review the install settings, then click Next 10 Installation

15 12.Setup will then install MS SQL Server Compact 13.Once that has completed, if successful you will get the message below, click Finish to go back to the IDPort Install Installation 11

16 14.The IDPort software is now setup, click Finish to finish the setup 12 Installation

17 Upgrading If you are upgrading from a previous version, there are requirements between server and firmware versions. You will need to upgrade both to the latest version to work correctly. The correct order for this is to upgrade the server first, then firmware, then only if required you will need to upgrade the burner. If this procedure is done in a different order, it may fail or cause corruption in the database or in the device requiring it to be sent back to Monitor. Print Manager Configuration During a new installation the Print Manager configuration occurs automatically. This step is only required when upgrading. Click on the Start Button > All Programs > Monitor Business Machines > Supervisor Net > Configure Print Manager. Tick enable IDPort under IDPort Settings. Upgrading 13

18 14 Upgrading

19 Basic Interface The screens below show the basic interface and location of controls in the various tabs. Further information and screen examples for the tabs and controls is shown later in the documentation. Top Left Controls File - Only has Exit at this stage Tools - Global configuration tools Help - The manual and version details Server - Start/Stop/Restart the server. The green bar shows the server status: green for started, red for stopped. Basic Interface 15

20 Left Panel The Groups column lists the IDPort groups The bottom toolbar strip accesses the functions: o Add - Adds a group o Edit - Edits the selected group name (except 'New') o Duplicate - Duplicates the selected group o Delete - Deletes the selected group (except 'New') 16 Basic Interface

21 Right Panel Contains the tabs to access the various information and functions for the group selected on the left. Devices Tab The details for the terminals belonging to the groups selected on the left are displayed in the grid. o The IDPort status is shown in different colours. Blue for online, red is offline or blocked by a firewall. o You can sort by each column by clicking on the column header. The columns are; Description - The device name, user edited. ID - the IDPort MAC address. IP Address - the current IP Address for that IDPort. Version - the firmware version for that IDPort. Resp List - If the device is listed in the responder list, this will show No List if there isn't one. The responder list is a text file called c:\mbm\idport\slpresponderlist.csv which limits the IDPorts to which the server will communicate with. It can be thought of as a 'White List'. If there is no responder list, the server will communicate with any IDPort. Status - Online for normal connection, offline for no connection. The bottom has 4 icons for the following in order o Refresh - Refreshes the device list o Add - Adds a new device Basic Interface 17

22 o Edit - Edits the selected device o Delete - Deletes the selected device from the database IO Ports Tab Configures the IDPort's digital I/O ports for connection to a TTL interface card reader. o Interface 1 and 2 map to the two I/O ports of the IDPorts in the group. 18 Basic Interface

23 Serial Ports Tab Contains the serial port configuration for the IDPort devices, for each group. o Configures the serial interface for each of the 3 serial ports on the IDPort devices in the group. o Configures the Serial Reader error string o Configures which card track to send, for multi track cards and readers Track Options Option Description Card Error String If the server detects this character or string of characters from the card reader, it will not pass it on to the application Track 1 magnetic card The server will only pass data formatted from a track 1 magnetic card reader on to the application Track 2 magnetic card The server will only pass data formatted from a track 2 magnetic card reader on to the application Decimal number The server will pass anything it gets from the card reader on to the application. This can be thought of as a 'Raw Card Read' Hexadecimal The server will pass anything it gets from the card reader on to the application number after converting it to hexadecimal. An important note is that no number will be passed on to the application if any of the characters read cannot be converted to hexadecimal. An example of this is attempting to read a magnetic card, where the raw data is ; ? - As a semi-colon cannot be converted to a Basic Interface 19

24 hexadecimal equivalent, no card number will be passed on Scan Tab From left to right IP Address scan range - IP ranges that the utility will scan for IDPorts. Checked to scan, uncheck to skip Scan range tools o Add - add a scan range o Edit - edit the selected scan range o Delete - delete the selected scan range Scan - scan the checked scan ranges Cancel - cancel the current scan ID Port List box - details of the ID Ports found during a network scan. You can sort by each column. IDPorts not in your database will be displayed as black, and IDPorts in your database will be displayed as blue. 20 Basic Interface

25 Card Processing The details for the card processing to the groups selected on the left are displayed in the grid. You can add further card processing options by clicking on the + Add button at the bottom of the screen. Double clicking a row or highlighting a row and clicking the icon of the pencil below will open up the edit window for that row. Basic Interface 21

26 The IDPort server will process the card number in the order that the options appear in the card setting window, i.e. leading zeros will be stripped before the card number offset and length are applied. The options are: Prefix - These settings will only be applied to card numbers that begin with this sequence of characters. No prefix defined means all cards, or all cards that don't match any of the other defined prefixes Monitor Cards - Only allows cards encoded with the special Monitor Card checksum to be accepted Offset - This is the number of characters that will be trimmed off the beginning of a card number swiped at the IDPort Length - The number of digits that will be kept. Any additional digits will be discarded Convert to Hex - This will convert the card number swiped at the IDPort to Hexadecimal Strip Leading Zeros - This will strip all leading zeros from the beginning of a card number swiped at the IDPort Pad with Zeros - This will pad leading zeros to the digits specified at the beginning of the card number. The reason that it doesn't just pad to the Length is because you may have a situation where you want to trim a card number to a certain length and then pad it with leading zeros to a different value. an example of this would be trimming a card number ' ' to '1234' and then padding it to 10 characters so that it ends up looking like ' ' Auto Suffix - This field is the SUFFIX that will be appended to each card swiped at the IDPort. The maximum length is 20 characters which includes the card number length plus the suffix 22 Basic Interface

27 Diagnostics Tab Contains additional diagnostic commands that can be sent to the ID Port via the network connection. This tab is only enabled when diagnostic logging is turned on, and the configuration tool is reopened. Caution: Some of these commands are able to edit the SQL Database directly, and others can delete version information. You will only be asked to open this by support personnel, and they will take you through what the commands do. Basic Interface 23

28 Basic Setup The following section assumes that the IDPort has been connected to the network using DHCP. The IDPort can be changed from a DHCP to a static address by using a dongle when the unit is powered on. 1. Open the IDPort Server and select the Scan tab. 2. Add in the scan ranges you wish to scan for IDPorts, and select Scan. 24 Basic Setup

29 If you have configured the scan ranges correctly you should get a listing of IDPorts as below. Any IDPorts already in your database will be displayed in blue. 3. Right click on your chosen IDPort and select Edit. Basic Setup 25

30 An edit window will be displayed, allowing you to configure the IDPort. 26 Basic Setup

31 4. Click on Receive to receive the setup details the IDPort already has. This will now be populated with the IDPort's IP details. Basic Setup 27

32 5. Edit these details as required, and give the IDPort a proper name. 6. Click Send to send the details to the IDPort, the below message will be displayed when successful, then click OK 28 Basic Setup

33 7. Click Add to add the device to the database. 8. Click onto the Devices tab, and you will see that your IDPort now appears in the list. Basic Setup 29

34 9. To complete the setup, right click on the device so the following menu appears: 10. Right click on the device to get the same menu, then click Send Setup. The following box should appear. Click Ok to close Your IDPort will now recognise your server, and request a copy of the configuration parameters. One this has been done, it will start sending card details as they are swiped. 30 Basic Setup

35 System Configuration These options configure the server, and effect all of the IDPorts that are connected to it. Global Options Configuration information is held in a SQL Server Compact Edition database in the install directory, called IDPortDB. The configuration program is called IDPortConfig.exe. When it is first started, it attempts to insert sensible default values into the database. The following global parameters are set up: Server IP address and listening port. These parameters control the address and port to which the network card readers will connect to retrieve their configuration information, and to report on card swipes. They default to the first IP address of the local machine, and port External server URL. The IDPort server communicates with other applications, such as the Supervisor Net, using the http or https protocol. The server URL gives the base URL to which card swipes will be reported. It defaults to If use of SSL is enabled on the external server, this can be enabled in the IDPort server simply by changing "http" to "https". These options can all be edited using the global options entry form, accessible from the Tools/Options menu item. System Configuration 31

36 E In the Tools Menu, there are 4 Global Tools as shown below. Weigand Formats The Wiegand Editor allows for custom Weigand formats. All of the following parts can be customised. This configuration will come from your Weigand reader manufacturer. 32 System Configuration

37 Options The Options tab allows several configuration options. The first time you open this you will be presented with a windows similar to the below: Server IP Address o Gives the server address, typically the server the IDPort Utility is setup on. Server Listen Port o This is the port that the IDPort server will listen for card reads from the IDPort terminals on. Defaults to Logging o Detailed diagnostic logging to help if there are any problems o This also enables/disables the Diagnostic Tab Encryption o When enabled, the data sent and received between the IDPort and the IDPort software will be encrypted Reboot Settings o Number of hours between IDPort reboots Scan Settings o Delay - length of time between scans for offline/online display - set to 0 to disable o Timeout - length of time it waits for a response before stating the unit is offline External Server URL o The URLs of the applications listening for card numbers from the IDPort server. The server can send to multiple applications simultaneously. There are three URLs set up by default: System Configuration 33

38 - - Supervisor Net for Konica Minolta open API Supervisor Net (For print release functionality) HTTP Server Demo application - Displays cards as they are swiped at the IDPort terminals for diagnostic and configuration purposes IDPort Config URL o The URL the IDPort terminals will request the setup from, this is in the format of server:port Find Servers This option details a listing of the current available servers. If your server isn't listed you may need to open some ports in your firewall. This function is also used in the situation where you have connected an IDPort to the network, but it is not showing in your list of connected devices. It may be that the IDPort has attached itself to another server running on the site. Start Demo Server The demo server displays the IDPort sends and requests. This will capture all card reads, so do not run this application when you are expecting the card reads to be sent to a different application. The basic layout shows a text listing of the setup requests and card swipes as shown below. 34 System Configuration

39 The text can be configured as below by right clicking anywhere in the text window. This will change the formatting in a text editor which allows unicode formatting. This allows some basic formatting for viewing and if you are wanting to copy and paste the output elsewhere. System Configuration 35

40 IO Port Configuration This shows the configuration of the two digital IO interfaces on the devices in the group. Note that these are NOT RS232 serial interfaces. Two parameters are supplied for each port - the attached card type, and whether the bits are read out most significant bit first or least significant bit first. The second setting will almost always be MSB first. The following card types are currently supported: ABA Track 2 ABA Track 1 Mifare HID Wiegand 26 bit In addition, a facility is provided to create custom Wiegand formats. This can be accessed using the Tools/Wiegand formats menu option. The card details are specified by giving the first and last bits of the card number. A variable number of parity sections can also be specified. The example screen shown above is for the standard Wiegand 26 bit card format. 36 System Configuration

41 Serial Port Configuration Each device has three serial ports, and this screen allows specification of the standard serial parameters for each port for all devices in the current group. Speed - baud rate of card reader Stop Bits - number of stop bits the reader uses Start Character , ASCII value of the start of the card data Parity - even/odd/none - the parity of the card reader, refer card readers manual for this. Data Bits bits of data per character of the card reader Stop Character , ASCII value of the end of the card data Wait For Reply - Used for special card readers, such as motorised card readers, where the IDPort will get a reply to any communication. Ignore Parity Errors - ignore any errors due to parity System Configuration 37

42 Track Options Card Error String - Some card readers give out an error message if the card cannot be read, such as 'E'. By entering this error code here, the terminal will ignore any card swipes that generate this code, and not pass the card number on to the IDPort Server Track 1 Magnetic Card - The contents of track 1 will be read Track 2 Magnetic Card - The contents of track 2 will be read Decimal Number - The card reader is not an ABA magnetic card reader (Such as a Mifare reader). You therefore want the raw digital output from the reader Same as Digital Number, however the number is converted to Hexadecimal prior to being transmitted back to the IDPort server Group Membership Each device is part of a device group, and configuration information for the devices is held at the group level. The following screen shows 2 new groups setup. The 'New' group is inserted by default and cannot be removed. When an unknown card reader connects for the first time, it is automatically added to the 'New' group. Groups can be added, edited, deleted, or cloned from an existing group using the buttons at the bottom of the left-hand panel. 38 System Configuration

43 System Configuration 39

44 A window will popup, requesting the group name, type it in and click OK to add the group. Devices can be moved to a different group by selecting them in the right hand panel in the Devices tab and dragging them on to the group entry in the left-hand panel. 40 System Configuration

45 IDPort Terminal Tools These options effect individual or configured groups of IDPorts. IDPort Controls The IDPort controls are opened by right clicking the name of the IDPort you wish to edit. IDPort Terminal Tools 41

46 Some of these controls are also available on an IDPort group level, by right clicking on a group in the left hand panel: By controlling an entire group, the action is performed on all terminals in that group. Edit Allows the settings to be edited for each device. 42 IDPort Terminal Tools

47 Device Name - Allows each device to be given a meaningful name ID - The device MAC address. This cannot be configured except when manually adding a new device IDPort Address - Allows the device IP/Subnet/Gateway/Server address to be manually entered Server Port - Alters the port that the terminal communicates on to match the one the server is listening on is the default value and should not usually be alterd Use Static - Whether or not the IDPort is to use a static IP address rather than DHCP IDPort Terminal Tools 43

48 Status This displays whether the device is connected to the network or not. If it is connected, it will display its IP address and firmware version. 44 IDPort Terminal Tools

49 Statistics This displays information such as the number of card swipes processed since the device was powered on, and the length of time it has been connected to the network. Send Setup This is used after the device or device configuration parameters have changed, and results in the new parameters being sent to the device. IDPort Terminal Tools 45

50 Download Firmware Download firmware (see Important Notes and Warnings) - this will be used when new firmware has been issued for the device. When it is selected, the user is prompted to select the new firmware file, which is then downloaded to the device if it is for a different version than that currently installed. Further details can be found in the IDPort Update section. Download Burner Download Burner (see Important Notes and Warnings) - Further details can be found in the IDPort Update section. Diagnostic Status Diagnostic Status - Shows detailed information about the IDPort, which can be used when diagnosing a connection issue etc. 46 IDPort Terminal Tools

51 Reset Tells the device to reboot and request a new setup. Clear Statistics Sets the terminal's statistics back to default values. IDPort Update This is the procedure to update the firmware or burner of the IDPort. Please read the WARNING before proceeding with this. In the Devices tab, right click on the IDPort you wish to update, and select Download Firmware... A file explorer will be displayed. Navigate to and select the latest firmware, then click Open. The new firmware will now be downloaded and installed on the IDPort. IDPort Terminal Tools 47

52 A message will be displayed once the update has completed. Click OK to close and return to the configuration tool. 48 IDPort Terminal Tools

53 If you are going to update the burner, you will need to select Download burner... A warning message will be displayed, giving you the opportunity to cancel the upgrade. Please review this Warning BEFORE updating the burner, more information can be found here. The rest of the process is identical to downloading the firmware, including selecting the same firmware file. A copy of the burner is included with every firmware file. The IDPort will take approximately 10 seconds to come back online after a firmware or burner upgrade. Any configuration changes, firmware/burner downloads or card swipes within that time will fail. Add New Devices Devices can be created manually, although it is not expected that this will generally be done. To manually create a device, click Add a new device from the bottom right of the Devices tab. IDPort Terminal Tools 49

54 You will be presented with a window similar to the one below: Edit the information as per your device, and click on OK to add it. The ID field is the IDPort MAC address. Once this has been saved it cannot be changed. If the MAC has been entered incorrectly, the record must be deleted and re-created. This device can be edited later by selecting the edit button at the bottom of the screen, or by right clicking on the device and selecting Edit from the resulting menu, as per the Basic Setup instructions. 50 IDPort Terminal Tools

55 IDPort Factory Reset The IDPort can be reset to factory defaults by shorting pins 6 and 9 on the DB9 female socket, and powering the device on for a few seconds. Pins 6 and 9 are the outside pins of the bottom row. In the image below the DB9 female socket is the socket on the left. A tool can be made for this, by using a male DB9 connector, and shorting only pins 6 and 9. This can then be plugged in when the power is off, then turning the device on for a few seconds, then removed when the power is turned off. Setting the IDPort to use static IP details The IDPort can be forced to use a static IP address (Disabling DHCP) by shorting pins 1 and 6 on the RJ11/RJ12 female socket, and powering the device on for a few seconds. The device will be set to the following details: IP Address: Subnet Mask: Gateway Address: Server Address: Server Port Number: IDPort Terminal Tools 51

56 Pins 1 and 6 are the outside pins of an RJ11/RJ12 socket. In the image below the RJ11/RJ12 female socket is the socket second in from the left. A tool can be made for this, by using a male RJ11/RJ12 connector, and shorting only pins 1 and 6 (The outside pins). This can then be plugged in when the power is off, then turning the device on for a few seconds, then removed when the power is turned off. 52 IDPort Terminal Tools

57 Supervisor Net Configuration IDPort units can be used as simple print release devices for printers controlled by Monitor Print. They are ideal for devices that don't have a user interface, so an embedded solution cannot be used. The user simply walks up to the printer and swipes their card at the IDPort. Any jobs belonging to the user in the pull print queue will be released to that printer. IDPort Terminal Set up General - IDPort Mac Address Go to the terminal database in Supervisor Administrator and create a new terminal. 1. Ensure that the Setup Type is set to IDPORT. 2. If the IDPort has already been connected to the system, its MAC address should appear in the IDPort MAC Address drop down box. If it does not appear there, you can manually type the MAC address value for the appropriate terminal. Print Release - IDPort Print Queue Go to the Print Release tab of the terminal record. Supervisor Net Configuration 53

58 Define the Pull Queue and Print queue. the Pull queues are the queues that will be looked in for jobs belonging to the user when they swipe their card. The print queue is the queue that their jobs will be moved to when they are released. If a user's account is marked as 'Prompt for secondary', the jobs will just be released and the print jobs assigned to their default secondary account. If they have no default secondary, the jobs will not be released. If a user has insufficient funds to release the jobs, they will not be printed. 54 Supervisor Net Configuration

59 Windows Firewall The IDPort and IDPort server use several ports which are blocked by default in Windows. The following ports and programmes are used by default and may need to be added as exceptions to the Windows firewall, they will need to be changed to your values. TCP Ports: This port is used to send and receive configuration information between the IDPort and the IDPort configuration utility, this can't be changed This port is used to send and receive configuration information between the IDPort and the IDPort server and well as the IDPort configuration utility and IDPort server This port is used to send card information from the IDPort to the IDPort server This port is used to send the IDPort configuration to the IDPort and receive configuration requests from the IDPort to the IDPort server. Programs/Executables: IDPortServer.exe IDPortConfig.exe HttpServerDemo.exe Windows Firewall 55

60 Monitor Business Machines Wireless House, Grafton Road, Auckland, New Zealand. Phone: Web: