User Tools

Site Tools


manual:subscriber

Subscribers

The HSMX has a very powerful subscriber database, the subscriber database can be populated in many ways.

  • Voucher creation via the web interface by an admin or receptionist
  • Auto generated accounts from the hospitality module (hotel PMS integration)
  • Self-registration by the client on the portal
  • Accounts generated by the UMS application (easy to use voucher generation application)
  • Accounts generated by ticket printers
  • Accounts added via the XML module (by external authentication systems)

The web-interface allows you to view, search, update and delete accounts on your system as well as export the subscriber database to your other applications.

Activate

This module allows you to authenticate devices that cannot authenticate on their own. This can be a browser-less device or a device with too strict browser / security settings that cannot open or properly display the portal page.

To activate a subscriber simply select the correct MAC or IP and choose a billing plan. As soon as the billing plan expires or the subscriber goes offline, he or she will need to authenticate or the device needs to be activated again. If you choose MAC based billing, the subscriber will always be able to go online without explicit authentication.

You can optionally specify a user name to easily identify the device later on in the overview. The option login with an existing account, logs the user in with an existing account rather then creating a new one.

Add device

MAC addresses added here will either be blocked or activated automatically when establishing a connection. You can remove or update these devices by going to Subscribers → Overview → MAC list.

You can use the upload tab to batch import a CSV list of clients. You can configure the CSV separator symbol, a Tag and the default Account status. You can use this feature to block certain MAC-addresses from accessing Internet.

The CSV file format should contain two mandatory columns; first is MAC (format 00:00:00:00:00:00) and the second is username. The third and optional column can be active or blocked, if unspecified the default setting. An example CSV file format structure:

00-11-22-33-44-55,MACA,active
00-11-22-33-44-56,MACB,blocked
00-11-22-33-44-57,MACC,

Create

This module is designed to add subscriber(s) to HSMX. This can be done one-by-one, in batch mode or by uploading a CSV file (upload).

Add Subscriber

Add a single subscriber. Fill in the username / password or use the generate-button to assist. You can configure the employed voucher template and select the associated billing-plan. Optionally, fill in the personal details fields under Advanced settings or link the account to a group, make a one-time-exception and overrule a billing-plan start- and/or end date, expiration time-out or charge the cost associated with the selected billing plan to a PMS room.

Create Voucher

Enter the amount of desired vouchers and an optional subscriber username prefix (or voucher code, if voucher code only is enabled). You can fill in a description in the Tag field. Select the billing-plan to be linked with the new vouchers and use the template drop-down menu to select the output.

Under advanced settings you can select your output; by default type is set to voucher and you'll generate new vouchers based on the selected template file. If you select csv the output will be a two column CSV file separated with , or ; depending on the next setting.

Use Amount to print to configure the number of duplicates you wish to print. You can select a group or set a company name for each voucher at once. It's also possible to overrule the start/end date and expiration time-out associated with the billing plan.

Upload

You can create new vouchers via CSV file upload. Make sure to properly configure your type to match the separator used in the CSV file. Select the CSV file and set the associated billing-plan. The most important step is to select your columns you'll want to upload, change the order using the up/down arrows and make sure the columns match exactly your CSV file.

Subscriber overview

Introduction

This module shows all users in the user database and connected devices. The listed users can be updated / deleted or logged out when they are online. It is possible to change the order and available fields of the list by clicking on the icon right of the column names. Move items from the right side to the left to include them in the view.

Some fields have an info popup (icon), when you click it; a popup will open with more information. When you click next to the username, you see the current package details and the original billing plan details (for comparison). You can also click on the bandwidth to see the current throughput of this subscriber.

Sections

  • Active: Subscribers that are currently logged in.
  • Pending: Devices that are connected to the network haven't authenticated (yet).
  • Idle: Authenticated subscribers that are not actively using their connection.
  • Expired: Subscribers with expired billing-plans.
  • Unused: Subscribers and voucher codes that haven't been used.
  • Archive: Expired (usernames in this list can be reused).
  • Blocked: Subscriber/Vouchers that have been blocked.
  • MAC list: A list of all connected and authenticated MAC addresses.
  • Connected devices: an overview of all LAN port connected devices to HSMX.

Reload cards

Introduction

Reload cards can be used to top up existing accounts. Enter the number of reload cards that need to be created, as well as the prefix for the reload code (this is to keep the codes similar). Select the billing plan and template, and click Create. In the advanced settings box, there are some additional options available.

  • Type
    • Export to a CSV file instead of a template.
  • Voucher code: Specify the format of the generated vouchers:
    • Numeric
    • Alphanumeric
    • Numeric / alphanumeric
  • Number of characters: Allows you to specify the length of the generated reload cards.

Other tabs

The other tabs list the existing reload cards.

  • used: Reload cards that are used to top up other accounts.
  • unused: Reload cards created but still unused.
  • search: Search for a specific reload card.
  • list: A list of the generated templates with reload cards that can be used for re-printing.

Subscriber Search

Introduction

In this module you can search for a specific subscriber that matches your search criteria.

Search criteria

  • Username
  • City
  • Country
  • E-mail
  • Fax
  • First name
  • Last name
  • Phone
  • State
  • Street + no
  • ZIP
  • Company
  • MAC
  • Room
  • Custom fields

These search criteria can be combined and regular expressions can be used to allow complex and powerful search queries. There is a regular expression helper next to the search field, when the regular expressions works on the example it will mark the match yellow.

Results

After clicking search the results are displayed, you can click on the information icon next to the subscriber to update or view the details. By clicking the checkbox in front of a name you can delete or batch delete the subscribers returned by the search engine.

Settings

Subscriber table

These settings can be used to auto archive subscribers from the subscribers overview.

Subscriber creation

When unique serial number per batch is enabled the system will keep increasing the serial number per voucher. If not enabled the system will start over whenever a new batch of vouchers is created.

Device connectivity

Period of no activity in minutes after which connections will be removed and accounts become idle. Configuration is applied after restarting the guest networks. The current list of all connections can be seen in Subscribers / Overview / Connected devices.

Default AAA off settings

When a location is configured with AAA state set to open devices will freely browse the Internet. This type of subscriber will employ the configured defaults:

  • Idle timeout (minutes)
  • Band up (kbps)
  • Band down (kbps)

Bandwidth utilization

This feature stores bandwidth usage per subscriber which can then be viewed in a graph. Enabling this feature when handling many authenticated devices carries a performance penalty. The collected data is not used for reporting purposes, we recommend to leave this setting off on clustered setups.

Voucher list

This lists the templates of all the vouchers that were generated on the system. From here you can download them for re-printing or delete them from the system.

manual/subscriber.txt · Last modified: 2016/01/18 08:57 by ewald