- Preface
- Getting Started
- The Cisco CMX Detect and Locate Service
- The Cisco CMX Analytics Service
- The Cisco CMX Connect and Engage Service
- The Cisco CMX Presence Analytics Service
- Managing Cisco CMX Configuration
- Managing Cisco CMX System Settings
- Performing Administrative Tasks
- Authentication with Social Network Accounts
Cisco Connected Mobile Experiences Configuration Guide, Release 10.2
- Updated:
- February 8, 2018
Chapter: Getting Started
- Introduction to Cisco Connected Mobile Experiences
- Overview of Cisco CMX Services
- Prerequisites for Configuring Cisco CMX 10.2
- Prerequisites for Configuring Cisco CMX 10.3
- Importing Maps and Cisco Wireless Controllers
- Logging In to the Cisco CMX User Interface
- Using the Evaluation License
- Enabling or Disabling Cisco CMX Services
- Importing Certificates
- Adding Users and Managing Roles
- Using the Cisco CMX Setup Assistant
- Getting APIs
- Changing Time Zones and NTP Server
Getting
Started
- Introduction to Cisco Connected Mobile Experiences
- Overview of Cisco CMX Services
- Prerequisites for Configuring Cisco CMX 10.2
- Prerequisites for Configuring Cisco CMX 10.3
- Importing Maps and Cisco Wireless Controllers
- Logging In to the Cisco CMX User Interface
- Using the Evaluation License
- Enabling or Disabling Cisco CMX Services
- Importing Certificates
- Adding Users and Managing Roles
- Using the Cisco CMX Setup Assistant
- Getting APIs
- Changing Time Zones and NTP Server
Introduction to Cisco Connected Mobile Experiences
Cisco Mobility Services Engine (Cisco MSE) acts as a platform to deploy and run Cisco Connected Mobile Experiences (Cisco CMX). Cisco MSE is delivered in two modes—the physical appliance (box) and the virtual appliance (deployed using VMware vSphere Client) . Using your Cisco wireless network and location intelligence from Cisco MSE, Cisco CMX helps you create personalized mobile experiences for end users and gain operational efficiency with location-based services.
For more information about Cisco CMX features for this release, see the Release Notes for Cisco CMX, at:
Overview of Cisco CMX Services
-
DETECT & LOCATE—The Detect & Locate service uses the data provided by Cisco WLCs to calculate the X,Y location (based on 0,0 at the top left hand side of the map) of wireless devices that are detected by the access points that support the wireless LAN (WLAN) to a high degree of precision (generally +/-5 to 7M, 90% of the time with standard location technologies and +/-1 to 3M, 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 (Lightning icon)
-
Access Points (Circles)
-
BLE Beacons (Bluetooth 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 & LOCATE—Active for 120 day trial period unless either a CMX base or advanced license is added.
-
ANALYTICS—Active for 120 day trial period unless a CMX advanced license is added.
-
CONNECT & ENGAGE—Active 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.
-
-
ANALYTICS—This 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.
For more information, see The Cisco CMX Analytics Service.
- CONNECT
&
ENGAGE—This 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:
For more information, see The Cisco CMX Connect and Engage Service.
- PRESENCE
ANALYTICS—Cisco
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.
If you choose Presence during installation, you will see the following services in the Cisco CMX GUI.
- MANAGE--This service enables you to manage licenses, users, zones, beacons, and notifications. For more information, see Managing Cisco CMX Configuration.
- SYSTEM—This service enables you to verify the health of the system and view patterns and metrics. For more information, see Managing Cisco CMX System Settings.
For a complete list of new features supported by Cisco CMX for this release, see the Release Notes for Cisco CMX, at:
 Note | The installation methods for Location and Presence are different. If you want to change the service, you must perform a fresh installation. |
Prerequisites for Configuring Cisco CMX 10.2
The following components are mandatory for you to configure Cisco CMX 10.2:
-
Exported maps (in the form of files) from Cisco Prime Infrastructure 1.3, 1.4, 2.2, 3.0, or 3.1
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.
-
Cisco Wireless Controller (Cisco WLC) 7.6, 8.0, 8.1, 8.2, or 8.3
-
Cisco CMX 10.2 License (Cisco CMX 10.2 ships with a fully functional 120-day evaluation license that is activated after Cisco CMX is installed and started for the first time. For information about adding permanent licenses, see Add a License.)
Prerequisites for Configuring Cisco CMX 10.3
The following components are mandatory for you to configure Cisco CMX 10.3:
-
Exported maps (in the form of files) from Cisco Prime Infrastructure 1.3, 1.4, 2.2, 3.0, or 3.1
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.
-
Cisco Wireless Controller (Cisco WLC) 7.6, 8.0, 8.1, 8.2, or 8.3
-
Cisco CMX 10.3 License (Cisco CMX 10.3 ships with a fully functional 120-day evaluation license that is activated after Cisco CMX is installed and started for the first time. For information about adding permanent licenses, see Add a License.)
Importing Maps and Cisco Wireless Controllers
Cisco CMX relies on incoming Network Mobility Service Protocol (NMSP) data from any of the Cisco Wireless Controllers (Cisco WLCs) added to the system. The following sections describe the process to follow.
Exporting Cisco Prime Infrastructure Maps
To obtain maps for Cisco CMX, you have to export maps from Cisco Prime Infrastructure.
Copying the Exported Maps
Use Secure Copy Protocol (SCP) to copy the exported maps to a directory of a server accessible by Cisco CMX.
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.
-
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.3, at:
https://www.cisco.com/c/en/us/td/docs/wireless/mse/10-3/cmx_command/cmxcli103.html .
Note | When importing the maps from Prime Infrastructure using CLI, you also can import the zones. To import zone, set the import zone option as Yes and import the maps. After importing maps from Cisco Prime Infrastructure, you can update them in Cisco CMX by drawing new zones. However, these changes are not synchronized back to Cisco Prime Infrastructure. |
-
Log in to Cisco Mobile Connected Experiences (Cisco CMX).
-
Click SYSTEM > Dashboard.
-
Click the Gear icon at the top-right corner of the window.
-
Click Controllers and Maps Setup > Import.
Adding Cisco WLCs
You can add Cisco WLCs using CLI or the CMX user interface. If you add Cisco WLCs using Prime Infrastructure, then the controller configuration will not work unless the NMSP connection is correct. However, the controller may be added successfully, but the connection may not work.
To add Cisco WLCs from the Cisco CMX CLI, run one of these commands:
For more information about Cisco CMX commands, see the Cisco Connected Mobile Experiences (CMX) Command Reference Guide, Release 10.3, at:
https://www.cisco.com/c/en/us/td/docs/wireless/mse/10-3/cmx_command/cmxcli103.html
Note | After adding Cisco WLCs, you must verfiy if the controller status is up and running. Using the CLI, you can run the command cmxctl config controllers show to display the list of controllers with the status. An Active status indicates a established connection. To validate the controller status using user interface, you need to navigate to the System tab. The controllers list is displayed in the tab and the new controller should appear in green. |
Logging In to the Cisco CMX User Interface
Using the Evaluation License
Cisco Connected Mobile Experiences (CMX) ships with a fully functional 120-day evaluation license, which is activated after Cisco CMX is installed and started for the first time. The evaluation license is based on Cisco CMX usage, not calendar days (meaning, days when Cisco CMX is not used are not counted).
You must upload a permanent license to CMX before the evaluation license expires. Otherwise, you will not be able to access the Cisco CMX GUI or APIs. Cisco CMX will continue to run in the background and collect data until you add a permanent license.
After the evaluation license expires, only users with admin privileges can log in to add additional licenses.
CMX provides multiple reminders that the evaluation license is about to expire:
-
For two weeks before the evaluation license expires, a daily alert is displayed on the Cisco CMX System > Alerts window.
-
An alert email is sent, if you have configured email settings.
-
An alert is displayed when you log in to Cisco CMX.
To add a license, click Add new license from the alert. You can also add a license from the Cisco CMX Manage > Licenses window. For information about adding permanent licenses, see Managing Licenses.
Note | The license file has an .lic extension. Make sure it is the .lic file that you install on Cisco CMX. |
For details about procuring licenses, see the Cisco Connected Mobile Experiences (CMX) Version 10 Ordering and Licensing Guide.
Enabling or Disabling Cisco CMX Services
-
To enable a Cisco CMX service using the CLI, run the following command:
cmxctl enable {consul | qlesspyworker | cassandra | iodocs | cache_6382 | cache_6380 | cache_6381 | cache_6383 | cache_6385 | influxdb | metrics | confd | cache_6379 | cache_6378 | haproxy | database | analytics | connect | location | configuration | matlabengine | hyperlocation | nmsplb | agent}
-
To disable a Cisco CMX service using the CLI, run the following command:
cmxctl disable {consul | qlesspyworker | cassandra | iodocs | cache_6382 | cache_6380 | cache_6381 | cache_6383 | cache_6385 | influxdb | metrics | confd | cache_6379 | cache_6378 | haproxy | database | analytics | connect | location | configuration | matlabengine | hyperlocation | nmsplb | agent}
For detailed information about these 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
Importing Certificates
Cisco CMX requires certificates for serving the user interface over SSL. You can import self signed certificates or certificate authority (CA) signed certificates to Cisco CMX. Before initiating the import process, ensure that you have a self signed or a CA signed certificate. We recommend you to consult your CA authority to generate certificate signing requests (CSR) and certificates.
The certificate should be in the PEM format (with .pem extension) as shown below:
-----BEGIN RSA PRIVATE KEY----- (Your Private Key: your_domain_name.key) -----END RSA PRIVATE KEY----- -----BEGIN CERTIFICATE----- (Your Primary SSL certificate: your_domain_name.crt) -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- (Your Intermediate certificate: DigiCertCA.crt) -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- (Your Root certificate: TrustedRoot.crt) -----END CERTIFICATE-----
Adding Users and Managing Roles
Using the MANAGE service in Cisco CMX, you can create new users and assign roles to them based on the tasks they have to perform, that is, enabling role-based access control.
The following list displays the types of users:
-
Admin users—An admin user can access all the services and functionalities (based on the license type) of Cisco CMX.
-
Others—An admin user can create other users and assign roles to them.
The following is a list of roles that can be assigned to users:
For more information about the creation of users and assignment of roles, see Managing Users.
Using the Cisco CMX Setup Assistant
The Cisco CMX Setup
Assistant pop-up helps you through the basic steps before you start using your
system. The Cisco CMX Setup Assistant is automatically displayed when you log
in to Cisco CMX. To relaunch the Cisco CMX Setup Assistant, click the Help
(
)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.
Changing Time Zones and NTP Server
After the initial CMX configuration, you can change the time, time zone, and NTP server details using the CLI. You can edit the ntp.conf file to change the NTP server. Ensure that you are logged in as root user to change the NTP settings.
To change time zones and NTP server after initial configuration using CLI, perform the following task:
-
Ensure that your server has a valid hostname before making any NTP changes. If not, some of the ntp commands will fail, for example, ntpstat.
-
Ensure that incoming and outgoing UDP port 123 for NTP communication is open in your configuration setup.
-
Ensure to manually edit /etc/ntp.conf as admin user and appropriate time zone is selected using /opt/cmx/bin/tzselect before restarting ntpd using service ntpd restart.
Feedback