Professional Documents
Culture Documents
Hotspot Manual
Hotspot Manual
A ntam edia HotS pot is W indow s PC gatew ay softw are w hich helps you in controlling and billing your custom ers for the Internet usage. It is suitable for all the purposes w here a custom er should be prom pted to type the usernam e and the passw ord to get the Internet access. S oftw are includes billing, statistics and reporting w ith m any other useful features. It is hardw are independent and you can use any type of access points, routers, sw itches and other equipm ent to control your W iFi, W iM ax, LA N, C able, DS L, S atellite and other type of netw ork connections.
Table of Contents
Part 1 Introduction
................................................................................................................................... 1 What is Antamedia HotSpot ? ................................................................................................................................... 2 Requirements ................................................................................................................................... 3 How Can It Help You ? ................................................................................................................................... 4 The User Interface
1
1 1 2 3
4
4 6 7 9
10
10 11 12
14
14 15 17 18 20 21 21 22 22 23
24
24 26 28
29
29 31
I
32 33
34
34 34
Part 8 Statistics
................................................................................................................................... 1 Bill Report ................................................................................................................................... 2 HotSpot Log ................................................................................................................................... 3 Connection Log ................................................................................................................................... 4 Statistics 5 Usage................................................................................................................................... Report
35
35 36 37 38 40
42
42 43 44
45
45 46
47
47 47 49 50 50 50
51
51 52 53 54
Part 13 Whitelists
1 What ................................................................................................................................... is Whitelist ? ................................................................................................................................... 2 MAC Whitelist
Antamedia 2008
55
55 55
II
56 57
58
58 62 63 64
65
65 66 67 67 68
69
69 70
Part 17 Usage Schedule Part 18 SMTP Roaming Part 19 Integration Part 20 HotSpot Language Editor Part 21 Additional HotSpot Options
71 72 73 75 76
Antamedia 2008
III
1
1.1
Introduction
What is Antamedia HotSpot ?
Antamedia HotSpot is Windows PC gateway software which helps you in controlling and billing your customers for the Internet usage. Antamedia HotSpot does not require any Client software installations. It uses captive portal technology to show login page in customer browser. Upon connecting to your network (using wireless cards or UTP cable), customer will be prompted to enter valid username and password to get Internet access. After successful login, your customer will see the remaining time and bandwidth quota, expiration date and other relevant info. HotSpot keeps track of customer account and shows warning message when the account is due to expire, helping a customer to refill the account and continue using your service without interruption. Software includes billing, statistics and reporting with many useful features. It is hardware independent and you can use any type of access points, routers, switches and other equipment to control your WiFi, WiMax, LAN, Cable, DSL, Satellite and other type of network connections.
1.2
Requirements
Antamedia HotSpot software should be installed on a standard PC computer, running Windows OS. Computer needs to have two network cards which are connected to the Internet on one side and to your network on the other side. HotSpot analyzes all network traffic between customers on your network and Internet. If customer is logged in, traffic is passed through the second network card to the Internet. Antamedia HotSpot have to be configured as a gateway for all computers in your network. On the first run, HotSpot will help you to configure your network through Setup Wizard.
Antamedia 2008
1.3
Antamedia 2008
1.4
If you prefer smaller computer icons, you can switch to compact view and display more computers on the screen. Option is located in HotSpot - Setup - Options page. Inactivity field is showing remaining time until automatic logout. Inactivity is optional for every account and default number of seconds can be specified in HotSpot - Network page. Customers will appreciate this option, as it will save their time and bandwidth in case they forgot to logout.
Antamedia 2008
2
2.1
Network Configuration
Network Setup
Network Setup page shows the following options: Network Interface Autostart HotSpot IP address Maximum users Inactivity logout Start Stop Save Network interface which connects HotSpot to your network Automatically starts HotSpot control when program starts IP address of the selected network interface Maximum number of users connected at the same time Automatically disconnects a user after specified time of inactivity Press Start button to activate HotSpot control Press Stop button to deactivate HotSpot control Save network settings
The first step in setting up the HotSpot is sharing Internet connection. This step is required in order to allow all customers in your network to access the Internet. There are several ways to share the Internet connection. It can be done by: - Using Antamedia HotSpot NAT (Network Address Translation), a feature available in Premium Edition and within trial interval. Setup Wizard will help you to configure NAT and give you sample how to configure connections of computers in your network - Using Microsoft Internet Connection Sharing available in Windows operating system - Using Routing and Remote Access available in Windows Server editions After you configure Internet sharing, please select Network Interface which connects your network to
Antamedia 2008
the HotSpot. On the selected network interface HotSpot will activate the integrated Web Server which is used to display all pages to customers, like login, logout, info and welcome pages. By changing the network interface, IP address will be automatically filled in. Please enable Autostart and press on the Save button to store your settings. The last step is clicking on Start button for activating HotSpot engine. From that moment your customers should see login page in their browsers in attempt to connect to the Internet. If login page doesn't appear, please check if - Internet connection is shared - computers in your network have correct connection settings (IP address, subnet mask, gateway, DNS). Please make sure that the gateway IP of client computers is the same IP as IP address in Network Setup page. - Windows Firewall and other firewalls are configured to allow HotSpot communication - other web servers are using port 80 - Skype is using port 80. Please disable this feature in Skype - Options - Connection - 'Use port 80 and 443 as alternatives for inoming connections' and restart Skype and Antamedia HotSpot.
Antamedia 2008
2.2
NAT Setup
Network Address Translation (NAT) is the process of modifying packet network address in order to use one public IP address with multiple, usually local, IP addresses. To say it simply, NAT is performing a Internet connection sharing. For example, you are using ADSL to connect to your ISP, and your computer gets one public IP address (like 202.102.43.11). Since all customer computers in your HotSpot network should have it's own IP address, you can use NAT to do translation between local IP address (like 192.168.0.2 - 192.168.0.254) and public IP which ISP assigned to your ADSL. Of course, NAT can be used with any type of devices and is not limited to ADSL. To configure NAT, you need to know how you are connected to the Internet. If you are using a modem (like ADSL, Cable etc), please select Dial-up modem. If you are connecting through switch, router or other devices, please specify LAN. As a NAT Network Interface, please select network interface which connects HotSpot to the Internet. The last option to configure is DNS redirector. Please type here one of the DNS addresses specified by your Internet service provider, or any other working DNS server. This option helps in cases when customer has incorrectly configured DNS address. HotSpot will redirect client to the correct address and DNS query will be resolved.
Antamedia 2008
2.3
Antamedia 2008
Antamedia 2008
2.4
SSL Certificate
SSL Certificate is used to encrypt communication between HotSpot Web Server and customer Internet browser. Secure connection can be used: - to switch to secure login. Instead of standard http:// based login page, customer can go to https://yourIPorDomain/login and authenticate through secure connection - when customer is about to pay with credit card, to keep the data safe - to change account password To configure SSL certificate, you need to specify correct location of Certification File, Private Key File and CAcert Root Certificate file. HotSpot comes with default SSL certificate produced for IP 192.168.0.1. Although this is included free of charge, it creates a warning messages in browser and might drive away customers. If you want to create your own certificate file, please follow instructions from www.antamedia.com/manuals/hotspot/ssl-setup.htm However, if you want a fully working SSL certificate which doesn't create any browser warnings, we recommend ordering your own certificate from SSL Certification Service www.hotspotssl.net You will get correct files so you can skip a bit complicated process. Such certificate allows you to show your domain in customer browser instead of HotSpot IP address. For example, instead of http://192.168.0.1/info customer will see http://www.myhotspotname.com/info Please note that Antamedia doesn't collect any fees from this service, and we recommend it as a money worth alternative to the manual certification process.
Antamedia 2008
3
3.1
Database Server
Database Server
Antamedia Database Server stores the data from Antamedia software (customers accounts, pricing plans, bills, statistics, reports, action log etc.). Database Server will be installed from HotSpot Installer which is available for download from Antamedia download page www.antamedia.com/download. Database server can be installed on the same computer as Antamedia HotSpot or some other computer. For small HotSpot installations (100 simultaneous users) Database Server can be located on the same computer, assuming that such computer is fast enough to handle all tasks. Please use Task Manager to monitor system resources and CPU usage. When idle, HotSpot and Database Server doesn't show any significant CPU usage. However, with large number of concurrent users, HotSpot and Database Server might reach 40-50% of CPU usage, and this is a sign to move Database Server to other computer. Upon installing Database Server, Installer will start ADBConfigurator (Antamedia Database Configurator) which will perform maintenance, update and add new database tables, stored procedures, triggers etc. If you intend to run multiple HotSpots and share the accounts between these locations, you will have to install Database Server on a computer with Public IP address (accessible from Internet). This way, all HotSpots will be able to connect to one Database Server. Recommendation: To keep your database safe, please use UPS (Uninterruptible power supply) on a computer where Database Server is installed. In case of power issues, database will remain intact. Power problems might lead to corrupted database and cause downtime. You can learn more about UPS in Wikipedia: http://en.wikipedia.org/wiki/Uninterruptible_power_supply Repairing database: If you already have database problem, please close HotSpot and run ADBConfigurator, which is located in the same folder as Database Server. Select Accounts tables and click on Repair button. In most cases database can be fixed successfully.
Antamedia 2008
10
3.2
With search and sorting With this option enabled you have ability to sort accounts (per name, IP, functionality on grid time etc. ). If you are using computer with slower CPU and Ram memory, headers it's recommended not to use this option. Without search and sorting functionality on grid headers Account sorting is disabled and HotSpot will display accounts much faster and get overall better performance. It's recommended to select this option.
Always display only 1000 If you have a large database and experience slow display of accounts when first accounts clicking on ACCOUNTS button, please consider using this option. It will significantly speed up database display on screen as only first 1000 accounts from result set will be displayed. *Please note that the default port, username and password can be changed in the Database Server configuration menu
Antamedia 2008
11
3.3
Antamedia 2008
12
Please note, Antamedia Database Server can be installed on any of the HotSpot locations. For example, you can install Database Server on HotSpot location 1 and configure other two HotSpot locations to connect to the IP address of the first location.
Antamedia 2008
13
4
4.1
Customer Accounts
What is User, Ticket and Refill ?
Before we start with the instructions how to create User, Ticket or Refill let us explain differences first. User accounts are represented with Username and Password required for login to HotSpot. Tickets are represented with a code, which is a sequence of letters and numbers. Tickets are PrePaid based Refills are not login accounts. Refills are used to add more time or bandwidth quota to an already existing PrePaid user account or Ticket.
Antamedia 2008
14
4.2
Generate Accounts
Generate Accounts option is located in Accounts tab available from the main HotSpot screen. The same option is used to generate: Users, Tickets and Refills. HotSpot takes care to generate unique accounts, with settings defined by Price Plan. Each price plan has price, time, bandwidth quota, expiration date and other options. However, administrator or employee (with appropriate access rights) is able to modify any of the settings before generating accounts.
Generate Accounts page has following options: Generate _ Type Price Plan Print Please enter how many accounts you want to generate Select if you want to generate user accounts, tickets or refills Choose a Price Plan to define parameters of new accounts Enable Print if you like these accounts to be printed on paper
Antamedia 2008
15
Depending of Type selection, different options will appear in the right side of the screen: Prefix Start Number Password Length Length A word which comes as a first part of the generated account username (like NEW) Defines starting number to be added to prefix (like 21). With this examples, accounts that will be created are NEW21, NEW22, NEW23 etc. Defines how many characters (letters and numbers) will a password have Defines how many characters (letters and numbers) will ticket or refill have
Accounts are saved in the database, sold and added to bills and statistics, and ready for use. Accounts are saved in the database, and will be sold on the first usage or when operator click on Sell button in Accounts page Use generate button to create new user account, ticket or refill Save generated accounts in the database Close Generate Accounts tab
What are the steps to generate accounts ? 1. Type 10 to generate 10 accounts 2. Select User Prepaid 3. Choose desired price plan 4. Optionally select discount 5. Enable Print if you want to print account on paper 6. Click on Generate button 7. Click on Save button If you want to print accounts directly, without print preview, you can select No Preview option in HotSpot - Setup - Options - Print Options.
Antamedia 2008
16
4.3
Quota
Total bandwidth traffic available to a user for downloading or uploading. It's usually displayed MB, GB or TB depending on value. Quota is not a sum of download and upload traffic. If you define 100 GB as quota, user can download and upload maximum of 100 GB, whichever comes first. Enable this option if you do not wish to limit users by bandwidth quota Time available for Internet usage. It's measured in seconds Enable this option if you do not wish to limit users by time. It's useful if you charge users by bandwidth or users pay monthly fees Download rate limitation. Download rate can be displayed in: KBytes, Kbits, MBytes or Mbits. Like 1 Mbit/s Upload rate limitation. Disabled option means that generated accounts can not be used for login until they are activated Automatically disconnects the users from the Internet after specified time of inactivity Set the date when account expires. After expiration date account can not be used anymore for login and user will see a message that account has expired Number of days in which will account expire from the first login. For example, if you set to 10 days, and user will not be able to login on 11th day from first login Number of days in which will account expire from the last login. For example, if you set to 10 days, and user does not login in the next 11 days, account will expire
Download
Inactivity timeout
Accounts expires on
Antamedia 2008
17
Limitations available on the Additional Options page: Bandwidth quota daily limit Total bandwidth traffic available to user on daily basis. When all daily quota is used, user can login on the next day Limit daily time usage Total time available for Internet usage on daily basis. When all daily time is used, user can login on the next day
Limit number of daily logins Limit how many times user can login on daily basis Multilogin with maximum _ Multilogin option allows more than one user (computer) to login with the simultanious logins same account. Users sharing one account also shares total download and upload rate. For example, 100 KB/s can be used by one user, or it can be used for 10 users to have approximately 10 KB/s each. Accounts are valid for Chooses which Antamedia softwares can use generated accounts
4.4
Quota
Account is active
This option defines wether user can login in HotSpot. With this option you can temporary disable selected customer. For example, excessive download, bill payment is late etc. Automatically disconnect selected user from the Internet after specified time of inactivity Delete account from database Immediately stops and logouts user
Inactivity timeout
Antamedia 2008
19
4.5
Expiry and Limits page contains the following options: Account expires on Specify the date when an account expires. After the expiration date the account can not be used anymore for login and a user will see a message that the account has expired Number of days in which will an account expire from the first login. For example, if you set to 10 days, and a user will not be able to login on 11th day from first login Number of days in which will an account expire from the last login. For example, if you set to 10 days, and a user does not login in the next 11 days, the account will expire
Bandwidth quota daily limit Total bandwidth traffic available to a user on daily basis. When all daily quota is used, a user can login on the next day Limit daily time usage Total time available for the Internet usage on daily basis. When all daily time is used, a user can login on the next day
Limit number of daily logins Limit how many times a user can login on daily basis Accounts are valid for Choose which Antamedia software can use the generated accounts
Enable Usage schedule Specify time period when an account can login. Day and time rules are days and time for account defined in HotSpot - Setup - Usage Schedule page. This option can be login used for example to allow login for account from 8AM to 8PM, or only on weekends, or to force the users to logout at midnight. Fixed MAC Limit an account so it can login only from one computer. If MAC address does not exist yet, it will be stored in the first login. From that moment, a customer has to use the same computer
Multilogin with maximum _ Multilogin option allows more than one user (computer) to login with the simultanious logins same account. The users sharing one account also share the total download and upload rate. For example, 100 KB/s can be used by one user, or it can be used for 10 users to have approximately 10 KB/s each.
Antamedia 2008
20
4.6
Customer Details
Customer Details page contains customer personal information and creates valuable addition to the rest of the account options. Details available on Customer Details page are displayed in screenshot:
Details include: - First and last name, - address, city, postal code, state, country, - customer ID, - phone and mobile number with an option to send SMS Reminders (requires additional Antamedia software) - Email addresses with an option to send Email Reminders - gender and birthday - credit Card information
4.7
Antamedia 2008
21
4.8
Customer Photo
Antamedia HotSpot goes beyond te usual personal data collection and provides an option to save customer photo, document image and document details. This is especially useful in the countries with anti-terrorism laws, where all users have to provide identification document. With options provided by HotSpot, you can save customer ID Card, Passport, Driver licence etc. Picture can be loaded from hard drive, or it can be acquired from any twain compatible device, like scanner, web camera etc. The same applies to Customer Photo. We recommend keeping pictures in appropriate sizes since large scanned documents can quickly increase database size.
4.9
Account Maintenance
Everyday HotSpot activity increases database size. Although HotSpot can handle millions of records easily, it might be a good idea to perform maintenance on a regular basis. With default HotSpot setting all the accounts are displayed after clicking on ACCOUNTS button. With large database and many old and expired accounts it might take time to show them on screen. Account maintenance can help you keep the database fresh and speed up the display of accounts. Account maintenance options available in HotSpot - Setup - Database - Maintenance page are: Expire Before Last used before Time left less than Inactive Unsold Use it to delete the accounts which expired before the specified date Delete old accounts that have not been used lately Use it to delete accounts with few minutes left time. In the field specify the time interval in minutes Delete all deactivated accounts Delete the account that is generated with Sell Later option enabled, but not sold yet
After selecting the desired options, please click on Delete all accounts to delete the accounts from the database. Please be careful with this function since deleted accounts can not be restored.
Antamedia 2008
22
Please select desired options and click on Update all accounts button to perform update.
Antamedia 2008
23
5
5.1
Customer types username and password and clicks Login button. Welcome screen shows, then redirects to the page which customer requested.
Infobox is useful as it keeps a customer informed about the remaining time and bandwidth quota, and current MAC and IP address. Since many browsers blocks pop-up windows, it is recommended to advise customers to click on Open Infobox link before clicking on Login button. Most of the browsers do not prevent pop-up windows which are the result of user action.
Antamedia 2008
24
Help page explains that HotSpot is commercial and that customer should buy a ticket. This page can be modified to show your contact numbers, live chat link, terms of usage etc.
If you accept credit cards, a customer can click on Signup link and pay for your service. In three step process, a customer will choose username, password, then select a price plan and pay by entering credit card details.
The same Signup link can be used to refill existing account. Customer should enter the existing username and type (and confirm) a password.
Antamedia 2008
25
5.2
Autologin
Autologin feature automates the login process since a customer does not need to enter a username and password. As soon as a customer connects to your network, HotSpot will detect it and automatically login customer account. This way a customer skips login page and has a feeling that the computer is always connected to the Internet. However, HotSpot will track customer usage and logout account in case of inactivity. How to configure Autologin ? 1. You have to Enable Autologin globally in the software (see the screenshot 1 below) 2. In Manage Account page please Enable Autologin to allow autologin for that account (screenshot 2). By default, this option is enabled while generating the accounts so this step is usually not necessary (screenshot 3). 3. Customer has to login initially in order to store MAC address of computer in HotSpot database. From that moment, autologin will be functional for that account. MAC address is stored in Account Expiry & Limits page, in a field below Fixed MAC option. This feature can be used to allow the selected VOIP phones to access network automatically. In order to do this, you have to create the accounts for each VOIP phone and store its MAC address manually. You will also have to add VOIP ports that should trigger the autologin. By default, HTTP, FTP, SMTP, DNS, POP and SSL ports are stored in autologin ports list. This means that autologin will be activated if a customer tries to access the Internet by using any browser, FTP software or tries to send or receive Emails. If you like, you can add additional ports if you like, that can react on the other applications.
Screenshot 1
Antamedia 2008
26
Antamedia 2008
27
5.3
Logout
HotSpot users will be logged out automatically when time or bandwidth quota expires. Of course, there are other parameters that can cause a logout, like daily time or quota expiration, an account expiry date has been reached, usage schedule definition, or a user did not perform any activity in the specified time (like computer shutdown, forgot to logout manually etc). User can logout in different ways: 1. By clicking on Logout button located on Infobox pop-up menu (displayed after login) 2. By clicking on Logout button located on Info page (like http://192.168.0.1/info) 3. By typing keyword LogMeOut in browser address bar. This keyword is tracked in two ways: - through the NetBIOS (if a customer has enabled NetBIOS in network interface used to connect to your network). This feature is available in all the editions. - as a URL Keyword function located in HotSpot - Setup - URL - URL Keyword tab, that functions as a parser of incoming traffic. The second case require URL Tracking feature enabled, which is available in Premium edition. 4. Automatically if a user has not performed any Internet activity in the specified time. Inactivity timeout interval can be configured in HotSpot - Setup - Network - Network setup page.
Antamedia 2008
28
6
6.1
Price Plans
Defining a Price Plan
Price plan is a preset of values which are assigned when you generate or refill accounts. For example, price plan defines price which customer should pay for specified time usage, data transferred, download and upload rate, but may also define the expiration date, daily limits etc. When you generate user accounts, tickets and refills, the values defined by price plan are stored in database for each account. If you refill an account with a price plan, time and quota values are added to the current account values. If a price plan has unlimited settings for time and quota, an account will also become unlimited for these values. Download and upload rate, the expiration date and other values defined by price plan used for refill, are assigned to the account no matter which values the account had had before.
Creates new price plan Deletes selected price plan Modifies selected price plan. When you make changes to price plan, please click on this button to save it
Antamedia 2008
29
Price plan options on HotSpot software - Setup - Prices - Price Plans page are: Time Unlimited Time Time available for the Internet usage. It's measured in seconds Enable this option if you do not wish to limit users by time. It's useful if you charge users by bandwidth or users pay monthly fees Cost of selected price plan. If tax is not specified, this is what customer pays Description is displayed in list from where operator chooses which price plan to select If selected price plan is active and can be used for account generating Number of days in which will an account expire from the first login. For example, if you set to 10 days, and a user will not be able to login on 11th day from first login Number of days in which will an account expire from the last login. For example, if you set to 10 days, and a user does not login in the next 11 days, the account will expire
Price
Description
Antamedia HotSpot creates default price plans on first installation so you can have a better idea of the possibilities. You can modify them, or create totally new price plans. The number of price plans in database is not limited.
Antamedia 2008
30
6.2
Limit number of daily logins Limit how many times user can login on daily basis
Bandwidth quota
Total bandwidth traffic available to a user for downloading or uploading. It's usually displayed MB, GB or TB depending on value. Quota is not a sum of download and upload traffic. If you define 100 GB as quota, a user can download and upload maximum of 100 GB, whichever comes first.
Bandwidth quota daily limit Total bandwidth traffic available to user on daily basis. When all daily quota is used, a user can login on the next day Download Upload Download rate can be adjusted for each user separately Upload rate can be adjusted for each user separately
Antamedia 2008
31
6.3
Taxes
If you are required to charge tax for your services, Antamedia HotSpot offers flexible tax setup. There are 3 different taxes to configure with tax on tax option. Tax configuration examples: If you have single tax to charge: 1. enable Tax1, 2. name it (like VAT) 3. configure % value 4. press Save button If you have two different taxes to charge: 1. enable Tax1, 2. name it (like VAT) 3. configure % value 4. enable Tax2, 5. name it 6. configure % value 7. press Save button If your country regulation requires second tax to be calculated as percent from the value of the first tax, please enable Tax2 on Tax1.
Antamedia 2008
32
6.4
Discounts
Discount feature helps you to offer the discounts when there is a need for it. You can offer a discount to your regular customers, for buying 10 tickets in advance, for daily promotions or similar reasons. In the HotSpot - Setup - Prices - Discounts page please define different discount types. To define a discount: 1. Enter discount name 2. Specify discount percent (like 10 %) 3. Enter discount description 4. Press Save button To delete a discount from the list, please select it with left mouse click and press Delete button.
Antamedia 2008
33
7
7.1
Receipt Printing
Printing Options
Antamedia HotSpot offers different templates for account, refill and receipt printing. Please configure print templates in HotSpot - Setup - Options - Print options page. If you do not want to see a preview before printing, which is suitable once you configure print templates, please select No Preview. To print directly to the default printer, without showing print dialog, please disable Show Print dialog option.
7.2
Receipt Details
Receipt title, header and footer text can be modified on HotSpot - Setup - Options - Print options page. Depending on receipt template, this text will appear on printed receipt which you give out to the customer.
Antamedia 2008
34
8
8.1
Statistics
Bill Report
Bill report shows the list of all charged bills. Each bill has the following details: - Date - Subtotal - Discount - Tax - Total amount If you want to see what was charged on the selected bill, please click on + button to open the list. You can see the following details: - Description - Subtotal - Quantity - Tax - Total amount For example, if you generate and sell 10 accounts, you will see in description field Description: Sold 10 accounts (ID 1-10) with price plan 15 minutes test Quantity: 10 To display all the bills of specified time period, please select starting and ending date in the From and To fields and press Show button. HotSpot automatically calculates totals for all bills and displays it in bottom bar.
Antamedia 2008
35
8.2
HotSpot Log
HotSpot log shows all the actions and events initiated by HotSpot users, operator or software. Log shows the following details: 1. Level - Information, used for account login and logout, and many other informational messages - Warning, wrong user login and information that might require administrator attention - Payment, when customers pay for your service - System Error, if any HotSpot malfunction occurs 2. Date and time 3. Description 4. Action (Login, Logout, Modify, Start, Stop, Error, Generate, Add, Del, New) 5. Account 6. IP address 8. MAC address To display all the log items for specified time period, please select starting and ending date in the From and To fields and press Show button. If you like to show log for specific computer, please enter its account, IP or MAC address and press Show button.
Antamedia 2008
36
8.3
Connection Log
Connection log shows all the connection attempts to your HotSpot which can give you a realtime report who is trying to login to your network. It is a powerful tool which shows IP and MAC address and the port which remote computer is trying to access. This log can be used to monitor your network, to detect if any hacking attempts are in progress, to identify a reason when a customer is having a problem to login. In case when Autologin feature is enabled, connection log will show which connection was granted to login automatically, based on autologin settings. In such case customer does not see HotSpot login page, but instead get instant Internet access and HotSpot handle login process. Autologin is possible as MAC address of customer computer is known and tied to customer account. To activate this feature, please Enable Connection Log.
Antamedia 2008
37
8.4
Statistics
Statistic report is providing valuable data about your HotSpot operation. It will show you total time usage, bandwidth, number of logins and total sales for selected day or time period. Using this feature you can identify which days generate lower profit and stimulate customers with appropriate benefits. Statistical data is collected continuously, after each customer logout, so you can always enjoy fast report display on screen. Statistics is available in Chart and Table mode. By default, statistics is displayed in chart mode, giving you a graphical overview of HotSpot activity. You can see, for example, time usage displayed in minutes, over the selected period displayed as days of the year. Depending on the date range selected, you will see an activity in 24 hours for current day, or for a time period defined with the starting and the ending date in the From and To fields.
Antamedia 2008
38
Table mode shows statistics in a condensed view on a daily basis. For each year, month, and day, you will see usage time, number of logins, download, upload and total sales.
Antamedia 2008
39
8.5
Usage Report
Usage report is a session based report which precisely shows who, when and how much has used your HotSpot services. This report shows the following details: - Account - IP address - MAC address - Start time, when a session started (customer logged in, or autologin occurred) - End time, when session stopped (customer logged out, or an account expired) - Usage time - Download - Upload - Sales, if a customer has paid To display usage report for specified time period, please select the starting and the ending date in the From and To fields, or choose one of the predefined time periods (Today, Yesterday, Last 7 days etc.), and press Show Usage Report button. You can filter such report for a specified account, IP or MAC address.
Antamedia 2008
40
Usage report offers many reports like: Usage Log - shows all sessions and it's details Summary per Account - get totals for selected account Summary per MAC - get totals for the selected MAC address Summary per IP - get totals for the selected IP address
You can also get top customers statistics which can help you to identify the customers who have made the biggest profit, most download, or have spent most of the time using your services. Top customers by download Top customers by upload Top customers by time usage Top customers by sales Top customers by number of sessions The report names are self-explanatory. Top statistics only take sessions where an activity exists.
Antamedia 2008
41
9
9.1
HotSpot Operator
What is HotSpot Operator ?
HotSpot Operator is a feature specially developed to keep account creation simple. Very intuitive user interface will guide an employee through 3 simple steps which significantly decreases learning time and everyday account creating. This feature is available in all HotSpot Editions and can be accessed through the main screen by clicking OPERATOR button. However, you can have multiple HotSpot Operators at the same time and on different physical locations. For this purpose, additional HotSpot Operator licenses are required, which can be purchased on Antamedia website. How can this help you ? - Allow front desk operators to generate accounts without access to sensitive data - Hotel reception can generate accounts while main HotSpot is located in secured place (server room) - Resorts can install multiple HotSpot Operator software in each building, effectively connecting entire resort in one network. As soon as one of the Operators create an account, it can be used in the entire network - Administrator can use it to generate, modify or delete accounts, view bills and statistics, generate reports, make new employee accounts, configure price plans, send email notifications (account expiry or maintenance reminders) - Owner can monitor HotSpot activity from home, take a look at sales, logs, statistics The most important aspect of additional Operator licenses is that they protect the main HotSpot gateway from human activities that can cause downtime. Keeping main HotSpot on a secure place is recommended as it minimizes the problems like: - viruses or bad software downloaded by employees which can lower the Internet bandwidth and destabilize the system - multiple programs started by employees which increase CPU usage - accidental reboots etc. Please note: Additional HotSpot Operator license can not be used as standalone, to control users and data transfer. It does not provide captive portal functionality (does not display login page). It requires main HotSpot software installed.
Antamedia 2008
42
9.2
User Interface
User interface is very simple and easy, and it is designed keeping in mind inexperienced staff. Accounts are generated in 3 easy steps: 1. Choose Price Plan 2. Choose number of the accounts to generate 3. Click on Generate button User interface is touch screen friendly with large buttons, and several layout configurations. Printing is optional and it can be turned on or off with a single click. An operator can choose between several screen layouts showing 3 steps to generate accounts, smaller or larger price plan list, price plan cost and total amount to bill, and optionally display or hide generated accounts with username and password.
Antamedia 2008
43
9.3
Antamedia 2008
44
10
Employee Accounts
Antamedia 2008
45
Antamedia 2008
46
11
11.2 PayPal
There are 2 PayPal processing options: 1. Website Payments Pro - available to US customers only 2. Express Checkout - available in other countries depending on the current PayPal regulation Website Payments Pro - payment is completed from our software and there is no need to transfer a customer to PayPal site. Processing is completed faster but this option requires PayPal account with Payments Pro option enabled which is usually charged monthly by PayPal. Express Checkout - payment is initiated on HotSpot pages and completed on PayPal site. Customer can use already existing PayPal account for the payment which significantly simplifies order, and the credit card payment is available for new customers who do not have a PayPal account. Please configure IP address for PayPal response and Port where internal web server will be activated to receive processing result message from PayPal.
To configure PayPal 1. In the page select PayPal as a payment processing gateway. 2. Please select Website Payments Pro or Express Checkout 3. Enter Paypal API username 4. API password 5. Type path where API Certificate (PEM) is located on your hard drive 6. Press Save button
Antamedia 2008
47
After setting up, please check Host Whitelist page and make sure that following addresses are listed : api.paypal.com paypal.com www.paypal.com www.paypalobjects.com paypalssl.doubleclick.net and HotSpot public IP . If you are not getting PayPal pages, or a response is very slow, please check at PayPal support what are the current requirements for host whitelisting since sometimes change the servers involved in payment processing. To check if your country is supported for Express Checkout, please visit: http://www.paypal.com/cgi-bin/webscr?cmd=_display-approved-signup-countries-outside
Antamedia 2008
48
Antamedia 2008
49
11.4 Authorize.Net
If you have an account with API, please configure details as follows: Merchant Login = API Login ID Merchant Password = Transaction Key Please make sure that your Authorize.net account is not configured in test mode. Antamedia HotSpot uses production gateway.
11.5 Moneris
To setup Moneris e-Select Plus payment gateway, please configure details obtained from Moneris as follows: Merchant login = DirectPost ID (ps_store_id) Merchant Password = DirectPost Key (hpp_key) To obtain required merchant account details from Moneris e-Select Plus payment gateway please login to your Moneris e-Select plus account. - Click on Admin. - Click on DirectPost Config. - Generate a New Configuration. - NOTE THE GENERATED IDs Setup the following fields - Default Transaction: Purchase - DirectPost Response Method: Displayed as key/value pairs on our server. Optional Response Fields: - Transaction Number:NO - ECI:NO
11.6 Optimal
In Add Special Field please type the account Merchant Account Number provided by Optimal Payments gateway and enable this option.
Antamedia 2008
50
12
Antamedia 2008
51
Antamedia 2008
52
Antamedia 2008
53
Antamedia 2008
54
13
Whitelists
Antamedia 2008
55
13.3 IP Whitelist
To add computer IP address that should pass to the Internet through the HotSpot software without authentication, please type computer IP address in Add IP address field and press Add button. To remove computer from the whitelist, please select computer IP address in the whitelist using left mouse click and press Remove button. When you finish, please press Save button.
Antamedia 2008
56
Press Add button to add host IP or host name, or press Remove button to remove host IP or URL address selected in the whitelist. When you finish, please press Save button.
Antamedia 2008
57
14
HotSpot Themes
14.1 Themes
HotSpot Themes are easy and convenient way to completely change how the HotSpot pages look in customer browser. Changing theme is very simple. In Current Theme field located in HotSpot - Setup Pages - Themes page, configure the preferred theme and your customers will see the change in their browsers for every new HotSpot page they open. Antamedia HotSpot comes with several themes which you are allowed to use and modify. Default HotSpot skin also comes in a white-label variant, which you can use to put your logo. Themes can be modified in order to match your corporate look. You can change colors, modify graphics and buttons and save it as a new theme. These details are specified in Style.css file which is located in each theme folder (like c:\Antamedia\HotSpot\www\Themes\Default).
Antamedia 2008
58
Default Theme
Antamedia 2008
59
Blue Theme
Red Theme
Antamedia 2008
60
Counter Theme
Antamedia 2008
61
Antamedia 2008
62
Antamedia 2008
63
Antamedia 2008
64
15
E-mail Notifications
Antamedia 2008
65
Each Email template is defined with: Description Subject From Email Reply to Delivery notification to Sensitivity Priority Description is displayed in the software from where an operator chooses Email template Email subject Your name, company name or the department Your Email from which you are sending a message Email address where you want to receive the replied Emails If you like to receive delivery status It usually helps that your message is not marked as SPAM If your Email should have priority configured (it might increase SPAM score)
Antamedia 2008
66
These values are checked only on account login. Email template specifies which message template will be used to prepare Email for the customer.
Antamedia 2008
67
Antamedia 2008
68
16
Website Filtering
Antamedia 2008
69
Antamedia 2008
70
17
Usage Schedule
Usage schedule feature helps you to define when the customers are allowed to use your services. Using a graphical interface you can draw the blocks which define the time intervals when your services can be used. Graphical grid is displayed like daytime hours on one axis and the days in a week (Monday to Sunday) on the other axis. This provides the full control over the whole week. Blocks are displayed in 15 minute steps. To create a new time block, please select a time period and click on Add button or press Insert key on a keyboard. To delete time block, please press Remove button or Delete key on the keyboard. If you like to create a new template, you can start by pressing on New button. To store template changes, please use Save button. To save new template use Save As New button and specify template name. Use Delete button to delete usage schedule template from the database. You can move the block by pressing and holding left mouse button on top blue bar. Once you configure all the templates, you can assign them to desired accounts. To do this, please click on the account and go to Expiry & Limits page. Enable the usage schedule for that account and choose a template. Press Save Changes button. From that moment, a customer may login and use your services only in time periods defined by the assigned usage schedule. For example, if customer may login from 8AM to 8PM, login will be possible within that interval, and if logged in, a customer will be automatically logged out at 8PM. Default usage schedule templates that come which comes with software include Daytime, NightTime, Happy hour, Weekend only, Business days etc. You can use it or modify it depending on your needs. If you are running central database server, the usage schedule templates are visible on all HotSpot locations.
Antamedia 2008
71
18
SMTP Roaming
Internet service providers sometimes blocks SMTP port (25) in order to stop abuse. If you are using such Internet service provider, your customers will not be able to send Email when their Email configuration uses that port. SMTP Roaming feature helps you to overcome this problem by redirecting all Email traffic to other SMTP server running on different port. The entire process is transparent for the customer and no changes are required in customer Email settings. For example, a customer uses mail.companydomain.com on default port 25 when working from the company office. When a customer connects to your HotSpot where ISP blocks port 25, it will not be possible to send an Email although all the settings are the same in customer Email client software (Outlook, The Bat ...). The solution is to redirect all traffic for the port 25 to a different SMTP server and port. Although a customer does not see any changes and may think that Email was been sent through the company server, an Email will be sent through your SMTP server. To activate SMTP roaming, please Enable it and type SMTP Server IP and Port where to redirect Emails. If you do not know IP address, please type SMTP Server URL address and press Resolve IP button. You can click on the correct IP address to transfer it to SMTP Server IP field. When you finish, please press Save button.
Antamedia 2008
72
19
Integration
Antamedia HotSpot can be easily integrated with the third-party software. This feature is located in HotSpot - Setup - Options - Integration page. Integration is done as a HTTP GET query and XML response which offer very short integration time. To put it simply, it works this way: 1. Your software should send a formatted query similar to URL you type in browser to see certain web page 2. Our software gets this query, parse it and execute the actions (example: generate accounts) 3. Our software generate XML response with details (example: account details) and return it to your software 4. Your software parse XML and process the data (example: use account details to print receipt) To activate this feature please Enable Integration, specify port (82 by default), and Secret PassPhrase. Purpose of the PassPhrase is to protect from unauthorized usage while allowing you to use integration commands from different IP addresses. For example, multiple instances of your program can communicate with HotSpot and generate accounts. For the purpose of this manual, we will take 192.168.0.1 as HotSpot IP address, port 82 and PASS as PassPhrase. These are integration examples: http://192.168.0.1/generateaccounts?number=5&priceplan=1&pass=PASS This command will generate 5 accounts and assign price plan 1 to those accounts. You can put a button in your software and send such command after user click on it. XML response contains all account data, like username, password, time, quota, expiration. http://192.168.0.1/generateaccounts?number=3&priceplan=2&print=1&preview=0&pass=PASS This command will generate 3 accounts, assign them price plan 2 and print the accounts in HotSpot software without print preview. If you intend to handle printing from your software, printing is not needed. http://192.168.0.1/generateaccounts?account=TEST&pass=PASS This command will generate one account with username TEST. It is suitable in cases when you always generate unique accounts, like personal ID number from ID card. The account will not be generated if such an account already exists. http://192.168.0.1/getpriceplans?pass=PASS This command is used to retrieve all price plans from HotSpot software. XML response will contain price plan description, cost, time and quota values, expiration etc. You can use these details to store them in your controls (like Listbox, Combobox) and allow a customer to choose a price plan before you send command to generate the accounts. http://192.168.0.1/deleteaccount?account=TEST&pass=PASS This command will delete the account TEST from the HotSpot software. The time is displayed in seconds, Quota, Download, Upload are in bytes. Other fields with 0 and 1 represent false and true. If you have a specific integration requirements, please contact Antamedia.
Antamedia 2008
73
XML response example for generated accounts looks like: <?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE Accounts (View Source for full doctype...)> <Accounts> <Account> <Username>TEST15</Username> <Password>FD61U</Password> <TimeUsed>0</TimeUsed> <TimeLeft>3600</TimeLeft> <UnlimitedTime>False</UnlimitedTime> <Quota>0</Quota> <UnlimitedQuota>True</UnlimitedQuota> <GroupPlanID>2</GroupPlanID> <AccessFromTo>False</AccessFromTo> <AccessID>1</AccessID> <ExpireIn>1</ExpireIn> <ExpireAfter>1</ExpireAfter> <EnableDailyTime>False</EnableDailyTime> <DailyTime>0</DailyTime> <EnableDailyQuota>False</EnableDailyQuota> <DailyQuota>0</DailyQuota> <EnableDailyLogins /> <DailyLogins /> <Download>131072</Download> <Upload>65536</Upload> <GenerateID>15</GenerateID> </Account> </Accounts>
Antamedia 2008
74
20
Antamedia 2008
75
21
Force clearing account Clears IP addresses which are in use by customer computers. It is useful when IP addresses on you have to restart HotSpot software HotSpot restart Hide SignUp link on login page If you do not accept credit card payments from your customers, you can hide SignUp link
Allow login for unsold All the accounts will be able to login even if an operator have not sold them accounts Allow relogin if IP address changes Allow a customer to login again if the account is already in use. The previous session will be logged out and a customer asked to login again (it can help when the connection is not stable and a customer is trying to connect while getting different IP addresses) Store all HotSpot messages (information, warnings etc) in a log file
Improve performance Minimize HotSpot software after the specified time period of inactivity to get by minimizing HotSpot better performance. This feature is enabled by default and we recommend leaving it enabled Show accounts from Show the accounts from other Antamedia software (Internet Cafe software, HotSpot, Bandwidth Manager) Choose format which is used to display time HH:MM (2:35), Hh:Mm (2h 35m), Hh:Mmin (2h 35min), M m (155m), M min (155 min) Choose quota format between bytes, KB, MB, GB, TB, PB, or adaptive which automatically displays the correct format depending on value Choose the display format of download and upload rate KB (KBytes), Kb (Kbits), MB (MBytes), Mb (Mbits)
Antamedia 2008
76
SALES +381652106600 sales@antamedia.com CUSTOMER SUPPORT +381652107700 +381652108800 support@antamedia.com www.antamedia.com www.antamediahotspot.com