Articles in this section

Configuring Hotspots

Kani Peiris
  • Updated

 

Introduction

Once Site settings have been configured for a hotspot network (see the Encapto integration guide for your WLAN system) you can move on to configuring Hotspot Settings.

Hotspot Settings are where hotspot functionality is applied to a network (LAN or SSID) that has been configured on a Site. This functionality includes captive portal content, authentication methods, and related user experience settings.

Not all WLAN systems support all Encapto functionality directly from the Cloud Deck control panel. In these cases, these will be pointed out in the course of this guide. For a full list of Encapto functionality supported by our WLAN partners, please refer to our Encapto-WLAN Functionality Matrix.

Additionally, as much as possible, we follow the WLAN vendor’s network hierarchies, topology, and terminology, so there are differences in the ways in which some aspects of the hotspot settings are described and configured. Where this is the case, it will be clearly indicated in this guide.

 

 

Access Site Details

Hotspots are usually created in the course of configuring a Site to interface with Encapto. The exception to this is for the Mikrotik site, where a Network is configured on one or more of the Device’s interfaces and can be left as a standard network or made into a hotspot network.

 

Site List View

In all cases, hotspots can be accessed and configured via the Sites List View. To access and use this view:

  1. Click + button on Sites to expand the Sites sub menu.

    TIP: Click on Sites instead of + will show all the Sites (from every vendor) and the list view is different to below figure.

  2. Click on a vendor type to list all Sites from that vendor, in this case we use Mikrotik.

  3. Search for Sites;

    1. Enter the search text in Text field.

    2. Choose Name, Tag or Location from the drop-down menu and click the search button.

  4. Click on a Tag to search by that tag only.

  5. Click a link under PROFILE to view the Profile being used on a Mikrotik site (Profile is only applicable for Mikrotik).

  6. Click a link under HOTSPOTS to quick-view hotspots that are operating on the Site.

  7. Select a Site using the checkbox and:

    1. Delete the Site; or

    2. Edit tags on the Site (this will become an Add tags button if more than one Site is selected); or

    3. Rename the Site (single selection only).

  8. Click non-active area of the relevant Site’s line item to access Site Details.

 

Setup a hotspot on a Mikrotik Network

To set up a hotspot on a Mikrotik Site, it must first have at least one network configured on an interface (See the latest Mikrotik Integration Guide). When this has been completed, a hotspot can be configured by clicking on the Site line item from the Site List View as described at Step 8, above, then:

  1. Click the Hotspot settings tab.

  2. Find a standard network by clicking the Standard networks button.

  3. Click the Make hotspot button next to the Network on which the hotspot will be setup.

  4. The Hotspot is now ready for configuration and can be accessed by clicking the Hotspots button.

TIP: The network can be returned to its Standard network state by scrolling to the right on the line item in the Hotspots list and clicking the Remove hotspot button.

Configure Hotspot Settings

For all supported WLAN types except Meraki, Hotspot settings can be configured from the Hotspot settings tab. In the case of Meraki, Hotspot settings are configured on a per SSID basis in the SSIDs tab.

To access Hotspot Settings, click on the Site’s line item from the Site List View, click on the Hotspot settings tab (or SSIDs for Meraki Sites), and then click on the line item for the Hotspot to be configured.

 

Login Setup

The first screen to appear for all Sites is the Login setup tab. A hotspot’s Login Setup page is where the user journey – including portal, terms of use, Authentication methods, and (optionally) surveys are applied.

 

About Native Access and Roaming Access

It is possible to create a wide variety of Authentication methods by which end-users are able to access an Encapto managed Wi-Fi network. These can be applied to a hotspot in two ways:

  • As Native Access – these authentication methods will appear as options to the end-user during the onboarding journey.

  • Roaming Access – these authentication methods allow an end-user who has already accessed any hotspot using the method to automatically connect to this hotspot. Roaming Access Authentication methods are invisible to the end-user.

Where a Native Access Method and a Roaming Access Method of the same type are enabled on a hotspot for click and go, passphrase, social media, email, or SMS Authentication – the limits associated with the Native access method will apply.

For Payment Gateway, User ID, and Access Code methods, the limits associated with the Roaming method will always apply regardless of whether there is a Native method of the same type.

 

Apply Native Authentication Methods

To apply Native Auth methods to the hotspot:

  1. Click Login Setup.

  2. In the NATIVE ACCESS section, click the +Add button

    In the lightbox:

  3. Search for Authentication method;

    1. Enter the search text in Text field.

    2. Choose Name or Tag from the drop-down menu and click the search button.

  4. Select the Authentication methods to be set as Native Access from the list.

  5. Set Auto Login to either OFF or ON (see note below).

  6. Save.

Notes on Auto-Login

Auto-Login is a property of the relationship between a hotspot and an Authentication method. When Auto-login is turned on for a Native Authentication Method on a hotspot, end-users who have logged on using that same method at that hotspot will be automatically logged on (and will not see the portal) when they reconnect.

Note that for Auto-Login to function correctly, for most WLAN systems, this will also need to be enabled in the WLAN management system. For information on this, please see the relevant Encapto integration guide.

 

Configure Roaming Access

As noted above, Roaming Access allows users who have already logged in at a different hotspot using this method, to automatically roam onto the hotspot. A Roaming Access method will not be presented as an Authentication option on the hotspot.

To configure roaming access, in the ROAMING ACCESS section, click the +Add button, select the Authentication method(s) that will have roaming access to this hotspot from the list, and Save.

 

Enabling a Portal

The Encapto Portal (sometimes called a splash or landing page) is the screen that appears on an end user device on connection to the Wi-Fi network. For information on creating Encapto Portals, please refer to the Designing Portals User Guide.

To enable a portal on a hotspot:

  1. In the PORTAL section, click the Change button.
    In the lightbox:

  2. Search for Portal;

    1. Enter the search text in Text field.

    2. Choose Name or Tag from the drop-down menu and click the search button.

  3. Select a Portal.

  4. Save.

TIP: A Portal can also be assigned to a hotspot from the Portal’s Assignment tab.

Attach a Terms of Use

Terms of Use are documents used to let users know about their rights and responsibilities on connection to the hotspot. They can be created from the Terms of use navigation item. For information on creating Terms of use, see the Managing Terms of Use User Guide.

To enable a Terms document on the hotspot:

  1. In the TERMS OF USE section click the Change button
    In the lightbox:

  2. Search for Terms document;

    1. Enter the search text in Text field.

    2. Choose Name or Tag from the drop-down menu and click the search button.

  3. Select the relevant Terms document.

  4. Tick the checkbox to force the end-user to scroll through the Terms before connecting (or leave unchecked for the Terms to be presented as an optional reading link from the login screen).

  5. Save.


TIP: Terms can also be assigned to a hotspot from the Terms document’s Assignment tab.

 

Add a Survey

Surveys are used to collect information from visitors connecting to a Wi-Fi network and consist of a series on highly customisable questions that become an optional or mandatory part of the login process. For information on creating Surveys, see the Creating Surveys User Guide.

Surveys can be added to a Campaign (so that the Survey can be scheduled), an Authentication Method (so that it applies only to users who select that method), or to a Hotspot (so that it applies to all users, all the time).

To add a survey to a hotspot:

  1. In the SURVEY section click the Change button

  2. Search for Survey;

    1. Enter the search text in Text field.

    2. Choose Name or Tag from the drop-down menu and click the search button.

  3. Select the relevant Survey.

  4. Select an Asking frequency as:

    1. Always ask (not shown – will display for every user every time they login to the network);

    2. Ask once only (not shown – will display the first time a user device connects to the network only);

    3. Ask until answered once (not shown – will display for each user until that user has responded to the survey once);

    4. Ask every and then select an asking frequency.

  5. Tick the checkbox to make the survey optional (end users will be presented with a “No thanks” option and can proceed to login) or leave unchecked to make the survey a mandatory step in the login process (individual questions may still be optional as set in the survey itself).

  6. Save.

Campaign

Encapto Campaigns consist of scheduled content, which appears for a set time on end-user devices when they connect to an Encapto managed network. A campaign may also optionally include a Survey. For information on creating Campaigns, see the Building Campaigns User Guide.

A Hotspot may have a single default campaign, which will display when no campaigns are scheduled, and any number of scheduled campaigns.

 

Set a Default Campaign

The Default Campaign for a Hotspot will run when no other Campaigns are scheduled to run on the Hotspot. The default campaign will ignore any schedule settings associated with the Campaign.

To set or change a Default campaign:

  1. Click Campaign tab on the hotspot to which the Campaign(s) will be added.
    In the lightbox:

  2. In the DEFAULT CAMPAIGN section, click the Change button.

  3. Search for Campaign;

    1. Enter the search text in Text field.

    2. Choose Name or Tag from the drop-down menu and click the search button.

  4. Select the required Campaign.

  5. Save.


 

 

Set Scheduled Campaigns

Any number of scheduled campaigns can be added to a hotspot and will display according to the schedule associated with the Campaign.

To add one or more campaigns to a Hotspot:

  1. Click the +Add button in the SCHEDULED CAMPAIGNS section (not shown).
    In the lightbox:

  2. Search for Campaign;

    1. Enter the search text in Text field.

    2. Choose Name or Tag from the drop-down menu and click the search button.

  3. Select the desired Campaign(s) using the checkboxes.

  4. Save.

 

TIP: When campaigns with overlapping schedules are applied to the same Hotspot, they will display on end-user devices in a round robin fashion. Campaigns can also be assigned to hotspots from the Campaign's details tab.

 

Hotspot Details (except Mikrotik)

Hotspot details tab can be found on every vendor except Mikrotik, in Mikrotik it is called “Settings & Security” tab. This tab differs a little between different site types depending on the features of the WLAN system.

 

Portal & Redirect URLs

For Ruckus Zone Director (ZD) and vSZ, Cisco Meraki, Lancom and Cambium hotspots, the Hotspot details tab shows the Encapto Portal URL, which must be used in the WLAN management system to enable Encapto services.

 

Editing Hotspot Details

To edit Hotspot details on all WLAN systems, except Meraki and Mikrotik:

  1. Click the Edit details button.
    Then, in the lightbox:

    1. Edit the name of the hotspot.

    2. Search and select an existing tag or press enter to create a new tag and add Notes to help you locate the Hotspot later (optional).

    3. Save.

  2. Click the +Add AP button to add more Access Point MAC addresses (and SSIDs where relevant) to the hotspot.

    1. Enter the new AP MAC address.

    2. Enter the SSID.

    3. Save.

  3. Click on the existing AP MAC or SSID to Edit (Click to Delete) if required.

    1. Enter the new AP MAC address.

    2. Enter the SSID.

    3. Save.

TIP: Because Lancom works slightly differently, no SSIDs need be entered in Encapto. Note that all changes made to MAC address lists and SSIDs must correspond with changes made in the WLAN management system.

Hotspot Location

To add the location (address) of the hotspot click Edit in the HOTSPOT LOCATION section and enter the address. This will allow “Session by location” reports module, which is a heatmap report, it uses the given location/address to draw a pin on the map.

 

 

Changing the Time zone

For all Encapto managed networks it is possible to set the time zone for the network to enable effective scheduling of features such as Encapto Campaign and to produce accurate, localised reporting. To change the Time zone, click the Change button in the SETTINGS section, select the desired time zone, and click Save.

 

Settings & Security (Mikrotik Sites Only)

For Mikrotik gateway sites, Encapto is able to configure a range of hotspot settings, which for other sites are the domain of the WLAN management system. These settings are managed via the Settings & Security tab of a Hotspot on a Mikrotik Site.

 

Portal URL

Encapto Portal URL and the Preview button is for preview the portal assigned to the hotspot. Copy button can be used to copy the portal URL for sharing purposes.

 

Hotspot Location

To add the location (address) of the hotspot click Edit in the HOTSPOT LOCATION section and enter the address. This will allow “Session by location” repots module which is a heatmap report it uses the given location/address to draw a pin on the map.

 

Time zone

To enable effective scheduling of features such as Encapto Campaign and to produce accurate, localised reporting the Time zone can be changed for all Encapto managed networks. For convenience the Time zone setting for Mikrotik sites is in the Settings & Security tab.

To change the Time zone, click the Change button in the TIMEZONE section, select the desired time zone, and Save.

 

Walled Garden

Walled garden entries define the URLs to which users will be allowed access prior to logon. This feature allows Wi-Fi providers to allow free and unlimited access to key online resources.

For Mikrotik sites, walled garden entries are inherited from portals (external page links) and may also be entered here in the hotspot's Settings & Security tab.

To add Walled garden entries:

  1. In the WALLED GARDEN section, click the +Add button.

  2. In the lightbox, paste or enter the URL to which pre-logon access is required.

  3. Save.

To remove an entry from the Hotspot’s Walled garden, click the Delete button: next to the entry. Note that Walled Garden entries inherited from a Portal cannot be removed from a Hotspot’s Settings.

Tip: Websites often draw on resources from multiple domains. As a result, adding a single URL to a Walled garden may produce unexpected results. We recommend that you identify all required resources and test prior to deploying a hotspot with a Walled garden.

 

Device blacklist

The Device blacklist defines client devices that will not be allowed access to the Hotspot. These are defined by the MAC Address of the device. Users of a Blacklisted device will not be able to connect to the Hotspot or see a captive portal.

To add a device to the Device blacklist:

  1. In the DEVICE BLACKLIST section, click the +Add button.

  2. Enter the MAC address of the device to be added (colon or dash separated).

  3. Save.

To remove an entry from the blacklist, click the Delete button: next to the entry.

 

Device whitelist

The Device whitelist defines devices which are allowed unlimited and unauthenticated access to the Hotspot. This may be useful where constant and unlimited access is required for staff members for example. These devices are defined by their MAC Address.

To add a device to the Device blacklist:

  1. In the DEVICE WHITELIST section, click the +Add button.

  2. Enter the MAC address of the device to be added (colon or dash separated).

  3. Save.

To remove an entry from the whitelist, click the Delete button: next to the entry.

Tip: Whitelist devices will still be subject to any content filtering applied in Hotspot settings

 

Content filtering

Encapto content filtering blocks access to certain websites using DNS requests. Four levels of content filtering are available via Encapto’s Cloud Deck, which are labelled High, Medium, Low and None. The types of content blocked at each level are indicated in the Cloud Deck interface.

To set content filtering:

  1. Click the Change button in the CONTENT FILTERING section.

  2. Select the level of Content filtering required.

  3. Save.

 

 

 

Hotspot Sessions

Sessions tab is a read only tab which contains all the session related data in the hotspot. In the session list you’ll see;

  • Session Start time

  • Session Status

  • Name (social auth)

  • Email address

  • Mac address of the user device

  • Duration of the session

  • Amount of Downloaded data

  • Amount of Uploaded data

To view the session list;

  1. Click on Sessions tab.

  2. Search for a session by Name/Email or MAC address.

  3. INACTIVE sessions.

  4. ACTIVE sessions.

 

Network Manager

Network manager is the location that list all the Hotspot Networks in one place, which created under different sites regardless the vendor. In the Network manager you can;

  • View/Edit TAGS

  • View/Change Auth Methods

  • View/Preview/Change Portal

  • View/Change Campaigns

  • View/Change Survey

  • View/Change T&C

  • Rename the hotspot network name (except Mikrotik and Cisco Meraki sites)

To Access the Network Manager;

  1. Click on Networks tab under SITE MANAGEMENT.

  2. Search for Hotspot Network;

    1. Enter the search text in Text field.

    2. Choose Name or Tag from the drop-down menu and click the search button.

  3. Select a Hotspot network using the checkbox and:

    1. Edit tags for the Hotspot network; or

    2. Rename a Hotspot Network (except Mikrotik and Cisco Meraki); or

    3. Assign an Authentication and/or Campaign to a Hotspot Network.

    4. Change a Portal/Survey or Terms documents.

  4. Click Preview to preview the portal assigned to a Hotspot Network.

  5. Click on the non-active area to edit the Hotspot Network (see Section 3).


Related articles