Wireless Management System (WMS) Administrator Guide. Commercial-In-Confidence Prepared by Hitech Support Pty Ltd Version 2.0 / 16 th of May 2016

Transcription

1 Wireless Management System (WMS) Administrator Guide Commercial-In-Confidence Prepared by Hitech Support Pty Ltd Version 2.0 / 16 th of May 2016 ABN

2 Contents Glossary Overview WMS Configuration Parameters: WMS Portal Overview How to access the WMS Administrator Portal WMS Portal Overview Open Hotspot Configuration User Restrictions Section Overview Overview of the User Restrictions Editor Window Overview of the Apply To Window Add a User Restriction Template Apply a User Restriction Profile to SSID Edit a User Restriction Profile Delete a User Restriction Profile User Management SIP2 Authenticated Hotspot Configuration User Restrictions Section Overview Overview of the User Restrictions Editor Window Overview of the Apply To Window Add a User Restriction Template Apply a User Restriction Profile to SSID Edit a User Restriction Profile Delete a User Restriction Profile User Management Ticketed Hotspot Configuration (Legacy System) Print Tickets Section Overview Print a single ticket Print multiple tickets How to create tickets Ticket Layouts Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 2 of 51

3 5.2.1 Section Overview Overview of Layout Editor Window An Example of a Ticket How to Add or Edit a Ticket Layout How to Delete a Ticket Layout User Restrictions Section Overview Overview of the User Restrictions Editor Window Overview of the Apply To Window Add a User Restriction Template Apply a User Restriction Profile to SSID... Error! Bookmark not defined Edit a User Restriction Profile Delete a User Restriction Profile User Management MAC Bypass Additional Sections Authentication Groups Section Overview SSIDs Section Overview URL Redirection Portal Logins Section Overview Reports Section Overview How to generate a WMS Hotspot Report Appendix 1 Interpreting the WMS Report Hotspot Traffic Usage Hotspot Logins and Connecting Devices Hotspot Logins per Hour Hotspot Session Closures Top 20 Downloaders by MAC Address Top 20 Downloaders by User Top 20 Ticket users by MAC Address Appendix 2 Overview of Hotspot Login Process Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 3 of 51

4 Glossary ADSL2+ BWM Downloads DSL bps kbps Mbps CryptoWALL and CryptoLocker LMS MPLS MAC Address P2P Per-IP Bandwidth Management ADSL stands for Asymmetric Digital Subscriber Line. ADSL2+ is a type of broadband communication technology that uses the existing copper telephone lines and can support download speeds of up to 24 Mbps. Bandwidth Management is the process of measuring and controlling the traffic on an Internet link, to avoid network congestion and poor performance of the network. Download refers to the data that is received from a remote system such as a website that is located in the Internet. In contrast, Upload is when data is sent to a remote system. Downloads can be measured by the size and speed of the data that was transferred. Digital Subscriber Line. DSL is a type of broadband communication technology that uses the existing copper telephone lines to connect devices to the Internet. One of the most common type of DSL is ADSL2+. Bits per second is a common measure of data speed for computers and networks. The speed in bps is equal to the number of bits transmitted or received each second. Kilobits per second. A kilobit is equal to one thousand bits. See bps. Megabits per second. One megabit is equal to one million bits or 1,000 kilobits. CryptoWALL and CryptoLocker are a type of malicious software that were designed to infect machines running Microsoft Windows. These are also referred to as ransomware because the software encrypts the victim s data making it inaccessible and then the software demands a ransom in exchange for decrypting the victim s data. Library Management System is an enterprise resource planning system for a library, used to track items owned, orders made, bills paid, and patrons who have borrowed. Multiprotocol Label Switching. Commonly used to create private network Also referred to as the Physical address or Hardware address. MAC address is a unique identifier for network interfaces. Wireless devices commonly refer to the MAC address as the Wi-Fi Address. Peer-to-Peer file sharing protocols. This refers to the protocols used for distributing and sharing of files through services such as BitTorrent. Peer-to-Peer file sharing have also been widely used to illegally distribute copyrighted material. A feature in the SonicWALL that apply Bandwidth Management at a Per-IP or Perdevice level to prevent network congestion or saturation. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 4 of 51

5 QoS RADIUS Round-Robin Session SIP2 SSID Upload WMS Quality of Service is used in networks to prioritise a particular flow of traffic. For example, traffic destined to the Library Catalogue website may be deemed more important than the traffic destined to a Social-Networking website. QoS can be implemented to prioritise the traffic destined to the Library Catalogue website. RADIUS stands for Remote Authentication Dial-In User Service. It is the protocol used to authenticate and record hotspot user sessions. A feature in the SonicWALL that groups multiple Internet services allowing the available bandwidth to be distributed to groups of users. E.g. a percentage of the round-robin aggregated bandwidth can be assigned to the Wi-Fi users or Public PCs. Session refers to the hotspot session. A session starts from the time a hotspot user successfully logs into the hotspot. Protocol that we use to authenticate Library members with the Library Management System to provide a premium hotspot service. Stands for Service Set Identifier. Basically, this is the name of a Wi-Fi signal or network which devices can associate to in order to connect to the Wi-Fi network. Upload refers to the data that is sent to a remote system such as a website that is located in the Internet. In contrast, Download is when data is received from a remote system. Similar to Download, Upload can be measured by the size and speed of the data that was transferred. Wireless Management System Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 5 of 51

6 1.0 Overview The Wireless Management System (WMS) provides a Wi-Fi Hotspot solution for public Internet access. It was specifically designed to meet the requirements for NSW.net libraries. This service has been running since January 2011 and is managing around 350 libraries throughout NSW. The biggest challenge facing Library Hotspot services is the ongoing need to increase the bandwidth available to the public. The reason that WMS was created was to address the bandwidth management requirements and provide Libraries with some options to control how the bandwidth is being used. The primary design criteria for the WMS Solution is to provide the Wi-Fi Hotspot users with fairer access to the available Internet Service(s) bandwidth. Hence WMS tries to provide an equal share of the available bandwidth to each user so the heavy internet users who are watching videos or downloading large files/content are not having as big an impact on the Internet service. The WMS hotspot solution is made up of the following components: Cloud Based Authentication, Monitoring and Reporting Service (hosted in Hitech Support s data centre) Uses the Libraries or Council Internet service Is deployed with a Firewall, Hotspot Controller and Access Points Antivirus, Intrusion prevention and service/application control (optional) Content Filtering (optional) WMS provides the following key features: Wi-Fi Session control; time, bandwidth and download limits Monitoring and Reporting Advanced Bandwidth control based on content (optional) Three methods of Authentication: (one or more can be used per site) o Authentication with Library Management System (for offering premium service) o Open Hotspot (user just accepts Usage Policy) o Ticketed Hotspot (for restricted or customised access) This document is intended to be used as an Administrator Guide to provide a summary of the features and a reference to help manage the hotspots. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 6 of 51

7 How does it work? We setup a Wireless Access Point (small wireless radio device) in the vicinity where the public users will be able to sit at a desk with their laptops and mobile devices. This Wireless Access Point is connected back to a hotspot controller which connects to the library firewall, an Internet Service and to the WMS service. When a user tries to connect to the library hotspot, their device locates the broadcasted SSID(s) from the nearest Wireless Access Point. The user needs to select and connect to the appropriate SSID. The user is then either automatically prompted to login in or they will be prompted when they try and browse the Internet. This depends on the device and operating system. User Authentication overview: The patron connects his device to the Library SSID An IP address is assigned to the device (WMS Controller) The device is redirected to the Login page (Located on the WMS Controller per site) The patron agrees to the T&C and clicks on submit to login The hotspot controller contacts the WMS server in the cloud (WMS Server located in Hitech Data Centre) The WMS server accepts the login and replies to the hotspot controller (WMS Server uses RADIUS to authenticate user and record session details) The device is authenticated and allowed to browse the Internet Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 7 of 51

8 There are a three user authentication methods: 1. OPEN Hotspot: The hotspot can be left open to any users who are in the vicinity which means that they can connect without having to put in a username and password. Typically, a user would only have to agree to the library s Internet Usage Policy in order to complete the login process. The advantages of this login method is that it is simple and straight forward. Browsing time, download amount and bandwidth can be specified to prevent abuse of the hotspot service. 2. TICKETED Hotspot: (for restricted access) Users are prompted to go to a service desk and request a ticket. The users are prompted to enter a username and password to gain access to the Hotspot. Once the time period expires the username and password becomes obsolete and the ticket cannot be used again. The tickets can allow a specific amount of browsing time, bandwidth and download amount. The tickets will also have an expiry date and time. 3. SIP Authenticated Hotspot: (restricted to library members only) The third way is by integrating the Wireless Hotspot with the Library Management System (LMS) to authenticate the users. Library members need to use their Library membership credentials to log into the hotspot. Browsing time, download amount and bandwidth can be specified to prevent abuse of the hotspot service. We can also setup multiple wireless networks, with different SSIDs, using different methods of access. In this case multiple SSID are setup and each SSID can have different authentication type and unique usage parameters. For example, a library can deploy a Library Visitor SSID which can be an open hotspot with limited Internet access, a Library Member SSID which will be integrated to the LMS (to provide a premium service) and a Library Training SSID where tickets can be provided to the training participants (for extended access). Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 8 of 51

9 Other features of the WMS service: Bandwidth Management: Ability to control how much of the available Internet bandwidth can be used by each of the Wi-Fi connected user. Hence you can limit the effect of users hogging the bandwidth using video streaming or downloading large files. o o Bandwidth throttling is provided on a per user basis so a single wireless hotspot user cannot consume all the bandwidth and limit the effect of their high usage on other wireless users. The hotspot can also be configured to throttle the amount of bandwidth that is used based on the content. e.g. we can throttle YouTube or downloads/update type traffic. This will provide more bandwidth to users who are trying to use the facility for less bandwidth intensive research. (optional) Automated Monthly Reporting on Internet Usage: o o o Bandwidth by Device, Top Web Sites, and Top Applications/Services On-demand reports: o o o o o o o Hotspot traffic and usage Tickets generated Tickets used Number of devices that used the hotspot Number of tickets used per device Top downloaders by username. Top downloaders by device. Allow unrestricted access to Hotspot for specific devices (MAC Bypass): (Used for Library/staff devices) o o For Ticketed Hotspots, devices can be excluded by adding their MAC address and these will be excluded from the WMS hotspot controls. For Open hotspots need to add MAC address to Hotspot Controller. This is not available through the WMS portal. Need to log call with our help desk and they will do this. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 9 of 51

10 1.1 WMS Configuration Parameters: The WMS Hotspot service has been designed to allow flexibility and advanced user session control. Parameters that can be configured: Parameter Time Credit Ticket Lifetime Download limit (MB) Download Min Bandwidth (Kbit/sec) Download Max Bandwidth (Kbit/sec) Upload Min Bandwidth (Kbit/sec) Upload Max Bandwidth (Kbit/sec) Maximum connections Definition Amount of time that the user can connect to the hotspot Expiry date when the ticket is no longer valid and cannot be used The amount of data in MB that the user can download within their hotspot session This is the minimum download bandwidth that the WMS service will try and provide to the user session. (depends on the number of users connected and the amount of available bandwidth at that time) This is the amount of download bandwidth that the WMS service will allow the user session to burst to in order to allow fast page updates. (2 3 seconds of burst) This is the minimum upload bandwidth that the WMS service will try and provide to the user session. (depends on the number of users connected and the amount of available bandwidth at that time) This is the amount of upload bandwidth that the WMS service will allow the user session to burst to in order to allow fast page updates. (2 3 seconds of burst) This is the maximum number of connections that each user can open during their session. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 10 of 51

11 Sample Configuration of a Hotspot: The table below shows an example of a site with three hotspots configured. Notice that the site has deployed multiple SSIDs and each SSID is using a different type of authentication. Each SSID has also been configured with different parameters such as Time limits, Download limits, and Bandwidth (Speed) limits. Adjustable parameters are highlighted below. Site name Deployed SSIDs XXXX Library Visitor Hotspot Open (This is an open hotspot) Training Hotspot Ticketed (This is a ticketed hotspot) Member Hotspot SIP2 (This is SIP2 or LMS integrated hotspot) SSID Parameters SSID Name Visitor Hotspot Open Training Hotspot Ticketed Member Hotspot SIP2 Time Credit 1 Day 10 Hours 1 Day Ticket Lifetime 1 Day 7 Days 1 Day Download limit (MB) Download Min Bandwidth (Kbit/sec) Download Max Bandwidth (Kbit/sec) Upload Min Bandwidth (Kbit/sec) Upload Max Bandwidth (Kbit/sec) Maximum connections Table 1: WMS Configuration sample We will be referring to the parameters above as we go through the procedures in this guide. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 11 of 51

12 2.0 WMS Portal Overview 2.1 How to access the WMS Administrator Portal The WMS Administrator Portal was designed to enable authorised users to manage a WMS Hotspot deployment. Open a web browser and navigate to and enter your username and password. If you do not have a username and password please contact our Helpdesk on (02) or support@hitechsupport.com.au Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 12 of 51

13 2.2 WMS Portal Overview Print tickets Used for Ticketed hotspots. Generate and print tickets for ticketed hotspots. 2. Reports Generate historical hotspot reports. (Admins only) 3. User Management Manage the existing user session. (Admins only) 4. User Restrictions Setup the per-session restrictions such as time limit/credit, download and bandwidth limits. (Admins only) 5. Ticket Layouts Create, edit and customise the ticket layouts and appearance for Ticketed hotspots. (Admins only) 6. MAC bypass Used to add and remove MAC bypass entries only for ticketed hotspots. (Admins only) 7. SSIDs Lists all SSIDs created within the organisation or account. (Admins only) 8. Authentication Groups Each authentication group contains unique hotspot parameters. An Authentication group can be assigned to multiple SSIDs. This section shows all the Authentication groups available within the organisation. (Admins only) 9. Portal Logins Create, edit, and delete WMS portal accounts. You can create Administrator and Print only accounts. (Admins only) Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 13 of 51

14 3.0 Open Hotspot Configuration 3.1 User Restrictions This section is used to setup the User Restrictions which contains settings such as time credit or limit, download quota and bandwidth limits. This section is only accessible by Administrator level accounts Section Overview Name A descriptive name for the User Restriction. 2. Time The amount of time each user can stay connected to the hotspot. (max 1 day) 3. Expiry The amount of time before the user session will expire. (max 1 day) 4. Bandwidth (min/max) This shows the allocated minimum and maximum download bandwidth. (Minimum = Guaranteed bandwidth target; Maximum = burst rate for initial 2 3 seconds when user browses or updates content i.e. Does not help streaming traffic) 5. Download The amount of download quota allocated to each hotspot session in Megabytes. 6. Apply to Use this button to apply the User Restriction to an SSID. 7. Edit Use this button to modify the parameters of a User Restriction. 8. Add new profile Use this button to add a new User Restriction Profile. 9. Delete selected Use this button to delete a User Restriction Profile. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 14 of 51

15 3.1.2 Overview of the User Restrictions Editor Window Template name A descriptive name of the User Restriction Profile. 2. Time credit The amount of time each user can stay connected to the hotspot. (max 1 day) 3. Ticket lifetime The amount of time before the session will expire. (max 1 day) 4. Download limit The amount of download quota allocated to each hotspot session in Megabytes. 5. DL Min Bandwidth The target download speed. 6. DL Max Bandwidth The burst download speed. When a website is loading, the first 3 seconds will burst to this speed. 7. UL Min Bandwidth The target upload speed. 8. UL Max Bandwidth The burst upload speed. When a website is loading, the first 3 seconds will burst to this speed. 9. Maximum connections The maximum number of connections/session that a user is allowed to have open. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 15 of 51

16 3.1.3 Overview of the Apply To Window Select site Select a Site. Selecting a site will then list the available SSIDs. 2. Select SSID Select the SSID(s) where you want to apply the User Restriction Profile. 3. Add button Use the button to send the SSID to the right column. The SSIDs on the right column will be applied with the User Restriction upon pressing the Save button. 4. Remove button Use the button to remove SSIDs from the right column. 5. Save Save the changes. 6. Cancel Cancel the changes Add a User Restriction Profile 1. Click on Add new profile to add a new ticket template. 1. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 16 of 51

17 2. Fill in the following settings as required. Template name A descriptive name of the User Restriction Profile. Time credit The amount of time each user can stay connected to the hotspot. (max 1 day) Ticket lifetime The amount of time before the session will expire. (max 1 day) Download limit The amount of download quota allocated to each session in Megabytes. DL Min Bandwidth The target download speed. DL Max Bandwidth The burst download speed. When a website is loading, the first 3 seconds will burst to this speed. UL Min Bandwidth The target upload speed. UL Max Bandwidth The burst upload speed. When a website is loading, the first 3 seconds will burst to this speed. Maximum connections The maximum number of connections that a hotspot session is allowed to have. 3. Click Save once all the details required are filled in. Note: For non-ticketed hotspots, a User Restriction template is applied to the SSID and is then applied to every user who logs in to the hotspot. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 17 of 51

18 3.1.5 Apply a User Restriction Profile to SSID This procedure applies to non-ticketed and SIP2 hotspots only. User Restrictions Profiles are applied to ticketed hotspots upon printing tickets Click on Apply to next to the User Restriction Profile that you want to apply. This will open a separate window. 2. Select a Site 3. Select an SSID where you would like to apply the User Restriction Profile. 4. Click on the button to add the SSID to the list on the right. Multiple SSIDs can be added to the list. 5. Once all the SSIDs have been added to the list on the right, press Save to apply the User Restriction Profile to all the SSIDs you have added on the list. Note: You can use the SSID section to confirm that the User Restriction Profile has been applied. User Restrictions will apply immediately for any new logins or tickets. Existing tickets or users that have already logged in for the day will still use the previous restrictions. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 18 of 51

19 3.1.6 Edit a User Restriction Profile To edit a template, find the template name and click on Edit located on the right. Modify the fields as required. Click Save once all the details required are filled in. Note: User Restriction Profiles will apply immediately to new logins. Existing users that have already logged in for the day will still use the previous restrictions Delete a User Restriction Profile To delete a User Restriction Profile, you have to ensure that it is not in use. If you try to delete a User Restriction Profile that is currently in use, you will get the following warning. The warning will also show the SSIDs where the User Restriction Profile is currently applied. You must apply a different User Restriction Profile to the listed SSIDs first. Once you have freed up the User Restriction Profile from every SSID, you can select the User Restriction and click on Delete to remove the User Restriction permanently. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 19 of 51

20 3.2 User Management This section shows all the current users or tickets along with amount of time and data left on their session. It also includes details about the sessions bandwidth limits, last login, expiry and date of creation. This section is only accessible by Administrator level accounts. 1. Date This field can be used to filter the list using a date value. By default, the date value will refer to the date when the Username was created. 2. User Use this field to search for the username which can be any of the following: a. MAC Address - For Open Hotspots, the MAC address is used. b. Username For Ticketed Hotspots, the username on the ticket is used. c. Borrower ID For SIP2 Hotspots, the Borrower ID is used. 3. Delete Selected Use this button to delete the entries that have been selected from the list of users. 4. Date Type The Date Type can be changed to alter how the Date field (mentioned earlier in 1.) is used. By default, this is set to the Created. a. First Login Select this to filter the results based on the date when the user first logged. b. Last Login Select this to filter the results based on the date when the user last logged in. c. Created Select this to filter the results based on the date when the username was created. d. Expires Select this to filter the results based on the date when the username/ticket will expire. 5. Authentication Group The Authentication group which the ticket belongs to. Refer to Authentication Groups in section 6.1 for more information. 6. Search button Use this button to start the search. 7. Delete all button Use this button to delete all the users or tickets for the entire organisation. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 20 of 51

21 You can Search and Sort the list of Usernames to look for a user and check their current status or use the Delete button to delete their session. The Delete All button will delete all the users or tickets for the entire organisation. This is useful when doing housekeeping and purging hotspot tickets that can no longer be accounted for. Be careful when using this feature. Note: For non-ticketed and SIP2 integrated hotspots, deleting a username means the user will be able to login as if he is logging in for the first time today. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 21 of 51

22 4.0 SIP2 Authenticated Hotspot Configuration 4.1 User Restrictions This section is used to setup the User Restrictions which contains settings such as time credit or limit, download quota and bandwidth limits. This section is only accessible by Administrator level accounts Section Overview 1. Name A descriptive name for the User Restriction. 2. Time The amount of time each user can stay connected to the hotspot. (max 1 day) 3. Expiry The amount of time before the user session will expire. (max 1 day) 4. Bandwidth (min/max) This shows the allocated minimum and maximum download bandwidth. (Minimum = Guaranteed bandwidth target; Maximum = burst rate for initial 2 3 seconds when user browses or updates content i.e. Does not help streaming traffic) 5. Download The amount of download quota allocated to each hotspot session in Megabytes. 6. Apply to Use this button to apply the User Restriction to an SSID. 7. Edit Use this button to modify the parameters of a User Restriction. 8. Add new profile Use this button to add a new User Restriction Profile. 9. Delete selected Use this button to delete a User Restriction Profile. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 22 of 51

23 4.1.2 Overview of the User Restrictions Editor Window Template name A descriptive name of the User Restriction Profile. 2. Time credit The amount of time each user can stay connected to the hotspot. (max 1 day) 3. Ticket lifetime The amount of time before the session will expire. (max 1 day) 4. Download limit The amount of download quota allocated to each hotspot session in Megabytes. 5. DL Min Bandwidth The target download speed. 6. DL Max Bandwidth The burst download speed. When a website is loading, the first 3 seconds will burst to this speed. 7. UL Min Bandwidth The target upload speed. 8. UL Max Bandwidth The burst upload speed. When a website is loading, the first 3 seconds will burst to this speed. 9. Maximum connections The maximum number of connections/session that a user is allowed to have open. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 23 of 51

24 4.1.3 Overview of the Apply To Window 1. Select site Select a Site. Selecting a site will then list the available SSIDs. 2. Select SSID Select the SSID(s) where you want to apply the User Restriction. 3. Add button Use the button to send the SSID to the right column. The SSIDs on the right column will be applied with the User Restriction upon pressing the Save button. 4. Remove button Use the button to remove SSIDs from the right column. 5. Save Save the changes. 6. Cancel Cancel the changes Add a User Restriction Template 1. Click on Add new profile to add a new ticket template. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 24 of 51

25 2. Fill in the following settings as required. Template name A descriptive name of the User Restriction Profile. Time credit The amount of time each user can stay connected to the hotspot. (max 1 day) Ticket lifetime The amount of time before the session will expire. (max 1 day) Download limit The amount of download quota allocated to each session in Megabytes. DL Min Bandwidth The target download speed. DL Max Bandwidth The burst download speed. When a website is loading, the first 3 seconds will burst to this speed. UL Min Bandwidth The target upload speed. UL Max Bandwidth The burst upload speed. When a website is loading, the first 3 seconds will burst to this speed. Maximum connections The maximum number of connections that a hotspot session is allowed to have. 3. Click Save once all the details required are filled in. Note: For SIP2 hotspots, a User Restriction template is applied to the SSID and is then applied to every user who logs in to the hotspot. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 25 of 51

26 4.1.5 Apply a User Restriction Profile to SSID This procedure applies to non-ticketed and SIP2 hotspots only. User Restrictions Profiles are applied to ticketed hotspots upon printing tickets Click on Apply to next to the User Restriction Profile that you want to apply. This will open a separate window. 2. Select a Site 3. Select an SSID where you would like to apply the User Restriction Profile. 4. Click on the button to add the SSID to the list on the right. Multiple SSIDs can be added to the list. 5. Once all the SSIDs have been added to the list on the right, press Save to apply the User Restriction Profile to all the SSIDs you have added on the list. Note: You can use the SSID section to confirm that the User Restriction Profile has been applied. User Restrictions will apply immediately for any new logins or tickets. Existing tickets or users that have already logged in for the day will still use the previous restrictions. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 26 of 51

27 4.1.6 Edit a User Restriction Profile To edit a template, find the template name and click on Edit located on the right. Modify the fields as required. Click Save once all the details required are filled in. Note: User Restrictions will apply immediately for any new logins or tickets. Existing tickets or users that have already logged in for the day will still use the previous restrictions Delete a User Restriction Profile To delete a User Restriction Profile, you have to ensure that it is not in use. If you try to delete a User Restriction Profile that is currently in use, you will get the following warning. The warning will also show the SSIDs where the User Restriction Profile is currently applied. You must apply a different User Restriction Profile to the listed SSIDs first. Once you have freed up the User Restriction Profile from every SSID, you can select the User Restriction and click on Delete to remove the User Restriction permanently. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 27 of 51

28 4.2 User Management This section shows all the current users or tickets along with amount of time and data left on their session. It also includes details about the sessions bandwidth limits, last login, expiry and date of creation. 1. Date This field can be used to filter the list using a date value. By default, the date value will refer to the date when the Username was created. 2. User Use this field to search for the username which can be any of the following: a. MAC Address - For Open Hotspots, the MAC address is used. b. Username For Ticketed Hotspots, the username on the ticket is used. c. Borrower ID For SIP2 Hotspots, the Borrower ID is used. 3. Delete Selected Use this button to delete the entries that have been selected from the list of users. 4. Date Type The Date Type can be changed to alter how the Date field (mentioned earlier in 1.) is used. By default, this is set to the Created. a. First Login Select this to filter the results based on the date when the user first logged. b. Last Login Select this to filter the results based on the date when the user last logged in. c. Created Select this to filter the results based on the date when the username was created. d. Expires Select this to filter the results based on the date when the username/ticket will expire. 5. Authentication Group The Authentication group which the ticket belongs to. Refer to Authentication Groups in section 6.1 for more information. 6. Search button Use this button to start the search. 7. Delete all button Use this button to delete all the users or tickets for the entire organisation. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 28 of 51

29 You can Search and Sort the list of Usernames to look for a user and check their current status or use the Delete button to delete their session. The Delete All button will delete all the users or tickets for the entire organisation. This is useful when doing housekeeping and purging hotspot tickets that can no longer be accounted for. Be careful when using this feature. Note: For non-ticketed and SIP2 integrated hotspots, deleting a username means the user will be able to login as if he is logging in for the first time today. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 29 of 51

30 5.0 Ticketed Hotspot Configuration (Legacy System) 5.1 Print Tickets This section is used to generate and print tickets for ticketed hotspots. This section is only available for Print and Admin level accounts Section Overview Print a single ticket 1. User restrictions Select the User Restriction that will be applied to the ticket. 2. Ticket layout Select the Ticket layout that will be applied to the ticket. 3. Authentication group Select the Authentication group that will be applied to the ticket. 4. Print button (single) Click this button to generate a single ticket Print multiple tickets 5. Number of tickets Enter the number of tickets to be created. A maximum of 99 tickets can be generated per request. 6. Ticket settings profile Select the User Restriction that will be applied to the ticket. 7. Ticket layout Select the Ticket layout that will be applied to the ticket. 8. Authentication group Select the Authentication group that will be applied to the ticket. 9. Print button (multi) Click this button to generate multiple tickets. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 30 of 51

31 5.1.4 How to create tickets 1. In the Print tickets section. Select the setting for each of the following parameters: a. User restriction b. Ticket layout c. Authentication group. These settings are preconfigured and can be modified as required. Please refer to the later sections of this guide for further information on these settings. To create multiple tickets, enter the Number of tickets. A maximum of 99 tickets can be generated per request. 2. To proceed in creating a single ticket, click on the button. Alternatively, multiple tickets can be created by clicking on the button. After a few seconds, the ticket(s) should appear on the screen. 3. To print the ticket, click on the Printer button located on the top left corner of the Print Ticket window. Click here to print Note: If you are printing a ticket for the very first time using Microsoft s Internet Explorer, the Crystal Reports Print Control will ask to be installed on your computer as a browser extension. Please speak to your IT department to gain Administrative rights required to install Crystal Reports Print Control. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 31 of 51

32 4. On the Print Setup window that will appear, select your printer Click on Print to proceed with printing the tickets. 5 Note: When using a Google Chrome browser, a Print to PDF dialog box is presented instead of a Print Setup window shown above. In this case, a PDF document is generated which can then be printed as required. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 32 of 51

33 5.2 Ticket Layouts This section is used to create, edit and customise the Ticket layouts that are used to print tickets. This section is only available for Admin level accounts Section Overview Layout Name A descriptive name of the layout. This does not appear in the print out. 2. Printer Type The type of printer the layout is used for. Choose either A4 or Receipt. 3. Title Text The text that will appear in the header of the ticket. 4. Logo A thumbnail of the logo that will appear in the ticket. 5. Edit The Edit button can be used to modify an existing Ticket Layout. 6. Delete Use the Delete button to permanently delete a Ticket Layout. 7. Add new layout Use the Add new layout button to create new Ticket layouts Overview of Layout Editor Window The Layout Editor window appears when you click either the Edit or Add new layout button. 1. Layout name Enter a descriptive name of the layout. This does not appear in the print out. 2. Printer output Choose the type of printer that will be used to print tickets. Choose either A4 or Receipt. 3. Ticket title text Enter the text that will appear in the header of the ticket. 4. Ticket footer text Enter the text that will appear in the bottom of the ticket. 5. Current logo A preview of the logo that has been uploaded to the layout. This is blank if you are adding a new layout. 6. Upload new logo Use this button to upload a new or replacement logo for the ticket layout. 7. Save Save the changes. 8. Cancel Cancel the changes Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 33 of 51

34 5.2.3 An Example of a Ticket This is how the ticket will look like when printed. Title Text Logo Footer Text How to Add or Edit a Ticket Layout 1. Click on the Ticket Layouts tab to add/modify/remove configured ticket layouts. 2. Click on Add new layout or Edit to add/modify a new Ticket layout. Tip: A default Ticket layout can be specified per account in the Portal Logins tab. Refer to section 6.4 for further information. 3. Type in the Layout name 4. Select the Printer output. Either A4 or Receipt roll (80mm). 5. Enter a Ticket title text Enter a Ticket footer text 7. Click on Choose File to upload a new logo. 8. Click Save once all the details required have been filled in. This layout can then be selected when printing new tickets in the Print Tickets section How to Delete a Ticket Layout To delete a layout, find the layout name to be deleted and click on Delete. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 34 of 51

35 5.3 User Restrictions This section is used to setup the User Restrictions which contains settings such as time credit or limit, download quota and bandwidth limits. This section is only available for Admin level accounts Section Overview Name A descriptive name for the User Restriction. 2. Time The amount of time each user can stay connected to the hotspot. 3. Expiry The amount of time before the user session will expire. 4. Bandwidth (min/max) This shows the allocated minimum and maximum download bandwidth. (Minimum = Guaranteed bandwidth target; Maximum = burst rate for initial 2 3 seconds when user browses or updates content i.e. Does not help streaming traffic) 5. Download The amount of download quota allocated to each hotspot session in Megabytes. 6. Apply to Use this button to apply the User Restriction to an SSID. 7. Edit Use this button to modify the parameters of a User Restriction. 8. Add new profile Use this button to add a new User Restriction Profile. 9. Delete selected Use this button to delete a User Restriction Profile. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 35 of 51

36 5.3.2 Overview of the User Restrictions Editor Window Template name A descriptive name of the User Restriction Profile. 2. Time credit The amount of time each user can stay connected to the hotspot. 3. Ticket lifetime The amount of time before the ticket will expire. 4. Download limit The amount of download quota allocated to each hotspot session in Megabytes. 5. DL Min Bandwidth The target download speed. 6. DL Max Bandwidth The burst download speed. When a website is loading, the first 3 seconds will burst to this speed. 7. UL Min Bandwidth The target upload speed. 8. UL Max Bandwidth The burst upload speed. When a website is loading, the first 3 seconds will burst to this speed. 9. Maximum connections The maximum number of connections/session that a user is allowed to have open Overview of the Apply To Window 1. Select site Select a Site. Selecting a site will then list the available SSIDs. 2. Select SSID Select the SSID(s) where you want to apply the User Restriction. 3. Add button Use the button to send the SSID to the right column. The SSIDs on the right column will be applied with the User Restriction upon pressing the Save button. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 36 of 51

37 4. Remove button Use the button to remove SSIDs from the right column. 5. Save Save the changes. 6. Cancel Cancel the changes Add a User Restriction Template 1. Click on Add new profile to add a new ticket template. 2. Fill in the following settings as required. Template name A descriptive name of the User Restriction Profile. Time credit The amount of time each user can stay connected to the hotspot. Ticket lifetime The amount of time before the ticket will expire. Download limit The amount of download quota allocated to each session in Megabytes. DL Min Bandwidth The target download speed. DL Max Bandwidth The burst download speed. When a website is loading, the first 3 seconds will burst to this speed. UL Min Bandwidth The target upload speed. UL Max Bandwidth The burst upload speed. When a website is loading, the first 3 seconds will burst to this speed. Maximum connections The maximum number of connections that a hotspot session is allowed to have. 3. Click Save once all the details required are filled in. Note: For Ticketed hotspots, a User Restriction template is selected and applied when printing new tickets in the Print Tickets section. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 37 of 51

38 5.3.5 Edit a User Restriction Profile To edit a template, find the template name and click on Edit located on the right. Modify the fields as required. Click Save once all the details required are filled in. Note: Existing tickets will still use the old attributes of the User Restriction Profile. New tickets will need to be generated using the modified User Restriction Profile Delete a User Restriction Profile To delete a User Restriction Profile, you have to ensure that it is not in use. If you try to delete a User Restriction Profile that is currently in use, you will get the following warning. The warning will also show the SSIDs where the User Restriction Profile is currently applied. You must apply a different User Restriction Profile to the listed SSIDs first. Once you have freed up the User Restriction Profile from every SSID, you can select the User Restriction and click on Delete to remove the User Restriction permanently. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 38 of 51

39 5.4 User Management This section shows all the current users or tickets along with amount of time and data left on their session. It also includes details about the sessions bandwidth limits, last login, expiry and date of creation. 1. Date This field can be used to filter the list using a date value. By default, the date value will refer to the date when the Username was created. 2. User Use this field to search for the username which can be any of the following: a. MAC Address - For Open Hotspots, the MAC address is used. b. Username For Ticketed Hotspots, the username on the ticket is used. c. Borrower ID For SIP2 Hotspots, the Borrower ID is used. 3. Delete Selected Use this button to delete the entries that have been selected from the list of users. 4. Date Type The Date Type can be changed to alter how the Date field (mentioned earlier in 1.) is used. By default, this is set to the Created. a. First Login Select this to filter the results based on the date when the user first logged. b. Last Login Select this to filter the results based on the date when the user last logged in. c. Created Select this to filter the results based on the date when the username was created. d. Expires Select this to filter the results based on the date when the username/ticket will expire. 5. Authentication Group The Authentication group which the ticket belongs to. Refer to Authentication Groups in section 6.1 for more information. 6. Search button Use this button to start the search. 7. Delete all button Use this button to delete all the users or tickets for the entire organisation. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 39 of 51

40 You can Search and Sort the list of Usernames to look for a user and check their current status or use the Delete button to delete their session. The Delete All button will delete all the users or tickets for the entire organisation. This is useful when doing housekeeping and purging hotspot tickets that can no longer be accounted for. Be careful when using this feature. Note: For ticketed hotspots, deleting a username/ticket means the ticket will become invalid. 5.5 MAC Bypass Configure devices to bypass the hotspot login system. This is only applicable to ticketed setups. This section is only available for Admin level accounts. 1. Click on Add new MAC to add a MAC bypass. 2. MAC address Enter the MAC Address also known as the Hardware Address or Wi-Fi Address. 3. Description Enter a description to describe what this device will be used for. 4. Ticket Policy Select the User Restriction that will be applied to this MAC Bypass entry. 5. Authentication Group Select an Authentication group where this MAC bypass entry will take effect. 6. Click Save once all details required are filled in. A search function is also available when managing the MAC Bypass entries. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 40 of 51

41 6.0 Additional Sections The following sections applies to all types of hotspot configurations 6.1 Authentication Groups This section lists all the Authentication Groups that are currently available for use on the hotspots. This section is only available for Admin level accounts Section Overview 1. Name The Name of the Authentication Group. 2. Description A short description of what the Authentication Group is used for. 3. Type The Authentication Type configured for the Authentication Group. An Authentication Group is used to define an SSID s Authentication type and hotspot parameters. There are currently three types of Authentication Groups: Authentication Type Open Description Hotspot users can connect without having to put in a username and password. Using this authentication type, a user would typically only have to agree to the library s Internet Usage Policy in order to complete the login process. Ticketed SIP2 Table 2: Authentication types Hotspot users are prompted to go to a service desk and request for a hotspot ticket. Library members can login to the hotspot using their borrower ID. Each Authentication Group can have different hotspot parameters such as bandwidth, download quota and connection time. This allows every SSID to use a different set of hotspot parameters if necessary. If you need to modify/create/assign an Authentication Group or if you have any further queries, please contact our Helpdesk on (02) or support@hitechsupport.com.au. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 41 of 51

42 6.2 SSIDs This section shows all the current SSIDs deployed in your organisation and summarises the current configuration of each SSID. This is especially useful to identify which Authentication Group and User Restriction is currently applied to an SSID. This section is only available for Admin level accounts Section Overview 1. SSID This refers to the name of the SSID. 2. Location This refers to the name of the Site where the SSID is deployed. 3. Description A description of what the SSID is used for. 4. User Restrictions This refers to the User Restriction that is currently assigned to the SSID. Refer to User Restrictions on Page 12 for more information. 5. Authentication Group This refers to the Authentication Group that is currently assigned to the SSID. Refer to Authentication Groups on section 6.1 for more information. 6.3 URL Redirection After a device successfully logs into the hotspot, the WMS hotspot can redirect the user to a specific URL. For example, URL redirection can be useful to redirect hotspot users to the Library s social networking page or the Council s home page. To setup a URL redirection, please contact our Helpdesk on (02) or support@hitechsupport.com.au Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 42 of 51

43 6.4 Portal Logins This section is used to create, edit, and delete WMS Portal accounts. This section is only available for Admin level accounts Section Overview Username This refers to the username that is used to login into the WMS Portal. 2. Name This is a descriptive name of who the login is for. 3. Type This refers to the type of User. For more information, refer to Table 3 below. 4. Edit Use this button to modify the parameters of the user. 5. Delete Use this button to delete the user. 6. Add new user button Use this button to create a new user. Edit User Window Overview 7. Name This is a descriptive name of who the login is for. 8. User Type This refers to the type of User. For more information, refer to Table 3 below. 9. Username This refers to the username that is used to login into the WMS Portal. 10. Password & Confirm Password Enter and confirm the password that will used for the login. 11. Default User Template This refers to the User Restriction template that will be selected by default when printing tickets in the Print Tickets Section. This is handy when there are multiple User Restrictions available. 12. Default Ticket Setup This refers to the Ticket Layout that will be selected by default when printing tickets in the Print Tickets Section. This is handy when there are multiple Ticket Layouts available Address An address contact for the user who owns the login. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 43 of 51

44 Three User Types that are currently available: User Type Admin Description An Admin level user has access to all the sections of the WMS Portal. Ticket Printing Only Kiosk User A Print level user only has access to the Print Ticket section of the WMS Portal. Kiosk User is designed for Kiosk machines and has the same access level as a Print level user. Table 3: User Types for WMS Portal login Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 44 of 51

45 7.0 Reports This section is used to generate historical WMS Hotspot Reports. This section is only available for Admin level accounts. 7.1 Section Overview Start date and End date Select the dates that will be included in the report. The report will be generated and compiled using the data within the dates that you have selected. 2. Select site Select a Site that will be included in the report. 3. Select SSID Select an SSID that will be included in the report. 4. Create button Click the Create button to generate a WMS Report. 7.2 How to generate a WMS Hotspot Report 1. Select the Start date and End date. Print and navigation 2. Select the Site that will be included in the report. 3. Select the SSID. 4. Click Create. 5. A new window should appear with the WMS Hotspot Report. The report consist of six pages which can be navigated by using the buttons located on the top-left corner of the window. 6. To print the Report, click on the printer button located on the top left corner to print the WMS Hotspot Report. Note: Check that browser Pop-ups are allowed for hotspot.hitechsupport.com.au as your browser may block the WMS Hotspot Report window. For more information about the data included in the WMS Hotspot Report, refer to Appendix 1 - Interpreting the WMS Report. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 45 of 51

46 Appendix 1 Interpreting the WMS Report Hotspot Traffic Usage Downloaded - Amount of data received by wireless users expressed in Megabytes. Uploaded - Amount of data sent by wireless users expressed in Megabytes. Connected Cumulative amount of time that wireless users spent connected to the hotspot. Refer to the document Wireless Management System (WMS) SGMS Reporting - How to Guide for a detailed report of the data usage Hotspot Logins and Connecting Devices Name Hotspot logins Devices Description Total logins to the hotspot for this site. Note: Every time a user has to go through the hotspot landing page is counted as a hotspot login. Number of unique devices logging into the hotspot based on MAC address. Note: Unique devices are counted per day. For example, if an ipad is used to access the hotspot on the 1st of July and then the same device logged in again on the 2nd of July. When you generate a report including the dates 1st and 2nd of July, the ipad will be counted twice in the reports because it logged on to the hotspot on two different days. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 46 of 51

47 Hotspot Logins per Hour The Total number of Logins grouped by the hour. Hotspot Session Closures A graphical representation of the most common session closure reason for hotspot devices. Name User-Request Idle-Timeout Session-Timeout Lost-Service Lost-Carrier NAS-Request Description User logged out of the hotspot User was inactive and was logged out automatically Time limit for the session was reached User was disconnected from the hotspot without logging out Internet or hotspot server unavailable The session was terminated by the hotspot controller. Doc Name: Wireless Management System (WMS) User Guide RD.docx Page 47 of 51