User Guide for Middleware Synel SY715x

Transcription

1 User Guide for Middleware Synel SY715x

2 Introduction The Middleware has two distinct purposes. First, it facilitates communication between our servers and hardware devices. This allows In and Out punches from remote locations to be collected and sent to a central location for processing. The Middleware is designed to operate at multiple locations and can process data from different types of devices. Once collected and processed, information becomes available as part of an employee s timesheet. The Middleware can also serve as a tool that automates the upload of information from your network to central servers. Such information includes Employee Data, Accrual Balances, Cost Centers and Punches. The Middleware can be pointed to a specific directory on your network to retrieve a file that will then upload automatically. Purpose - Clock In/Out Data needs to get from hardware device to central server(s). Various employee and configuration data needs to be pushed from central server(s) to data collection devices (i.e. - valid employee IDs, default cost centers, employee templates for Biometric devices, etc). Automate the upload of information from your network to central server(s). Problem - Hardware device is usually connected to company s internal network. Due to strict security it is virtually impossible to establish direct connection to a data collection device from outside a company s internal network. Most data collection devices are designed to work in a polled mode only. That is, a device cannot initiate communication, but waits for an outside entity to do so. For those devices that can initiate communication, most are not capable of doing so via HTTP/HTTPS and in compliance with standard Firewall or Proxy settings. Solution - Middleware is designed as store-and-forward software. Positioned inside a company s network, the Middleware is capable of communicating with various data collection devices on that network. At configured intervals Middleware connects to central server(s) via a HTTP or HTTPS. At this point, data that has been collected from various data collection devices will be relayed to the central server(s). In return, available updates to employee IDs, Biometric templates, etc are pushed from the central server(s) to Middleware so data may be distributed to each data collection device as specified. User Guide for Middleware Synel SY715x 2

3 Choosing a Computer The computer that you choose to install the Middleware on must meet the following conditions 1. The computer must have access to the Internet. 2. The computer must also be connected to you company s local network. 3. The computer must have the latest version of Java installed. 4. The computer must be running one of the following - Windows XP, Windows 2000, Windows 2003, or Linux. (Please consult your Application Specialist to find out which versions of Linux are supported/tested). Installing Java The Middleware is written using Java programming language. This allows the program to be installed on multiple types of system platforms. To check Java version - 1. Click the button. 2. Click the button. 3. In the Run box, type cmd in Open field. 4. Type in java version and then press [ENTER]. 5. If Java is installed, the following information (or similar) will be displayed - Java version "1.5.0_02" Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_02-b09) Java HotSpot(TM) Client VM (build 1.5.0_02-b09, mixed mode, sharing) 6. If Java is not installed, the following information (or similar) would be displayed - 'Java' is not recognized as an internal or external command, Operable program or batch file. To install Java - 1. Using your web browser, go to 2. Download the Java Runtime Environment JRE 5.0 Update Follow the instructions provided to you by Sun Microsystems on installing Java. NOTE - Java is provided by a third party (Sun Microsystems) and periodic updates occur which can render the above information invalid. It is recommended to check the status of Java regularly. Installing Middleware 1. Within your Admin account, go to Maintenance > Hardware > Documentation and Downloads. Or, within a client account, go to Company > Global Setup > Terminals (External). 2. You have the option of downloading the program as a zip or executable file. NOTE - Regardless of the program used to zip files, the Middleware file should still be unzipped and saved on your C drive. User Guide for Middleware Synel SY715x 3

4 - Option #1 Zip File a. Click the Zipped link, and then click Save. This file should be saved in a location where it can be easily b. retrieved. c. Extract the files from this directory, as per your.zip application. d. A folder labeled MW is created by default, and can be renamed. e. Save the MW folder on root drive of your machine. f. Open the MW folder. g. Click on InstallHP_And_Start_MW.cmd. - Option #2 Executable File a. Click on the Executable link, and then click Run. The following window will appear b. In the Punch MW box, select the C -\ to save the Middleware. c. Click Extract. d. A window will prompt you to create the following directory e. Select Yes to start the extraction process. User Guide for Middleware Synel SY715x 4

5 f. Once all files are extracted the following window will appear g. Click Yes again to run InstallHP_And_Start_MW.cmd. h. Either option will install the Middleware as a service. The Middleware will start every time the computer is started. This ensures that Middleware will always be running when the computer is turned on. i. When installation is complete the icon will appear in the system tray. User Guide for Middleware Synel SY715x 5

6 Configuring Middleware To configure Middleware connection information 1. Click on the icon in your system tray to view the Middleware. 2. In the Connection Information box, click the Edit Settings button 3. In the Description field, you can enter in the location of this Middleware installation, or leave blank. 4. Ensure the WebApps Server field is populated with saas.com. 5. Ensure the WebApps Port field is populated with The Proxy Information field should be left blank unless you are directed otherwise. 7. In the Company Id field type in the value given to you by your time and attendance provider. 8. In the Password field type in the value given to you by your time and attendance provider. 9. Click the Save button. The icon within your system tray should now display as. User Guide for Middleware Synel SY715x 6

7 Connecting Synel-715 to Middleware 1. Go to Middleware and click on. 2. In The Device Settings window enter in the Name, Time Zone, and Type of Device. 3. You will then view the following settings, which need to be configured: User Guide for Middleware Synel SY715x 7

8 IP - enter in an available IP on your network, which can be assigned to the SY-715. Port - should be 3734 by default. Check Interval (Sec) - the rate at which the Middleware will update and pull information from the device. Update Times (hh:mm, hh:mm) - allows you to schedule the time(s) when the clock will update, if disabled the clock will update on it s own schedule. Card Type - the type of card used to swipe. (Example - barcode, magnetic, proximity) Card Length - should be 20 by default. Enable Keyboard - enables keyboard to allow employees to type in their badge id, job number, or flat dollar amounts. Validate Employee - after swiping, the setting will check the employee is part of that company. Prompt In/Out - allows the employee to select that their punch is an in or out punch. 1 is in, 2 is out. Job Costing - enables job costing on the device, using the drop down to select the appropriate tree. Please see SY-715 Setup Instructions for further information regarding job costing on the SY-715. Badge Length - how many digits the clock will read on the barcode. Example - If you only use 10 digits then 10 should be added into this field. User Guide for Middleware Synel SY715x 8

9 badge length is 20 digits, but the clock should only read the last 14 digits therefore offset in this case would be 6 digits Badge Prepend - a specified set of numerical digits, which the system assumes precede an employees badge ID. Collect Money - enables the entering of fl at dollar amounts. (Example - $ would need to be entered as and the system assumes the last 2 digits are cents) Money Store As - allows you to specify the pay category to which the dollars are assigned. Check Schedules - allows you to restrict an employee from punching if prior to their scheduled time. 4. Click the button. 5. In the Middleware Device Settings window, you will now see that the device has been added 6. Click the checkbox next to the device s name to enable the device. The Functions button will appear, listing the following options when clicked: User Guide for Middleware Synel SY715x 9

10 Sync Time - synchronizes clock time with server time. Ping - allows the Middleware to ping the IP address of the clock and automatically enters the results of the ping test into the log files. Trace Route - allows the Middleware to trace route the IP address of the clock and automatically enters the results of the trace route into the log files. Get Status - retrieves an updated status of the device and enters the results in the log file. Clear Buffer - will remove stored punches from the device. Reset Buffer - takes all the stored punches that were read and makes them unread. Upload Employees - forces the upload of employees to the clock. Upload Codes- forces the upload of codes to the clock. Upload Settings - forces the upload of settings on the Middleware to the clock. Reprogram - do not touch unless instructed to do so by your time and attendance provider. NOTE - See SY-715 Initial Setup Instructions on next page. User Guide for Middleware Synel SY715x 10

11 SY-715 Setup Instructions NOTE - Please have the following network information available - Subnet Mask, IP Address, & Gateway Address. SY-715 has two network ports on the bottom. The middle port should be used when connecting device to the network. 1. Press [1] and [2] simultaneously six times. 2. The screen will display the version and date. Press [Enter]. 3. The screen will display - ADJUST RTC (N/Y). By default N will be selected, press [Enter]. If N is not selected, press [Out] to scroll through the options. Once N is selected, press [Enter]. 4. The screen will display - BAUDRATE By default should be selected, press [Enter]. If is not selected, press [Out] to scroll through the options. Once is selected, press [Enter]. 5. The screen will display - STATION ID By default 00 should be selected, press [Enter]. If 00 is not selected, press [Out] to scroll through the options. Once 00 is selected, press [Enter]. 6. The screen will display - MODEM RINGS - N. By default N should be selected, press [Enter]. If N is not selected, press [Out] to scroll through the options. Once N is selected, press [Enter]. 7. The screen will display - NETWORK (N/A/B) - B. By default B should be selected, press [Enter] twice. If B is not selected, press [Out] to scroll through the options. Once B is selected, press [Enter] twice. 8. The screen may display one of the following messages - Display - POLLING INTERVAL - enter all zeros and press [Enter]. Display - POLLING (Y/N) - By default N should be selected, press [Enter] twice. If N is not selected, press [Out] to scroll through the options. Once N is selected, press [Enter] twice. 9. The screen will display - PLEASE, WAIT If the steps were done correctly, the device will prompt you to Press [Enter] key. If you get an error message, please repeat steps The screen will display - MY IP ADDRESS -, enter the IP Address that you wish to assign to this machine and press [Enter] twice. 11. The screen will display - GATEWAY ADDRESS -, enter your Gateway Address and press [Enter] twice. 12. The screen will display - REMOTE ADDRESS -, enter all zeros and press [Enter] twice. 13. The screen will display - SUBNET MASK -, enter your Subnet Mask and press [Enter] twice. 14. The screen will display - MY PORT By default should be selected, press [Enter]. If is not selected, punch in the numbers and press [Enter]. 15. The screen will display - HOST PORT -, enter all zeros and press [Enter]. 16. The screen will display - DISCONCT SEC - 5. By default 5 should be selected, press [Enter]. If 5 is not selected, press [5] and press [Enter]. 17. The screen will display - DHCP - N. By default N should be selected, press [Enter]. If N is not selected, press [Out] to scroll through the options. Once N is selected, press [Enter]. 18. The screen will display - PLEASE, WAIT The device will prompt you to Press [Enter] key. 19. The screen will display - USER FIELD By default 0000 should be selected, press [Enter]. If 0000 is not selected, punch in the numbers and press [Enter]. 20. The screen will go back to its default screen, displaying the version and date. The process has been completed. How to Job Cost on SY Device should read Swipe Card, once you swipe; you should be prompted with Enter Job. 2. Enter the job number you are punching into. Press [ENTER]. 3. If you are not switching jobs, do not enter a job number and press [ENTER]. The system will assume you are punching into your default job. User Guide for Middleware Synel SY715x 11