Page 1 Unibox User Guide An intelligent Network Access Controller Wifisoft Solutions Private Limited...
Page 2 © Disclaimer Copyright 2018, Wifi-soft Solutions Pvt. Ltd. All rights reserved. WIFI-SOFT SOLUTIONS PRIVATE LIMITED The information contained herein is subject to MAKES NO WARRANTY OF ANY KIND WITH RE- change without notice. This document con- GARD TO THIS MATERIAL, INCLUDING, BUT...
Page 3 IT approval of their BYOD devices and. UniBox is an all-in-one gateway controller i.e. it functions both as a firewall and an access controller as well as an authentication and billing server. It implements a captive portal that restricts unauthenticated users from getting access to the network resources e.g.
Page 4: Primary Functions
BYODs as well as secure access to internal devices from the Internet. Unibox also provides SNMP agents and SNMP traps to interface with third-party NMS systems. Finally the DDNS feature allows administrators to use DDNS services like anyDNS, no-ip etc that allows access to UniBox deployed on a dynamic IP.
Page 5 IT department by filling up a short browser based form splashed thru the Unibox, as user tries to go to Internet, and then submits the same over to the IT department, which then approves or otherwise the access and then notify the user via their company email to be of granted access to the limited BYOD network.
Page 6 QoS. Traffic management can be done at different levels like group of users, per user, per application or port or a subnet of IP addresses. UniBox provides dif- ferent policies to enforce fair usage on the network or penalize users who are misusing the network traffic.
Page 7: Important Concepts
User accounts created are generally associated to a particular groups, policies or plans. Users Internet usage can be restricted based on the plan or groups they belong. Unibox allows you to configure various restrictions for each user like Session timeout, Concurrency Limit, Idle Timeout, Upload/Download Rate, Daily Upload/Download Quota, Sessions per day and Us- age Quota.
Page 8 When the user registers for a new account, UniBox passes the credit card details to the pay- ment gateway for processing. If the card is charged successfully, the user’s account is created in subscriber table and user is given access based on the billing plans he selects.
Page 9 Activity logging means tracking the user browsing activity and logging the URLs the user visits while using UniBox managed network. This is an optional feature and can be activated on need basis. When activated, UniBox starts keeping track of the Internet activity for the user and logs the activity in a database.
Page 10 Available Models: U200 and U500 This model is ideal for medium sized networks and is capable for support up to 200 to 500 concurrent devices. This UniBox is ideal for medium venues like hotels, motels, shopping plaza, training institutes, medium sized businesses, etc.
Page 11 Large Campus Series Models: U5000 These models support large number of concurrent users and provides high throughput. It comes with 6 gigabit Ethernet ports and 2 SFP+ ports. It is ideal for very large venues like convention centers, universities, airports and large enterprises. In addition, you can also order custom model for networks that have more than 5000 concurrent users or where there is a need for a redundant power supply and redundant LAN side connections for hook up to a stack of enterprise switches or two core enterprise switches, for better resiliency.
Page 13: Installation
UniBox U-200 standalone unit comes in 1U form factor with 4 Ethernet ports, 2 USB ports, serial port and power jack. The photo shows the various ports available on UniBox U200. Any port can be configured as WAN or LAN port. The admin can create multiple WAN profile and then assign these profiles to multiple Ethernet ports.
Page 14: Network Deployment
POE switch using CAT-5e cables or via Power injectors. The LAN port of UniBox is plugged into the switch. The access points are usually configured in bridge mode thus allowing the clients to directly communicate with the UniBox. UniBox is responsible for assigning IP addresses on the network.
Page 15: Feature Summary
1. Port settings – Configure IP settings for WAN and LAN ports. 2. DNS server – configure the primary and secondary DNS servers 3. DHCP server – UniBox runs a DHCP server that issues IP addresses to the clients con- nected on LAN ports.
Page 16 Internet. The captive portal can be either hosted on UniBox or it can be loaded from an external web server. UniBox provides a simple, template-based captive portal design that the administrators can easily customize with the company branding.
Page 17: Technical Overview
Monitoring UniBox can be used to monitor the health of the wired or wireless network. It provide a monitoring service that can be used to check whether the network devices like switches, access points, routers, firewalls, etc are online and the connectivity is intact. UniBox can send alerts to the administrators in case there is an outage to avoid lengthy downtime for the network users.
Page 19: Menu Summary
Menu Summary UniBox offers the following menu options to the administrators. Some models may not have the menu options. Please refer to your admin console to check the menu options available for your model. Network • WAN • LAN • VLAN •...
Page 20 • Email Templates • Email Relay • Vouchers • PMS Tools • Diagnostics Tools • Remote Syslogs • User Activity Logs • Event Logs • Conntrack Logs Reports • Online Users • User Agents • SMS • Social Media • System •...
Page 21: Getting Started
2. Connect your Laptop with the network interface you just configured by using standard Ethernet CAT 5 cable (Patch Cord) to the LAN port of Unibox (Refer to screenshot above to know Unibox LAN port) 3. Open your browser (I.E., chrome etc.) and browse the URL http://192.168.100.1...
Page 22 1. DASHBOARD The dashboard gives an overall view of the status of the UniBox. It displays the status of all the important features present in the UniBox, which might be helpful in discovering any failure in the working of the UniBox and hence be able to repair and rectify the problems that rise up.
Page 23 WAN interface is currently down. ◦ AP Status – This gives an overview on the status of all the APs configured in the UniBox. The AP status displays the number of access points that are UP or DOWN, the number of unknown APs and also the number of wireless clients.
Page 24 Fig. 1.1(b) Fig. 1.1(c) 1.2 Graphical Dashboard The graphical dashboard gives a statistical view of: ◦ Users – This displays a user versus time graph of connected and online users. The graph displays the daily statistics of the users on a timely basis.
Page 25 Fig. 1.2.1 ◦ Bandwidth Usage: ▪ LAN – This graph shows the daily bandwidth (download and upload rates) consumed by the LAN ports over the given time period. ▪ WAN – The bandwidth (upload and download rates) passing through the WAN ports is represented in a graphical form on a daily basis.
Page 26 Fig. 1.2.2(b) ◦ Internet Bandwidth – The graph displays the upload and download speed of the Internet connection from the ISP, that has been noted down every three hours over 24 hour period. Fig. 1.2.3 ◦ Port Connections – The number of opened ports over 24 hours is represented in the graphical form.
Page 27 Fig. 1.2.4 ◦ Section: ▪ Memory Section – The pie chart displays the amount of memory used and also the amount of memory that is free and available. ▪ Disk Section – The amount of disk space used and the disk space available is represented in the pie chart.
Page 28 2. NETWORK 2.1 WAN 2.1.1 Create / New WAN Profile Administrators are allowed to add a new WAN profile. The WAN profile can be either static or dynamic. For static settings, enter the IP address, subnet mask and gateway IP for connection. The changes will take effect after the configurations are applied.
Page 29 Fig. 2.1.1(b) Fields Description Profile Name Name of the WAN profile. Connection Type Select the type of connection, either static or dynamic. IP Address Enter the WAN side IP address. Netmask Enter the subnet mask. Gateway Enter the gateway IP. Traffic Share Enter the share of traffic the WAN connection should get.
Page 30 WAN profiles define the internet port settings. The list of all the WAN profiles is displayed in a table. The list displays the type of connection, assigned IP address, Netmask, gateway IP for the WAN connection, traffic share along with the profile name. The listing table also contains an ‘Operations’ column wherein there are options to edit or delete WAN profiles.
Page 31 Fig. 2.1.3 (b) Click on the ‘Save’ button to apply the changed configurations. 2.1.4 Delete WAN Profile An admin is given the option to delete an existing WAN profile. To delete a WAN profile, click on the delete icon in the ‘Operations’ column present in the ‘WAN’ section under the ‘Network’ module. Fig.
Page 32 2.2.1 Create / Add New LAN Profile An admin is provided the facility to add a new LAN profile for the UniBox. The LAN profile will be applied to one of the available ports to create a LAN port on UniBox. The LAN profile will have an option to enable DHCP service on the LAN port.
Page 33 2.2.2 List LAN Profile All the LAN profiles configured on the UniBox are listed down in a tabular form. The list displays the profile name, IP address of the LAN port, subnet mask, and whether the LAN port has enabled DHCP services or not.
Page 34 Fig. 2.2.3 Click on the ‘Save’ button to update and apply the new settings. When the settings are changed, all the online users will have to relogin. 2.2.4 Delete LAN Profile An admin can delete a configured LAN profile. LAN profiles can only be deleted once they are dissociated from the LAN interface.
Page 35 Use this feature to define a VLAN profile in UniBox. The profile can be applied to a physical or virtual port and all the traffic following from the port will be tagged with the VLAN tag(s). Administrators can define a fixed single VLAN tag or a range of VLAN tags.
Page 36 2.3.2 List VLAN Profile All the VLAN profiles configured in UniBox are displayed in a list. The list displays the profile name, VLAN type, VLAN ID, end Id and start Id. The listing table also contains an ‘Operations’ column, which provides the options...
Page 37 An admin can view the list of VLAN profiles by going to the ‘Network’ module and selecting the ‘VLAN’ section. Fig. 2.3.2 2.3.3 Edit VLAN Profile The edit option allows an admin to make changes to the configurations of an already existing VLAN profile. To edit a VLAN profile, click on the edit icon in the ‘Operations’...
Page 38 2.4.1 List Interface All the available physical network interfaces on the UniBox hardware are listed down in a table. An admin can assign any LAN or WAN profile to the interfaces. In the list, each interface is labelled as ‘eth#’ where # is the number of the interface like eth0, eth1, etc.
Page 39 An admin is facilitated with the feature to configure the network interface. The admin can assign the interface to either LAN or WAN profile. If the the interface is assigned to a LAN profile, the interface will function as LAN port. If the interface is assigned to a WAN profile, the interface will function as WAN port. The admin can also enable VLAN tagging by enabling the VLAN profile and select VLAN profile from the list in the drop-down menu.
Page 40 2.5 DNS 2.5.1 Create DNS An admin is allowed to add a new DNS server. All devices connected to the UniBox will use the DNS servers configured in this section. To create a DNS server, select the ‘DNS’ section under the ‘Network’ module. Then click on the ‘+’ icon, a window pops-up to get the DNS server’s IP address.
Page 41 Once the DNS server IP is entered, click on the ‘Save’ button. 2.5.2 List DNS All the DNS servers configured in the UniBox are listed down in a table. The DNS servers will be used in the order they were added.
Page 42 2.6 VPN An admin is facilitated with the feature which allows him/her to run a VPN server inside UniBox. This feature is beneficial if the admin wants to offer VPN access into the enterprise network. The VPN can run in two modes: •...
Page 43 • Cannot be used in bridges. The VPN server will require a signed SSL certificate for authenticating the client. By default, UniBox comes with a signed SSL certificate, but the client can upload their own SSL certificate in UniBox. To configure an on-board VPN server, go to the ’Network’ module followed by the ‘VPN’ section. A page displays a form to gather all the details required to configure a VPN server.
Page 44 UniBox is used within a wireless network, then admin can configure the devices in UniBox for monitoring. UniBox will check the status of all devices periodically and will send email alerts if any of them are down. The UniBox can monitor devices, both on LAN and WAN side. LAN side devices are monitored using their MAC address while the WAN side requires the IP addresses.
Page 45 Fig 2.7.1(a)
Page 46 AP on the map. Enable Monitoring Ticking off the check-box enables the device to be monitored. Monitoring Interval Select the interval for monitoring the device from the options available in the drop-down menu. UniBox will monitor the device after the configured interval.
Page 47 Enable Notification If ticked-off, the UniBox will email the UP or DOWN status of the device to the configured email addresses. Notify After Enter a number which indicates the number of failures after which the notification will be sent. Notify Frequency Indicates whether the notification is sent once or multiple times.
Page 48 An admin is allowed to make changes to the information about an already existing monitoring device. To edit the device information, click on the edit icon in the ‘Operations’ column present in the ‘Monitoring’ section of the ‘Network’ module. A modal form with the previously entered information is displayed for all the necessary changes to be made.
Page 49 Fig 2.7.4 Fields Description Monitoring Interval The default time interval for monitoring the device. Notify After Failure This setting will send notifications after the configured successive failures. Frequency Indicates whether the email notification is to be sent once or multiple times. From Email The email address from which the email notification will be sent.
Page 50 An admin is allowed to configure the Dynamic DNS client in the UniBox. Configuring Dynamic DNS client will help an admin to access the UniBox from public network, even when the UniBox WAN IP is set on dynamic mode and the IP changes frequently. DDNS client on UniBox will periodically update the host name record stored at the dynamic DNS server with WAN port settings.
Page 51 Fields Description Enable Dynamic DNS Ticking-off the check-box will enable the Dynamic DNS client in UniBox. This client is responsible for updating the UniBox WAN IP to the DDNS server. DDNS Provider Select the Dynamic DNS service provider from the drop-down list.
Page 52 2.9.1 New IP Routes An admin is allowed to create a new IP route on the UniBox for both inbound as well as outbound traffic. The IP route will decide how the packets are routed from the UniBox to other hosts or networks. The IP routes can be defined for a specified host or network.
Page 53 2.9.2 List IP Route All the IP routes configured in the UniBox are displayed in the listing table. The default IP route will display the route available to all UniBox clients. This cannot be edited since it is auto-generated when the WAN port settings are set.
Page 54 Fig 2.9.3 Click on the ‘Save’ button to set and apply the changes made. 2.9.4 Delete IP Route To delete the IP route, click on the delete icon present in the ‘Operations’ column in the ‘IP Routes’ section of the ‘Network’ module. A message window pops to confirm the delete action. Fig 2.9.4 Click on the ‘Delete’...
Page 55 LAN network. The NAT rules can be configured for different ports. For example, to access a client inside the UniBox network, there is a need to configure a port forwarding NAT rule. The NAT rules can be configured for both TCP and UDP packets.
Page 56 2.10.1.2 List Port Forwarding A table lists down all the NAT port forwarding rules defined in the UniBox. The listing table displays the name, WAN profile, LAN profile, protocol, external and internal port, along with the private IP address of the client.
Page 57 Fig 2.10.1.3 Click on the ‘Save’ button to set and apply all the changes made. 2.10.1.4 Delete Port Forwarding Deleting a NAT rule is quite simple. Click on the delete icon present in the ‘Operations’ column in the ‘Post Forwarding’ sub-section of the ‘Routing’ section. A window displays a message to confirm the delete action. Fig 2.10.1.4 Click on the ‘Delete’...
Page 58 An admin is facilitated with the feature to configure a group routing rule in UniBox. The rule allows a specific group of authenticated users to access the LAN segment. Usually the rule is used to route the traffic to the server pool or the restricted subnets for a group of users.
Page 59 Fig 2.10.2.1 (b) Fields Description Name Enter the name of the rule. Select the source, either LAN or controller. If the traffic Source from LAN side needs to access a specific LAN profile, then select the LAN interface source. Controller Select the controller profile on which the rule will be configured.
Page 60 To view the list of group routing rules, go to the ‘Network’ module and then the ‘Routing’ section, followed by the ‘Group Routing’ sub-section. The list displayed with the name of the rule, the controller it is assigned to, the user group, the LAN profile, the destination LAN profile and whether the active status of the rule. The listing table also contains the ‘Operations’...
Page 61 Fig 2.10.2.3 (b) 2.10.2.4 Delete Group Routing Rules To delete a group routing rule, click on the delete icon present in the ‘Operations’ column in the ‘Group Routing’ sub-section of the ‘Routing’ section, under the ‘Network’ module. A message window appears displaying a message to confirm the delete action.
Page 62: Wireless Client
3.3.1 List Wireless Clients This page displays the list of wireless clients present in the UniBox. The tabular format displays the MAC Address, Rx Bit Rate, Tx Bit Rate, Time Last Seen, RSSI, Vendor Name, AP Name, SSID and the status of the client.
Page 63 Fig 3.3.1 The (+) icon corresponding to the mac address displays the graph based on the data captured. 3.3.2 Export Wireless Client This section allows to download the current list of the connected clients. The report is downloaded with the name WirelessClient.csv .
Page 64 3.2 Manage AP’s 3.2.1 Creation This page allows administrators to add a new AP for management. If Unibox is used within a wireless network, then administrators can provision all the access points in Unibox for management. Unibox will check the status of all APs periodically and will display the status of the AP.
Page 65 Global Configuration Select the configuration to apply to the AP. The AP will get all the settings applied to the global configuration. Description Enter the description for AP. Table 3.2.2 List AP’s This page displays the list of UniMax access points that are provisioned for central management. These APs can be either manually added to the list or can be provisioned automatically using the auto-discover feature.
Page 66 3.2.2 Edit Configuration This page allows the administrator to edit the Access Point information. To change the access point information, change the necessary attributes and click the submit button. The edit AP configuration allows the administrator to edit the different subsections in the AP section. The edit AP configuration is sectioned into four sub-sections: General •...
Page 67 Retain AP’s Local Configuration Check this box for overriding the default configuration with the AP's configuration. Table Radio • Fields Description Country Select the country in which your AP is located. The available channels will change based on the selected country. 2.4GHz If the AP has 2.4 GHz radio, select this option.
Page 68 Bandwidth Select the desired bandwidth (only in case of 5Ghz). Enable Meshing To enable WiFi meshing, check the mesh option. A wireless mesh network (WMN) is a mesh network created through the connection of wireless access points installed in each network user's locale.
Page 69 Advanced • The advanced WAN port settings are categorized into three sections: Dynamic IP Address • Static IP Address • Default/Local • Select whether the APs WAN port will be on static, dynamic or local IP. Generally it is advisable to leave the AP on a dynamic IP.
Page 70 Table Upgrade Firmware • Fields Description Select Version Select the version. Take configuration Backup Check the checkbox if there is a need of saving the existing configuration backup. Table Reboot AP • Fast Checkin AP •...
Page 71 Enable this option during troubleshooting the AP. This will enable faster checking of the AP. Revert back the change once the debugging is complete. When we enable the static IP address, it prompts for entering the data in the following fields which are mandatory: Fields Description...
Page 72 UniBox discovers the UniMax APs and checks whether they are already added for management. If the APs are not managed, UniBox will display them in the list. An admin can review the APs and can provision them for management.
Page 73 The file to be imported should be in CSV format. The file should contain the name and MAC address of the AP. The MAC address of the AP should be separated by dash. Fields Description Global Configuration Profile Select the global configuration profile. File to import Select the valid csv file that is to be imported.
Page 74 3.2.6.3 Creation Click on the ‘ ’ icon to create or add a new global configuration in the Unibox. A data capture page will be displayed that collects the information required to create a new global configuration. Click on the ‘Save’...
Page 75 Click on the ‘Save’ button to save the global configuration. A new global configuration will be added in the Unibox. 3.3 Heatmap This section provides the administrator a detailed view of the radiation pattern from each AP (access points) that are configured with the Unibox. This page is sectioned into 3 parts: Connectivity • Location •...
Page 76 Click on the ‘Upload’ button to add a new floor map in the Unibox. Once the floor map has been uploaded, select the floor that has just been added. The image would appear in the center like below: Now click on the AP’s provided in the left corner. You can place these AP’s wherever you wish to on the selected floor.
Page 77 If you change the floor through the dropdown and drag and drops the same AP which is already used • for any other floor in the Unibox, will result into popping-up of the confirmation message asking you whether you are sure of moving the AP from previous to this new floor. If you are sure about moving the AP, click on the ‘Yes’...
Page 78 Location: • This feature is basically to get the location of the user/device. It helps you in tracking the user via the location. Each of the user’s location is marked accordingly on the floor map. Coverage: • Coverage basically indicates the range at which the signal can be reached. Each of the AP’s would have different coverages dependent on the type of AP.
Page 79 Hence the diameter of the circle differs. 3.3.1 List Floor Map This section allows the administrator to view the list of floor maps created in the Unibox. The table displayed lists down the floor name,floor map name,floor map width,floor map height,created date and the date at which it was last updated.
Page 80 3.3.1.2 Delete Floor Map This option allows the admin to delete an existing floor map from the database. Floor maps once deleted, cannot be restored. To delete the floor map, click on the ‘Delete’ button in the ‘Operations’ section. A confirmation message pops up to confirm the delete action.
Page 81 Each authentication service is controlled by the controller profile in UniBox. The controller is associated with the LAN profile and will create a hotspot service on the LAN port. Each controller profile will work independently of the other.
Page 82 Fields Decsription Controller Name Enter a name for the controller profile. LAN Profile Select the LAN profile associated with the profile. Select one of the authentication modes. Authentication Mode For remote mode, enter the IP address of the Primary Radius Server primary radius server.
Page 83 Realm:Sam@1234 There can be NO space or special character while entering a realm. Auto-login If the checkbox is checked, the auth service will enable MAC login. MAC login enables automatic authentication of a device using its MAC address. In case of Auto-login, the captive portal is not displayed.
Page 84 The changes made will be applied only when the changes are saved. So click on ’Save’. 4.1.4 Delete Controller Profile Click on the ‘delete’ icon, in the ‘Operations’ column, to delete a controller profile. Once clicked, a message asking for the confirmation of the delete operation pops up. A controller profile can be deleted only if it is not assigned to any captive portal.
Page 85 4.2 Groups The ‘Groups’ module allows an admin to define user groups in Unibox. This provides an admin the facility to assign rules and restrictions to a group of users, instead of assigning it individually to a number of users which is too tiresome and time-consuming.
Page 88 Fields Description Group Name A unique name for the user group. Description Brief description about the group. Controller Select the controller to which the group belongs Default Group Tick the checkbox if the group is to be a default one. So when the users register, they will be assigned to this group by default.
Page 89 Table Click ‘Finish’ and you have a new group. 4.2.2 List Groups When clicked on the ‘Groups’ section under the ‘Authentication’ module in the sidebar, a list of all the existing groups is displayed. Besides the group name, the list displays the details related to the groups like the controller profile, realm and the settings of Auto-MAC register.
Page 91 Click on ‘Finish’ to save and apply all the changes made. 4.2.4 Delete Group An admin is given the option to delete a user group if he/she wants to. To delete a user group, click on the delete icon in the ‘Operations’ column. A message pops up to confirm the delete operation.
Page 92 If sure, click on ‘Delete’ button. 4.2.5 Clear Auto-Login This option allows the admin to clear auto-login MAC of all the users in a group. Once the MAC addresses are cleared, the MAC login entries for all the users belonging to the user group will be cleared. The users will be prompted to login from the captive portal again.
Page 93: User Management
This option allows an admin to export all the users’ activity report for backup purpose. The code report is exported in PDF or CSV format. Click on the icon assigned to export group activity. A page is displayed where one has the option to export either a summarized or detailed group activity report. Summarized report will provide the summary of group activity.
Page 97 Fields Description Username Enter a unique username. Must be of atleast 3 characters and should not contain spaces. UniBox will automatically append a suffix to the username. Password Enter the password for the user. Must be of at least 6 characters.
Page 98 When the ‘Users’ section is selected under the ‘User Management’ sub-module, a list consisting of all the local users in the UniBox database is displayed. The list displays the details related to the corresponding to the username such as the controller assigned, the user group the user belongs to, the user type, i.e., free, paid or voucher based user, status and also the creation date.
Page 99 The list also contains an ‘Operations’ column, which provides several options to the admin, like: View • Edit • Change Password • Expire • Export User Activity • In the list page, there is also the feature to search for one or more users based on the various search criteria, namely, Controller: Specific controller profile for search.
Page 100 Live Session Information: Indicates whether the user is online or offline. • Total Usage: Shows the total usage of data by the user till now. • Last Five Sessions: Displays details of past five sessions. •...
Page 101 Accounting Details: Presents a summarized information on user accounting over the last seven days. • It includes details like total number of sessions, total usage, upload and download for each day of the week. Graphical Representation: Representing the usage ratio and Upload/Download for last five sessions. •...
Page 104 4.3.1.5 Change Password An admin is given the option to change the passwords of the users existing in the UniBox, which can be found either as an icon in the ‘Operations’ column or as ‘Change Password’ button in the ‘User Details’ section.
Page 105 4.3.1.6(b) Unexpire User An admin can unexpire an expired user, i.e., grant access to the internet to the user by reactivating the user account. This option is provided to allow the admin to extend the user’s time or manually recharge the user’s account.
Page 106 4.3.1.8 Delete User This option allows the admin to delete any existing user from the database. While performing the delete action on a user, keep in mind that all the user information, including session data and transactions will be lost. Users once deleted, cannot be restored. To delete the user, click on the ‘Delete’...
Page 107 This feature displays all the MAC addresses used by the users during login. When the auto-MAC capture is enabled on the controller profile, UniBox automatically captures the user’s MAC addresses for future logins. The page displays the username, controller, user-group, MAC address, vendor, framed IP address, creation date.
Page 108 The MAC address entries can be deleted by using the delete buttons. 4.3.1.12 User Accounting This page displays the session information for a given user. The information table displays session start time, end time, total duration in seconds, MAC address of the user’s computer, vendor, uploaded bytes, downloaded bytes, and reason for terminating session.
Page 109 4.3.1.13 Authentication History This page displays the user agent and the authentication history of a given user. Besides displaying the authentication date, MAC address of the user’s computer, vendor, original URL, user agent, IP address and host name for a given user are also displayed. 4.3.2 MAC Logins 4.3.2.1 Create / Add MAC Login An admin is allowed to add a new MAC address entry.
Page 110 Fields Description MAC Address Enter a valid MAC address in the format mentioned. Framed IP Address Enter the IP address to assign the device. This will be static IP assigned to the device. Table Once filled, click on the ‘Save’ button and the device will be added to the respective user’s MAC device list. 4.3.2.2 List MAC Login All the MAC addresses added or captured for the users or devices can be seen in the list.
Page 111 4.3.3 Approvals UniBox presents a unique feature which allows administrators to provide two-step user registration process. A new user will be allowed to register for an account online through the captive portal. However, the user’s account will not be approved immediately.
Page 112 4.3.3.1 List Approval Users All the users who need to be approved are listed in the approval table. The admin has the option to either approve or deny a user’s registration. If a user approved, the user’s account is activated in the system and the user is able to login.
Page 113 4.4 Passthrough Domain 4.4.1 Creation An admin is provided the facility to define a new passthrough or wall-garden domain in UniBox. Users can access the passthrough domains without authentication. Only the domain name of the domain needs to be entered.
Page 114 URLs for each social media login method for your reference. 4.4.2 List Passthrough Domain All the passthrough domains present in the UniBox are listed for the admin to see. A passthrough domain or URL can be accessed by all clients without authentication.
Page 115 4.4.3 Edit Passthrough Domain An admin is allowed to edit an existing passthrough or wall-garden domain in UniBox. To add a wildcard domain, you need to add * before the domain name. Eg., *.wifi-soft.com. To edit a passthrough domain, click on the edit icon against the corresponding domain.
Page 116 Unibox provides comprehensive feature to create new portal pages. The admin can choose one template from a list of various templates to create a new portal page of choice. UniBox creates a copy of the portal template using the options selected and saves it to the local disk.
Page 117 To add or create a new portal, select the ‘Portals’ section under the ‘Authentication’ module. Then, click on the ‘ ’ icon. A page displays a form to gather information required to create a new portal. List Portals Apply Portals Fields Description Name...
Page 118 Apply Portal Note : All the portals are hosted inside the UniBox so these portals are not accessible from outside UniBox. To access them from remote sites, one needs to change the domain name of the portal with the public IP of UniBox.
Page 119 Click on the ‘Update & Preview’ button to apply all the changes made. 4.5.4 Apply Portals 4.5.4.1 List Active Portals This section displays all the active portals. Every portal has a controller profile associated with it. At a given time, only one portal can be set to a controller profile. To view all the active portals, click on the apply portal icon.
Page 120 Apply Portal Reset Applied Portal 4.5.4.2 Apply Portal The portal section allows admin to create a new portal. However, the portal will be only activated once it is applied to the specific controller profile. This section allows an admin to set or apply a portal for a given controller profile. Click on the apply portal icon, in the ‘Operations’...
Page 121 Enter the URL of the external portal page. Please note that the external URL needs to be added to the passthrough list for UniBox to load the page on the user’s machine. The admin needs to create the external portal using the UniBox API and should be tested separately.
Page 122 4.5.4.4 Delete Portal An existing internal portal can be deleted from the UniBox. If the portal page is active, i.e., it is assigned to a controller profile, then the admin would not be able to delete the portal page. Once a portal page is deleted, UniBox will automatically delete all the images, texts and customizations associated with the portal page.
Page 123 All the fields under each type of SMS gateway will be defined below: 4.6.1 Gupshup Enterprise Fields Description API Username Specify the user ID. API Password Specify the password. SMS Template Specify the content of the template. The template needs to be pre-approved from the vendor. Please get your template approved from Gupshup before uploading it.
Page 125 Fields Description SMS Gateway Hub Type Select the type of gateway hub from the drop- down list. API Username Depending on the selected gateway hub, specify the user ID. API Password Specify the password. API Id Enter the API Id, when the selected gateway hub is API Id.
Page 126 Fields Description API Username Specify the user ID. API Password Specify the password. Sender Name Enter the sender’s name. SMS Template Specify the contents of the template. The contents of the SMS will be sent to the user. If there are any placeholders, their values will be substituted before sending to the user.
Page 127 API Id Specify the API ID. The admin is supposed configure the API ID. SMS Template Specify the contents of the template. The admin needs to configure the template. Is Active Tick checkbox enable configuration. Table 4.6.5 Twilio Twilio is another international SMS gateway. It provides SMS services to many countries. Please visit www.twilio.com to find the rates and the countries served by the SMS gateway.
Page 128 Fields Description API Username Specify user ID. API Password Specify a password. Sender Id Enter the sender’s ID. SMS Template Specify the contents of the template. Is Active Tick checkbox enable configuration. Table 4.6.7 Utopia Group Fields Description API Id Enter the specific API Id.
Page 129 Table Note In all the gateways, the admin needs to configure the API Id, API Username and Password, SMS • template content, Channel, and Sender Id wherever required. For some SMS gateway, the SMS template content needs to be vetted by the company. Please contact •...
Page 130 Click on ‘Save’ to the add device MAC address to the list. 4.7.2 List Blacklist MAC All the blacklisted MAC in the UniBox can be found listed in a table. The MAC addresses added in the list are not allowed to login on a given controller.
Page 131: External Services
To delete multiple entries at once, click on all the checkboxes of the entries that need to be deleted. Then click on the red coloured delete icon that appears. 4.8 External Services 4.8.1 Social Media Social Media section allows admin to configure the social media account credentials for enabling social media login on the captive portal.
Page 132 Fields Description Social Media Type Select the type of social media for which the configuration will be created. Client ID Client ID or Oauth ID for selected social media. Please refer to the social media documentation to find how to get the Client ID from the social media settings.
Page 133 To edit a social media entry, go to the ‘Social Media’ section in the ‘External Services’ sub-module present in the ‘Authentication’ module. Then click on the edit icon present in the ‘Operations’ column. A window is displayed with a form similar to the one displayed during the creation. Refer. Once the required changes are made, apply the changes by clicking the ’Save’...
Page 134 4.8.2.1 Add/Create LDAP An admin is facilitated with the feature to configure and create an LDAP profile. UniBox will use the profile to establish a connection to the LDAP server to authenticate the users. The users will be authenticated with the LDAP credentials during the login process.
Page 135 Search Criteria Select the search criteria, whether anonymous or admin, from the drop-down menu. Port Enter the port number of LDAP server. Version Enter the LDAP version. Description Enter short description for the profile. Base DN Enter the base DN string. Filter Enter the filter string.
Page 136 Once all the changes are made to the settings, click on the ‘Save’ button to apply the changes made to the LDAP profile. These changes will then be used for the subsequent logins. 4.8.2.4 Delete LDAP Deleting an LDAP profile is simple. Click on the delete icon, present in the ‘Operations’ column in the ‘LDAP’ section which falls under the ‘External Services’...
Page 137 If sure, click on the ‘Delete’ button. 4.8.3 G SUITE 4.8.3.1 Create / Add GSuite The feature to manually add a GSuite user record is made available to an admin. To create or add a new GSuite user record, go to the ‘GSuite’ section in the ‘External Services’ sub-module of the ‘Authentication’ module. Then click on the ‘...
Page 138 A list of all the GSuite users is displayed to an admin. The list contains all the user records that were imported from the GSuite database. The list displays the name of the user, username, group name, status, and creation date.
Page 139 To sync the database with GSuite, click on the sync icon in the ‘GSuite’ section of the ‘External Services’ sub- module. If the login is successful, UniBox will sync the user records and will import the users in the local database.
Page 140 A GSuite user’s password can be changed and reset by an admin. To reset password, click on the reset password icon present in the ‘Operations’ column of the ‘GSuite’ section. A window is displayed where the existing password and the new password are to be entered. When the existing and new passwords are entered, click on the ‘Save’...
Page 141 5.1.1.1 Creation An admin is allowed to define new date and time policy for a given user group. UniBox will grant access to the internet based on the date and time rules defined under this policy. The policy needs to be defined for a specific user group.
Page 142 5.1.1.2 List Date & Time Policy The date and time policies defined in the UniBox are displayed in the listing table. The list allows an admin to view which policy has been assigned to which user group, whether it is enabled or not, for how many days and how long.
Page 143 Click on the ‘Save’ button to apply the changes made. 5.1.1.4 Delete Date & Time Policy This option allows an admin to delete an existing date and time policy. Though, the policy restrictions will remain on the current users until they log off. To delete a date &...
Page 144 Click on the ‘Delete’ button to discard the policy. 5.1.2 Relogin 5.1.2.1 Creation An admin is facilitated with the feature to create or add a new relogin policy for a given user group. The relogin policy will control the bandwidth allocation to the users when they login multiple times on a given day.
Page 145 5.1.2.2 List Relogin Policy An admin can view a list of all the relogin policies defined in UniBox. The list allows the admin to see a user’s access restrictions, which are based on the maximum number of times the user logins in a given day.
Page 146 Click on the ‘Save’ button to save and apply all the changes made to the policies. 5.1.2.4 Delete Relogin Policy The option to delete an existing relogin policy is provided to an admin. The policy restrictions will remain on the current users until the users log off. To delete any existing policy, the ‘Operations’ column in the ‘Relogin’ section provides the delete option.
Page 147 5.1.3.1 Creation The feature to create a variable bandwidth gives an admin the option to downgrade the bandwidth rate, either upload or download, for current users that have been online for longer than the given time period. This policy allows the admin to enforce a fair usage policy based on the online time, which means the users who are online for a longer period of time will automatically get reduced bandwidth.
Page 148 5.1.3.2 List Variable Bandwidth Policy An admin is allowed to view all the variable bandwidth policies defined in the UniBox. The list displays the group name, the upload and download speed, whether it is enabled or not, along with the policy name. The list also includes an ‘Operations’...
Page 149 Click on the ‘Save’ button to apply the changes made. 5.1.3.4 Delete Variable Bandwidth Policy This option allows an admin to delete an existing variable bandwidth policy. The policy restrictions will remain enforced on the current users until the users log off. To delete the policies, click on the delete icon present in the ‘Operations’...
Page 150 Click on the ‘Delete’ button to delete a policy. 5.1.4 Fair Usage Fair Usage policy allows admin to ensure fair usage of bandwidth on the network. This policy will automatically reduce the speed of the users who are abusing the network resources. The policy applies to real-time users and gets enforced on the users when they are online.
Page 151 5.1.4.2 List Fair Usage Policy An admin can view all the fair usage policies defined in the UniBox. The fair usage policy is a run-time policy i.e., the restrictions are applied to a user’s session while the session is still in progress. This, in a way, helps the admin to curtail the bandwidth usage of heavy internet users, thus enforcing a fair usage policy on the network.
Page 152 Once the necessary changes are made to the policy, click on the ‘Save’ button. 5.1.4.4 Delete Fair Usage Policy Deleting a fair usage policy is fairly simple. Click on the delete icon in the ‘Operations’ column present in the ‘Fair Usage’ section under the ‘Policies’ sub-module. A message window appears to confirm the delete action. Click on the ‘Delete’...
Page 153: Content Filter
UniBox maintains a database of domains or URLs that belong to each category. When the user tries to access the domain, UniBox checks if the domain is in the blocked list and will block the user access. The user is redirected to a blocked page.
Page 154 Blacklist Keywords Enter the list of keywords that will be blocked. UniBox will check for the keyword in the domain name and will block the website if the keyword exists in the domain name.
Page 155 5.2.2 List Content Filter Policy The list of all the content filter policies defined in the UniBox is displayed to an admin. The policies are listed in a table with policy name, policy id and description and group names. The policy will apply to all the groups defined in the rule.
Page 157 When the required changes are made, click on the ‘Save’ button to update and apply the edited policy. 5.2.4 Delete Content Filter Policy To delete a content filter policy, all an admin has to do is to click on the delete icon in the ‘Operations’ column present in the ‘Content Filter’...
Page 158 6.1.1 Creation Click on the ‘+’ icon to create or add a new plan in the Unibox. A modal form will be displayed that collects the information required to create a new plan.
Page 159 Plan Fee (USD) Enter the fees in the Plan Fee field. (numbers only). The amount specified will be in the currency configured in UniBox profile. Controller Select the controller profile on which the given plan will be active. User Group Select a user group for the plan.
Page 160 Fields Description Plan Type Select Time Usage from the Plan Type drop down menu Plan Name Enter the name of the plan. Plan Fee Enter the fees in the Plan Fee field. (numbers only). The currency will be same as the one configured in the profile section.
Page 161 Table Bandwidth Usage: Fields Description Plan Type Select Bandwidth Usage from the Plan Type drop down menu. Plan Name Enter the name of the plan Plan Fee Enter the fees in the Plan Fee field. (numbers only). The currency will be one that is configured in the profile section.
Page 162 Enter the download speed to apply to users who select this plan. Table Click on ‘Save’. A new plan is added in the Unibox! 6.1.2 Delete Plan This section allows administrators to delete an existing billing plan only if it is not associated with active users and portals.
Page 164: Payment Gateway
The payment gateway accepts the credit card details of the users and process the payment on them. Click Payment Gateway (below Billing Configuration), Billing Payment Gateway page appears. Currently, there are 4 types of payment gateways supported in UniBox: Authorize.Net •...
Page 165 Fields Description Select Payment Gateway Select Authorize.Net from the Select Payment Gateway drop down menu. API Login Id Specify the API Login ID. Transaction Key Specify the Transaction key. Confirm Transaction Key Confirm the Transaction key by specifying the same transaction key as above. Transaction Currency Specify transaction currency.
Page 166 Fields Description Select Payment Gateway Select PayPal.Std from the Select Payment Gateway drop down menu. PayPal Id Enter the PayPal id (email address) in the PayPal ID field. PORT Number Enter the PORT Number. Transaction Currency Select the transaction currency from the Transaction Currency drop down menu.
Page 167 Fields Description API Key Enter the API key. API Token Enter the API token. Transaction Currency Select the currency for transaction Table PayUMoney: Fields Description Merchant Key Enter the merchant key. Merchant Salt Enter the merchant salt.
Page 168 UniBox will only serve as an intermediary for processing the payments. NOTE: UniBox doesn’t save any credit card or other sensitive information. All the information is passed to the payment gateway for processing the payment. Since UniBox doesn’t save any card information and processes all the transactions over 256-bit SSL certificate, it is PCI-DSS compliant.
Page 169 6.4.1 List Transactions This section displays all the billing (online payment) transactions in reverse chronological order. The transactions are logged whenever the user attempts to sign up for the paid service online. Unibox logs all (successful and failed) attempts. Each entry displays the full name of the user, Username, Transaction ID, the status of the transaction, amount and the date of the transaction.
Page 170 A csv file gets downloaded than. 6.5 Email Template Unibox allows administrator to define a new email template. An email template will be used to send canned emails to the users who sign up or renew the service. Predefined placeholders can be inserted in the template text to customize the email. Unibox will automatically insert the customer information in the placeholder while sending the email.
Page 171 Once the form is filled, click on the ‘Save’ button and a new email template would be created. 6.5.2 List Email Template This section displays the list of email templates defined in Unibox. Placeholders are special strings that are replaced with the actual value before the email is composed. For example <<>> placeholder will be replaced with the first name of the user.
Page 172 If you are sure, go ahead and click on the ‘Delete’ button.
Page 173 • 6.6.1 Batches Unibox allows the administrator to create new voucher batch of voucher codes. A batch can have 1 or more prepaid codes. When you select a group for voucher batch, group constraints like control policy assigned to the group, if any, will also get applied to all voucher users under that batch.
Page 174 Download Rate Enter the maximum download speed for the voucher codes in the Download Speed field. Idle Timeout Enter the time in Idle Timeout field. User sessions will be closed if it is idle for the given time Total Sessions Enter the maximum number of sessions allowed for the code in the Sessions field.
Page 175 If the restriction selected is Time Usage and the restriction type is ‘Use for’ , then it looks something like this:...
Page 177 If the restriction selected is Time Usage and the restriction type is ‘Between’ , then it looks something like this: Fields Description Valid for Enter time duration for which the code is valid in the Validity field. Select the validity limit in seconds, minutes, hours and days.
Page 178 6.6.1.2 List Voucher Batches This page displays the list of voucher batches defined in UniBox. Each batch is identified using a batch name. The tabular format displays the total number of voucher codes and the used Voucher Codes in each batch, a...
Page 179 It also allows you to search for particular codes by providing various search parameters like Voucher Code, Activate From date , Activate To Date or Status. Click on the 'Search' button once you have provided the desired search criteria and you will be displayed with the list of desired Voucher Batch Codes. The list can be sorted in ascending or descending order using the icon on each column header.
Page 180 6.6.1.4 Delete Voucher Batch For deleting the voucher button click on the delete button. This section will allow admin to delete an existing voucher batch provided it is expired. If the batch has voucher codes that are in use or have been used, then the batch can't be deleted. It gives links to download batch report/record before deleting batch.
Page 181 6.6.1.5 Export Voucher Batch This section allows an administrator to export the batch of Voucher Codes for printing or distribution. All voucher codes in the batch (used, new or active) are included in the exported list. batch exported formats Excel (CSV) PDF.
Page 182 6.6.1.6 Export Voucher Batch Report This section allows an administrator to export individual voucher code report for accounting/auditing purpose. The code report is exported in PDF as well as CSV format. To export the individual voucher batch, click on the ‘Export Voucher Group Report’ button in the ‘Operations’ section.
Page 183 6.6.2 Customize Voucher Design Unibox allows an administrator to customize the look of the voucher card. The customization will be applied to each card printed from UNIBOX. The card can be printed in a PDF file.
Page 184 6.7.1 PMS Configuration Unibox allows an administrator to setup PMS configuration. This configuration will establish communication of PMS Server with Unibox, and help processing sign up and login requests from Unibox portal. Click on the Enable Configuration checkbox to enable PMS configuration.
Page 185 • Lucid • Virtual *Need special certification. Comtrol: Fields Description PMS Type Select Comtrol option from the PMS Type drop down menu. IP Address Enter the IP Address of the PMS server in the IP Address filed. Port Enter the port of PMS server in the Port field. PMS Timeout Enter timeout...
Page 186 Fields Description PMS Type Select Hotelier option from the PMS Type drop down menu. PMS Url Enter the PMS Url in the PMS Url field. API Key Enter the API key for the PMS in the API Key field. PMS Timeout Enter the PMS timeout in seconds in the PMS Timeout field.
Page 187 Fields Description PMS Type Select the Hotsoft PMS type from the drop-down list. PMS Url Enter the PMS Url in the PMS Url field. API Key Enter the API key for the PMS in the API Key field. PMS Timeout Enter the PMS timeout in seconds in the PMS Timeout field.
Page 188 Fields Description PMS Type Select IDS Fortune Serial option from the PMS Type drop down menu. Set Device Enter the device set for the PMS server in the Set Device field. Baud Rate Select the Baud rate for PMS server from the Baud Rate drop down menu.
Page 189 Micros: Fields Description PMS Type Select Micros option from the PMS Type drop down menu. IP Address Enter the IP Address of the PMS server in the IP Address filed. Port Enter the port of PMS server in the Port field. PMS Timeout Enter timeout...
Page 190 Fields Description PMS Type Select WinHMS option from the PMS Type drop down menu. IP Address Enter the IP Address of the PMS server in the IP Address filed. Port Enter the port of PMS server in the Port field. PMS Timeout Enter timeout...
Page 191 This page displays the list of all PMS guests downloaded from the PMS server as well as those defined in the system manually. UniBox communicates with the PMS system and downloads the list of current guests so they can be validated locally. Each guest is displayed in a tabular format with its name, room number, guest number, arrival date, departure date and username linked.
Page 192 The list can be sorted in ascending or descending order using the icon on each column header. 6.7.2.3 Delete PMS Guest This section allows the administrator to delete the existing PMS guest from Unibox. To delete a specific PMS guest, check in the checkbox provided besides the guest details and then click on the delete option.
Page 193 It basically removes the existing pms guest from the pms guest list. In order to perform the check-out operation, check on the checkbox provided besides the guest details and then click on the check-out button. A message pops up to confirm the check-out operation. If sure, click on ‘check-out’...
Page 194 6.7.3 Transactions 6.7.3.1 List PMS Guest Transaction This page displays the list of all PMS guest transaction defined in the system. Each guest transaction is displayed in a tabular format with its name, room number, guest number, transaction id, transaction date and amount.
Page 195 6.7.4 Monitor PMS Guest For some PMS system, UniBox needs to maintain a TCP connection with the PMS server. This page displays the status of PMS client connection with PMS server. Select the time duration and the display type, and the report would be displayed accordingly.
Page 196: Diagnostic Tools
7.1.1.1 Ping This feature allows an admin to run ping utility in UniBox. The admin needs to enter the IP address or domain name for the server. Ping utility will help an admin to check the health and latency of the connection to a remote machine and whether the link to the remote machine is up or down.
Page 197 An admin is allowed to run IP Scan on the entire LAN subnet. This provides a list of IP addresses of the live machines which are connected to the network under UniBox. To do an IP scan, select the ‘IP Scan’ section from the ‘Diagnostic Tools’ sub-module present in the ‘Tools’...
Page 198 Note: The IP scan will take a few minutes to complete. So, it is requested for the admin to remain patient while the scan runs are calculated. 7.1.3 Network Trace The network trace tool enables an admin to capture detailed information about data that are streaming through the network.
Page 199 This is especially useful for the support technicians since they can remotely authenticate the user and get the user online. This list shows the authorized and unauthorized DHCP leases in the UniBox. The admin can also search a specific MAC address or IP address in the list. The ‘State’ column indicates...
Page 200 7.2.2 List Remote Server All the remote syslog servers defined by the admin in the UniBox, is listed down in a table. Along with the name of the server, the IP address and the protocol used for syslog are also displayed. The list also contains an ‘Operations’...
Page 201 Refer. Click on the ‘Save’ button to apply the changes made. 7.2.4 Delete Remote Server An admin can delete an existing remote syslog server entry. Once the entry is deleted, UniBox will stop sending messages to the remote server.
Page 202 7.3.1 Top Sites This feature displays a list of the top websites visited by UniBox users over a 24 hour period. The sites are displayed in descending order, i.e., the most frequently visited sites are at the top of the listing table. The list displays the URL, the connect which is the number of access to the site, and the bytes, i.e., the bandwidth...
Page 203 The ‘Site & Users’ section allows an admin to search for the web browsing activities of specific users using the web address (URL) or Username or MAC address of a user’s system. To find the web activities, go to the ‘Sites & Users’ section in the ‘User Activity Logs’ sub-module under the ‘Tools’...
Page 204 Event logs provide an admin the complete view of the activities happening inside the UniBox. These logs are helpful in debugging user login issues and any other issue on the network. All the events in UniBox are logged in the event logs, allowing an admin to perform audit trails, troubleshoot and diagnose the problem easily.
Page 205 Through the export feature, an admin is provided the facility to export the logs locally for review and future reference. The logs are stored with the timestamp, severity, the source of the event, the UniBox module that generated the event and also the description of the event. The logs are stored in simple text file and are saved locally on the machine.
Page 207: Online Users
8. Reports 8.1 Online Users This page displays the list of online users in Unibox. Each row displays the username, IP address, MAC address of the user's machine and the vendor name, Online Duration (online and idle), Bandwidth usage (upload and download), Bandwidth rate (up/down speed), controller name and Logout button.
Page 208 Report Type: Operating System Vs Number of Users Report Type: Vendor Vs Number of Users 8.2.1 List User Agents The reports are categorized in two types of display: Graphical • Tabular • This section allows the administrator to select the type of report ,the type at which the report should be displayed for the specific time interval .To display a report, click on the ‘Display Reports’...
Page 209 8.2.2 Export User Agents This section allows an administrator to export various user agent reports based on the browser, operating system, device vendors and the number of users information. The report is exported in csv format file and it is saved as a CSV file based on the report type selection. If the file exported is Browser Vs Number of Users, then it follows the format: •...
Page 210 • Operating System • Number of Users If the file exported is Vendor Vs Number of Users, then it follows the format: • Vendor Name • Number of Users 8.3 SMS This section displays the report of all SMS sent from the system. 9.3.1 List SMS Report The table shows the details of each SMS transaction.
Page 211 8.4 Social Media Report This section displays all the social media reports available in Unibox. The Social Media Type includes the following type of social media: • Facebook Reports - Displays the different types of reports available for Facebook users.
Page 212 Twitter • Displays all the twitter reports available in Unibox. 1. Social media Overview - Displays the number of logins over a given time period. 2. Visitor Loyalty - Displays the count of new and repeat count for daily, weekly and monthly users over a given time period.
Page 213 8.4.2 Port Connections This page displays the list of ports opened in Unibox at a given time. It displays the list of all System IP addresses along with its open Source and Destination ports. Use refresh button to get the latest status. You can click on the ‘+’...
Page 214 On initiating a scan, Unibox will send an ARP request to all the IP addresses in the subnet and will listen for a response from the clients. To display the ARP table list, select one of the network interface. It will build the table on receiving the responses or timing out.
Page 215 Disk Usage - Disk space usage by Unibox over given time period. Ports Usage - Displays source and destination ports used on Unibox. Unibox will take 24 hour time period from the current system time. The graph will progress forward automatically when displayed on the screen.
Page 216 8.4.6 System Power Cycles...
Page 217 Services: Various services running on the controller. • CPU Information: Information about Unibox CPU. • Memory Information: Displays the RAM Memory usage on Unibox. • Storage Information: Displays the Secondary Storage usage information. • System temperature: Data about different sensors.
Page 219 Packets: Displays Packets downloaded and uploaded on Unibox. Users: Displays Online users. Unibox will take 24 hour time period from the current system time. The graph will progress forward automatically when displayed on the screen. The area graphs displayed would be completely based on the report type selected.
Page 220 Report Type is Local Bandwidth...
Page 221 Report Type is Packets:...
Page 222 Report Type is Users:...
Page 223 8.5.2 Usage Summary This page displays various usage reports based on the session information. Following types of reports can be generated- 1. Total Session Vs Time: Display the total number of user sessions over a given time period. 2. Number of Sessions Vs. Days of Week: Display total number of sessions for a given day of the week. If the day occurs more than once during the given time period, then the sessions are added up for that day.
Page 224 Residual Upload Speed: Displays upload speed of residual ISP bandwidth. Residual Download Speed: Displays download speed of residual ISP bandwidth. WAN Upload Speed: Displays upload speed of Unibox WAN interface. WAN Download Speed: Displays download speed of Unibox WAN interface.
Page 225 1. Prepaid Revenue Report: Displays total prepaid revenue for given time interval. 2. Credit Card Revenue Report: Displays total credit card revenue for a given time interval. 3. Total Revenue Report: Displays the prepaid revenue , credit card revenue and the total revenue. The time interval defines the date range for the report.
Page 226 Time Unit is Month: Time Unit:...
Page 227 The above screenshots were displayed in the tabular format. But when the display type is selected as graphical, the report is displayed as: Fields Description Report Type Select the type of report. Payment Gateway Select the payment gateway. From Date Select From which date the revenue report should be exported.
Page 228 Table 8.6.1.1 Export Revenue Report This section allows an administrator to export the revenue report based on the date. To export a revenue report, click on the ‘Export’ button. A csv file would then be downloaded to your local machine. The CSV file exported follows the format: •...
Page 229 Time Unit is month: Time Unit is Year: 8.6.2.1 Export Revenue Report This section allows an administrator to export the revenue report based on the plan. To export a revenue report, click on the ‘Export’ button. A csv file would then be downloaded to your local machine.
Page 230 The CSV file exported follows the format: • Date • Revenue 8.6.3 Voucher Usage This page displays the prepaid usage report over the given time interval. Following types of prepaid usage reports are displayed - 1. Voucher users Vs time 2.
Page 231 If the report type selected is Total time Used Vs Time and the time unit is day: 8.6.3.1 Export Voucher Usage List This section allows an administrator to export the voucher usage report over the given time interval. To export a voucher usage report,click on the ‘Export’...
Page 232 This page displays the number of users signed up for the service using the Unibox registration interface for the given time period. The tabular report displays the date, the total number of new users who signed up for the service using plans.
Page 233 This section allows an administrator to export the existing number of users signed up for the service using the Unibox registration interface from the database. Click on the ‘Export’ button to download the Signup summary report on your local machine. A csv file is generated having the format as follows: •...
Page 234 If the time unit selected is, a day, then the report is displayed as: Time Unit is Week: Time Unit is Month:...
Page 235 This page displays the monitoring status of devices. One should ensure that Device Monitoring is enabled in Network Section of Unibox. This page displays the real-time network status in a tabular format. If the devices are down, the entry will be shown in red.
Page 236 indicates whether an AP is UP/Down. The list can be sorted in ascending or descending order by using the icon on each column header. The administrator can also view the devices on Google map (if latitude and longitude are configured) by clicking the View Map option.
Page 237 Full control – When you select the Full Access radio button Unibox gives the account holder full access to the feature including delete. • Edit - When you select the Edit radio button, Unibox gives the account holder edit access to the feature. •...
Page 239 The second section is the access control section that allows you to select the modules to which the admin will have access to. Click ‘Finish’ and a new admin would be added in the Unibox. 9.1.2 List Accounts Each account has an account name (username) and password. The list shows the last time the account was accessed.
Page 240 9.1.3 Edit Account The ‘Edit’ option allows to make changes to the information about the existing admin account. Click on the edit icon in the ‘Operations’ column to edit an admin’s account. A modal, similar to the one that was displayed while creating a new account, will be displayed.
Page 241 The profile page allows administrators to edit the general information of Unibox. The administrator can enter information about the location where Unibox is installed. In addition, this page also displays the unique code, realm and prepaid password for Unibox. This information is needed if you are implementing external login/portal pages.
Page 242 Lastly administrator can define the date format, currency and language for Unibox. Changes to these settings will take effect on next login. The edit profile page is sectioned into two sections: Basic Information: Capturing all the basic information about the organization.
Page 243 Address Enter the address where the Unibox is installed in the Address field. City Enter the name of the city where the Unibox is installed in the City field. State Enter the name of the state where the Unibox is...
Page 244 This is an expensive operation so please use it with caution. Execute After Time period after which the application tracking will take a snapshot. Table Once the form is filled, click on the ‘Finish’ button. The profile details are being added into the Unibox.
Page 245 9.3.2 Upload License This page allows admin to apply a new license file to UniBox. Admin needs to get the license file from Wifisoft and then apply the license. The license will take effect immediately and will be displayed in the License Manager.
Page 246 The administrator can apply the backup configuration in the future to revert Unibox to the saved settings. UniBox generates a config file and stores the file on the local disk. To add a new configuration, click on the + icon.
Page 247 All the configurations are saved with a profile name. Click on the profile name to change an existing configuration. UniBox will try to load the new configuration on reboot. Please make sure that the config file is correct before upload.
Page 248 Fields Description Profile Name Enter the profile name. Description Enter a short description. Upload Configuration Upload a valid file containing the configuration. Table 9.4.3 Edit Configuration This section allows an administrator to make changes to an existing configuration. The administrator can change the name of the profile or description.
Page 249 ‘Update’ to save the changes made. 9.4.4 Apply Configuration This section allows the administrator to apply the configuration added in the unibox. Once applied, the previous configuration would be replaced by the new configuration. In order to apply the configuration, click on the ‘Apply’ button in the ‘operations’ column. A confirmation message pops up to confirm the apply action.
Page 250 9.4.6 Download Configuration This section allows the admin to download an existing configuration, To download a configuration, click on the download icon in the ‘Operations’ column. A confirmation message pops up to confirm the download/export action. Once sure, click on the ‘Export’ button .This saves the downloaded file on the local disk.
Page 251 The approval admin is further allowed to configure the notification template as per his/her wish. Note: In order to use Approval Portal, the approver needs to access the UniBox and hence needs to be in the same network. If the approver is remote, then the approval process may not work.
Page 252 9.5.3 Configure Template This section allows the approval admin to configure the approval template for notifying the user and the approver. A pre-defined template is set already. If in case the admin wants to modify it, he/she can update the template by adding the new template. To configure an approval template, click on the ‘Configure’...
Page 253 Fields Description Notify Registration Checking this checkbox would enable the notifications of approval request. Notification Type Select the notification type - sms, email or both. Requester Success Email Template Enter the requester success email template. This email template is sent to the user requesting the internet access on successful approval.
Page 254 Requester Failure SMS Template Enter the requester failure sms template. This SMS template is sent to the user requesting the internet access on denail of user's request. Approver's SMS Template Enter the approver's sms template. This SMS template is sent to the approver who is responsible for approving the user's reqeust.
Page 255 Once the changes are made, click on ‘Save’ to save the changes made. 9.5.7 Delete Approval Admin This option allows the admin to delete any existing approval admin from the database. Approval admins once deleted, cannot be restored. To delete the approval admin, click on the ‘Delete’ button in the ‘Operations’ section. A confirmation message pops up to confirm the delete action.
Page 256 This page will display the current date and time of Unibox. This page allows an administrator to define or set the current date and time for Unibox. Please note that the date and time on old records will not adjust whenever date and time is changed. The change will take effect for all the new activities in Unibox.
Page 257 This section allows the administrator to RESET Unibox to factory defaults settings from Unibox User Interface using administrator’s credentials. Please note that all the Unibox settings will be reverted back to default. The historical data such as billing transactions, users details, usage history, etc will NOT get deleted.
Page 258 This page displays the access logs of all administrative accounts in reverse chronological order. The history will allow the main administrator to view or search the date and time when administrator access Unibox. Also the list can be sorted in ascending or descending order by using the icon on each column header.
Page 259 9.11 9.11.1 List Change Logs This section displays the changes done to the Unibox configuration from the user interface. This allows administrator to track changes done in the past and keep an audit trail of the changes. All the database changes, including the insertion, deletion, modification, change password and so on.
Page 260 • Database Change Date 9.11.3 Download Tar.gz This page allows admin to download the archived change logs. UniBox automatically archives the old change logs and stores them in zip format. Admin can download these logs for audits and record keeping.