B CG cmx102
B CG cmx102
B CG cmx102
10.2
First Published: September 23, 2015
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version
of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://
www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)
2015
CONTENTS
CHAPTER 1
Preface 1
Audience 1
Conventions 1
Related Documentation 2
Obtaining Documentation and Submitting a Service Request 2
CHAPTER 2
Getting Started 3
Introduction to Cisco Connected Mobile Experiences 3
Overview of Cisco CMX Services 3
Prerequisites for Configuring Cisco CMX 10.2 6
Importing Maps and Cisco Wireless Controllers 6
Exporting Cisco Prime Infrastructure Maps 6
Copying the Exported Maps 6
Importing Maps 7
Adding Cisco WLCs from the CLI 7
Logging In to the Cisco CMX User Interface 8
Adding and Managing Licenses 8
Enabling or Disabling Cisco CMX Services 8
Adding Users and Managing Roles 8
Using the Cisco CMX Setup Assistant 9
Getting APIs 9
CHAPTER 3
Contents
CHAPTER 4
Contents
Verticalization 37
CHAPTER 5
Contents
Additional Information 55
Using the Connect and Engage Library 55
Device-Browser Matrix 56
Device-Browser Matrix for Connect and Engage 56
Device-Browser Matrix for Facebook Wi-Fi 57
CHAPTER 6
Contents
CHAPTER 7
Contents
CHAPTER 8
CHAPTER 9
Contents
APPENDIX A
Contents
CHAPTER
Preface
Audience, page 1
Conventions, page 1
Related Documentation, page 2
Obtaining Documentation and Submitting a Service Request, page 2
Audience
This document is for network administrators who configure Cisco Connected Mobile Experiences (Cisco
CMX) services.
Conventions
This document uses the following conventions:
Table 1: Conventions
Convention
Indication
bold font
italic font
Document titles, new or emphasized terms, and arguments for which you supply
values are in italic font.
[]
{x | y | z }
[x|y|z]
string
A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.
Preface
Related Documentation
Convention
courier
Note
Tip
Caution
font
Indication
Terminal sessions and information the system displays appear in courier font.
<>
[]
!, #
An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.
Means reader take note. Notes contain helpful suggestions or references to material not covered in the
manual.
Means reader be careful. In this situation, you might perform an action that could result in equipment
damage or loss of data.
Related Documentation
For more information about Cisco Mobility Services Engine and related products, see:
http://www.cisco.com/c/en/us/support/wireless/mobility-services-engine/tsd-products-support-series-h
For more information about Cisco Connected Mobile Experiences (Cisco CMX), see:
http://www.cisco.com/c/en/us/solutions/enterprise-networks/connected-mobile-experiences/index.html
CHAPTER
Getting Started
Introduction to Cisco Connected Mobile Experiences, page 3
Overview of Cisco CMX Services, page 3
Prerequisites for Configuring Cisco CMX 10.2, page 6
Importing Maps and Cisco Wireless Controllers, page 6
Logging In to the Cisco CMX User Interface, page 8
Adding and Managing Licenses, page 8
Enabling or Disabling Cisco CMX Services, page 8
Adding Users and Managing Roles, page 8
Using the Cisco CMX Setup Assistant, page 9
Getting APIs, page 9
Getting Started
Overview of Cisco CMX Services
+/-5M, 90% of the time with standard location technologies and +/-1M 50% of the time with
Hyperlocation technologies). Given the proper physical environment with access points deployed in
accordance with Cisco best practices for a location ready environment. The CMX GUI will be able to
display the physical location of:
Associated Wireless Devices (shown as green dots in default view)
UnAssociated Wireless Devices (shown as red dots in default view)
RF Interferers (Lighting icon)
Access Points (Circles)
BLE Beacons (BLE Icon)
Active Wifi RFID Tags (Tag icon)
The background map can display:
Inclusion and Exclusion Zones imported from Cisco Prime Infrastructure
Analytics Zones created in Cisco CMX
Additionally when passed to the CMX Analytics service, this location information provides visibility
into customer movements and behavior throughout the venue and throughout the day. The Cisco CMX
Analytics service determines device parameters and can display this information as part of six different
unique widgets.
If you choose Location during installation, you will see the following services in Cisco CMX GUI.
DETECT & LOCATEActive for 120 day trial period unless either a CMX base or advanced
license is added.
ANALYTICSActive for 120 day trial period unless a CMX advanced license is added.
CONNECT & ENGAGEActive for 120 day trial period unless either a CMX base or advanced
license is added
MANAGE
SYSTEM
For more information, see Overview of the Connect and Engage Service, on page 39.
ANALYTICSThis service provides a set of data analytic tools packaged for analyzing Wi-Fi device
locations. It functions as a data visualization engine that helps organizations use their network as a data
source for business analysis to understand behavior patterns and trends, which can help them take
decisions on how to improve visitor experience and boost customer service.
The ANALYTICS service allows for the creation of six different type of widgets.
Device count
Dwell time
Dwell time breakdown
Associated User Report
Path
Getting Started
Overview of Cisco CMX Services
Correlation
For more information, see The Cisco CMX Analytics Service, on page 21.
CONNECT & ENGAGEThis service provides intuitive, simple, highly customizable, and
location-aware guest services in the form of a captive portal that offers two types of guest on-boarding
experiences:
Facebook Wi-Fi
Custom Portal
For more information, see The Connect and Engage Service, on page 39.
PRESENCE ANALYTICSCisco Presence Analytics service is a new analytics engine that detects
the presence of visitors via their mobile devices interactions with even a single network access point.
The probe requests which are transmitted from the wireless devices provide information, which is used
to identify the general location of a client, in respect to the location of even a single access point which
hears the clients probing activity. The information available from even a single AP allows the Presence
Analytics service to develop valuable business intelligence. Presence Analytics uses Received Signal
Strength Indication (RSSI), along with the duration of high signal strength to determine whether a client
device is in the site or just passing by. Even if a device is not connected to the access point, its presence
is still detected if the device is within the signal range and the wireless is turned on. Given
that Presence Analytics develops location information with respect to a given set of APs it has a simpler
management overhead in that it does not require the importation or configuration of any maps into the
CMX instance. By simply knowing the association of a given AP, or set of APs, to a physical location,
Presence Analytics allows a business insight into the number of visitors to a location, whether these are
first time or repeat visitors, the average amount of time each visitor spent in physical proximity to the
AP, and the ability to ascertain whether a devise was just passing by a location or if they were actually
within the location serviced by the AP. For more information, see Overview of the Presence Analytics
Service, on page 60.
If you choose Presence during installation, you will see the following services in the Cisco CMX GUI.
PRESENCE ANALYTICS
CONNECT & ENGAGE
MANAGE
SYSTEM
MANAGE--This service enables you to manage licenses, users, zones, beacons, and notifications. For
more information, see Managing Cisco CMX Configuration, on page 73.
SYSTEMThis service enables you to verify the health of the system and view patterns and metrics.
For more information, see Managing Cisco CMX System Settings, on page 93.
For a complete list of new features supported by Cisco CMX 10.2, see the Release Notes for Cisco CMX 10.2
at:
http://www-author.cisco.com/c/en/us/td/docs/wireless/mse/release/notes/cmx_10_2_rn.html
Getting Started
Prerequisites for Configuring Cisco CMX 10.2
Note
Import maps from Cisco Prime Infrastructure only if you are using the Cisco CMX
Location service. You do not have to import them if you are using the Presence Analytics
service because this service does not require maps; all configurations are accomplished
using the Presence Analytics Dashboard.
Procedure
Step 1
Step 2
Step 3
Step 4
Getting Started
Importing Maps
Importing Maps
You can import maps from Cisco Prime Infrastructure into Cisco CMX using either GUI or CLI.
When you import maps, they are appended to the existing ones in Cisco CMX. When Cisco CMX finds that
a campus whose name already exists in Cisco CMX has a different AesUID in the import map file, Cisco
CMX performs a map sync operation under this campus if the override option is set to Yes.
To import maps using CLI, perform one of the following tasks:
Import all the maps directly from Cisco Prime Infrastructure using the cmxctl config importmap or
the cmxctl config import command.
Import the exported maps into Cisco CMX using the cmxctl config maps import --type FILE --path
<path to .tar.gz file> command.
For more information about Cisco CMX commands, see the Cisco Connected Mobile Experiences (CMX)
Command Reference Guide, Release 10.2, at:
http://www.cisco.com/c/en/us/td/docs/wireless/mse/10-2/cmx_command/guide/cmxcli10.html
To import maps using the GUI, perform the following tasks:
1 Log in to Cisco Mobile Connected Experiences (Cisco CMX).
2 Click SYSTEM Dashboard.
3 Click the Gear icon at the top-right corner of the window.
4 Click Controllers and Maps Setup Import.
Note
Cisco CMX 10.2 provides an Override Maps option (SYSTEM > SETTINGS). By default, this option
is enabled. When you enable this option, the Cisco CMX maps will be replaced with the maps defined in
the file that you import.
Getting Started
Logging In to the Cisco CMX User Interface
Launch the Cisco CMX user interface using Google Chrome 40 or later.
Step 3
In the browsers address line, enter https://ipaddress , where ipaddress is the IP address of the server on which
you installed Cisco CMX.
The Cisco CMX user interface displays the Login window.
Getting Started
Using the Cisco CMX Setup Assistant
)icon.
Getting APIs
To obtain the following APIs, use the https://cmx-ip-address /apidocs/ URL:
Configuration REST APIs for configuring different aspects of Cisco CMX.
Location-based REST APIs for finding location-specific details about visitors.
Analytics-based REST APIs for finding analytical data on visitors.
Connect-based REST APIs for finding user session information.
Presence-based REST APIs for finding presence data on visitors.
Getting Started
Getting APIs
CHAPTER
Initial Configurations
In order to use the DETECT & LOCATE service, the following initial configurations have to be performed:
Import mapsFor information about this, see Importing Maps, on page 7.
Add controllersFor information about concept, see Adding Cisco WLCs from the CLI, on page 7.
Step 3
Using the left pane of the Activity Map window, navigate to the desired building and floor.
The Activity Map window displays a list of icons to the right.
Step 4
Choose any combination of the following icons to customize your view of the devices:
ClientsClick the Clients icon to show or hide all the client devices (connected and detected) that are
being tracked by your Cisco CMX. Client devices are displayed either as red dots (probing clients) or green
dots (connected clients). Clicking a connected client shows the APs the client is associated with (blue lines),
while clicking a probing or unassociated client displays the APs that are being used to detect the clients (red
lines).
Note
The maximum number of clients (connected and detected) that can be displayed at a given time is
2000. If this limit is exceeded, only connected clients are displayed, again up to a maximum of 2000
(see the figure below). However, if the number of total connected clients also exceeds 2000, no clients
are displayed. In such a scenario, we recommend that you use the Analytics service to view the client
information.
HeatmapClick the Heatmap icon to show or hide areas with varying concentrations of client
devices. Areas with a high concentration of client devices are marked bright red, as shown in this
figure.
Clicking an AP shows the clients connected to it (blue lines) and the probing clients
that are detected by the AP (red lines).
If you have a Cisco Hyperlocation module that is attached to the back of your Cisco
Aironet 3700 and 3600 Series APs, you can track the location of customers, visitors,
or assets to less than a meter. Currently, the Hyperlocation solution works for the
associated clients only.
icon to show or hide all the RF interferers that have been detected by the wireless network,
and their zone of impact.
BeaconsClick the Beacons
Step 3
Using the left pane of the Activity Map window, navigate to the desired building and floor.
The Activity Map window displays a list of icons to the right.
Step 4
Click the corresponding icon to show the desired devices, for example, client devices, APs, beacons, and so
on.
Click the corresponding device on the map.
A pane displaying details of the device, such as MAC address, IP address, status, and so on is displayed.
Step 5
Procedure
Step 1
Step 2
Log in to Cisco Connected Mobile Experiences (Cisco CMX) either as an admin user or a user with Location
role.
Click DETECT & LOCATE.
Step 3
Using the left pane of the Activity Map window, navigate to the desired building and floor.
The Activity Map window displays a list of icons to the right.
Step 4
Step 5
Step 6
Log in to Cisco Connected Mobile Experiences (Cisco CMX) either as an admin user or a user with Location
role.
Click DETECT & LOCATE.
Step 3
Using the left pane of the Activity Map window, navigate to the desired building and floor.
The Activity Map window displays a list of icons to the right.
Step 4
Click the corresponding icon to show the desired devices, for example, client devices, APs, beacons, and so
on. The more icons you click, the more filtering options are enabled.
Step 3
Using the left pane of the Activity Map window, navigate to the desired building and floor.
The Activity Map window displays a list of icons to the right.
Step 4
Step 5
Step 6
Click the corresponding icon to show the desired devices, for example, client devices, APs, beacons, and so
on. The more icons you click, the more filtering options are enabled.
Click the Filter
icon.
In the Filters dialog box that is displayed, you can add or remove client filters based on the following
parameters:
Connection StatusUnassociated or Connected
Device Manufacturer TypeName of the device manufacturer, for example, Apple, Samsung, and so
on
SSIDDevices SSID
Step 3
Using the left pane of the Activity Map window, navigate to the desired building and floor.
Step 4
In the Search field of the Activity Map window, enter any of the following parameters to search for or filter
a desired device:
MAC AddressEnter the corresponding clients MAC address in lowercase, colon delimited, for
example, 00:a0:22:bc:e2:00.
Device IP AddressEnter the clients IPv4 or IPv6 address in dotted format, for example, 10.22.12.212.
SSIDEnter the clients SSID in free-form text.
Device ManufacturerEnter specific manufacturer names, for example, Apple, Samsung, and so on
in free-form text.
UsernameEnter the client's username in free-form text.
Procedure
Step 1
Step 2
Step 3
Using the left pane of the Activity Map window, navigate to the desired building and floor.
Step 4
Use the search option on the Activity Map window to search for a client.
Step 5
Step 6
Step 7
In the Enter a test name text box, type a name for the location accuracy test, and then press the Enter.
A dialog box, asking you to place the
Step 8
Step 9
Client Playback
The Client Playback feature enables you to locate and track the movement of clients in a venue. You can track
the activity of one client at a time.
Procedure
Step 1
Step 2
Step 3
Step 4
Using the left pane of the Activity Map window, navigate to the desired building and floor.
Search the client you want to track using the its MAC ID.
For more information about how to search client devices, see Searching for a Device, on page 16.
Step 5
Step 6
Note
FastLocate and Hyperlocation are supported by Cisco CMX 10.2.1 and later.
The Hyperlocation feature is enabled in Cisco CMX by default.
Hyperlocation and FastLocate features are supported with 8.1.123.0 and later Cisco WLC releases.
Currently a Hyperlocation-enabled Cisco WLC can support only one Hyperlocation-enabled Cisco
CMX.
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
In the Location Calculation Parameters window, check the Enable Hyperlocation check box.
Step 6
Step 7
Step 8
To stop Cisco CMX from processing Hyperlocation, disable the Hyperlocation option (by unchecking the
Enable Hyperlocation check box) in the Location Parameters window and restart the NMSPLB service.
For more information about the Cisco Hyperlocation solution, see the following documentation:
Release Notes for Cisco Connected Mobile Experiences (CMX), Release 10.2.0 and Later.
Release Notes for Cisco Wireless Controllers and Lightweight Access Points for Cisco Wireless Release
8.1.123.0
Configuring Cisco Hyperlocation in Cisco WLC section of the Cisco WLC Configuration Guide.
Cisco Aironet Hyperlocation Antenna (AIR-ANT-LOC-01=) Installation Guide
Installing and Removing Cisco Aironet Access Point Modules
CHAPTER
Step 3
Using the left pane of the Dashboard, navigate to the desired report using the deployment hierarchy (heterarchy).
The details pertaining to that report are displayed on the Dashboard.
Procedure
Step 1
Step 2
Step 3
Click the Expander icon
below the Location and Date pane.
The Edit Report window is displayed.
Step 4
Analytics Reports
The Analytics Dashboard provides reports to understand and monitor the behavior pattern of visitors within
a particular venue.
The Analytics services report facility also provides a more regular and manager-oriented set of information
through parameterized templates to measure various trends and patterns that occur over a period of time in a
particular zone. You can create new reports as well as modify the existing reports.
Step 3
Step 4
Click the location you want to analyze, Region, Building, Floor, Zone, or Tags.
In the Location and Date pane, choose the timeframe for the report. The available options are:
NowThe number of active devices in the last 15 minutes.
TodayThe report you specified is run for the current day and the generated results are displayed.
YesterdayThe report you specified is run using the previous day's values and the generated results
are displayed.
This Week The report you specified is run using the current week's values (Monday to Sunday) and
the generated results are displayed.
Last WeekThe report you specified is run using the previous week's values (Monday to Sunday) and
the generated results are displayed.
Last 2 WeeksThe report you specified is run using past two weeks' values and the generated results
are displayed.
This MonthThe report you specified is run using this month's values and the generated results are
displayed.
Last MonthThe report you specified is run using the previous month's values and the generated results
are displayed.
Last 3 MonthsThe report you specified is run using the past three months' values and the generated
results are displayed.
This YearThe report you specified is run using this year's values and the generated results are displayed.
Last YearThe report you specified is run using the previous year's values and the generated results
are displayed.
Custom RangeThe report you specified is run using the date values you specified in the Start and
End date fields.
A report based on the chosen criteria is displayed in the Dashboard and contains the following widgets:
Visitors widget
In the Device Count report, information about the total number of visitors, along with percentage
of repeat visitors and new visitors is displayed.
In the Dwell Time report, the average dwell time of all the visitors, along with the dwell time of
repeat and new visitors is displayed.
Compared Data to widgetA comparative result of repeat visitors vs. new visitors is displayed. The
available options are:
Previous
AverageThe average value is calculated by averaging the current period and the previous period.
If you select This Week in the Date pane, the previous to compared with is last week, and the
average is over last week and this week.
A line chart with a summary view and a detailed view of the criteria selectedYou can customize the
X-axis and Y-axis by applying the following filter criteria:
View Unique Devices or View Absolute Visits
LocationsCampus, Building, Floor, Zone, Zone Tag
ValuesAscending, Descending, Alphabetical
Note
If there is no report present in the dashboard, the Create New Report window is automatically displayed.
The following is the list of custom report-related tasks that you can perform:
Deleting a Customized Report, on page 27
Step 4
Step 5
From the Focus Area Filter drop-down list, choose the locations that you want to analyze.
The location types are Building, Campus, Floor, and Zone.
Step 6
Step 7
From the Date & Time filters drop-down list, choose the date and time range you want to run the report for.
In the Add Widgets
area, click the + to include any of the following widgets to the report:
You can set a threshold for dwell time. This is the amount of time spent by a client device (visitor) at a given
location. Select the minimum and maximum time from the drop-down options in the Advanced Widget
Filters
Step 9
area.
Click Done.
Based on the Focus Area and Date filters that you speocified, the report name is geneated. The new report
name is listed in the left pane under Reports.
The following is a list of tasks that can be performed after a Custom report is created:
1 Click the report for which you want to create a scheduled report.
2 Click the Expander icon that is displayed.
3 Click the Clock icon (Schedule) to schedule the report.
4 In the SELECT REPORT OPTION dialog box, choose HTML or PDF.
5 Click Next.
HTML ReportEnables you to schedule a report in HTML format.
Enter the email address of the recipients to send the report to.
Enter the start date and time from which the report has to be generated.
Select the frequency of the reportOne Time, Daily, or Weekly.
PDF ReportEnables you to schedule a report in PDF format. You can customize the PDF report
parameters.
In the Header text box, specify a Header for the PDF report.
Click Select a Logo to choose a logo for the PDF report. You can align the placement of the
logo to left, center, or right.
If you want to specify any comments, enter your comments in the Add your comments here
text box.
In the Footer text box, specify a footer for the PDF report.
Enter the email address of the recipients to send the report to.
Enter the start date and time from which the report has to be generated.
Select the frequency of the reportOne Time, Daily, or Weekly.
Procedure
Step 1
Step 2
Step 3
In the left pane of the Dashboard, expand the report name, and click Schedule.
The Select Report Option dialog box is displayed. The following options are available:
HTML Report
PDF Report
Step 4
Click the radio button corresponding to the kind of report you require and click Next.
If you select the PDF option, the following customization options are available:
HeaderAdd a header to the report and provide a name. You can customize the position of the header
text by using the right, top, and left arrow keys.
LogoAdd a logo to the report by clicking the Logo icon. A few default logos are available to choose
from. You can also upload a logo by clicking Upload a Logo.
CommentsAdd comments about the report by entering text in the Add your comments Here field.
You can move the sections by clicking the Up or Down arrow keys on the left side of the different
components present in the sections in the report.
FooterAdd footer text at the bottom of the report.
Step 5
Click Next.
The Schedule Report widget is displayed.
Step 6
Step 7
Step 8
Enter the email addresses of the recipients to send the report to.
Enter the start date and time of the period for which the report has to be generated.
Select the frequency of the report, One Time, Daily, or Weekly.
Step 9
Click Schedule.
Procedure
Step 1
Step 2
Step 3
In the left pane of the Dashboard, hover the cursor over a report, and click the Delete
icon.
Customized Widgets
Customized widgets enable you to view and analyze specific activities to better suit the objective of your
analysis. For example, you can create a widget that focuses on visitor (client) activity in a zone of interest.
The customized widget will gather and present only the data pertaining to visitor activity, and enable the
analysis and interpretation of this data. The information in the customized widgets enable you to take meaningful
decisions based on client activity.
Note
Dwell Time
The following trends are available for each different view:
View Unique Devices
View Absolute Visits
LocationsAllows you to filter by any of these values: Campus, Building, Floor, Zone, Day, Hour
of Day, Hour, Region, Building, Floor, Zone, Tag
Sort orderAscending, Descending, Alphabetical
TableThe tabular view provides information about the dwell-time breakdown in the time ranges of
0-5 minutes, 5-20 minutes, 20-60 minutes, 60-120 minutes, and > 120 minutes.
Note
This view allows you to search for records within the table. The search text box is
available above the table.
The Correlation widget of Cisco CMX 10.2 is referred to as Crossover widget in Cisco CMX Release
10.1.
The Correlation widget provides a detailed summary of correlation of client devices between two locations.
Correlation data can be used to determine the relation between two zones. Low correlation between zones
indicates lack of access between the two zones. For example, you can expect a high correlation between the
food court and the cinema in a shopping mall. The Correlation widget can be viewed in the following formats:
CorrelationProvides an interactive graphical representation of the correlation between zones. You
can configure the correlation between zones by filtering according to the focus areas, building, or absolute
versus unique devices.
TableThe table format lists the data in a tabular format with the following columns:
Area-The zone around which correlation is configured.
GroupingThe focus area for which the correlation data is collected.
CorrelationThe correlation data, in percentage, between the zone (Area column) and the focus
area.
The following trends are available for each view:
View Unique Devices
View Absolute Visits
The blue (right) side represents where a device goes to, for example, immediately after exiting the focus
zone.
Hovering your cursor over the focus reveals a breakdown based on:
Percentage of paths that either started or ended in the focus zone.
Percentage of paths that either arrived or departed from the focus zone.
Hovering your cursor over a green section shows the number of paths that entered the focus zone originated
in this zone.
Hovering your cursor over a blue section shows the number of paths that originated in the focus zone ended
in this zone.
Note
All paths are calculated based on the overall data set defined, but only the top 15 (by percentage) paths
can be displayed in the widget due to space constraints. The Edit Widget link allows you to define the
heterarchy level from which the data pool is collected from, and then define the specific focus of this
widget. That way, you can add more than one widget to the report and perform side-by-side comparisons
of one zone with another.
Associated status can be viewed in the following formats:
SummaryThis is the default view. The Summary view consists of the Associated Status, Compare
Data to, and Hourly Trend charts.
Chart-A line chart with a summary of associated and probing clients. The view can toggle to show
associated clients in terms of percentage and total clients. The X-axis can be based either on location or
time. A line chart with a summary view and a detailed view of the criteria selected is also available. You
can customize the X and Y axis by applying the following filter criteria:
View Unique Devices or View Absolute Visits
Locations--Campus, Building, Floor, Zone, By Hour
Values--Ascending, Descending, Alphabetical
Hover your mouse pointer at any point along the line to view the connected and probing data at that instance.
Table-Connected and detected attributes of clients are presented in a tabular format.
The following trends are available for each different view:
Step 3
In the left panel of the Dashboard, click the Addicon next to Custom Reports
The Create New Report window is displayed.
Step 4
Choose Customized from the Report Type widgets row in the right pane.
Step 5
Choose the locations that you want to analyze from the Focus Area Filter drop-down list.
The location types are Building, Campus, Floor, Zone.
Step 6
Choose the date and time range you want to run the report for from the Date & Time filters drop-down list.
Click the dot at the bottom of the Add Widget area to scroll to the next set of options. You can select multiple
widgets to combine in one overall widget.
Step 7
In the Add Widgets
area click theAdd+ icon to include any of the following widgets to the report:
Step 8
Click the dot at the bottom of the Add Widgetarea to scroll to the next set of options. You can select multiple
widgets to combine into one overall widget.
You can set a threshold for dwell time. This is the amount of time spent by a client device(visitor) at a given
location. Select the minimum and maximum time from the drop-down options in the Advanced Widget
Filters
Step 9
area.
Click Done.
The widget is created.
Step 2
Get consumer key and consumer secret key for the application from the Keys and Access tokens tab after
creating the applications.
Configuring Hashtags
SMA gets tweets from Twitter based on the hashtags. It could be name of the product or location or related
context. For example, restaurants hashtag could be restaurant name such as #olivegarden, #applebee.
Procedure
Step 1
Step 2
Step 3
Step 4
Enter location-specific hash tags that are relevant to your business and click the Add button.
Step 5
Procedure
Step 1
Step 2
Step 3
Procedure
Step 1
Step 2
Step 3
In the Activity Heatmap window, click the Date icon and select the date.
Step 4
Step 5
From the Building drop-down list, select the building on which you want to run this analysis. The
drop-down list contains all the buildings that are synchronized with Cisco CMX.
From the Floor drop-down list, select the floor on which you want to run the analysis.
Step 6
Click the Heatmap and Zone icons to display heatmap distribution and zones respectively.
Step 7
Click the Zoom in (+) and Zoom out (-) buttons to increase or decrease the view of the map.
Step 8
Step 9
Click Playback to play back the client movement for the selected date.
Verticalization
Verticalization capabilities provide the ability to change the names associated with each level of the hierarchy
used in report generation. Although you can change the names of the hierarchy levels, names of any existing
elements cannot be changed once created. Renaming through this process is global and will affect all users.
For more information about managing verticalization, see Managing Verticalization, on page 87.
CHAPTER
For a complete list of new features in the Cisco CMX Connect service, see the Whats New in This Release
section of the Release Notes for Cisco CMX 10.2 at the following URL:
http://www-author.cisco.com/c/en/us/td/docs/wireless/mse/release/notes/cmx_10_2_rn.html
Note
You cannot install both the Location service and the Presence Analytics service on the same Cisco CMX
instance in this release. Therefore, you can have either of the following:
Connect and Engage with Location
Connect and Engage with Presence Analytics
Restrictions
The Facebook Wi-Fi authentication feature for Cisco CMX Connect is not supported in Cisco IOS XE
3.3.x SE, Cisco IOS XE 3.6.x E, Cisco IOS XE 3.7.x E on the Cisco 5760 Wireless LAN Controllers
and Cisco Catalyst 3850 Series Switches.
After you upgrade from Cisco CMX 10.1 to 10.2, you need to clear your browser's cache, and then
launch the Cisco CMX Connect UI. If you do not perform this operation, the portal will not be upgraded,
and all CMX Connect features will not work properly.
Landing page
Facebook Wi-Fi
Custom Portal
Hosted on Facebook
(Facebook page)
Social authentication
Facebook only
No
Yes
Post on timeline
Check-in is unavailable
Demographic data
No
Yes
Facebook Wi-Fi
Customer profile
Custom Portal
No
Yes
Preparatory Tasks
You must have a Facebook account for a business page. For more information, see the Creating a Facebook
Page for Your Organization, on page 46.
Step 3
Step 4
Step 5
In the Add New User dialog box, enter the first name, last name, username, and password of a user.
From the Roles drop-down list, select Connect or ConnectExperience.
Note
For information about access rights for the Cisco CMX services available to the Connect and
ConnectExperience user roles, see User Role Summary, on page 41.
Click Submit.
Step 6
Role
Other Services
Dashboard
Experiences
Settings
Admin
Read
Read/Write
Read/Write
Read/Write
Connect
Read
Read/Write
Read/Write
No
Role
Connect No
Experience
Read*
Other Services
No
Connect Settings
The following data retention settings available:
User Retention PeriodThis value indicates how long a user entry is retained in data store if the user
does not reconnect. The default user retention value is 180 days. The oldest entries are removed if the
system has reached the capacity even if the value specified in the User Retention Period is not reached.
This is to ensure that the system continues to serve new users.
Statistics Retention PeriodStatistics are calculated once every day for each locaiton. The statistics
entries, which were caluclated before the value that you configured in this text box will be purged. The
range is 7 to 1000 days. The default retention value is 365 days.
SMS: Number of DevicesThis is the total number of devices that can use a single SMS code. The
range is 1 to 10 users. The default retention value is 3 users.
SMS: Time to expire (in min)This value indicates how long you want to keep the SMS code active.
The range is 3 to 1440 minutes. The default retention value is 15 minutes.
Connect & Engage prunes users based on the user retention period. This task is run once every day at 3 am
server time. If the maximum user capacity is exceeded, older users within the retention period are pruned to
make room for new users. To avoid losing any user data, we recommend that you perform the following tasks:
Periodically export data from Cisco CMX.
Adjust the retention period based on projected days for full capacity, which is calculated based on usage
patterns. The usage patterns are established after the system has been operational for a while.
Note
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Connect Experiences
Overview
Using Connect Experiences, you can choose between two types of guest on-boarding experiences:
Facebook Wi-Fi
The Facebook Wi-Fi feature provides organizations with a simple and fast guest access solution. With Cisco
CMX for Facebook Wi-Fi, organizations can:
Save time and effort on designing their own captive portal by directing guests to a facility's Facebook
page.
View aggregate social data gathered from visitors connected to Wi-Fi with their Facebook logins for
tailoring social media marketing strategy.
Facebook Wi-Fi is based on WLAN web passthrough authentication on Cisco Wireless Controllers (Cisco
WLCs). Cisco WLC intercepts HTTP traffic and redirects the client browser to Cisco CMX. Cisco CMX finds
the client location and redirects the client browser location to the configured location-specific Facebook page.
After a successful Facebook sign-in and check-in, Cisco CMX redirects the client browser to the specific
Facebook page.
For information about setting up Facebook Wi-Fi, see the Setting Up a Facebook Wi-Fi Portal, on page 44.
Custom Portal
Custom Portal enables you to perform the following tasks:
Create location-specific splash pages
Enable branding consistency using splash pages
Own registration information from customer sign-in page, which turns the captive portal into a data
source for targeted marketing later via email marketing
For information about setting up a custom portal, see the Setting Up a Custom Portal, on page 46.
Log in to the web UI of a Cisco Wireless Controller (Cisco WLC) that is associated with Cisco CMX.
Choose SECURITY > Access Control Lists > Access Control Lists.
Step 3
On the Access Control Lists window, click New to add an access control list (ACL).
Step 4
Step 5
On the Access Control Lists > Edit window, enter a name for the new ACL. You can enter up to 32
alphanumeric characters.
Choose the ACL type as either IPv4 or IPv6.
Step 6
Click Apply.
Step 7
On the Access Control Lists window, click the name of the new ACL.
Step 8
On the Access Control Lists > Edit window, click Add New Rule.
The Access Control Lists > Rules > New window is displayed.
Step 9
Seq.
Action
Source IP/
Mask
Permit
Destination
IP/
Mask
Protocol Source
Port
Destination DSCP
Port
Direction
TCP
HTTPS
Any
Any
Any
Permit
TCP
Any
HTTPS
Any
Any
Permit
MSE_IP/
0.0.0.0/
255.255.255.255 0.0.0.0
TCP
HTTP
Any
Any
Any
Permit
TCP
Any
HTTP
Any
Any
255.255.255.255
After upgrading to Cisco CMX 10.2, or after newly installing Cisco CMX 10.2, the sslmode is enabled
by default. Therefore if you want to have the HTTP redirect, you need to disable sslmode. Otherwise, you
need to conigure https://<CMX>/ in WLC SSID config.
To provide network access to users, you must configure a wireless LAN (WLAN) on the Cisco WLC, for
which you must set up the web passthrough on Layer 3 security of WLAN for Connect & Engage.
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Click Apply.
Step 6
Under the Layer 3 tab, from the Layer 3 Security drop-down list, choose Web Policy.
Step 7
Step 8
Choose the Preauthentication ACL defined using the procedure described in the Configuring Access Control
Lists on Cisco Wireless Controller, on page 44.
Step 9 To override the global authentication and web authentication pages, check the Over-ride Global Config
check box.
Step 10 To define the web authentication pages for wireless guest users, from the Web Auth Type drop-down list,
choose External (Re-direct to external server).
This redirects clients to an external server for authentication.
Step 11 In the URL field, enter the Facebook Wi-Fi page URL. The external redirection URL should point to the
corresponding portal on Cisco CMX for Facebook Wi-Fi, for example:
Example:
http://<CMX>/fbwifi/forward
Step 3
Step 4
Procedure
Step 1
Step 2
Select a specific campus, building, floor, or zone and click or hover over the Gear
Click Assign New.
icon.
Note
You can get a preview of the custom portal for a mobile, PC, or tablet.
The CONTENT tab allows you to add or edit the portal elements. Click an element to preview an area
of the portal and edit the elements settings.
The BACKGROUND tab allows you to:
Upload an image from the image library
Specify the background color and opacity for the portal.
The THEMES tab allows you to specify a theme for the portal.
The LANGUAGES tab allows you to choose the language of your choice. To add a language, choose
your desired language from the Select language drop-down list, and then click Add to list. For more
information, see the Enabling Multi-language Support in Custom Portals
Log in to the web UI of a Cisco Wireless Controller (Cisco WLC) that is associated with Cisco CMX.
Choose SECURITY > Access Control Lists > Access Control Lists.
Step 3
On the Access Control Lists window, click New to add an access control list (ACL).
The Access Control Lists > New window is displayed.
Step 4
Step 5
Enter a name for the new ACL. You can enter up to 32 alphanumeric characters.
Choose the ACL type as either IPv4 or IPv6.
Step 6
Click Apply.
The Access Control Lists page is displayed.
Step 7
Step 8
Step 9
Seq.
Action
Source IP/
Mask
Permit
MSE_IP/
0.0.0.0/
255.255.255.255 0.0.0.0
TCP
Permit
0.0.0.0/
0.0.0.0
TCP
MSE_IP/
Destination DSCP
Port
Direction
HTTP
Any
Any
Any
Any
HTTP
Any
Any
255.255.255.255
OR
Table 6: Configuring ACLs With Social Network Login
Seq.
Action
Source IP/
Mask
Destination DSCP
Port
Direction
Permit
0.0.0.0/
0.0.0.0
0.0.0.0/
0.0.0.0
TCP
HTTPS
Any
Any
Any
Permit
0.0.0.0/
0.0.0.0
0.0.0.0/
0.0.0.0
TCP
Any
HTTPS
Any
Any
Seq.
Action
Source IP/
Mask
Permit
MSE_IP/
0.0.0.0/
255.255.255.255 0.0.0.0
TCP
Permit
0.0.0.0/
0.0.0.0
TCP
MSE_IP/
Destination DSCP
Port
Direction
HTTP
Any
Any
Any
Any
HTTP
Any
Any
255.255.255.255
After upgrading to Cisco CMX 10.2, or after newly installing Cisco CMX 10.2, the sslmode is enabled
by default. Therefore if you want to have the HTTP redirect, you need to disable sslmode. Otherwise, you
need to conigure https://<CMX>/ in WLC SSID config.
To provide network access to users, you must configure a wireless LAN (WLAN) on the Cisco WLC, for
which you must set up web passthrough on Layer 3 security of WLAN for the Connect & Engage service.
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Click Apply.
Step 6
Under the Layer 3 tab, from the Layer 3 Security drop-down list, choose Web Policy.
Step 7
Step 8
Choose the Preauthentication ACL defined using the procedure described in the Configuring Access Control
Lists on Cisco Wireless Controller, on page 44.
To override the global authentication configuration web authentication pages, check the Over-ride Global
Config check box.
Step 9
Step 10 To define the web authentication pages for wireless guest users, from the Web Auth Type drop-down list,
choose External (Re-direct to external server).
This redirects clients to an external server for authentication.
Step 11 In the URL field, enter the custom portal URL. The external redirection URL should point to the corresponding
portal on Cisco CMX for custom portal, for example:
Example:
http://<CMX>/visitor/login
Step 3
Step 4
In the Portal Title field, enter the name of your custom portal.
Step 5
Click the template that you want to use and click Next.
Step 6
Step 7
Procedure
Step 1
Step 2
Select a specific campus, building, floor, or zone from the corresponding custom portal drop-down list.
Click Create New to create a new portal and assign it to that location. Alternatively, assign an existing portal
to that location.
Note
The portal page translations are not supported for right-to-left languages such as Hebrew and Arabic.
To support multiple pages by a portal page, each page must have the desired languages added to the page
before it can be enabled. Multilanguage support can be added when the portal is created. The non-English
languages can be disabled or re-enabeled one at a time when translations are completed.
To enable multilanguage support, the admin user should perform the following tasks:
Create a portal.
Add the languages that have to be supported.
To add a language, click the Languages tab inside the portal editor. Select the language from the
drop-down, and click Add Language. Only the Enabled languages(languages that are selected)
are used.
Provide translations for each language that is enabled.
Change which portal translation is currently being viewed by selecting different language from
the drop-down list above the preview area in the portal editor.
Most elements' translations are portal specific, which means, translating a text element in one portal
does not effect a text element in another portal.
However, the registration fields' translations are shared across all portals. When a field is changed
in one portal, the field is changed in every other portal.
Confirm that translations are correct by using the Live View, switching between each language and
verifying translation, and then saving the portal.
When the splash page is displayed to an end user, Cisco CMX uses the browser's settings to determine the
end user's most preferred languages. It then selects the preferred language that is available and displays that
version of the portal. An end user can manually select a different language by using the drop-down list on the
top-right corner of the splash page.
End-user devices will have a predefined language. This list of preferred languages is passed as part of the
HTTP header. Cisco CMX analyzes the HTTP header and displays the closest available translation of a portal
.
For example, if a user prefers languages such as English, Spanish, and French (in this order) and the portal
only has languages such as Russian, Spanish, Italian, German, then Spanish is displayed because it is the most
preferred language from among the available languages.
To view a portal in a different language, a portal user can use the Language drop-down list to select from the
list of available translations.
Procedure
Step 1
Step 2
Step 3
Procedure
Step 1
Step 2
Step 3
Step 4
Procedure
Step 1
In the Cisco MSE CLI, enable SSL mode by entering the following command:
cmxctl node sslmode enable
Step 2
In Cisco WLC (WLANs > Security > Layer 3), use HTTPS instead of HTTP for URL. For example, enter
https://<IP address>/visitor/login instead of http:/<IP address>/visitor/login.
Note
As you enable SSL mode, during client connecting to SSID, you need to accept certificate.
SMS Authentication
To provide a proof of the identity of the connected individual, Cisco CMX 10.2 offers the ability to add SMS
based authentication to a custom portal. Currently this feature only integrates with Twillio accounts for SMS
authentication. You must establish your own Twillio account (see https://www.twilio.com/user/account/settings).
Also, this feature requires you to have an SMS capable device to gain access to the network.
Without an appropriately configured preauth ACL the wireless client will not be able use the link provided
in the SMS message to return the auth code to Cisco CMX and will remain in the WebAuth required state.
To use this feature, either edit an existing portal or use a template to create a new portal to use SMS Auth.
You can only have one Twillio account, but that account can have many phone numbers associated with it so
you can use the same account with multiple portals, but each portal can only have a single number associated
with it. The Reset button is used to remove the association between the portal and the configured Twillio
account.
The From Number that you configure in the Twillio Configuration area should be purchased from Twillio.
You cannot use an existing number.
Procedure
Step 1
Step 2
Step 3
Ensure that your portal has a Registration Form element, or add one if required
Ensure that you specify a phone number field, but you may include other fields if desired.
Step 4
Select the Edit icon (next to the SMS Auth check box) to enter the Twilio account information.
Step 5
In the Registration Form area, check the SMS Auth check box.
The Registration form allows you to receive the auth code on a SMS capable device and still enter it on a
non-SMS capable device.
a) Enter your Twilio Account ID. This is a 34 character string that uniquely identifies the Twilio account.
b) Enter the Twillio Auth Token.
c) Enter the From Number. This number is purchased from Twillio. You cannot use an existing phone
number.
d) Click Create.
You can click the Reset button to remove the association between the portal and the configured Twillio
account (that is, removing the connector).
Step 6
Click Save.
Zones
Sites
From the Interval drop-down list in the Connect & Engage Dashboard window, you can select the time frame
for generating historical reports:
Last 7 Days (default)
Last 28 Days
Last 365 Days
Summary Information
The summary information presents users usage information for the present day. Note that the time used is
server time, and not web browser time.
Historical Information
The Connect & Engage Dashboard displays historical information:
New and Repeat VisitorsNew Visitors are the people seen for the first time. Repeat Visitors are those
recognized from an earlier visit.
Network UsageNetwork Usage is the total amount of data uploaded and downloaded by all visitors.
Pages Served vs SubmittedPages Served is the number of times a portal page was displayed to the
visitors' devices. Pages Submitted is the number of times a portal page was submitted by the visitors.
SMS Sent vs AuthenticatedSMS Sent is the total number of texts sent. SMS Authenticated is the
number of texts that were used to successfully authenticate visitors.
Languages Used Languages used is the count of visitors authenticated using each language.
In historical reports, you can choose the type of chart you want to be displayed in the reports:
Area Chart
Line Chart
Column Chart
Visitor Search
The Connect & Engage Dashboard provides a search option, where the following types of searches can be
performed:
Advanced Search
Export All Visitors
To search for a visitor, enter a search term, for example, name or email address, in the Visitor Search field.
Additional Information
The Search table provides a preview of up to 50 clients per page.
The entire search result can be exported to a .CSV file.
The search time range is based on the Cisco CMX system time, and not on the web browser time.
Partial search is supported; however, wildcards (*) are not supported.
Advanced search can be performed based on the following parameters:
All
MAC
Facebook Name
Facebook Gender
Facebook Locale
Facebook Timezone
Facebook Friends
Foursquare Name
Foursquare Email
Instagram Name
Instagram Email
Registration Form Email
Registration Form Gender
Registration Form Name
Registration Form Phone Number
Templates LibraryProvides pre-defined templates that you can use to create your own portal. The
following templates are available:
Registration Form
Social Login
Social or Registration Login
SMS Form
Custom
Image LibraryThe image library allows an imported image to be used for multiple portals. There is
no size limit on uploaded images as they are scaled during the upload. Once uploaded, the images can
be rotated, cropped, or have their aspect ratio changed using the built-in image editor. In the Image
Library, you can:
AddAllows you to add new images. Images are scaled down so that you get a thumbnail view
of the image.
ViewAllows you to preview an image. When you preview an image, you can crop, resize or set
its aspect ratio. After making changes in the image editor, click Save and Close to copy the image
into the Image Library or overwrite the existing image.
DeleteAllows you to delete images from the Image Library.
Device-Browser Matrix
Device-Browser Matrix for Connect and Engage
The following table lists the tested devices and browsers for Connect & Engage in the context of custom
portals.
Table 7: Device-Browser Matrix for Connect and Engage for Custom Portals
OS Version
Remarks
Google Nexus 7
4.3
Google Chrome
32.0.1700.99
Amazon Kindle
13.3.2.2
Silk 1.0.454.220
Apple iPad
7.0
Safari 7.0
Apple iPhone
6.1.3
Safari 6.0
10.8.4
Safari 6.0
OS Version
Remarks
33.0.1750.152
Google Chrome
33.0.1750.152
7.0
Safari 7.0
Internet Explorer 11
Samsung
Default browser
4.2.2
The portal pages with Social OAuth do not work properly on Mozilla Firefox browser.
The following table lists the tested devices and browsers for Facebook Wi-Fi.
Table 8: Device-Browser Matrix for Facebook Wi-Fi
OS Version
Google Nexus 7
4.3
Google Chrome
32.0.1700.99
Amazon Kindle
13.3.2.2
Silk 1.0.454.220
Apple iPad
7.0
Safari 7.0
Apple iPhone
6.1.3
Safari 6.0
10.8.4
Safari 6.0
33.0.1750.152
Google Chrome
33.0.1750.152
7.0
Safari 7.0
Google Chrome
34.0.1874.114
Internet Explorer 11
Samsung
4.2.2
Default browser
One+ phone
5.0.1
Google Chrome
OS Version
Amazon Reader
5.6.2.1
Default browser
CHAPTER
Initial Configurations
In order to use the Cisco CMX Presence Analytics service, choose the Presence option when you install
Cisco MSE Virtual Appliance. For more information, see the Installing a Cisco MSE Virtual Appliance
section in the Cisco MSE Virtual Appliance Installation Guide for Cisco CMX Release 10.2. After installation,
perform the following operations:
Add Controllers.
Add sites.
Add APs.
Chart
Description
Insights
Proximity
Proximity Distribution
Dwell Time
Chart
Description
Repeat Visitors
Adding Sites
You can add new sites individually, or upload a .CSV list of sites to add sites in bulk.
You can add new sites using one of the following methods:
Add sites individually. For more information, see Adding Sites Individually, on page 62.
Add sites in bulk. For more information, see Adding Sites in Bulk, on page 63.
Create sites from APs. This allows administrator to create sites by filtering APs by name and adding
them directly to a new site. For more information, see Adding an AP to a Site, on page 65.
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
Configure the Signal Strength Threshold to determine whether a client device is in the site or is just a
passer-by. You can move the circular blue butons to specify the Visitor Signal Threshold and Ignore Signal
Threshold values.There are two RSSI threshold values defined for a site, low (-95 dBm default) and high (65
dBm default).
Clients with RSSI below the low threshold (-95 dBm default) are discarded.
Clients with RSSI above the low threshold are classified as passer-by.
Clients with RSSI above high threshold over x minutes (default 5) in past 20 minutes are classified as
visitors.
Clients associated with AP in a site are classified as visitors at the site.
Step 8
Step 9
In the Configure the Minimum Dwell Time For Visitor (minutes) field, specify the minimum dwell time
for visitors.
Click Save.
Step 3
Click Import.
Step 4
Step 5
Step 6
The file that you upload for importing site information must be in .csv format.
Navigate to the location of the CSV file that contains the list of sites you wish to upload, select the CSV file,
and click Open. To import the site details correctly, store them in the following order and format: Site
Name,Address,RSSI High Threshold,RSSI Low Threshold,Dwell Time in MinutesFor example, Test Site,123
Main Street City CA US,-65,-95,5
Click Import.
A set of new sites is created and added to the table of sites under PRESENCE ANALYTICS > Manage.
Step 3
Under the Sites tab, you can view a list of available sites in a tabular format, sorted alphabetically by site
name. You can customize your view of the Sites table by sorting according to Location, Timezone, or AP
count.
Step 3
Under Sites, click the name of the corresponding site listed in the table of available sites.
The dialog box is displayed.
Step 4
Edit the site Name, site Address, Signal Strength Threshold limits, or the Minimum Dwell Time for
Visitor.
Step 5
Click Save.
Step 3
Under Sites, check the check box of the site that you want to delete.
Step 4
Click Delete.
You will receive a confirmation dialog box when you try to delete a site. Click OK to confirm the delete
action.
Note
If you want to delete all available sites simultaneously, select the check box in the header row, and
then click Delete.
Step 3
In the Search field on the top right-corner of the window, enter the sites name, and press the Return key. If
the specified site has already been added to PRESENCE ANALYTICS, it is displayed in the search results.
Adding APs
You can add new APs individually or by uploading a .CSV list of APs to add them in bulk.
You can add new APs, with or without maps, using one of the following methods:
Add APs individuallyAdd individual APs to specific sites. For more information, see Adding an AP
to a Site, on page 65.
Add APs in bulkAdd multiple APs at one go by importing a list of APs in .CSV format. For more
information, see Adding APs in Bulk, on page 66.
Adding an AP to a Site
Note
If you do not see the AP list, youshould update the community string of the WLC using the System >
Settings window. The AP information is retrieved from the WLC using SNMP.
Procedure
Step 1
Step 2
Step 3
Step 4
Under Controller AP list, click Download CSV to download the .CSV file, add the missing site names for
APs, and import the file again from the Import tab.
CSV Format: Radio MAC Address,Ethernet MAC Address,Name,Site Name,Site Address
Example: aa:bb:cc:dd:ee:ff,bb:cc:dd:ee:ff:11,AP-1,Site-1,123 Main St City CA US
Procedure
Step 1
Step 2
Step 3
Step 4
Navigate to the location of the .CSV file that contains the list of APs you want to upload, select the .CSV file,
and click Open.
To import the AP details correctly, store them in the following order and format:Radio MAC Address,Ethernet
MAC Address,Name,Site Name,Site Address, for example, aa:bb:cc:dd:ee:ff,bb:cc:dd:ee:ff:11,AP-1,Site-1,123
Main St City CA US
Step 5
Click Import.
A set of new APs is created and added.
Deleting an AP
Procedure
Step 1
Step 2
Step 3
In the table of available sites, click the name of the site from which you want to delete and unassociate the
corresponding AP.
The dialog box is displayed.
Step 4
Step 5
Click the Delete icon next to the AP that you wish to delete.
Step 3
Step 4
Select a duration from the DATE drop-down list. You can choose from the following options:
Today
Yesterday
Last 3 Days
Last 7 Days
Last 30 Days
This Month
Last Month
CustomSpecify a date range and click Change. You can either manually enter the dates in the FROM
and TO fields in yyyy-mm-dd format, or select the dates from the respective calendars. These calendars
are displayed when you select Custom or click the FROM or TO fields. The window is refreshed to
show the site KPIs based on your selection.
Note
You can choose a single day by selecting the same date in both the FROM and the TO
fields.
Step 3
Step 4
Step 5
Click the corresponding elements within the Proximity or Proximity Duration chart to view hourly breakdown
of passersby, visitors, and connected devices for the selected site during the specified duration.
Note
If the duration selected in Step 4 exceeds one day, clicking the elements in the Proximity chart will
display the details for the selected site for the specific date.
Emailing a Report
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Printing a Report
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
You can customize the logo on the PDF reports. To view an archived report, choose PRESENCE
ANALYTICS > Manage > Reports.
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Managing Reports
The Presence Analytics service enables you to manage the scheduled and generated reports. In addition, you can customize the logo
that appears on the generated PDF reports.
The Reports window contains the following areas:
Report LogoEnables you to upload an image file that you can use as a logo for your PDF report.
Scheduled ReportsEnables you to modify or delete a report that is already scheduled (email or PDF).
Generated PDF ReportsEnables you to download or delete a generated PDF report.
To upload a logo for your report, perform the following steps:
a) Log in to Cisco CMX.
b) Click PRESENCE ANALYTICS > Manage.
c) Click Reports.
d) In the Report Logo area, click Browse and then choose the image file that you want upload as the
report logo.
e) Click Upload.
To edit or delete a scheduled report, perform the following steps:
a) Log in to Cisco CMX.
b) Click PRESENCE ANALYTICS > Manage.
c) Click Reports.
d) In the Scheduled Reports area, under the Link column, click either Edit or Delete.
If you choose to edit a scheduled report, the existing schedule details are displayed in the EDIT
SCHEDULED REPORT window, where you can make the necessary changes.
To download or delete a generated PDF report, perform the following steps:
a) Log in to Cisco CMX.
b) Click PRESENCE ANALYTICS > Manage.
c) Click Reports.
d) In the Generated Reports area, under the Link column, click either Download or Delete.
Procedure
Step 1
Step 2
Step 3
Step 4
Click Save.
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Click Save.
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Click Save.
Step 3
Step 4
CHAPTER
Note
All the Manage service tasks can be performed only by users with corresponding user roles. For information
on user roles, see User Roles, on page 75.
Managing Licenses
To view the list of licenses that your Cisco Connected Mobile Experiences (Cisco CMX) system has, log in
to Cisco CMX and choose MANAGE > Licenses. The list of licenses is displayed in the Licenses window.
For information about the licenses required to operate Cisco CMX, see the Cisco CMX 10.2 Ordering and
Licensing Guide.
Note
Cisco CMX Release 10.2 comes with a 120-day full-functionality evaluation license. All the access points
(APs) connected to Cisco CMX must be licensed.
Adding a License
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Deleting a License
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Managing Users
Cisco Connected Mobile Experiences (Cisco CMX) is shipped with a default admin user account and password.
An admin user can add, edit, and delete other users.
Adding a User
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
User Roles
Your Cisco Connected Mobile Experiences (Cisco CMX) system comes with the following services, depending
on whether or not you have the license for that service:
SYSTEM service (included with Cisco CMX base license)
MANAGE service (included with Cisco CMX base license)
DETECT & LOCATE service (included with Cisco CMX base license)
CONNECT & ENGAGE service (included with Cisco CMX base license)
ANALYTICS service (provided only with Cisco CMX advanced license; not included with Cisco CMX
base license)
When setting up users in Cisco CMX, you can select one or more roles for each user. Each role provides
access privileges to one or more services, provided your license includes those services.
See the table below for a description of the access privileges associated with each role.
Table 10: Access Privileges Associated With User Roles
Role
Allows
Admin
System
Role
Allows
Manage
Location
Analytics
Connect
Connect
Experience
Read Only
Note
A user can be allocated the System, Manage, Location, Analytics, and Connect roles. This allows
the user to function like an admin user. Such nonadmin users can be deleted by admin users, but not
vice-versa.
Only an admin user can delete another admin user.
Deleting a User
Procedure
Step 1
Step 2
Step 3
Step 4
Step 4
Creating a Perimeter
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
When you double-click the last vertex point, the CREATE A PERIMETER dialog box opens.
Click Add to add this perimeter to the floor.
Figure 1: A Perimeter and its Vertices
Deleting a Perimeter
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
icon.
Editing a Perimeter
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
Step 8
Creating a Zone
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
An Item pane pertaining to this zone is displayed on the right side of the window. You can add existing tags
from the drop-down list, or add a new tag.
Note
Zones cannot be outside the floor map and they cannot overlap. Overlapping zones can be created
using Cisco Prime Infrastructure.
Figure 2: A Zone and its Vertices
Deleting a Zone
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Editing a Zone
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
Step 8
To move the zone, use the drag tool, denoted by the Hand
icon, to drag the zone around. Click the Hand
icon, move the cursor to the center of the zone, where it will change to an Arrow icon. You can then drag the
zone.
Click outside the zone to save your changes.
Note
Zones cannot be outside the floor map and they cannot overlap. Overlapping zones can be created
using Cisco Prime Infrastructure.
Note
Cisco CMX has the capability to view the current location of beacons using access points (APs). Cisco
CMX can determine if a beacon is missing or has been misplaced.
To use the BLE beacons feature, choose MANAGE > BLE Beacons. This opens the Beacons Activity Map
window, where you can:
View the number of beacons, and the status and location of each beacon. The status of a beacon is
indicated by the color of its icon, which is described in the table below.
Keep track of the positions of all the BLE beacons on a particular floor.
Position the BLE beacons on a floor map.
Table 11: Beacon Status
Description
Unplaced
A newly created beacon that is yet to be placed. Positioned at the top-left corner
of a map.
Icon in green
Known
A beacon that has been defined and placed, or converted from Rogue status.
Icon in red
Missing
A beacon that is marked as Missing because the network status of the beacon
is inactive.
Icon In blue
Misplaced A beacon that has been moved beyond its accuracy range.
For example, if the accuracy range is 5 feet, and the currently detected location
is beyond a radius of 5 feet of the configured location.
A newly discovered beacon that has not been defined or changed to Known
status.
Step 6
Deleting a Beacon
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Notification Type
Used for
Association
Beacon Movement
Generating a notification when a BLE beacon has moved more than a specified
distance.
Absence
Location Update
In / Out
Beacon Absence
Generating a notification when a BLE beacon has been undetected for more than
five minutes.
Movement
Area Change
Network Configuration
Change
If you are a non-admin user, you can make changes to only those notifications that were created by you.
A non-admin user cannot make changes to notifications created by other users.
The following are the changes that you can make to notifications:
Enabling and Disabling a Notification, on page 87
Editing a Notification
Procedure
Step 1
Step 2
To edit a notification, in the NOTIFICATIONS window, under the Actions column adjacent the notification,
click Edit.
The EDIT NOTIFICATION dialog box is displayed.
Edit the details of the notification, as required.
Note
You cannot edit the name of the
notification.
Deleting a Notification
Caution
A notification delete action takes effect immediately without a delete confirmation dialog box being
displayed.
Procedure
To delete a notification, in the NOTIFICATIONS window, in the Actions column adjacent the notification,
click Delete. The notification is immediately deleted.
Managing Verticalization
Cisco CMX Analytics comes packaged with a report generator that can automatically generate reports with
the most important metrics for specific businesses. By selecting a vertical, you can take advantage of predefined
reports that can help you make informed decisions based on the vertical your network is set up for. This feature
is called verticalization.
Customizing your vertical enables you to quickly generate valuable reports specific to the requirements of
that vertical. The customized verticals can also be configured with the correct tags suitable to your vertical.
CMX Analytics verticalization feature enables you to customize the names of your entities such that they are
specific to a vertical. Depending on the vertical you choose, the CMX Analytics verticalization feature can
generate customized reports.
The following are some of the verticals supported by Cisco CMX, along with the reports they contain:
Default
Visitor Count
Connected Clients
Average Dwell Time
Location Correlation
Most Popular Zones
Path Analysis
Retail
Store Type Popularity
Average Shopping Time
Most Popular Entrance
Most Popular Department
Department Transition
Footfall
Hospitality
Most Popular Restaurant
Connected Clients
Most Used Amenity
Local Correlation
Longest Used Amenity
Path Analysis
Education
Corridors vs Classroom
Connected Clients
Diners per Hall
Local Correlation
Library Time
Path Analysis
Healthcare
Visitor Count
Connected Clients
Busiest Department
Wait Times
Diners per Cafeteria
Path Analysis
Mall
Store Type Popularity
Average Shopping Time
Most Popular Entrance
Most Popular Restaurant
Department Transition
Footfall
Customizing Verticals
Customizing a vertical means changing the names of the entities in your vertical based on your business. You
can optimize your vertical by customizing it to meet your specific needs. Customizing includes naming the
hierarchy of your vertical, association of icons, building a tag library, and specifying tag locations.
Procedure
Step 1
Step 2
Step 3
Step 4
The setup wizard displays the steps required to optimize the vertical and complete the customization.
Step 5 Click Get Started.
Step 6 The first step enables you to configure the hierarchy of your vertical. Follow the instructions on the wizard
and select an icon. If you approve of the hierarchy name and the associated icon, click Skip Step. The wizard
iterates through all the hierarchies for that vertical.
Step 7 After completing the hierarchy customization, review the changes and click Save.
Step 8 Click Continue.
Step 9 Tags are used to categorize locations and devices. Click Continue to configure tagging.
Step 10 Depending on the vertical you select, the tags specific to that vertical are listed. Select the tags you want to
create by clicking the button corresponding to that tag. The setup wizard creates the tags. Click Continue.
Step 11 Location tags can be applied to specific locations based on your hierarchy. The setup wizard iterates through
the hierarchies in your vertical. Select the hierarchies that you want to tag by clicking the corresponding name.
The right pane lists the Zone item name and a list of tags to choose from. Select the tags that are applicable
to the Zone. Click Continue.
Step 12 Click Create a Report.
The Analytics Reports window is displayed with the list of customized wizards for your vertical.
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
If the Override checkbox is checked, the import will override the existing entries.
In the Mail Server window that is displayed, enter the corresponding details.
Click Next to complete the configuration.
Caution
Do not use the root user account; unless explicitly directed to do so by the Cisco Technical Assistance
Center team.
CHAPTER
The Cluster table and the Controllers table are shown in the following figure:
Figure 3: System at a Glance
The following list shows the parts of the System at a Glance window:
1Gear icon for setting cluster services and metrics
2System at a Glance table
3Legend of status indicators for the cluster table service
4Controllers table
5Legend of status indicators for the Cisco Wireless Controllers (Cisco WLC) in the Controllers table.
The IP addresses of active controllers are shown in green. The IP addresses of inactive controllers are
shown in red.
Click a node name to view its metrics. See Viewing CMX Node Metrics, on page 104.
ServicesLists all the services for each Cisco CMX node.
The colors of the icons pertaining to these services indicate the status of these services. Ensure
that the services are in green color; this indicate a healthy status.
Click a service icon to view the corresponding service or system metrics.
MemoryShows the load on the memory, in percentage.
Click it to view the Live Alerts window. See Viewing Live System Alerts, on page 110.
CPUShows the load on the CPU, in percentage.
Click it to view the Live Alerts window. See Viewing Live System Alerts, on page 110.
ActionsAllows you to restart all the services for a node.
Step 3
Step 3
Click the Gear icon at the top right corner of the page.
The Settings window is displayed.
Step 4
Step 5
Click a node name to view its details, including Node ID, Name, Hostname and Type.
Step 3
Step 4
Step 5
In the Elements column, check the check box of each device that you want to select for tracking.
Only the elements selected here will be tracked by the network location service and will appear on the Activity
Map window.
To track Bluetooth low energy (BLE) beacon tags, check Interferers. For BLE beacon-enabled
devices to be tracked, you require a Cisco WLC with software Release 8.0.115.0 or later.
Click Save.
Note
Step 6
Step 3
Step 4
Duty Cycle CutoffThis is a percentage value. Interferers with a Duty Cycle that is less than the
specified cutoff will not be tracked.
RSSI CutoffThis is the radio signal strength cutoff for filtering. The default is -85 dBm.
Exclude probing clientsCheck this check box to filter out clients that are only probing. This enables
the system to track only connected clients.
Enable Locally Administered MAC filteringCheck this check box to filter out self-assigned MAC
addresses. This parameter is checked by default. This discards Apple iOS8 random MAC addresses.
Enable Location MAC filteringCheck this check box to filter out specific MAC addresses. For
example, you can use this to filter out MAC addresses of employees devices. After checking this, you
can either specify a MAC address that you want to allow or disallow, or choose to allow, disallow, or
delete previously entered MAC addresses.
Step 5
Click Save.
Step 3
Step 4
Enable OW LocationCheck this check box to enable the use of Outer Walls (obstacles) for location
calculation.
Enable Location FilteringCheck this check box if you want the system to use previous location
estimates for estimating the current location. This parameter will be applied only for client location
calculation. Enabling this parameter reduces location jitter for stationary clients and improves location
tracking for mobile clients. This parameter is enabled by default.
Use new location algorithmNew aggregation algorithm changes how the RSSIs are aggregated before
computing location. We recommend that you do not modify this parameter without the guidance of
Cisco Technical Support.
User Default Heatmaps for Non Cisco AntennasCheck this check box to enable the usage of default
heat maps for non-Cisco antennae during location calculation.
Chokepoint UsageCheck this check box to enable the usage of chokepoint proximity to determine
the location of a device. This applies only to Cisco-compatible tags that are capable of reporting
chokepoint proximity. This parameter is enabled by default.
Enable HyperlocationCheck this check box to enable hyperlocation in Cisco CMX. This parameter
is disabled by default.
Use Chokepoints for Interfloor conflictsUse this drop-down list to specify the frequency to determine
the correct floor during interfloor conflicts.
Chokepoint Out of Range TimeoutAfter a Cisco-compatible tag leaves a chokepoint proximity
range, RSSI information will be used again to determine the location only after this timeout value is
exceeded. Specify a timeout value, in seconds, accordingly.
Relative discard RSSI timeEnter the time, in minutes, after which the RSSI measurement should be
considered obsolete and discarded from use in location calculations. This time is from the most recent
RSSI sample, and not an absolute time. For example, if this value is set to 3 minutes, and two samples
are received at 10 minutes and 12 minutes, both the samples will be retained. However, an additional
sample received at 15 minutes will be discarded. We recommend that you do not modify this parameter
without the guidance of Cisco Technical Support.
Absolute discard RSSI timeEnter the time, in minutes, after which the RSSI measurement should
be considered obsolete and discarded from use in location calculations regardless of the most recent
sample. We recommend that you do not modify this parameter without the guidance of Cisco Technical
Support.
RSSI cutoffEnter the RSSI cutoff value, in dBm, at which you want the server to discard AP
measurements. We recommend that you do not modify this parameter without the guidance of Cisco
Technical Support.
You can also set the following Movement Detection Parameters:
Individual RSSI change thresholdEnter a threshold, in dBm, beyond which you want individual
RSSI movement recalculation to be triggered. We recommend that you do not modify this parameter
without the guidance of Cisco Technical Support.
Aggregated RSSI change thresholdSpecify the Aggregated RSSI movement recalculation trigger
threshold. We recommend that you do not modify this parameter without the guidance of Cisco Technical
Support.
Many new RSSI change percentage thresholdSpecify the trigger threshold recalculation (as a
percentage) for many new RSSI changes. We recommend that you do not modify this parameter without
the guidance of Cisco Technical Support.
Many missing RSSI percentage thresholdSpecify the trigger threshold recalculation (as a percentage)
for many missing RSSI changes. We recommend that you do not modify this parameter without the
guidance of Cisco Technical Support.
You can set the following History Storage Parameter:
History Pruning IntervalSpecify the number of days of client location history to be stored for the
location maps.
Step 5
Click Save.
Step 3
Step 4
Step 5
To test your settings, click Test Settings, and then click Send e-mail.
Step 6
Procedure
Step 1
Step 2
Step 3
Step 4
To test your settings, click Test Settings, and then click Send e-mail.
Step 6
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
If you check the Override Maps check box , the maps existing in Cisco CMX will be replaced
by the maps that you import from Cisco Prime Infrastructure.
b) Navigate to the location of the map file, select the map file, and then click Open.
c) Click Upload.
d) Click Save.
Note
Step 6
To import a Cisco WLC, configure the following parameters under the Controllers area:
a)
b)
c)
d)
e)
Click Save.
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Either choose a local .cmx file or point to the URL of the .cmx file
Before selecting the local file option, ensure that the .cmx file is available on the machine from which access
to the web GUI is being made.
The upgrade process involves the following tasks:
1 The .cmx file is copied to /opt/image/newimage
2 The cmxos upgrade command is executed in the background:
Services are stopped
New files are copied and configured
Procedure
Step 1
Step 2
Procedure
Step 1
Step 2
Step 3
In the Services column, click the Configuration, Location Heatmap Engine, NMSP Load Balancer, or
Proxy icon to view the corresponding System Summary metrics.
Note
Hover your cursor over the metrics and graphs for descriptions and details.
Procedure
Step 1
Step 2
Step 3
In the left pane, click a Cisco CMX node name to view the metrics for that node.
Procedure
Step 1
Step 2
Step 3
In the Node column, click a Cisco CMX node name to view the metric details for that node.
Note
Hover your cursor over the metrics and graphs for descriptions and details.
Procedure
Step 1
Step 2
Step 3
Procedure
Step 1
Step 2
Step 3
Procedure
Step 1
Step 2
Step 3
Procedure
Step 1
Step 2
Step 3
Procedure
Step 1
Step 2
Step 3
Procedure
Step 1
Step 2
Step 3
many notifications are rejected per second. Ideally, you require this chart to show a flat line of 0. If it
does not show 0, you should consider adding another server to the cluster for running the Analytics
service. This will distribute the load over the two servers.
Notification incoming rateThis is the number of notifications received by the Analytics service per
second. This trend should roughly equal the client count, that is, the more clients are detected by the
Location service, the more notifications are expected. However, the trend is also influenced by the clients'
movement rates because notifications are only sent when the location of a device changes.
To view the Analytics Notification metrics:
Procedure
Step 1
Step 2
Step 3
Procedure
Step 1
Step 2
Step 3
Procedure
Step 1
Step 2
Step 3
Viewing Patterns
The Patterns window shows the pattern of a specific feature, such as client count, unique devices, and so on
over the week for a selected time period. For example, if you select client count for the last 1 month, it shows
which days or times of the week had the most client counts in the last 1 month.
Client CountDisplays the total devices seen at a given time.
Location Calculation TimeDisplays the average amount of time, in milliseconds, taken by the
Location algorithm, to calculate a client's location.
Incoming RateDisplays the number of Network Mobility Services Protocol (NMSP) messages
received from the NMSP load balancer.
CPU UsageDisplays the percentage of used CPU on a per-node basis.
Memory UsageDisplays the percentage of used memory on a per-node basis.
Dropped NotificationsDisplays the notifications sent to the Analytics service by Cisco CMX, but
were dropped because of some reason, for example, because the Analytics queue is full.
NMSP LB Read OperationsDisplays the number of bytes received from socket.
Redis Connections ReceivedDisplays the total number of connections received by the cache service.
To view patterns:
Procedure
Step 1
Step 2
Step 3
From the Select Criteria drop-down list, choose the criteria for which you want to view pattern data.
Step 4
From the Select Date Range drop-down list, choose the time frame for the criteria pattern.
Step 5
Optionally, from the Select Server drop-down list, choose the Cisco CMX node for which you want pattern
data to be displayed. By default, the pattern data for all the Cisco CMX nodes in a cluster is displayed.
Step 3
In the Live Alerts window that is displayed, sort the alerts By Severity, By Node, or By Service, using the
drop-down list at the top-right corner.
To dismiss an alert, in the Actions column adjacent the corresponding node name, click the Dismiss icon.
CHAPTER
Note
The password of the root account is now being set and maintained by the system owners,
and no longer has a default password configured. This way, the account is still available
for special-case installation and tackling debugging issues, and the root user will be
owned by the end-user. Password recovery is accomplished through the use of the single
user login process. For more information see Recovering Password, on page 115.
cmxA no login account that now owns all the CMX processes with the exception of postgress.
cmxadminPrimary account used for the performance of all administrative tasks using CLI. User will
sudo from this account to perform tasks requiring root-level access. This account is used to upgrade
Cisco CMX 10.2 to a future release using GUI.
adminAdmin user account for configuring maps, and Cisco WLCs, and restart services using Cisco
CMX Web UI.
normal user accountsUser-defined accounts.
Backing Up Data
After you install and run Cisco CMX successfully, you can take a backup to avoid losing any data.
You may lose data on your CMX server, if:
The hard disk in your CMX server fails
The data on your CMX server is corrupted while upgrading
Therefore, backing up your data enables you to restore it to the original state.
If Cisco CMX contains huge amount of saved data, the backup operation will take up extra disk space. In that
case, you can consider the following:
Back up to an external drive if there is not enough space on the Cisco CMX server. You can perform
this operation by plugging in a removable hard disk or a mounted hard disk.
After the backup operation, move the backup file (using ftp or scp) to a different server and remove it
from the Cisco CMX server.
The following components are included in the backup:
Database
Cache
Cassandra
Influxdb
Consul
Floormaps
Licenses
Setup
Conf
Procedure
To perform a backup operation, run the cmxos backup command using the cmxadmin (non-root user) account.
You can include the -i (for example, cmxos backup -i database) parameter with the backup so that you can
choose the components that you want to include in the backup.
The following is a sample output from the cmxos backup command:
[cmxadmin@test ~]$ cmxos backup
Please enter the path for backup file [/tmp]: /tmp
[17:01:30] Preparing for backup...
Data size 287388806
Available disk space 139165282304
Pre-backup took: 0.0118758678436 seconds
['database', 'cache', 'cassandra', 'influxdb', 'consul', 'floormaps', 'licenses' , 'setup',
'conf']
[17:01:30] Backup Database...
Backup database took: 1.15777993202 seconds
[17:01:32] Backup Cache...
Procedure
Step 1
Stop all the Cisco CMX services by entering the following commands:
cmxctl stop
cmxctl stop -a
Step 2
Step 3
Edit the virtual machine settings and increase the hard disk space.
Note
You cannot increase the hard disk space if the virtual machine was ever restored from snapshot.
Step 4
Restoring Data
After the backup, you can save the backup file in a safe location. If required, you can restore from this location.
When you restore data, if there is not enough disk space in the Cisco CMX server, try to untar the file from
an external drive. The untarred files will be in binary format, which can be read by database servers.
Procedure
To restore the data, enter the cmxos restore command using the cmxadmin (non-root user) account.
You can include the -i (for example, cmxos restore -i database) parameter with the restore command so that
you can choose the components that you want to restore.
The following is a sample output from the cmxos restore command:
[cmxadmin@test~]$ cmxos restore
Please enter the backup file path: /tmp/cmx_backup_test.cisco.com_2015_07_28_17_01.tar.gz
Please enter the path for untar backup file [/tmp]: /tmp
[17:08:54] Preparing for restore...
Restore size 27866720
Available disk space in /tmp is 139137040384
Recovering Password
Cisco CMX Release 10.2 uses a single user mode to reset the root and cmxadmin user passwords.
To enter into the single user mode you require:
A (non-SSH) console connection to the Cisco Mobility Services Engine (Cisco MSE).
A power-cycle of the Cisco MSE appliance
The GUI admin user password can be reset to the default of admin from the Cisco MSE CLI using the following
command:
cmxctl reset ui-password
You should know the cmxadmin user password for CLI access.
To reset the root or cmxadmin password, perform the following tasks:
Procedure
Step 1
Step 2
Step 3
Step 4
Step 5
Step 6
Step 7
Type reload and press Enter to reboot the system and load the Cisco CMX services.
APPENDIX
The portal pages with Social OAuth do not work properly on Mozilla Firefox browser.
Procedure
Step 1
In the Social Login element of the custom portal, click on the link ( ) icon to the right of Facebook to go
to the associated developer website.
Step 2 Log in to Facebook with your username and password.
Step 3 Click the +Add a New App button.
Step 4 Click the Website button.
Step 5 Enter a name for the application, and then click the Create New Facebook App ID button.
Step 6 From the Choose a Category drop-down list, choose a category for the new application, and then click the
Create App ID button.
Step 7 Scroll down to the Tell us about your website area and enter the same URL as the Wireless LAN Controller
(WLC) redirect URL (http://<CMX>/visitor/login) in the Site URL field, and the click the Next button.
Note
This configuration will fail if Cisco CMX has an IP address in the 172.x.x.x range as it will be seen
as a Facebook URL.
Step 8 Click the Skip to Developer Dashboard link.
Step 9 Select and copy the App ID for a later step.
Step 10 Click Settings in the left navigation pane, and add the contact email and click the Save Changes button.
Step 11 Click Status & Review in the left navigation pane, and click the Yes/No slider to make the app available to
the general public.
Step 12 Click the Confirm button.
Step 13 If you want to collect information such as first name, last name, friend list, submit those items for approval
by Facebook.
Step 14 To configure a private IP address for the Facebook Oauth configuration, choose the Advanced tab, and enter
http://cmxIP/visitor/login in the Valid OAuth redirect URIs field. By default, the Valid OAuth redirect
URIs field is empty.
Step 15 Go to the custom portal and click Create New, add the App name, paste the App ID information that you
generated using the preceding steps.
Step 16 From the Scope drop-down list, choose the scope to collect Social Network data, and then check the Facebook
checkbox.
In the Social Login element of the custom portal, click on the link ( ) icon to the right of Instagram to go
to the associated developer website.
Log in to Instagram by clicking Log In on the top right hand side, then enter username and password and click
the Log in button.
In the Manage Clients tab, click on the Register a New Client button
Enter the application name and the description
Enter the same URL as the Wireless LAN Controller (WLC) redirect URL (http://<CMX>/visitor/login) in
the website field and in the OAuth redirect_url field. Check the Disable Implicit OAuth check box.
Enter the Captcha and click the Register button.
Select and copy the Client ID for the next step.
Go to the custom portal and click Create New, add the App name, paste the Client ID that you generated
using the preceding step.
In the Social Login element of the custom portal, click on the link ( ) icon to the right of Foursquare to go
to the associated developer website.
Log in to Foursquare by clicking on the My Apps tab at the top right hand side.
Enter your email address and password and click the LOG IN button.
Click the CREATE A NEW APP button.
Enter the same URL as the Wireless LAN Controller (WLC) redirect URL (http://<CMX>/visitor/login) in
Download/welcome page url field, in the Your privacy policy url field, and in the Redirect URI(s) field.
Click the SAVE CHANGES button.
Select and copy the Client id for the next step.
Go to the custom portal and click Create New, add the App name, paste the Client ID that you copied using
the preceding step.
From the Scope drop-down list, choose the scope to collect Social Network data, and then check the checkbox.