aptilo_spa_81_usermanual-4

Users Manual

Notices

Notices

Safety NoticesPlease observe all safety markings and instructions when using this product.

Disclaimer of LiabilityEvery care has been taken in the preparation of this manual; if you detect any inaccuracies or omissions, please inform us at an address which can be found at the back of the manual. Aptilo Networks cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. APTILO NETWORKS AB MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THE MATERIAL CONTAINED WITHIN THIS DOCUMENT, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. APTILO NETWORKS AB SHALL NOT BE LIABLE NOR RESPONSIBLE FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING, PERFORMANCE OR USE OF THIS MATERIAL.

Notes: You should be a professional Linux adminis-trator when logging on to the system as a superuser using the root password.

All shell prompt commands are executed at your own risk.

Do not use any other software with the Aptilo Mobile Access Server without per-mission from Aptilo Networks AB.

Trademark AcknowledgmentsBluetooth is a trademark owned by the Bluetooth SIG, Inc. Ethernet and Windows, are registered trademarks of their respective holders.

Software AcknowledgementsThis product includes software developed by:

Ralf S. Engelschall for use in the mod_ssl project (http://www.modssl.org/).

The OpenSSL Project for use in the OpenSSL Project and Toolkit. (http://www.openssl.org/)

Eric Young (eay.cryptsoft.com)

Copyright InformationThe unauthorized copying of materials that are covered by

copyright and other international proprietary or intellectual property rights is prohibited in most countries. Aptilo Networks AB recommends that the users of this equipment seek the necessary authorizations for copying material. The instructions for use in the manual shall not be considered as an inducement to make illicit duplications of material. Any duplication will be made at the users own risk.

Support ServicesFor operational support regarding this functionality, please refer to your Support Agreement with your service provider. In the Support Agreement you will find details on included services and your contact information.

About This ManualThe manual provides introductory information as well as detailed instructions on how to manage useraccounts. It is expected that the administrator has got an introductionary training of the complete solution before using this functionality.

Aptilo Official Home PageAll applicable software and information are available from the Aptilo home page at http://www.aptilo.com. This site enables you to access corporate and support information, and learn more about other Aptilo products.

Aptilo Service Portal ManualRevision 8.1Manual version: 1.0

Dated: July 2008Copyright Aptilo Networks AB, 2008

Table of contents 2

Table of contents

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.1 Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2. Solution overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42.1 Network overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.2 Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62.3 Usage data & statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3. Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84. Network configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4.1 Service Portal - main page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104.2 Control Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114.3 Legal Intercept. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124.4 System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144.5 Network and node configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

5. Report configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185.1 Configure Network Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185.2 Configure Custom Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195.3 Archive reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225.4 Online report templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235.5 Notifications - Send reports by email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

6. Venue Portal overview and configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256.1 Overview of Venue Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256.2 Create a Venue Portal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

7. Operational activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317.1 SPA Start, SPA Stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317.2 Archive activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317.3 Backup and Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347.4 Upgrade procedure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

8. Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398.1 Monitoring overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Appendix A -Venue portal application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42

Appendix B -Report types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46

Introduction 3

1. IntroductionThis manual describes how to set up and use the Aptilo Service Portal, which is a product in the Aptilo product portfolio.

The Service Portal complements existing products by being the main tool for automatic processing and display of data output from the solution; including usage data, aggregated statistics and monitoring data.

The significant benefits of the Aptilo Service Portal are:

The configuration is automatically updated as the hotspot network changes Flexible and easily configurable report generator, where reports easily can be

added and configured An intelligent tree view displays status and network statistics, efficiently combining

network overview with detailed information A web-based display of the network including status presentation and usage reports.

The Aptilo Service Portal solution also offers the operator the possibility to provide this information partly or to the full extent to their customers. This is done by creating external or internal customer adapted venue portals. The web-application providing these portals are delivered as a separate web-application that can be hosted on almost any commercial web-server. The information is then exported from the service portal node to the external web-server

1.1 Definitions Aptilo Service Portal or Service Portal

The Aptilo Service Portal is a product in the Aptilo product portfolio. All configura-tion of reports, nodes, monitoring and customizations are done in the service portal.

Venue Portal or PortalThe Venue Portal is a portal where the result is shown for the users.The status and data reports are displayed in the Venue Portal. Several portals can be configured in one Aptilo Service Portal.

Solution overview 4

2. Solution overview

Thha

Outai

W

e Aptilo Service Portal is a separate node in the Aptilo Hotspot Solution. It currently s two main feature areas, monitoring and statistics.

r aim is to provide a simple-to-use, cost-effective and feature-rich alterative lor-made for the hotspot/broadband/visitor network scenario.

ith the Aptilo Service Portal installed, operators are able to:

Monitor hotspot network down to AP levelView status and status history in purpose-built web interface featuring the intelli-gent tree view for network overview and details View graphs detailing e.g. number of user sessions and bandwidth usage per loca-tionSearch for user events in event databaseRetrieve usage data history (e.g. basis for billing or market analysis)View reports generated to summarize important aspects of usageOffer partners, such as venue owners and roaming partner, to have access to limited parts of the portal for online information for their own benefitAutomatically retrieve and store usage data generated by Aptilo MASAutomatically backup configuration, usage data and statistics.Manually backup and restore of configuration, usage data and statisticsAutomatically archive data based on time.Manually archive feautures enabling export and import of data based on timeEnjoy cost-savings in management of the monitoring and statistics solution since the Aptilo Service Portal automatically updates itself as the network developsSend reports to specified email groupsSearch on legal intercept data.

Solution overview 5

2.1 Network overviewThe complete solution consists of the following main nodes:

The access network nodes placed at the venue property. These nodes collects network status and usage information from the local network and passes that infor-mation to the central nodes.The central AAA, payment and network management nodes. These nodes col-lects the status and usage information from each venue site/sub-site and passes that information to the Service NodeThe Service Node, this node collects the information from many central nodes, stores it and generate reports, graphs and network data in a format that can be dis-play to the different users. It also exports information to one or more internal or external venue portalsThe public web-server node hosting the Venue Portal application. This node allows users to get access to their part of the information through a very end-user friendly interface.

Solution overview 6

2.2 MonitoringThe monitoring functionality in the Aptilo Service Portal provides tools for viewing the sta(MAl

Thup

Th

ThpeSene

2.3 UThboa c

Thtus of the complete hotspot network, including not only the Aptilo components AS, PAS and AC's) but also other network elements such as routers and switches. so the status of critical processes, such as links to external systems, can be included.

e network status is displayed using a tree view. In the tree view, status is propagated wards to cater for status overview at higher levels in the tree.

e monitoring functionality in the Service Platform consist of four main parts:

Node Monitoring, Monitoring of Aptilo MAS's, PAS's and other network elements in the hotspot network

Tree Display of Network Status, Based on Node Monitoring and Alarm Collection. Allows viewing hotspot networks status on different levels.

Status History Logs, Status history is stored and viewable node by node in the Service Portal

e Aptilo solution uses a distributed monitoring model, which means the monitoring is rformed in a distributed fashion and then the status is communicated to the Aptilo rvice Portal. This means that e.g. the ACs monitors access points (and other local twork elements), the MAS monitors ACs and the Service Portal monitors MAS'es.

sage data & statisticsis area of functionality in the Aptilo Service Portal aims at satisfying the needs of th the network-operating department and business related users. Both groups require ombination of detailed information, generated reports and diagrams.

e statistics functionality in the service platform consist of these main components:

Collection and database storage of usage data records from MAS'es, including sessions, payments and other events.

Search and display functionality of usage data records Collection of statistics from ACs directly (e.g. ongoing sessions and bandwidth) Statistics from virtual access nodes (ongoing sessions) Graphical presentation of statistics Report generator, produces standard reports and allows the possibility to add

tailor-made customer-specific reports.

Solution overview 7

Usage dataThe Aptilo MAS generates usage data output, which any external application can access via the usage data Interface of the Aptilo MAS. The Aptilo Service Portal also fetches daPo

Usstaest

Ev

StThev

an

sub

Staav

can

ReReex

roa

vo

Thof repta via this MAS interface and stores it in the Service Portal database. In the Service rtal, the detailed log of usage events can be viewed by users.

age data records from the MAS includes AC Auto-Initialization completed, PAS rt page accessed, PAS top-up page accessed, PAS transaction completed, session ablished, session purged, session terminated, user account created and many more.

ents include information such as time, location and other important attributes.

atisticse Aptilo Service Portal also regularly collects usage data directly from AC's (e.g. ery 5 or 10 minutes).Values collected can typically be number of ongoing sessions, d bandwidth consumed at the hotspot. The AC provides statistic values separated per net.

tistical values from the AC's can be used to produce graphs, which are made ailable to users in the Venue Portal. Other portal values, such as report results, etc., naturally also be displayed as graphs.

portsports are generated from the usage data to target specific information needs. For ample, reports can summarize values such as usage generated from a specific ming partner or a certain site. Other examples are reports giving summeries of

ucher accounts usage.

e configuration of the report generator is highly flexible to cater for the unique needs portal users in the best possible way. The administrator can choose from a choice of ort types, define time interval and the form of presentation.

Installation 8

3. InstallationThis chapter describes how the Aptilo Service Portal should be installed. It is a separate logLin

3.1 In

H

ApThLin

Toforyowe

ThEvins

NeThwe

bypro

* Iopical node in the Aptilo Hotspot Solution. It should be installed on top of the ux-based Aptilo Base Platform software on an x86 server.

stallation

ardware and network requirements

tilo Service Portal HWe Aptilo Service Portal can be installed on almost any standard server supporting ux (x86 processor).

verify if your hardware of choice has been certified for the relevant Linux base used the Aptilo solution, please verify with Aptilo support which version of Redhat that ur Aptilo sw is based on and check the hardware compatibility list on the RedHat b site: http://hardware.redhat.com/hcl/

e installation erases the disk completely and installs its own Linux operating system. erything needed is included in the installation, no additional software should be talled on the computer.

twork connectione Aptilo Service Portal interacts mainly with MAS-servers and one or more b-servers hosting the venue portals. If the connections to these servers are protected a firewall, then please make sure that the following ports are opened in the firewall tecting the service portal:

Port 443/TCP in/out : https access & remote SW upgrade Port 22/TCP in : ssh access Port 25/TCP out: SMTP mail Port 162/UDP in: SNMP access from external tool Port 161/UDP out: SNMP access towards any monitored nodes Port 53/TCP+UDP out+ConnT* : DNS Port 37/TCP+UDP out+ConnT* : Time sync 20/TCP+UDP out+ConnT*: FTP 21/TCP+UDP out+ConnT*: FTP 2345/TCP out: Aptilo MAS-Service Portal communication

f connection tracking is not supported, then these ports marked ConnT* need to be en both for out & in

Installation 9

The firewall protecting the Aptilo MAS needs to be set up to allow:

20/TCP+UDP in : FTP 21/TCP+UDP in : FTP

SoInsHWinf

SW

Warning!

Wau

Yo

Nopreser 2345/TCP in: Aptilo MAS-ServicePortal communication

ftware installation proceduretalling a complete sw package, including the Linux based operating system onto the server, does the installation. The procedure is done in two phases, collecting

ormation and then installing the sw.

Installation

The SW installation method will overwrite all current data on your hard disk.

hen the computer restarts with the CD inserted, the installation wizard will start tomatically. Please follow the instructions provided by the wizard.

u will be asked to answer/confirm choices on:

Driver disk question. Keyboard selection. License key: You should enter the key provided to you. Disk partitioning: We strongly recommend using Automatic Network settings (DHCP or fixed, your choice) Host name (A valid host name is normally needed for alarm/event E-mails to reach the

system admin) Time zone Root password (Please write it down, a failure to remember will force you to do a

complete re-installation). Add extra administrator users (not needed) Confirm install (the formatting of the disk will start) Confirm completion (proceed to reboot and remove the installation CD) After the reboot, the Service Portal will start automatically and provide a login prompt.

te that when doing installation on some servers with new hard disks an error will be sented informing that no hard disk can be found. If that happens, please reboot the ver using Ctrl Alt Delete and the installation will work the second time.

Network configuration 10

4. Network configurationTo configure the Aptilo Service Portal, the web interface should be used. ThTh

4.1 Se

ThabThis e default web password is the last 5 characters of the license key.e overall configuration process is done in four separate parts:

Create and initiate the System Configuration:The node configuration mainly includes IP and network information for the service portal itself. Create and initiate the Network configuration:This includes the configuration of the network that should be managed. It also includes defining the network related reports that should be created.Create and initiate configuration for Custom Reports: This involves reports that is related to non-network items, like organization, sites or realms for roaming partners.Create and initiate Venue Portals: This involves defining venue portals, what parts of the network that should be display and what reports that the venue portal will dispaly. See Appendix A to find out how the Venue Portal is used.

rvice Portal - main page

e main page Service Portal is a status overview. This page will show information out server status, service status and status of the the venue portals. e service status summary will show an OK, warning or Not OK for each area. If there a problem or a warning, one row per error will be displayed.


The section Venue Portals shows the time stamp when the venue portal was last updated. The name is also a link that will open the selected venue portal directly.

4.2 CChCopaPoIf kn

Mo

MAThcoontrol Panelangesnfiguration changes are made in two steps. The changes are first saved locally on the ge where the actual change was made (for example Custom Reports or Venue rtals). there are locally saved changes, a text will be shown on top of the page to let you ow that you hve unsaved changes. The next step is to save or rollback the changes.

Commit: the new configuration is saved and taken into operations using the commit command. Uncommitted changes are rolled back automatically when the admin user has been idle for 30 minutes.

Rollback: if the new configuration was saved locally, but it should not be taken into operation, the command rollback can be used to get the old configuration back.

st parameters, functions and buttons have online help instructions linked to the item.

S Nodeis is a list of all monitored MAS nodes and that date when the last time the nfiguration was fetched. This is done automatically in regular intervals. Click on


Reload when all available configuration should be collected immediately. Venue Portals

This is a list of the created Venue Portals and the date when the last update was done. To

AcA un

SerDethe

4.3 LeLethesea

the

Wfro trigger a new update manually, click on Rebuild. tive Userslist of all logged in users in the service portal is displayed. The list shows if a user has saved changes and how long it takes before the session will time out.vice Status Detailstails of the service status. This is updated on regular basis but it is possible to update detailed spa-check by clicking on New Check

Network: If gateway, hostname, name server are ok. Services: Check if the used services are ok. Node: If the node is reachable, if MAS configuration is fetched, if MAS status is

identified, status fetched and processing Database performance:Check events in database. Usage data: If the data has been fetched from MAS. Report engine: If the reports are OK and when the last update occurred and the

duration of the update. Venue Portal: If the venue portal is created, if data has been uploaded to the

external venue portal and if the internal portal is updated.

gal Interceptgal intercept allows a service provider to tie network activity to a specific IP. When service provider has received a search request from a law enforcement agency, a rch can be made to obtain information about a user.The Service Portal is gathering connection tracking logs from the MAS.

ARNING! You are only allowed to use the legal intercept if you have permission m a law enforcement agency.


Parameters to set in SPA to be able to search. All parameters are mandatory. Wild card can be used (*):

Destination IP: The destination for the communication in the perspective of an

If sea

wi

Ththaa n

Re

Ththepa

StaIP,

EnDeTimend user. Outgoing IP: The outgoing IP is either the ACs IP if NAT is used or the clients

IP if public IP addresses are used. Start date: The start date for the search interval, should be in the format:

YYYY-MM-DD Start time: The start time for the search interval, should be in the format:

HH:MM:SS and in UTC time. End date: The end date for the search interval, should be in the format:

YYYY-MM-DD End time: The end time for the search interval, should be in the format:

HH:MM:SS and in UTC time.any event was found that matches the input, the users that had a session during the rch interval and matches the client IP will be extracted to a file. Note that the output

ll be extracted in UTC time.

e link to the result file will be available on the screen below the search frame. Note t it is only possible to save one file at the time. The old file will be overwritten when ew file is created

sult file information

ere are two types of events; start and end.If full verbosity has been used on an AC, end event will contain more information than a start event. Namely the number of

ckets and bytes set in both directions. The events are output in CSV format.

rt or end event: Source IP, Source Port, Destination IP, Destination Port, Outgoing Outgoing Port, Transport protocol, Event type (START or END), Timestampd event when full verbosity has been used: Source IP, Source Port, Destination IP, stination Port, Outgoing IP, Outgoing Port, Transport protocol, Event type (END),

estamp, Source packets, Source bytes, Destination packets, Destination bytes


4.4 SystemTo change the system settings of the Service Portal server, use the System menu and theTh

SNM

InfO

AcIn haTone

4.5 NTh

Tothebythan commit the changes in the Control Panel menu.e network settings that can be changed are:

Email to sysadmin Mail Relay Server (if configured, all emails will be sent via this external server instead of

attempting to deliver it directly to the destination mail server) Admin web password Boot protocol IP address Netmask Hostname Domain Gateway Nameserver Secondary nameserver Tertiary nameserver

MP: Read more about SNMP in the section Monitoringonitor: Read more about how Monitor is used in the Monitoring section.

ormation about Data Archive Schedule and Backup Schedule, see the section perational activities that will describe how to use auto archive and auto backup.

cess Managementaddition to the Admin user, it is possible to add other users. The logs can show who s done configuration changes in the system. add a new user, click on Access Management and add a username. Click on the w created user and add the details (name, company, email, password)

etwork and node configuratione Aptilo Service Portal can handle both Aptilo MAS networks and generic nodes.

simplify the configuration of the MAS managed networks, the service portal fetch network configuration from the MAS. This network data includes all nodes handled the MAS and the sub nodes managed by the Aptilo ACs (APs etc.). This means t no manual entering of network elements in addition to the MAS servers are needed.


The activities that needs to be done are:

Add the MAS-servers (or generic Nodes) to be managed

4.5.1 AdIn a M

SyIP

Couse

the Enable the nodes to be handled by the service portal (initial state is set to new) Configure reports to be generated for the networks objects (MASs, zones,

ACs) you like.

d MAS-serversthe Network menu, MAS servers or generic nodes can be added or removed. Select

AS node in the dropdown menu, enter a name and click on Add button.

stem: Click in the system node that appear in the tree below the new node. Add the address of the MAS server.

llector: Controls whether configuration and status should be collected. This can be d to temporary disable collection from a MAS during maintenance. Enter how often MAS configuration and status should be fetched.


Usage Data: Enables or disables user data import from MAS. The login credentials should match the setup in the billing usage account in MAS. (In MAS, go to Billing and add a usage data account. Add login credentials, output tem

CoPaplate should be CSV files. Select the events.) Strip null sessions: If this option is enabled, the SPA will avoid importing

sessions that have no duration, sent data and received data. Additional Usage Data Sources: If the Service Management Platform is using

splitted architecture (e.g a MAS and a separate PAS) the relation has to be set up. All involved nodes need to be set up. 1. Enter a name of the additional node and click Add.

2. A new page will show. Enter the hostname (ip or hostname) and the username and password for the billing account for this data source.

mplete the configuration by the doing a Commit and Reload under the Control nel. This will then initiate the service portal to start the download of usage data.


The names of the PAS sites that are configured on the extra PAS, also needs to be configured on the base MAS.

4.5.2 EnWne

an

Stano

ToNono

co

whvaable Nodeshen a new or updated network has been download to the service portal, all the new twork objects are set to the state New. This means that they will not be available in y venue portals. To make them available, the state needs to be change to enabled.te changes can be set recursive, which means that the same status will be set to all

des below. enable the node, click on the node and change the state to enabled.des can also be changed todisabled and deleted. By disabling the nodes, they will t be visible in the network tree of the Venue Portal. A delete will remove all data ncerning the node from the database. Please note that there is a delay from the time en the state has been changed to delete until the actual node is removed. The delay

ries, but the deleted node change is only updated a couple of times per day

Report configuration 18

5. Report configurationReports can be configured in two different places, in the node tree and in the custom rep

Cude

Se

5.1 CRethea r

the

Selen

ap Cli

Se Cli

of orts folder. The node reports are often used by support staff to find specific data.

stom reports are normally used for overview reports, to be used by a financial partment, a venue owner or other groups.

e Appendix B for the different report types used in the Aptilo Service Portal.

onfigure Network Reportsports covering different parts of the network can be created by configuring a report in network tree. Go down in the network tree to the node/zone where you like to have eport and click on the Report menu for that node/zone. When the reports are created y will be available for publishing in a venue portal.

ect the type of report that should be added. In the next field the name of the report is tered, for example: Sessions - list last 7 days. Click on add and the report will pear in the selected folderck on Arguments and choose credentials/configuration for the content of the report. e Appendix B for information about the report types.ck on the Report (see picture below). On this page it is possible to change the name the report and check the status of the report.


Generation interval: Add how often the report will be generated (in seconds). Schedule: Set specific scheduling for the report. Scheduling overrides the interval, which means that the interval settings will be ignored if a schedule is set. A report sch[(d

Ex

It im

5.2 CThstrne

of

Crpicedule is written in the format:ayofmonth|weekday1)][[hour]]:minutes] amples:

01 04:03 - Generate report at 04:03 the first day of every month 01 :03 - Generate once an hour, at 3 minutes past the hour, but only the first day

of the month Mon 04:30 - Generate report at 4:30 every Monday Mon :03 - Generate once an hour, at 3 minutes past the hour, but only on

Mondays :03 - Generate once an hour, at 3 minutes past the hour

is very important to set the interval and schedule settings correct as this is portant for the performance of the Aptilo Service Portal.

onfigure Custom Reportsere are instances where you like to provide reports that dont follow the network tree ucture, or you might have customers that only should see the reports and not the twork with node status. An example is reports for a specific organization independent location. The Custom Report menu can handle these needs.

eate a new folder for your custom reports in the Custom Reports folder. See the ture below.

Description: Change name or set description of the folder. The field Order is found on all levels in the Customer Reports folder. Folders/reports can be ordered by name or by a specific order (1-20). If 1 is selected, the folder/report will be shown as the first report in the list in the Venue Portal. The order apply to the folders/reports in the tree level where you set the order.

Manage Tree: Add a report or a folder and set the name of the report/folder Add report structure: Optional. If a report structure has been saved or imported

to the service portal, the structure is selected here. Read more about reuse of report structure in a the section Inheritance report structure.

Remove report or folder: Select the report or folder that should be removed.


Mashome

all

ThincPlepofolsho

5.2.1 ReIf yit irep

Cr

Toste

Lonage Report Arguments: Optional. If a new folder has been created and the folder uld contain several reports, it is possible to set report arguments recursively. This ans that you can select the base node/organization/PAS sites on the folder level and new created reports in the folder will inherit these arguments.

e state of network objects are ignored when creating reports, i.e. all available data is luded even for disabled nodes.ase note that when defining which custom reports that should be available in a venue

rtal, the finest granularity is a report folder. This means that all reports in the same der will be included when adding the report folder to venue portal. If not all reports uld be available for all venue portals, please divide them into several folders.

port structure templatesou want to reuse a report structure without adding all arguments from the beginning,

s possible to reuse an already existing report structure. It is also possible to import ort structures from other service portals.

eate a report template

make the support structure available in the web interface of a service portal, some ps needs to be done in the console. This must be done by the root user in console.

gin to the Aptilo Service Portal using the console. Enter the following command:


root> spa-report-template

This will show how this feature is used:

Us

In ser

roo

YoEn1: 2: 3: 4: 4Th

A T

If /va

Cr

Wintage: /usr/bin/spa-report-template [name]this example, we will create a template from an existing report structure on the same vice portal.

t>spa-report-template create This_month2

u will now get a list of all report folders that exist on this service portal.ter the number of the report folder that you want to copyCustomer C(id13095)Yesterday (id13095/id26384)Last month (id13095/id26400))This month (id13095/id624931)

e template has been created here: /var/aptilo/spa/configtemplates/This_month2

copy of the folder structure This month has now been saved as report-template his_month2.

a report structure is imported from another service portal, import it to the folder: r/aptilo/spa/configtemplates/

eate a report structure using a template

hen the report structure has been created as above, it is now possible to use in the web erface.


In this example, the folder Customer E is marked. It is now possible to select This_month2 in the drop-down field for Add report structure. Add a new name, e g Month and click OK. The folder has now appeared in the folder Customer E, inc

Noset

5.3 AAnint

Thbe

Ho

In

Arluding the reports.

te that all configuration is not copied. Nodes, organizations and PAS-sites need to be in the new folder. Recursive settings are recommended.

rchive reports archive can store old today, this week or this month reports. A new report is put o the archive when the interval for this report has passed.

is feature is used for example if a daily report is used, and the old daily reports should saved and possible to view.

w it will look in the Venue Portal:

the service portal, go to the Custom Report that should be archived.

chive properties:

Store old reports in an archive: change the value to yes. Title prefix: Prefix of the archived report title in the venue portal


Titel suffix: Suffix of the archived report title in the venue portal.

5.4 OCuSP

Wor

Tosom

Ple Max number of reports: Maximum number of reports that the archive should show.

Min number of reports: Minimum number of reports that the archive should show.

Delay: Set to 14400 seconds as default. Usage data may be delayed from the MAS, therefor should the delay time be greater than 0 seconds. The report will then be regenerated and put into the archive when the delay time has passed.

nline report templatesstomized online report templates, or Query report templates, can be created in the A. Please see Appendix B - Report Types for information about online reports.

hen customize a query report, it is for example possible to hide columns in the report to change the default time interval.

make a new query report template available in the web interface of a service portal, e steps needs to be done in the console as a root user before uploading the template,

ase contact Aptilo Support to get the exact instruction on how to do this.


5.5 Notifications - Send reports by emailCreated custom reports can be sent to specified email addresses. A group of recipents is cre

Th

Th

Cr

Onemated and then a selection is made which reports this group should receive by email. e notifier is checking for chenged reports every 30 minutes.

e Notication folder is found in the menu below the Venue Portal folder.

eate a group and add reports Click on Notification. Enter a name of the group and click on add. The

notification folder is created with two subfolders, Recipients and Reports. Click on the folder called Recipients. Add the email address of the first recipient

and click on add. Click on the group folder again to add a new recipient to the same group. Note that if you have more than one recipient in a group, all to and cc addresses wil be seen by all group members.

each level it is possible to remove groups or email recepients. If you click on the ail address, it is possible to set a name or change email address.

Click on the folder called Reports in your new notification folder. Add report: The drop-down field will show all custom reports created in this

service portal. Click on the report that should be received by the email group that was created. Each time the selected report is updated, an email notification will be sent to the recipients.

Venue Portal overview and configuration 25

6. Venue Portal overview and configurationVenue portals are used to display status and usage data reports.

Thspepocan

ThSeuse

ex

als

6.1 O

Th

Re Ne

noese portals can be defined to include information that represent a limited part of a cific networks and also a limited time frame. Different users can get different

rtals. For example: an operator can get one subset of information, support personnel get another and a venue owner (hotel...) can get another view.

e venue portals can by default be created and handled internally by the Aptilo rvice Portal. But if you as an operator like to provide the venue portal to external rs, a more secure way would be to run the venue portal web application on an

ternal web-server. In that case the service portal will export the application itself and o push the data to the web-server on a regular interval.

verview of Venue Portal

e tree structure appear in the left hand window. The base nodes are:

ports: Custom reports will appear here according to the configured folder structure.twork. Depending on the base network node that is chosen, all subfoders and access des from the base node will be shown.


SummaryThe summary is an overview of the present status of the network. A node in the network tree needs to be chosen to be able to view the summary page.

DeTobe.

Thve Node name - Name of the node Type - Type of the node, for example AC Status - Status of the node can show OK, not OK or unknown Connections - Number of connected users Bandwidth in - Data received in kbyte/s Bandwith out - Data sent in kbyte/s

tails be able to view information in the tab Details, a node in the network tree needs to chosen. The page includes information and graphs about the node.

e first section includes information about the node such as IP address, identity and rsion of the product.


StatusThe status informs of the node status for different time periods. The status for the last week is shown by default, but by clicking on the different options (last 24h, last month, lasof

StaThforforsho

ReAnR

1. be

2. locfort 12 months) the graph can be changed. The last option, Status list shows a history the status events in text format. This list can be saved as a csv-file or be printed.

tisticse last section shows statistics about connections and bandwidth. By default, statistics the last week is shown. Below the graph the average, minimum and maximum value the period are counted. Click on the links Last 24h, Last month or Last 12 months to w a different time period.

ports access node or a zone should be selected in the network tree when using the eports. The reports valid for the specific node will show.

Select a report: The time period for this report will appear. If the time period should changed, it is possible to specify a time period within the shown date/time.

Output style: The report can be executed in table format in a new window or saved ally as a csv file. The csv file can be opened in a calculation program. The table mat report can be printed.


3. Change search criterias: For each field, it is possible to be more specific on what the report should show. In the dropdown list, the alternatives are:

exact match with

Foex

.

AlTh

6.2 CThen

Po begins with ends with less than greater than is not

r example, if the report only should include the sessions for a specific user. Select act match with in the dropdown list and enter the username in the next field

ertse tab alert gives an overview of the present alerts in the system.

reate a Venue Portale portals are created using the Venue Portals menu. Click on Venue Portals and ter a name of the new portal. The name will appear in the menu list below Venue rtals with subfolders.


Content - Network Nodes.The configuration includes selecting which part of the defined network trees that should be included. When selecting from the network node structure, all enabled network obno

CoIn ve

W

Thintcu

wi

Dojects below the item are automatically included. Enter a name of the selected base de and click on Add.

ntent - Custom Reportsthe drop-down list, select the base folder of the reports that should be available in the nue portal. All report folders below the selected item are automatically included..

riter

is part covers configuration parameters controlling the communicaton with the ernal or external web-server and the Venue Portal application. Aptilo recommend stomers to use the Internal Venue Portal. The status collection is faster and there are a der selection of reports that can be used.

Internal Venue PortalEnable internal venue portal.If the internal portal is used, enter a username and password. The username must be unique and cant be admin. Path suffix: The suffix of the internal venue portal location. A suffix will be generated if this is not set. Example: https://HOSTNAME/portal/PATHSUFFIX.

External Venue PortalEnable external venue portal if the data should be uploaded to a FTP account on the external webserver. FTP Hostname - Address of the external webserver hosting the Venue Portal.FTP Directory - Directory on the FTP host where the files should be uploaded.FTP Username/FTP Password - Login credentials for the account.Use passive mode yes/no - If the server is behind a NATing firewall, it may benessessary to run the FTP retrieval in passive mode.

Please note that in additional to the specific username and password for the Venue Portal, the admin login credentials for the Service Portal can be used to login to any venue portal.

nt forget to go to the Control Panel and save the changes.


Customization of the Venue portal

Click on the name of the Venue Portal. Name: Name of the portal Description: Description, only for internal use. Notes: These fields are only for internal use and will not be shown in the portal. Internal URL: If the internal Venue Portal has been acitvated the URL will be

shown. Change External URL: The external Venue Portal URL is shown, so it is easy

to access by clicking on the link that appear above this setting. Heading: This text will be the header in the Venue Portal.

Data template: Select a data template. The template defines the available data in the Venue Portal.

Resource file template: Select a resource file template. The template may contain changed images and user defined configuration for the portal. Please see Appendix A for more information on how to upload and create a template.

Update interval: How often the Venue Portal will be updated in seconds.

Operational activities 31

7. Operational activities

7.1 SPThBa

Tospco

fro

An

roo

....

roo

....

roo

....

roo

....

roo

....

7.2 AThMAno

Th

AuThthemeA Start, SPA Stope Aptilo Service Portal has a couple of important console commands to support ckup/Restore, Archive and Update/Upgrade.

make sure that the server is in a stable state when these commands are executed, the a-stop & spa-start should be used before and after. By executing the spa-stop mmand, the Aptilo Service Portal will stop all processes involved in fetching data m the defined MAS-servers, creation of reports etc.

example of how these commands should be used when doing an update:

t> spa-stopcommand output .....t> aptilo-backup

command output .....t> aptilo_autoupdate update SPA

command output .....t> spa-startAuto

command output .....t> spa-check

command output .....

rchive activitiesere is a feature to export and import both data and configuration for a specific

S-node. It is also possible to define a specific time period to export/import. Please te that graphs are not exported.

is feature is mainly targeted for:

Export of old data. As time goes by, the Aptilo Service Portal will fetch a lot of data from the MAS, and the data needs to be archived at some point to avoid filling up the disks and databases.Move a MAS-server to another Aptilo Service Portal.

to-archivee archive function can be configured to automatically archive data. This is set up in web inteface. Click on System and then on Data Archive Schedule in the left hand nu.


Tosch

En

Ad

Cl

A on

Co

En

Ar

M configure an auto archive schedule, start to add one task. One or several archive edules can be set up:

able archive functionality: Select Yes if the auto-archive should be used.

d task: Enter a name of this archive

ick OK to save

new folder has now been created in the Data Archive Schedule in the menu. Click the new folder.

nfigure the archive schedule:

abled: Select Yes if this schedule should be used

chive Name: The name of this archived data schedule

AS: Select the MAS node that you want to archive data from


Schedule: Select when to run this auto-archive. Default value is 01 02:14 which means that this task will run the first day every month at 02:14. Click on the online help to see other options.

MNOOffro

Mtheau

2) Arofco

De

Ar/vaReDitry

ImIf Thuse

Lofro(usEx

Th

ap

Wexim

Wonth Offset: Select how many months that should be kept in the SPA and that should T be archived. Example: My schedule says that I will run this task 03 03:22 and

fset is 2. The 3rd of november, at 03:22 the auto-archive will run but it will keep data m October (offset 1), September (offset 2) and November (offset 0).onths included: Select how many months that should be archived, for example 5. If previous example is followed it means that the 3rd of november, at 03:22 the

to-archive will run but it will keep data from October (offset 1) and September (offset and archive data for 5 months (April-August).chive Filename Prefix: Enter a prefix of the file. The beginning and ending dates the archive will be appended to the base filename to clearly indicate the ntent of the archive.lete: Enable delete of the original data when the archive is successful

chive storage: If Local is selected, the archive file will be saved in folder r/aptilo/autoarchive/. If ftp is selected, the following paramaters need to be set: mote FTP Host, Remote FTP Username, Remove FTP Password and Remove FTP rectory. If there is a connection problem to the FTP directory, the auto archive will to send the archived data until the FTP connection works.

port archived datathe archived data should be imported, this needs to be done using the command line. e command line can also be used to export data if the auto-archive function is not d.

g on to the server as the root user using the command line. If this is done through ssh m another computer, first logon as the admin user and then change to the root user ing the su - command).ecute the command to stop the service portal: spa-stop.

e usage of the archive command is

tilo-archive [options] here mode is one of: port export data from database (defaults to all available data)port import data to database

here target is one of:


address address of node to export (export mode only)file file to import (import mode only)Available options are: --f--t-d,-e,-n,

-h,-v,

Desel

Ex

roo

00

roo

Dosto

Ex

7.3 BaThoth

AuBaint

Tosch

En

Ad

Cl

A nerom_date export data from date (export mode only)o_date export data unil date (export mode only) --delete delete usage data after export (export mode only) --export_file target file (export mode only) --node_ip IP of target node, imports into existing node (import mode only) --help display this help --verbose be verbose, can be used more than once

fault (i.e. only aptilo-archive and no options selected) will export all data for the ected node.

amples of archive commands are:

t> aptilo-archive -v --from_date="2004-12-30 00:00:00" --to_date="2004-12-31 :00:00" export 192.168.122.60

t> aptilo-archive -v import /tmp/spa-data-2005-01-12.tgz nt forget to move the archive file (using the scp command) to another computer for rage.

ecute the command to start the service portal: spa-start

ckup and Restoreere is functionality to create backup and restore data if a disk fails or the data by any er reason has been corrupted.

to-backupckups can be set up to run on schedule automatically. This is set up in the web eface. Click on System and then on Backup Schedule in the left hand menu.

configure an auto backup schedule, start to add one task. One or several archive edules can be set up:

able backup: Select Yes if the auto backup should be used.

d task: Enter a name of this backup schedule

ick OK to save.

new folder has now been created in the Backup Schedule in the menu. Click on the w folder.


Co

En

Ba

CaNe

Sctheoth

Ba/vaReDi

Th

ReIf co

Ba

Th

Alnfigure the backup schedule:

abled: Select Yes if this schedule should be used.

ckup Name: The name of this archived data schedule.

tegory: Default is All (exept Legal Intercept). It is also possible to select Config, twork or Legal Intercept.

hedule: Select when to run this backup. Default value is 01 02:14 which means that this task will run the first day every month at 02:14. Click on the online help to see er options.

ckup storage: If Local is selected, the backup file will be save in folder r/aptilo/autobackup/. If ftp is selected, the following paramaters need to be set: mote FTP Host, Remote FTP Username, Remove FTP Password and Remove FTP rectory.

e file will be resend if the communication fails.

store and manually backupthe backup should be restored, it needs to be done using the command line. The mmand line can also be used to backup run manullay backups.

sed on the selected backup options the backup can include different data.

e data on the Aptilo Service Portal can be divided into categories:

Network configuration (the server)Monitored nodes and their data

l categories are handled by the backup feature based on the selected options.


The format of the backup command is:

aptilo-backup

Th

De

Ththe

BaTh

ReLiFoser

hoe available backup options are:

all contains all available information (the same as aptilo-backup network config)network contains network information of the server itselfconfig general configuration of the Nodes monitored by the Aptilo Service Portal and the data fetch from them.

fault (only aptilo-backup and no options selected) is equal to aptilo-backup config. is option should be used if you want to move the complete configuration including data to another server which is configured with another IP address.

ckup proceduree backup procedure includes the following steps:Log on to the server as the root user using the command line interface. If this is done through ssh from another computer, first logon as the admin user and then change to the root user (using the su - command).Execute the command to stop the service portal: spa-stopExecute the backup-command: e.g. aptilo-backup allThe backup information is created and placed in the folder /var/tmp/. An example of a backup filename is: /var/tmp/backup.20031006_091838.tar This name indi-cates that the backup was made on the 2003 Oct. 6 at 09:18:38.Copy the backup-file (using the scp command) to another computer for storage.Execute the aptilo-start command to get the configuration data activated.Log off the Aptilo Service Portal server.

store proceduremitation: r the restore procedure to work properly, the backup-file needs to be created from a vice portal of the same release number as the release installed on the restore target st.


The restore procedure includes the following steps: Restore must be done on a new installed system. Install a new SPA with the same

version as the backup file.

Log on to the Aptilo Service Portal server as the root user using the command line interface. If this is done through ssh from another computer, first logon as the admin user and then change to the root user (using the su command).Execute the command to stop the service portal: spa-stopExecute the restore command: aptilo-restore /var/tmp/Please note that the full path need to be given!The restore process may take a few minutes if the backup file is large.The data is now restored.Execute the aptilo-start command to get the configuration data activated.The server is now restored to the state it had before the aptilo-backup that created the backup file.


7.4 Upgrade procedureThis part of the manual describes how to prepare for an upgrade and perform it.

OThdaIf ve

UpUp

If rec

litt

Ne

CD

Ma

perational impact during upgradee upgrade/update will have a very limited impact on end-users. During the upgrade ta and status update will be hold and reports will not be generated and updated.the end-user is using an external venue portal, the only difference will be that the nue portal will not get any new updates during the actual upgrade.

grade Proceduregrade is possible from a CD or over the Internet.

the Aptilo Service Portal that will be upgraded is in commercial operation we ommend that the upgrade is done over the Internet as this interrupts the operation as le as possible.

twork upgrade.

Backup the Aptilo Service Portal and store the resulting backup file on an external server. Please see: Operational activities, on page 31Please execute the upgrades procedures described in the release notes.Verify the functionality by doing: spa-check.

upgrade

ke sure you have received a CD containing the target Aptilo Service Portal version.

Backup the Aptilo Service Portal and store the resulting backup file on an external server. Please see: Operational activities, on page 31Insert the CD containing the target Aptilo Service Portal version.Make the CD available by executing the command(as the root user):mount /mnt/cdromadd the following string to the update/upgrade command --url=file:///mnt/cdrom/RedHat/RPMS/Before the CD is removed, please execute the command:umount /mnt/cdrom/Verify the functionality by doing spa-check.

Monitoring 39

8. Monitoring

8.1 MThporep

Alsysfou

It i

8.1.1 SPSP

Thpa

Th

roo

Thou

mionitoring overviewis chapter describes how the Aptilo Service Portal monitors the system. The service rtal monitors among other things the status of important processes, data capture, orts and accessnode status.

arms can be sent via mail or snmp traps. Useful information and statistics how the tem is working is shown if the spa-check command is executed. The command is nd in the console and in the web interface.

s also possible to get information about the SPA via SNMP v1.

A-checkA-check shows:

network status the process status statistics and status about status collection from nodes statistics and status about configuration fetch from MAS nodes usage data (csv) file fetch status report status database performance status and statistics about internal and external venue portals.

e spa-check command can be executed both in the web interface , Control Panel ge and from the console.

e command to be used from console:

t> spa-check

e Control Panel page has a button called New Check. If the button is clicked on, the tcome of the check will show in the section below the button. It can take a couple of nutes before the spa-check outcome is updated.

Monitoring 40

8.1.2 Monitor - Report probesReports can be monitored. Add a probe, select a report in the report structure and set the minimum numbers of rows that the report normally have. An alarm will be triggered if thiis ror

Th

If

8.1.3 AlThfaimo

ale

Ws requirement is fulfilled. The report will be checked each time it has been updated. It ecommended that the report is configured so it is created at a specific time every day week.

e above probe will in this case show the following in the spa-check:

the report had contained between 3-100 rows, the status should have been OK.

armse possible alarms are grouped into types, such as network and reports. When a lure is found for a group, an alarm will be triggered. A new trigger will also occur if re or less alarms in the group are found. An alert resolved trigger occurs when no rt no longer exist for a group.

arnings from the spa-check does normally not trigger an alarm.

Monitoring 41

An SNMP trap or email can be sent when an alarm is triggered. Configure the SNMP traps settings if you want to receive a trap and configure the sysadmin email address if you want to receive an email when an alarm occurs.

SNThAnset

On

E-AnsysMPe Aptilo Service Portal can be monitored externally using SNMP. SNMP trap can be sent when an alarm is triggered. Configure the SNMP traps tings if a trap should be received.

the System page, the SNMP settings are found.

Trap version: Select between v1 or v2 Trap destination: IP-address of a receiver of SNMP traps from the service

portal. (e.g. an external supervision device). Customer Community String: Community string needs to be defined. Customer Community Oid: Oid needs to be defined

mail email can be sent when an alarm is triggered. Configure the email address to the tem administrator on the System page. It is only possible to use one email address.

42

Appendix A - Venue portal application

CoThis repApser

are

mu

Ne

InToeas

Apcu

ThpaVeve

cu

Thon

upon

Enwe

wenfidentiality noticeis document and any information herewith associated are private and confidential. It the property of, and is proprietary to Aptilo Networks AB. It is not to be copied, roduced or disclosed in whole or in part without the express written authorization of tilo Networks AB. Aptilo, the Aptilo logo and all other Aptilo names, products and vices are trademarks of Aptilo Networks AB. All other names, products and services trademarks of their respective owners. The information included in this document st not be used as a model or precedent in any situation not related to Aptilo tworks.

troduction support an operator to provide status and usage information to their customers in a y accessible way without jepordize their network security of the operation centre, the tilo Service Portal solution includes a separate web-application that gives access to

stomer adopted information.

e Venue Portal is the presentation part of the Aptilo Service Portal solution. Other rts of the solution handle the configuration, monitoring, data processing etc. The nue portal is a web application that displays network status and reports for operators, nue owners, support personnel and other people. Each type of user will have a stomized Venue Portal with an individual configuration.

e configuration, data and reports are sent to a directory on a web server. PHP scripts the web server handle the HTML requests. The scripts reads and parse/analyzes the loaded configuration and data on each request. The web pages displayed, are based the user request, the configuration and current uploaded data.

d-user authentication, i.e. control of the access to the different Venue Portals on the b-server, is to be handled by the ordinary user management support of the b-server and is not part of the Venue Portal application.

43

General requirementsThe Venue Portal application set the following requirements on the web-server environment:

InThfileFT

Ma

Do

CuReIt ico

set

1. can

Ex

- A Support for PHP 4 or above UID/PWD protected FTP server login for data upload. End-user login authentication. The usage of the portal should be protected with

username/password-login handled by the web-server itself. Please note that in addition to the specific UID/PWD for the Venue Portal, the admin UID/PWD for the Service Portal can be used to log in to any venue portal.

The memory limit a script may consume must be configured depending on the size of the Venue Portal. The Venue Portal will show an error message if the max size is too small.

stallation and configuratione Venue Portal application is delivered as a tar.gz (GNU tar and zip format) file. The is then to be extracted into a file structure and then copied to the web-server by a P tool of your choise.

ke sure that the web-server has :

a ftp-user account with write access to the /data write access to /pages/templates_c and /logs/error.log enabled for the web-server

user (normally nobody or apache) the end-user accounts enabled

ne, please log in as the end-user and try it out.

stomizing the look and feelsource templates possible to customize the look and feel of the venue portal. For example by change lours, hide a tab or change the top banner. The changes will overwrite the default tings. The steps below are done from the service portal console.

Create a winzip archive containing the changes on the Aptilo Service Portal. The file be saved in the /tmp/ location.

amples:

dd a top logo named banner.gif.

44

- Add a file named user.conf. In this file there are several options to changes. It is important to have a space before and after =.

Hide tabs: It is possible to hide one or several tabs by adding the following in

2.

UsTh

Ex

3. temVe

Da

ThThbatha1. temuser.conf:tab_reports = notab_details = notab_alerts = no.

Change colors: The options are: top_bgcolor, body_bgcolor, body_bgcolor_if_nothing, left_body_bgcolor; frame_border_color, table_bgcolor, table_content_bgcolor, table_first_bgcolor, tree_highlight_bg, tree_highlight_color.To change a parameter: top_bgcolor = white

Time zone settings:For example:hours_offset = +02 for CET. If it is left blank the system time will be used.

Character set / encoding:charset = iso-8859-1

Displayed page: The page to be displayed on right frame when left tree nodes are clicked. The options are: summary, details, report, alerts.right_frame = summary

Run the command: spa-resource-template

age: /usr/bin/spa-resource-template [filename]e file should be in pkzip format.

ample: spa-resource-template add testname /tmp/filename

Go to the Service Portal web interface. It is now possible to select the created plate for the Venue Portal. To upload the new template, see the section Create a

nue Portal.

ta template

e data template is changed when for example data in a certain tab should be changed. e venue portal user should only see connections in the summary tab, and not the ndwidth information. A data template contains xml files that describes which items t are available in each page.Create a zip archive containing a data template for the venue portal. The default

plate is located: /usr/local/aptilo/spa/portal/templates/default

45

2. Run the command: spa-data-template

Usage: /usr/bin/spa-data-template [filename]Th

3. da

UpIn po

In roo

co

1. 2. 3. En....e file should be in pkzip format.Add the new data template by using the Service Portal web interface. To use the new ta template, see the section Create a Venue Portal

date one venue portalthe web interface there is a possiblity to update all or one specific portal. This is also ssible with a console command.

the console of the Service portal:t> spa-rebuild-venueportal.

mmand output:Venueportal AVenueportal BVenueportal Cter the number of the venue portal that you want to rebuildcommand output.....

46

Appendix B - Report typesThere are three types of reports: list reports, summary pages and online reports. Each typ

Litheor

Av

Suinf

Av

Exe will be explained in detail in the next section.

sts reports can be generated in two formats, html tables to view the report directly in browser, or it can be saved as a csv text file. These lists can be limited by adding one more limiting criterias.

ailable list reports: Network status - list Sessions - list* Sessions - user summary list Sessions - access denied list* Transactions - successful transactions list* Transactions - failed transactions list* Transactions - location summary list

*) The report can also be created as a network tree report

Example of a list report:

mmary pages are fixed text based reports. The reports will summarize the ormation without giving any detailed information per payment/session.

ailable summary pages: Network status - summary Sessions - organization summary page Sessions - organization/location summary page Transactions - summary page

ample of a summary report:

47

Online reports are more flexible than other reports. Most of the arguments are set directly in the venue portal when generating the reports. Online reports are also called Query reports. They can only be used in internal venue portals.So

Ex

Avme features with online reports

Default time interval is last 24 hours. The time interval can be changed. Show: It is possible to untick information that shouldnt be displayed in the

report. If the box in front of the row phone is unticked, this column will not show in the report.

Order by: Decide the sort order of the report.

ample of how you can set the search criterias and order the online report.

ailable online reports: Query: Sessions - list Query: Sessions - access denied list Query: Sessions - user summary list Query: Transactions - successful transactions list Query: Transactions - failed transactions list Query: Transactions - location summary list Query: Sessions - organization/location summary page Query: Transactions - summary page

48

List reports

Network Status - listA arg

Arnetwork status list will show a status list of the selected node types. Most of the uments are set when configuring the report in the Service Portal.

guments:

Select base node:The node tree in the MAS will show. Select from which node the data should be retrieved. Click OK.

Select node type to include: What node type to include in the report: MAS, Generic SNMP, Zone, Access node, Subnet or Access Point

Max number of levels: Max recursion depth of the network tree structure. Select All or 1-10

Time span: What data to ignore Duration threshold: A status change can be ignored or another status can be set

if the duration is shorter than the threshold. The threshold is specified in seconds. Duration threshold action: Select an action if the duration is shorter than the

threshold: Ignore status if lower, Set Poor status if lower, Set Unknown status if lower.

49

Sessions - listThe report will show all details related to sessions in the system. Arguments:

SeThAr Recursive: Set to yes to include subzones in this report Select base node:The node tree in MAS will show. Select from which node that

data should be retrieved. Click OK. Zone path match string: Match string in the full zone path. The report engine

will match the zone path against the specified string, and only present nodes whos zone path contains this string. If left empty, all nodes in the base will be included in the report.

Time span: What data to include in this report. Organization: To be able to select an organization, the base node needs to be

selected. The organizations in the MAS subscriber management will show. Select one organization if you only want the report to show this organization specific data.

Sort order: Choose ascending or descending

ssions - user summary listis list will show data based on each unique user.guments:

Recursive: Set to yes to include subzones in this report Select base node: The node tree in the MAS will show. Select from which node

the data should be retrieved. Click OK. Time span: What data to include in this report Organization: To be able to select an organization, the base node needs to be

selected. The organizations in the MAS subscriber management will show. Select one organization if you want the report to show this organization specific data.


50

Sessions - access denied listThis report will show the failed attempts to login, one attempt per line including information why the access was denied.Ar

TrTha v

Ar

TrThwhguments:

Recursive: Set to yes to include subzones/nodes in this report Select base node:The node tree in the MAS will show. Select from which node

that data should be retrieved. Click OK. Time span: What data to include in this report Sort order: Choose ascending or descending

ansactions - successful transactions liste list will show information about successful payments.The report is also used when oucher generator is used. This report will then show generated vouchers.

guments:


that data should be retrieved. Click OK Zone path match string: Match string in the full zone path. The report engine


Time span: What data to include in this report PAS Sites: To be able to select PAS sites, the base node needs to be selected.

Select one or several PAS sites that you want to base you report on. To select more than one site, hold the Ctrl button at the same time as you select PAS sites.


ansactions - failed transactions liste list will show attempts to pay but that have failed. It is possible to see the reason y the payment failed.

51

Arguments:

Recursive: Set to yes to include subzones in this report.

So

TrAr Select base node: The node tree in MAS will show. Select from which node the data should be retrieved. Click OK.

Time span: What data to include in this report PAS Sites:To be able to select PAS sites, the base node needs to be selected.

Select one or several PAS sites that the reports should be based on. To select more than one site, hold the Ctrl button at the same time as you select PAS sites.

rt order: Choose ascending or descending

ansactions - location summary listguments:


that data should be retrieved. Click OK Zone path match string: Match string in the full zone path. The report engine


Time span: What data to include in this report PAS Sites:To be able to select PAS sites, the base node needs to be selected.

Select one or serveral PAS sites that you want to base you report on. To select more than one site, hold the Ctrl button at the same time as you select PAS sites

52

Summary pages

Network summaryThno

Ar

SeThorge report will display a summary in percent how long the selected node has been OK, t OK or poor during the selected time span.

guments: See the arguments for the Network list

ssions - organization/location summary pagee report will show session summary based on organizations or location. One line per anization or location is shown in the report.

Recursive: Set to yes to include subzones in this report Select base node: The node tree in MAS will show. Select from which node the

data should be retrieved. Click OK. Zone path match string: Match string in the full zone path. The report engine


Time span: What data to include in this report Organization: To be able to select an organization, the base node needs to be

selected. The organizations in the MAS subscriber management will show. Select one organization if you only want the report to show this organization specific data

Principal: The principal data can be organization or location.

53

Sorted by: The choices are: principal, session count, session duration, sent data, received data

SeThses

TrTh

Ar Sort order: Choose ascending or descending

ssions - organization summary pageis report will show a session summary based on organizations. The report counts sion time per organization. One line per organization will be displayed.

ansactions - summary pagee report gives an overview of the made transactions. One line per product will show.

guments: See Transactions - location summary list

54

Online reports

Query: Sessions - listOnthe

Ar

In use

,

QOnuse

Arly base node and organization are set as predefined arguments. In the venue portal, user can select time span and which columns to show, one session per row.

guments:

Select base node: The node tree in the MAS will show. Select from which node the data should be retrieved. Subzones will be included. Click OK.

Organization: To be able to select an organization, the base node needs to be selected. The organizations in the MAS subscriber management will show. Select one organization if you only want the report to show this organization specific data

the example below, the following columns are selected: first name, last name, rname, client ip, endtime, duration and term cause.

uery: Access denied - listly base node and organization is set as predefined arguments. In the venue portal, the r can select time span and which columns to show,. One session per row.

guments:

Select base node: The node tree in the MAS will show. Select from which node the data should be retrieved. Subzones will be included. Click OK.

Zone path match string: Match string in the full zone path. The report engine will match the zone path against the specified string, and only present nodes whos zone path contains this string. If left empty, all nodes in the base will be included in the report.

55

Query: Sessions - user summary listThis list will show data based on each unique user.Arguments:

QThan

the

Ar Select base node: The node tree in the MAS will show. Select from which node the data should be retrieved. Subzones will be included. Click OK.

Organization: To be able to select an organization, the base node needs to be selected. Select one organization if the report should display organization specific data.


uery: Transactions - successful transactions liste list will show successful payments. In the venue portal, the user select time span d which columns to show in the report. Only base node and PAS sites are set in the setup. Query reports can only be used in internal venue portals..guments:

Select base node: The node tree in MAS will show. Select from which node the data should be retrieved. Subzones will be included. Click OK.


PAS Sites:To be able to select PAS sites, the base node needs to be selected. Select one or several PAS sites that the reports should be based on. To select more than one site, hold the Ctrl button at the same time as you select PAS sites

56

Query: Transactions - failed transactions listThe list will show successful payments. In the venue portal, the user select time span and which columns to show in the report. Only base node and PAS sites are set in the the

Ar

QAr

QThIt ian

Ar

In an setup. Query reports can only be used in internal venue portals.guments: the same arguments as Query: successful transactions list.

uery: Transactions - location summary listguments: the same arguments as Query: successful transactions list:

uery: Transactions - summary pagee report gives an overview of the made transactions. One line per product will show. s possible to split the report on payment methods (e.g if both credit card payments d voucher generator are used)guments: the same arguments as Query: successful transactions list:the example below, the following columns are selected: description, payment method d count. These columns are unselected: code, currency and subtotal.

57

Query: Sessions - organization/location summary pageThis report will show a session summary based on organizations. The report counts session time per organization. One line per organization will be displayed.

Arguments:

Select base node: The node tree in MAS will show. Select from which node the data should be retrieved. Subzones will be included. Click OK.


Organization: To be able to select an organization, the base node needs to be selected. Select one organization if you only want the report to show this organization specific data.

www.aptilo.com Aptilo Service Portal Users Manual

Heading1 - NoticesHeading1 - Table of contentsHeading1 - 1. IntroductionHeading1 - 2. Solution overviewHeading1 - 3. InstallationHeading1 - 4. Network configurationHeading1 - 5. Report configurationHeading1 - 6. Venue Portal overview and configurationHeading1 - 7. Operational activitiesHeading1 - 8. MonitoringTitleAppendix - Appendix A - Venue portal applicationTitleAppendix - Appendix B - Report types

aptilo_spa_81_usermanual-4

Documents

aptilo products

copyright aptilo networks

aptilo home page

support information

aptilo mobile access

support agreement

manualthe manual

manual version