User Tools

Site Tools


manual:layout

Layout

Introduction

Here you can adjust the appearance of all the different aspects of your HSMX Gateway.

  • Portal page : The page that the subscriber will see when logging onto the Internet.
  • Logout Console: Optional pop-up when the user has logged on.
  • Templates: The templates that will be used when printing out Vouchers or Invoices.
  • Logout page: Page shown when a guest logs out.
  • Registration forms: configuration on how a client should register.

Logout console

Deprecated in HSMX 5 A logout console is a small popup that guests will see when they login. A logout console can show the remaining time and volume and has a logout button. The logout console needs to be enabled in the (portal page) rules. There are two types of log-out consoles:

  • HSM logout console: a build-in logout console. The colors and text can easily be adjusted.
  • Custom logout console: a fully customizable console (requires HTML knowledge). You can download the provided example as basis for inspiration and guidance.

Logout page

Deprecated in HSMX 5 The logout page is a page where the client will be redirected to after they logout. Upload a ZIP archive that contains “index.html”

Portal page

Overview

Here is a list of all portal pages, they can be edited or deleted. In the navigation bar there is an icon to create a new portal page. The portal page rules determine which portal will be displayed to the client. Depending on the type of portal, the portal can be uploaded or a SFTP account can configured to upload the portal to the HSMX gateway.

types

There are five types of portal pages:

  • HSMX portal: this is the standard and built in portal, you can change the entire look and feel with the portal editor.
  • External: a portal page that is hosted on an external web server.
  • Custom HSM portal: this is also a standard portal but can be fully customized (requires HTML knowledge).
  • Hospitality portal: a portal page like the custom HSM portal but with advanced PMS functionalities (view bill, text messages, check out).
  • HSM portal: (depreciated) you can only change the colors and text (does not support registration forms).

Custom Portal Options

Cookie/MAC based authentication

  • Enable cookie based authentication: Check to allow cookie based authentication, this identifies the device based on the cookie the portal sets.
  • Enable MAC based authentication: Devices will be tried to identified based on their MAC address.

Login settings

  • Voucher code: this is a standard username/password log in.
  • In house guest: this option allows PMS guests to log in with their room information ( PMS for more details). Make sure PMS is enabled as payment method in the portal rule or the room fields will not be shown. If PMS is enabled in the portal rule but in house guest is disabled, the gateway will show a “new user” button on the portal page which customers can use to create a voucher by entering their room details (charge will be sent to the PMS system).

Registration forms

Registration forms are used by subscribers to register themselves into the system and (generally) receive a free billing plan. The registration form can be used in combination with OAuth / Social media websites and SMS.

The captive portal needs to support registration forms and uses the ordering to assign identifiers to each registration form. The first entry refers to ID 1, the second to ID 2 and so on.

Billing plans

  • Allow billing plan change on login

With this option enabled, guests will always be redirect to the billing plan page even if they already possess a valid billing-plan.

Welcome e-mail

Send predefined e-mail to a subscriber upon account creation. Enable it independently for vouchers and/or credit-card authorizations.

Registration forms

Registration forms can be used to create accounts on the portal and capture data while doing so! The registration form needs to be enabled while editing the portal page and the portal page needs to have the registration logic (portals created by the portal editor are already compatible with the latest features).

Form fields

These fields will be showed on the portal page and stored in the database. Placeholder and HTML5 validation are both HTML5 depended and will thus not work if the browser has no support for it.

The validate option has the following options:

  • No validation: the field is optional
  • Not empty: the field needs to contain something (equates mandatory).
  • Advanced: this option is based on regular expressions, the system will check if the input matches the expression entered here
  • If the input field is of type Checkbox (for custom fields create-custom-fields):
    • Checked The field needs to checked to validate
    • Unchecked The field needs to unchecked upon submission for validation

Username & password creation / Authentication

Defines the system auto-generated username and password if registration is successful.

  • No username: the system will generate an username with the details of the device (IP or MAC), auto login is required for this option.
  • Use guest data: one of the “form fields” can be used as username, the password will be generated by the system
  • Generate username: both username and password will be generated by the system
  • Manual: the client will be able to fill in his username and password during registration

! Username will be ignored when voucher code only is enabled.

As additional option you can enable oauth. This is a framework being used to support third party login details (Facebook, Twitter, …). With this option enabled the system will redirect you to another portal (for instance Facebook login) to complete registration. The system is also capable of fetching user info from this third party (like e-mail, if the software allows it).

OAuth

OAuth is an open protocol to allow secure authorization in a simple and standard method from web, mobile and desktop applications. Profiles for major social websites are available where only the client secret and client Id are missing. These values (together with the fields that can be captured, see data capturing tab) can be found when creating an APP on the third party server (Facebook, Twitter, …). To add more predefined values you can always contact support. More information regarding a manual API configuration can be found here: http://download.fdxtended.com/oauth_manual.html

The walled garden tab can be used to open a specific IP / domain for a specific amount of time to allow redirection without being validated, this is needed when redirecting the customer to, for instance, Facebook.

On success

This section will determine what happens when registration is complete, options are:

  • Show message: this will show a message on the portal (the PHP variable $error needs to exist on the portal)
  • Redirect to internal page: this page needs to exist in the portal (login.php for example)
  • Send e-mail: the system will sent an e-mail to the customer using the SMTP settings configured in system / system settings.
  • Send SMS: an SMS will be sent to the customer, this can be via SMTP or via an HTTP request. For more information see the SMS gateway which will be used.
  • Autologin: the system will login the subscriber without showing the portal.

Note: to send an e-mail, the registration form must contain the e-mail field. Similar logic applies to sending SMS (requires a phone number).

Misc

Name: name of the registration form

Visible for portal use: make the registration form visible for portals

Visible for admin interface: adds the registration form to web management interface (registration form will be ignored if authentication method is set to “no username”)

Layout settings

Portal session

Session cookie

A new feature that allows clients to connect even if they are blocking cookies, since the session is passed on page by page via the sessionid. The portal needs to be compatible with this feature, the portals built with the portal editor are automatically compatible with this feature. Message for portal session error. This error is retuned when Use cookies is enabled but the client block cookies.

Portal session error

When cookies are enabled, the portal session error shows up when multiple portal sessions are done with the same sessionid (e.g. multiple tabs in browser).

Templates

Templates that will be selected in the admin interface, you can change the template at any time when creating accounts.

Voucher code only

With this enabled the system will set the password equal to the username.

Password policy

Configure the password policy being used on the portal page, password policies can be used to make password changes mandatory and avoid password recycling by users.

Templates

Templates are used for vouchers, invoices and reload cards. The overview provides a list of current installed templates.

To add more templates use -icon to upload new templates in RTF file format (Microsoft Wordpad).

You can also create a template using the build-in text editor. To start press the create icon in the top-right corner and choose a name, template type and the height/width (in millimeter) of your new template. An WYSIWYG editor will load and allow you to modify the template, once done click Add.

You can delete a template using delete button in the Templates overview. To resume editing, click the edit button on the right side of the row. When trying to edit a default template a page will be shown that allows you to change the template name or download it in RTF format.

Templates created with the build-in text editor will generate PDF files when creating vouchers, whereas uploaded templates will give you an RTF file upon usage.

Available variables

Vouchers

  • ||user||
  • ||pass||
  • ||country||
  • ||state||
  • ||zip||
  • ||street||
  • ||city||
  • ||email||
  • ||phone||
  • ||fax||

Note: When Voucher Code Only is enabled use variable ||user|| to print the voucher code and not ||pass||.

Reload card

  • ||date||

Vouchers and reload card

  • ||description||
  • ||session_timeout||
  • ||volume_up||
  • ||volume_down||
  • ||expiration||
  • ||expire_time||
  • ||band_up||
  • ||band_down||
  • ||url_redirect||
  • ||sim_use|| → simultaneous use
  • ||idle_timeout||
  • ||limit_mac||
  • ||price||
  • ||sn|| → voucher serial number
  • ||creator||
  • ||bill|| → billing plan name

Invoice

  • ||voucher_code||
  • ||description||
  • ||number|| → invoice ID
  • ||price1|| → price
  • ||price2|| → price
  • ||company||
  • ||lastname||
  • ||firstname||
  • ||address||
  • ||city||
  • ||country||
manual/layout.txt · Last modified: 2016/01/18 08:48 by ewald