User manual FS Reader Software

Transcription

1 User manual FS Reader Software

2 Contact Priva B.V. Zijlweg LC P.O. Box ZG De Lier Nederland contact.priva@priva.nl Article number Version 1.1 Date Copyright 2014, Priva B.V. All rights reserved. No part of this publication may be reproduced, published or stored in a retrieval system without written prior permission of Priva B.V. This publication has been developed with care. However, the products shown may differ in dimensions and design from the actual products. Priva B.V. will not accept any responsibility for damages caused by any errors or deficiencies in this publication. Priva B.V. may modify its products and the associated manuals without prior notice. Priva B.V. advises to check product, installation, hardware and if present software on irregularities. Priva B.V. owns the patents, patent applications, trademarks or other intellectual property rights regarding the products described in this publication. With this publication Priva B.V. does not grant the use of the aforementioned intellectual property rights. Product and company names this publication may not be used without the permission of Priva B.V. Terms of delivery are applicable to the products described in this publication. The most recent version of these terms can be found on the web site of Priva B.V. (

3 FS Reader Software FS Reader Software User manual 1.1 3

4 Priva B.V. Contents About this manual... 6 Aim and scope... 6 Availability of the manual... 6 Explanation of symbols in this document... 6 Terms and abbreviations... 6 Safety... 7 Installation... 7 Troubleshooting... 7 Product description... 7 Functions and intended use... 7 Operation... 8 Login... 8 Overview Status explanation FS Readers Filtering the list Adding an FS Reader Removing an FS Reader Restoring a removed FS Reader Linking and Unlinking an FS Reader Adding a description to an FS Reader FS Reader details FS Concentrators Filtering the list Adding an FS Concentrator Removing an FS Concentrator Restoring a removed FS Concentrator Linking/Unlinking an FS Concentrator Adding a description to an FS Concentrator FS Concentrator details FS Routers Filtering the list Adding an FS Router Removing an FS Router Restoring a removed FS Router Linking/Unlinking an FS Router Adding a description to an FS Router FS Reader Software User manual 1.1

5 FS Router details Diagnostics Registrations by date Configuration Region selection Firmware versions Add Firmware Troubleshooting Troubleshooting - general FS Reader Software User manual 1.1 5

6 Priva B.V. About this manual Aim and scope This manual concerns the FS Reader Software, supporting software for handheld devices for registration of labour for the horticulture industry. This manual contains all of the information required to safely and correctly operate the FS Reader Software. This manual will also allow you to effectively observe and resolve any malfunctions. For the sake of simplicity this manual uses the term "unit", to refer to "FS Reader Software". Availability of the manual This manual is intended for end-users of the FS Reader Software. Make sure that for employees who operate and monitor the unit, this manual and any other relevant manuals (such as the software manual of the registration system) are made available at the workplace. Explanation of symbols in this document Safety warning: danger of physical injury or damage to the product, the installation or the environment. Caution (instruction to prevent problems or material damage) Information Tip Terms and abbreviations The list below states the abbreviations and terms relating to the Priva labour and production registration units of FS Performance. Therefore, abbreviations and terms that do not apply to your specific unit and as a result are not used in this manual may still be found in the list below. Abbreviation / term FS Reader FS Cradle FS Tag FS Concentrator FS Router FS Reader Software Explanation Handheld device for registration of labour Storage/charger for the handheld device for registration of labour Electronic label for the labour registration system Wireless access point for the labour registration system Wireless repeater for the labour registration system Supporting software for handheld devices for registration of labour 6 FS Reader Software User manual 1.1

7 Safety No special safety tips apply to the usage of this product. Installation Only Priva approved installers are allowed to install and configure the FS Reader Software. The labour manager may also use the FS Reader Software to monitor and maintain his network. Troubleshooting In case of problems, a message will be generated. This manual describes the problems you might be able to solve yourself. Product description Functions and intended use The FS Reader Software offers the following functionality to the user: Configuration of the wireless network, including the settings for the FS Concentrators, FS Routers and FS Readers to work properly. Monitoring the status of the wireless network components mentioned above. Updating functionality within the FS Concentrators, FS Routers and FS Readers by making new firmware versions available. Inspection of the details of transaction data that has been received from the FS Readers. Furthermore, the FS Reader Software performs the following functions: Receiving transaction data from the FS Readers, acknowledging the receipt, and storing the data in its database. Checking the completeness of the data from the FS Readers and when complete, forwarding it to the Priva FS Labour system. Receiving and storing status messages from all components in the wireless network. Logging relevant details of its activities in log files. Taking care that old transaction data and log files will be purged at scheduled times. FS Reader Software User manual 1.1 7

8 Priva B.V. Operation Login The FS Reader Software Client application opens with the login screen. In this screen the user can choose: 1. to login with his current windows user profile, or 2. to provide the login credentials of another windows user. By clicking on the More options button the options appear to select a language and to specify the FS Server. By choosing a different language the language of the application will change after login or restart. The chosen language will be remembered for all users on the current machine. In the FS Server field the user fills in the address of the computer with the server software installed. This information will be remembered after pressing the login button. Only windows accounts with one of the roles registered at installation can log in. If no roles were supplied at installation, all users can log in. 8 FS Reader Software User manual 1.1

9 If a newer version of the server software for the FS Reader Software has been installed, you ll also be prompted to install the related newer version of the client software: After a successful login, the FS Reader Software opens the Overview screen. This screen shows in the bottom left corner the six components that together build the FS Reader Software client application: There is a general overview screen, three screens for the functionality of each of the different devices, a diagnostics screen and a screen for the configuration of the FS Reader Software. The top right corner of each screen shows: A refresh button that renews the information that is presented on the screen. A Help button: when pressed it opens the electronic version of this manual in a PDF Reader. FS Reader Software User manual 1.1 9

10 Priva B.V. Overview The main part of the overview screen shows some general information about the current configuration of the system. The top section shows the number of FS Readers, FS Concentrators and FS Routers defined within the system and what part is Registered, Unlinked, Linked or Active: The Add/configure button below above pie-charts leads the user to the screen to add new devices. When positioning the cursor above one of the coloured parts, a pop-up shows how many and what percentage of devices are in a specific status: The middle section shows two types of statistical information: 10 FS Reader Software User manual 1.1

11 Finally, the bottom section shows a graphical representation of the number of uploads that have been processed during the last 48 hours: Status explanation Each of the FS Reader, FS Concentrator and FS Router devices can be in one of four statuses: Registered: Unlinked: Linked: Active: The serial number of the device has been entered into the system and is ready to become operational. However, the device has not yet communicated with the FS Reader Software. The device has been blocked from this network in the FS Reader Software and should not send any scanned data to the FS Reader Software anymore. The device has been active on the network, but recently (1 hour for FS Readers and 2 minutes for FS Routers and FS Concentrators) no communication has been received from the device. The device has reported to the FS Reader Software and is operational, i.e. it is active in the network. Be aware that it can take up to a few minutes before the specific device becomes aware that its status setting has been changed in the FS Reader Software. FS Reader Software User manual

12 Priva B.V. FS Readers When the FS Readers component has been selected, a list is presented of all FS Readers that are known to the system: By clicking on the headers of the columns the overview can be sorted on Serialnumber, Current Firmware, Last activity and Status. Clicking on the header a second time will invert the sorting order. The default sorting of the overview is on Status: Unlinked Registered - Linked. Filtering the list In the top left menu of the screen some filters are available. By double clicking on a status, the list will only show FS Readers with the selected status. The filter can be reset by double clicking the Clear Filter(s) option. The textbox will look for the serial numbers of the FS Readers after hitting the enter key. 12 FS Reader Software User manual 1.1

13 Adding an FS Reader One can add new FS Readers to the system by entering the serial number of the device in the box at the top of the screen and then clicking the +Add button or pressing the Enter key. The serial number must consist of six digits. The +Add button can only be pressed when this condition is met. When an FS Reader is added, the screen will only show the new device in the list. As long as the addition of FS Readers continues, the newly added devices will be joined in this reduced list. After switching the view or pressing the Clear Filters, the complete set of FS Readers will be shown again. Removing an FS Reader FS Readers with the status Registered or Unlinked can be removed from the list of FS Readers. When you move the mouse over a specific FS Reader in the overview list, an icon appears that can be pressed in order to delete the FS Reader. When the mouse is on the icon, a tooltip explains the Delete function. Restoring a removed FS Reader If you add an FS Reader that was previously removed, the FS Reader will be restored as an Unlinked device. FS Reader Software User manual

14 Priva B.V. Linking and Unlinking an FS Reader When you move the mouse over a Linked FS Reader in the overview list, an icon will appear that can be pressed in order to Unlink the FS Reader. When the mouse is on the icon, a tooltip explains the Unlink function. When you move the mouse over an Unlinked FS Reader in the overview list, an icon will appear that can be pressed in order to Link the FS Reader. When the mouse is on the icon, a tooltip explains the Link function. By clicking the link button, the FS Reader will return to the status Linked and have its full functionality. Unlinking the FS Reader is useful when the device should be used somewhere else. The following procedure is then applicable: Upload all data from the FS Reader. Unlink the FS Reader. Set the FS Reader back to Factory defaults. Also in a situation where the FS Reader is not able anymore to transmit the data, it should be switched to Unlinked. Tags that were already scanned by the FS Reader before it got Unlinked will remain in the memory of the handheld device. If an incomplete batch was already started on the Server, it will be forced to completion automatically. If the FS Reader gets repaired, it can be switched to the Linked status again. If after all the FS Reader sends the stored data to the Server, then the related batch will be re-opened and the data will be appended. 14 FS Reader Software User manual 1.1

15 Adding a description to an FS Reader When you move the mouse over a specific FS Reader in the overview list, an icon will appear that can be pressed in order to Edit additional information to the FS Reader. When the mouse is on the icon, a tooltip explains the Edit function. By clicking the Edit button, a pop-up opens and you can enter a description up to 32 characters. Press the Save button to close the pop-up and save the description in the Remark column. FS Reader Software User manual

16 Priva B.V. FS Reader details By clicking on a row in the list of FS Readers, more details of the selected FS Reader will be presented. By clicking the same device again, the detailed information will collapse. This information includes some more technical details of which the most important are: Last Info Update shows the moment that the most recent data from this FS Reader has been received. Last two batches shows for the two most recent batches: o o Items amount is the number of received events in that batch; Processing date is the moment that the data of a batch that was completed has been transferred to the Priva FS Labour system. 16 FS Reader Software User manual 1.1

17 FS Concentrators When the FS Concentrators component has been selected, a list is presented of all FS Concentrators that are known in the system. By clicking on the headers of the columns the overview can be sorted on Serialnumber, Current Firmware, Last activity and Status. Clicking on the header a second time will invert the sorting order. The default sorting of the overview is on Status: Unlinked Registered - Linked. Filtering the list In the top left menu of the screen some filters are available. By double clicking on a status, the list will only show FS Concentrators with the selected status. The filter can be reset by double clicking the Clear Filter(s) option. FS Reader Software User manual

18 Priva B.V. Adding an FS Concentrator In order to register a new FS Concentrator to the system, the user must enter the following information at the top of the FS Concentrator screen: the serial number of the FS Concentrator (this number must consist of 6 digits); the IP-address of the FS Concentrator on the local network. The FS Concentrator will be registered by clicking the +Add button or by pressing the Enter key. When an FS Concentrator is added, the screen will only show the new device in the list. As long as the addition of FS Concentrators continues, the newly added devices will be joined in this reduced list. After switching the view or pressing the Clear Filters, the complete set of FS Concentrators will be shown again. Please be aware that a Region (see page 24) must be selected in order to allow the FS Concentrator to switch to the linked status. Removing an FS Concentrator FS Concentrators with the status Registered or Unlinked can be removed from the list of FS Concentrators. When you move the mouse over an FS Concentrator in the list, an icon appears that can be pressed in order to delete the FS Concentrator. When the mouse is on the icon, a tooltip explains the Delete function. If the FS Concentrator must be replaced by another one, first add the new FS Concentrator before removing the old one! (Else all FS Readers must be rebooted to connect to a new network.) Restoring a removed FS Concentrator If you add an FS Concentrator that was previously removed, the FS Concentrator will be restored as an unlinked device. The host of the device will be changed to the newly specified host. 18 FS Reader Software User manual 1.1

19 Linking/Unlinking an FS Concentrator When you move the mouse over a Linked FS Concentrator in the overview list, an icon will appear that can be pressed in order to Unlink the FS Concentrator. When the mouse is on the icon, a tooltip explains the Unlink function. Unlinked FS Concentrators will not communicate within your network; if there is no linked FS Concentrator available at all, no wireless communication is possible. Complementary, when you move the mouse over an Unlinked device in the overview list, an icon will appear that can be pressed in order to Link the FS Concentrator. When the mouse is on the icon, a tooltip explains the Link function. By clicking the Link button, the FS Concentrator will return to the status Linked and proceed with its full functionality. Adding a description to an FS Concentrator When you move the mouse over an FS Concentrator in the overview list, an icon will appear that can be pressed in order to Edit information to the FS Concentrator. When the mouse is on the icon, a tooltip explains the Edit function. By clicking the Edit button, a pop-up opens and you can enter a description up to 32 characters. FS Reader Software User manual

20 Priva B.V. Press the Save button to close the pop-up and save the description (in the Remark column). FS Concentrator details By clicking on a row in the list of FS Concentrators, more details of the selected device will be presented. By clicking the same device again, the detailed information will collapse. This information includes some more technical details of which the most interesting are: Last Info Update shows the moment that the most recent data from this FS Concentrator has been received. 20 FS Reader Software User manual 1.1

21 FS Routers When the FS Routers component has been selected, a list is presented of all FS Routers that are known to the system. By clicking on the headers of the columns the overview can be sorted on Serialnumber, Current Firmware, Last activity and Status. Clicking on the header a second time will invert the sorting order. The default sorting of the overview is on Status: Unlinked Registered - Linked. Filtering the list In the top left menu of the screen some filters are available. By double clicking on a status, the list will only show FS Routers with the selected status. The filtering can be reset by double clicking the Clear Filter(s) option. FS Reader Software User manual

22 Priva B.V. Adding an FS Router One can add new FS Routers to the system by entering the serial number of the device in the box on top of the screen and then clicking the +Add button or pressing the Enter key. The serial number must consist of six digits. The +Add button can only be clicked when this condition is fulfilled. When an FS Router is added, the screen will only show the new device in the list. As long as the addition of FS Routers continues, the newly added devices will be joined in this reduced list. After switching the view or pressing the Clear Filters, the complete set of FS Routers will be shown again. Removing an FS Router FS Routers with the status Registered or Unlinked can be removed from the list of FS Routers. When you move the mouse over an FS Router in the overview list, an icon appears that can be pressed in order to delete the FS Router. When the mouse is on the icon, a tooltip explains the Delete function. Restoring a removed FS Router If you add an FS Router that was previously removed, the FS Router will be restored as an unlinked device. Linking/Unlinking an FS Router When you move the mouse over a Linked FS Router in the overview list, an icon will appear that can be pressed in order to Unlink the FS Router. When the mouse is on the icon, a tooltip explains the Unlink function. Unlinked FS Routers will not communicate within your network, so this could result in reduced or no wireless communication possibility in part(s) of the deployment area. Also, when you move the mouse over an Unlinked device in the overview list, an icon will appear that can be pressed in order to Link the FS Router. When the mouse is above that icon, a tooltip explains the Link function. 22 FS Reader Software User manual 1.1

23 By clicking the Link button, the FS Router will return to the status Linked and proceed with its full functionality. Adding a description to an FS Router When you move the mouse over an FS Router in the overview list, an icon will appear that can be pressed in order to Edit information to the FS Router. When the mouse is above that icon, a tooltip explains the Edit function. By clicking the Edit button, a pop-up opens and you can enter a description up to 32 characters. Press the Save button to close the pop-up and save the description in the Remark column. FS Reader Software User manual

24 Priva B.V. FS Router details By clicking on a row in the list of FS Routers, more details of the selected device will be presented. By clicking the same device again, the detailed information will collapse. This information includes some more technical details of which the most important one: Last Info Update shows the moment that the most recent message from this FS Router has been received. 24 FS Reader Software User manual 1.1

25 Diagnostics The Diagnostics component offers the possibility to focus on specific registration data. Registrations by date In the left selection box one can choose to filter all or just one specific FS Reader: the FS Readers are sorted by serial number; when typing in the selection box, only FS Readers that match the entered data will be presented. After picking a date in the calendar and pressing the Generate button, a list of all registrations will be shown, sorted by Scan date/time. By (double) clicking on the headers of the columns, the sorting order can be changed. The overview shows the following information: Reader: the serial number of the FS Reader that generated the scan. BatchId: a unique number per FS Reader that is used to identify scans that belong together; BatchIndex: sequence number of the scan within the batch (it starts counting from zero); Processed date: date and time when the scan was transferred to FS Labour; Status: o o o Incomplete: not all scans of one batch have been received yet; Completed: all scans of one batch including the BATCH_END have been received, but not yet transferred to FS Labour; Processed: all scans of a batch have been transferred to FS Labour. Tagtype: the type of scan that was generated; Value: the specific value of the scanned Tagtype; Scan date: date and time when the scan was generated. FS Reader Software User manual

26 Priva B.V. Configuration Region selection In this component, the user can select the region and channel within the specific region that the devices will use to communicate over the wireless network. After pressing the Save button, the user is asked to confirm to proceed. When the FS Concentrator has adopted the new frequency for the wireless communication, this frequency is presented on the screen. This can take a few minutes. Choosing a region is required for the software to work properly. Choosing the wrong region will cause the devices to use an illegal frequency for your region, thus violating the local law. Therefore this step should only be performed by a Priva approved installer. 26 FS Reader Software User manual 1.1

27 In case it appears that the selected channel is disturbed by other equipment, it is possible to switch to the other channel in that region. Be aware that it requires the following steps before the complete wireless network will be operational on the new channel: An FS Concentrator checks every minute for the configured channel and will switch to the new frequency directly after it has become aware of the change. The new frequency will then be visible on the screen. If more than one FS Concentrator is connected, you can check the ones that have already switched to the new frequency by inspecting the Last Activity time stamp in the overview of all FS Concentrators. When an FS Router detects that the communication towards the FS Concentrator has been dropped, it will keep trying to reconnect to the original frequency for five minutes. The FS Router will then also try the other frequencies to reconnect to the FS Concentrator. The total time it takes before all FS Routers have switched to the new frequency depends on the number of FS Routers that form a chain. You can check which FS Routers have already switched to the new frequency by inspecting the Last Activity time stamp in the overview of all FS Routers. An FS Reader will only check for a new wireless frequency when it is placed in the FS Cradle and no wireless communication is possible. You can check which FS Readers have already switched to the new frequency by inspecting the Last Activity time stamp in the overview of all FS Readers. FS Reader Software User manual

28 Priva B.V. Firmware versions In this component, the user can view the available firmware versions and delete versions that are not required anymore. In the top left menu of the screen some filters are available. By double clicking on a device type, the list will only show the firmware versions that are available for the selected device. The filter can be reset by double clicking the Clear Filter(s) option. The overview shows all firmware versions that are known to the system: The column Status indicates: Installed version is the firmware version that is operational on a specific device; this firmware is not available for download to other devices; Update is the firmware version that has been Added to the system and that is or was available for download to the related devices. The column Required indicates: True if it is an Update type of firmware that has been selected to be downloaded to all devices of the related type; False if it is a firmware version that will not be downloaded to any device. A firmware version that is not required anymore can be deleted by selecting the related firmware version and then pressing the Delete icon that appears in the row at the right side. 28 FS Reader Software User manual 1.1

29 Add Firmware In this screen, new firmware versions can be made available to the system. Please be aware that adding a new firmware version to the system should be done by or in direct contact with a Priva service engineer. Press the Select firmware button and choose a file location where the firmware file has been supplied. After pressing the Save button, the new firmware version will be loaded into the system and set to be Required for download to all related devices. Further, automatic processing: An FS Reader will download and install a new firmware version when it is placed in the FS Cradle, after remaining scans have been uploaded from the FS Reader. FS Routers and FS Concentrators (individually) send a status message to the FS Reader Software server every two minutes. In response, the FS Router or FS Concentrator is informed about a new firmware version that can be downloaded. Since the downtime of an FS Router or FS Concentrator is very limited and the FS Readers keep working, it is not expected that firmware updates during working time will cause operational problems. The wireless network regulates that only one device (FS Reader, FS Router or FS Concentrator) will get a new firmware package at a time, to limit the load on the wireless network. FS Reader Software User manual

30 Priva B.V. Troubleshooting Troubleshooting - general Certain activities may only be performed by authorised installers/service engineers because they require specialist knowledge and skills. These activities are indicated by "Installer" in the table below. Problem Possible cause Solution(s) No login possible The Server part of the software is a The Installer should download and install the newer version than the Client part. indicated newer version of the Client software. 30 FS Reader Software User manual 1.1

31 FS Reader Software User manual

32 Priva B.V. Priva B.V. Zijlweg LC De Lier Nederland P.O. Box ZG De Lier Nederland I E contact.priva@priva.nl 32 FS Reader Software User manual 1.1