Get Started with CMX Analytics
This chapter provides information on prerequisites, system requirements, and enabling the Cisco CMX analytics service.
Workflow for Setting up the CMX Analytics System
The following table describes the steps to be followed while setting up the CMX analytics system.
Prerequisites for Enabling CMX Analytics Service
- The CMX analytics system takes input from the Cisco Mobility Service Engine (MSE). The CMX analytics is installed as part of the MSE installation but you must select CMX Analytics service explicitly from the list of available services in the Prime Infrastructure UI. For details on enabling the CMX analytics service, see the “Enabling CMX Analytics Service on the Mobility Services Engine” section.
- If you want to use data from specific parts of your network, then you must edit the mse.properties (/opt/mse/analytics/intellify/tools/MSEclient/mse.properties) file in order to select either network, building, or floor that you want to analyze.
Follow these guidelines when editing the mse.properties file.
–
Network, building, or floors—By default, the analytics takes all the data that is available in the MSE. These three settings allow you to download only a subset. For example, if you have three building B1, B2, and B3 in network N and want to run analytics only on building B1 and building B2, then you need to specify as buildings=N>B1,N>B2.
– max-history—By default, when the analytics becomes active for the first time, it searches for the previous three days data in the MSE history file and tries to fetch data if there is any. If there is more data available in the history file and you want to retrieve, then you must set this to a different value.
If you set the max-history to nnnD, then it retrieves nnn days and if you set to nnnW, then it retrieves nnn weeks.
– Control the size of the database—New parameters max-points and reset-points are added in the mse.properties file to help control the size of the database. Once the database reaches the threshold value of 8 million points, it removes the oldest data to reset the size to 7.9 million points.
Note In order for the CMX analytics to access data from the MSE, you must set the history parameters on the MSE. For more information, see the http://www.cisco.com/c/en/us/td/docs/wireless/mse/7-6/MSE_CAS/7_6_MSE_CAS/7_4_MSE_CAS_chapter_010.html#ID136.
Note Depending on your browser and the hardware, images over 2MB may not appear in the 3D environment. In the mse.properties file, set the value of max-dimension. For example, setting max-dimension to 2048 can reduce the resolution of the picture to at most 2048 pixels on the longest side.
– All settings (including the above mentioned information) are documented in the properties file.
- CMX analytics requires both floor plans and coverage areas to be defined in the Prime Infrastructure in order for CMX analytics visualization and reporting to function. You need to provide floor numbers for each floor plan. Floors on the same level should have the same number and floors above should have a higher number. The choice of coverage areas correspond to the zones which you want to report on. If you want to know the details of location A, then an area defining that location should be made available in the Prime Infrastructure.
- You can define at least three GPS markers for each floor in the Prime Infrastructure UI (Optional).
- You need three APs to get reliable location information on the device.
Prerequisites for Defining Inclusion and Exclusion Areas on a Floor
- Inclusion and exclusion areas can be any polygon shape and must have at least three points. Points can sometime be located outside the building. If this is where the devices are, then a coverage area should be created. At other times, the points are actually inside and should be moved to the nearest inside location (same applies for unlikely areas inside). Defining inclusion and exclusion areas does this and therefore the analytic results are more consistent.
- You can only define one inclusion region on a floor. By default, an inclusion region is defined for each floor when it is added to Prime Infrastructure. The inclusion region is indicated by a solid aqua line, and generally outlines the region.
- You can define multiple exclusion regions on a floor.
- Newly defined inclusion and exclusion regions appear on heatmaps only after the mobility services engine recalculates location.
Prerequisites for Monitoring Geo-Location
The MSE provides physical location of wired clients, wired endpoints, switches, controllers, and access points present in a wireless network deployment. Currently, MSE provides location information in geo-location format to the external entities through northbound and southbound entities.
To improve the accuracy of the geo-location information provided by MSE, this feature aims to transform the geometric location co-ordinates of a device to geo-location coordinates (latitude and longitude) and provides it to the external entities through northbound and southbound interfaces.
You need GPS markers only for 2D view and not for 3D view. You can still use 3D view without GPS markers.
Note For CMX Analytics, the 2D OpenStreetMaps requires all points to be geo-located as latitude/longitude in order for the results to be displayed in the correct geographical location.
Note The GPS marker information is required by the CMX analytics to show results for the building in the 2D Open Street Maps view. A warning message is displayed if these GPS markers are not set. The latitude or longitude of the GPS markers can often be obtained through some of the mapping software such as Google maps or Open Street Maps.
Enabling CMX Analytics Service on the Mobility Services Engine
Note When the CMX analytics service is enabled, the presence analytics gets enabled.
To enable CMX analytics service on the mobility services engine within the Prime Infrastructure UI, follow these steps:
Step 1 Launch the MSE admin UI. To launch the MSE admin user interface, type https://mseip/mseui/ in the Web browser or you can launch it from the Cisco Prime Infrastructure (PI) by clicking the MSE name link from Services > Mobility Services Engines page. The MSE admin UI is enabled by default in the Administration > User Preference page.
Step 2 Enter the username and password and click Sign In.
The MSE Admin UI home page appears. All the available MSE services are listed under the Services group box in the Home page.
Step 3 Enable the CMX Analytics service in the Services group box.
Logging into the CMX Analytics User Interface
To log into CMX analytics user interface through a web browser, follow these steps:
Step 1 Log into MSE Admin UI using Username and Password.
Step 2 In the Apps group box, click CMX Analytics Service.
The CMX Analytics User Interface (UI) Login page appears.
Step 3 Enter the username and password.
The CMX analytics home page appears.
WebGL Requirements
The CMX analytics provides ability to view the analytic results in both 2D (Open Street Maps) and 3D (WebGL) environments. This provides improved understanding of results on multiple floor paths, or when dwell times are calculated throughout a multi-storey building. The 3D environment presents the same information as the 2D environment.
WebGL is an advanced feature that provides graphic capabilities. All browsers do not support WebGL on a particular hardware. Verify your browser compatibility at the following URL: http://get.webgl.org/. If your browser supports WebGL, then you must see a spinning cube.
If your browser does not support WebGL, you must do the following:
- Update your latest drivers for video card.
- For Google Chrome, follow the instructions given in the Google Chrome support website.
- For Firefox, follow these steps to enable WebGL:
– In the browser address line, enter about:config
– In the Search text box, enter webgl to filter the settings.
– Double click webgl.forceenabled.
– Make sure that webgl.disables is disabled.
– Download the latest building of Safari browser.
– You must enable the Develop menu and enable the WebGL.
– To enable Develop menu, choose Safari > Preferences.
– Select the Show Develop menu in menu bar check box.
– Choose Enable WebGL from the Develop menu.
Note If your system does not support 3D, then the analytic results are displayed only in 2D Open Street Maps view provided that GPS markers are enabled.
Feedback