Using the Motorola Data Collection Solution with MSP

Transcription

1 Using the Motorola Data Collection Solution with MSP

2

3 Using the Motorola Data Collection Solution with MSP 72E Revision A December 2011

4 2011 by Motorola Solutions, Inc. All rights reserved. No part of this publication may be reproduced or used in any form, or by any electrical or mechanical means, without permission in writing from Motorola Solutions. This includes electronic or mechanical means, such as photocopying, recording, or information storage and retrieval systems. The material in this manual is subject to change without notice. While every reasonable precaution has been taken in the preparation of this document, neither Symbol Technologies, Inc., nor Motorola Solutions, Inc., assumes responsibility for errors or omissions, or for damages resulting from the use of the information contained herein. The software is provided strictly on an as is basis. All software, including firmware, furnished to the user is on a licensed basis. Motorola Solutions grants to the user a non-transferable and nonexclusive license to use each software or firmware program delivered hereunder (licensed program). Except as noted below, such license may not be assigned, sublicensed, or otherwise transferred by the user without prior written consent of Motorola Solutions. No right to copy a licensed program in whole or in part is granted, except as permitted under copyright law. The user shall not modify, merge, or incorporate any form or portion of a licensed program with other program material, create a derivative work from a licensed program, or use a licensed program in a network without written permission from Motorola Solutions. The user agrees to maintain Motorola Solution s copyright notice on the licensed programs delivered hereunder, and to include the same on any authorized copies it makes, in whole or in part. The user agrees not to decompile, disassemble, decode, or reverse engineer any licensed program delivered to the user or any portion thereof. Motorola Solutions reserves the right to make changes to any software or product to improve reliability, function, or design. Motorola Solutions does not assume any product liability arising out of, or in connection with, the application or use of any product, circuit, or application described herein. No license is granted, either expressly or by implication, estoppel, or otherwise under any Motorola Solutions, Inc., intellectual property rights. An implied license only exists for equipment, circuits, and subsystems contained in Motorola Solutions products. Motorola Solutions and the Stylized M Logo and Symbol and the Symbol logo are registered in the US Patent & Trademark Office. All other product or service names are the property of their respective owners. Motorola Solutions, Inc One Motorola Plaza Holtsville, New York

5 Table of Contents About This Guide... 1 MSP Documentation... 1 Service Information... 1 Chapter 1 Introduction... 3 Overview... 3 Varieties of the Motorola Data Collection Solution... 3 Acquiring the Motorola Data Collection Solution... 4 Obtaining Add-On Kits... 4 Add-On Kit for Windows... 4 Add-On Kit for Windows PCs... 4 Add-On Kit for Android... 5 Add-On Kit Installation... 5 Licensing the Motorola Data Collection Solution... 5 Chapter 2 Understanding Data Collection... 7 Overview... 7 Collection Manager... 7 Collection Strings... 7 Collection Modules... 7 Collection APIs... 8 Collection Services... 8 Explicit Naming... 9 Mapped Naming... 9 Collection APIs SystemManager Collection APIs...11 Unparameterized Collection APIs that Return Structured Data...11 MotorolaTools Collection APIs...13 Unparameterized Collection APIs that Return Scalar Data...13 Parameterized Collection APIs that Return Scalar Data...14 RegistryData Collection APIs...27

6 vi -- Using the Motorola Data Collection Solution with MSP Parameterized Collection APIs that Return Scalar Data...27 WwanStats Collection APIs...29 Unparameterized Collection APIs that Return Scalar Data...29 Parameterized Collection APIs that Return Scalar Data...30 GPSInfo Collection APIs...33 Unparameterized Collection APIs that Return Scalar Data...33 Unparameterized Collection APIs that Return Scalar Data...34 Unparameterized Collection APIs that Return Structured Data...35 SmartBatteryInfo Collection APIs...37 Unparameterized Collection APIs that Return Scalar Data...37 Collection Log Files Collection Documents Chapter 3 Security Considerations Overview Sensitivity of Collected Data Storage of Data on Device Delivery of Data to Relay Server Storage of Data on Relay Server Uploading of Data to the MSP Server Storage of Data in the Collected Data Tables Availability of Data via the MSP Console UI Chapter 4 Control Modules Required Control Modules MotorolaDC...43 Purpose...43 Installation...43 Configuration...43 Operation...43 Device Attributes...43 PC_MotorolaDC...44 Purpose...44 Installation...44 Configuration...44 Operation...44 Device Attributes...44 Android_MotorolaDC...44 Purpose...44 Installation...45 Configuration...45 Operation...45 Device Attributes...45 Chapter 5 How the Motorola Data Collection Solution Works Overview High Level Architecture Receiving and Processing Settings Jobs Configuring Data to be Collected Collecting Data Collection Sample Acquisition...49 Handling Suspend and Resume...49 Storing Collected Data When Data Cannot be Collected Delivering Collection Documents... 51

7 Table of Contents -- vii Chapter 6 Using the Motorola Data Collection Solution Overview Prerequisites Suitable MSP Agent Version...53 Deployed Control Module...53 Activated and Applicable Collection Request...54 Correct Device Local Time...54 Using Data Collection and Collected Data Data Collection Solutions Variations... 54

8 viii -- Using the Motorola Data Collection Solution with MSP

9 About This Guide MSP Documentation This document provides information on the Motorola Data Collection Solution. The library of available MSP documentation is extensive and widely available to MSP customers. Customers may obtain the latest version of all documents from: A Documentation library is available by accessing the MSP Console UI online Help. Service Information If you have a problem with your software, contact Motorola Enterprise Mobility support for your region. Contact information is available at: When contacting Enterprise Mobility support, please have the following information available: Serial number of the software Model number or product name Software type and version number Software license information Motorola responds to calls by , telephone or fax within the time limits set forth in support agreements. If you purchased your Enterprise Mobility business product from a Motorola business partner, contact that business partner for support.

10 2 -- Using the Motorola Data Collection Solution with MSP

11 Chapter 1 Introduction Overview This document describes the Motorola Data Collection Solution provided as an add-on to MSP. As an add-on, the components required to use the Motorola Data Collection Solution are not automatically installed with MSP. One or more Add-On Kit(s) must be separately imported into MSP in order to use its functionality. Varieties of the Motorola Data Collection Solution The Motorola Data Collection Solution is separate from, but cooperates with and is dependent on the MSP Client Software running on a device. For more information on the MSP Client Software, refer to the MSP Client Software Guide. The Motorola Data Collection Solution theoretically can be supported on any device for which a variety of the MSP Client Software is available. In practice, a variety of the Motorola Data Collection Solution may or may not be available to support every device that is supported by a variety of the MSP Client Software. This document will describe all the varieties of the Motorola Data Collection Solution that are available and will be updated to reflect new varieties as they become available. Varieties of the Motorola Data Collection Solution are available for Windows (Device Class Mobile Device ), Windows PCs (Device Class Windows PC ) and Android (Device Class Android Device ). For more information on Device Classes, refer to Understanding MSP Understanding Device Classes and Proxies.

12 4 -- Using the Motorola Data Collection Solution with MSP Acquiring the Motorola Data Collection Solution Obtaining Add-On Kits The Motorola Remote Control Solution components are provided via Add-On Kits that are included with MSP and that are separately available for download from the following link: Updated versions of the Add-On Kits containing updated components may also periodically be available for download from the same link. Add-On Kit for Windows The Add-On-Kit for Windows will be a.zip File with a name of the form: MotorolaDC_<version>_<date>.ZIP where: <version> <date> indicates the version number of the software delivered in the Add-On Kit. indicates the release date of the Add-On Kit.ZIP File (represented in YYYYMMDD format). The Add-On Kit.ZIP File contains the following contents: The Motorola Data Collection Solution Control Module Package MotorolaDC.APF. Add-On Kit for Windows PCs The Add-On-Kit for Windows will be a.zip File with a name of the form: MotorolaDC_PC_<core version>_<zip version>_<date>.zip where: <core version> This is the version of the primary component of the Add-On. <zip version> <date> This is a version number that is used to indicate that something has changed in the Add-On other than the primary component. This needs to be reset when the Core Version changes. indicates the release date of the Add-On Kit.ZIP File (represented in YYYYMMDD format). The Add-On Kit.ZIP File contains the following contents: The Motorola Data Collection Solution Control Module Package PC_MotorolaDC.APF.

13 Chapter 1 Introduction -- 5 Add-On Kit for Android * The Add-On-Kit for Android will be a.zip File with a name of the form: MotorolaDC_Android_<core version>_<zip version>_<date>.zip where: <core version> This is the version of the primary component of the Add-On. <zip version> <date> This is a version number that is used to indicate that something has changed in the Add-On other than the primary component. This needs to be reset when the Core Version changes. indicates the release date of the Add-On Kit.ZIP File (represented in YYYYMMDD format). The Add-On Kit.ZIP File contains the following contents: The Motorola Data Collection Solution Control Module Package Android_MotorolaDC.APF The MotorolaDC release notes, MotorolaDC_Release_Notes.txt New Collection Metrics in folder CollectionMetrics Modified Collection Categories to include new collection metrics, in folder CollectionCategories Note: If the Data Collection Category that is being imported is used in a Collection Request that is already activated, then the user is required to de-activate the Collection Request, before proceeding with the Collection Category upload. Once uploaded, the Collection Request can be re-activated to enable data collection. Add-On Kit Installation For Users with direct access to Windows Console on the MSP Server, an Add-On Kit.ZIP File can be installed using the MSP Administration Program. See Add-On Kit Installation in Administering MSP. Licensing the Motorola Data Collection Solution The licensing required to use the Motorola Data Collection Solution for all supported devices is included in the per-device license required to manage a device with MSP. Data Collection can only be used with MSP Control Edition and the act of deploying a the Motorola Data Collection Solution to a device will cause that device to require a Control License if it previously required only a Stage or Provision license. * Android is a trademark of Google Inc. Use of this trademark is subject to Google Permissions.

14 6 -- Using the Motorola Data Collection Solution with MSP

15 Chapter 2 Understanding Data Collection Overview This chapter discusses key concepts required to understand and use the Motorola Data Collection Solution. Key concepts related to all Data Collection solutions are described in Using MSP - Using Data Collection. Collection Manager The MotorolaDC Control Module implements the Motorola Data Collection Solution on a device; within this Control Module the core functionality of Data Collection is implemented by the Collection Manager. The Collection Manager coordinates the collection of data and utilizes a set of Collection Services to acquire Collection Samples for supported Collection Metrics. Data Collection via the Motorola Data Collection Solution is configured via Collection Settings that are sent by the MSP Server. Collection Settings contain Collection Strings which define how each Collection Sample for each Collection Metric are to be acquired. Collection Strings Collection Strings are used to configure Data Collection performed via the Motorola Data Collection Solution. Collection Strings follow the syntax described in Using MSP - Using Data Collection. The semantics of Collection Strings are defined with the standard syntax by specifying Collection Module Names and Collection API Names, potentially qualified by Parameters and/or Field Names, as required for a given Collection API. Collection Modules Collection Strings within Collection Settings are used to configure the Collection Manager to acquire Collection Samples for sets of selected Collection Metrics at selected Collection Frequencies.

16 8 -- Using the Motorola Data Collection Solution with MSP Within the Collection String for a specific Collection Metric, a Collection Module Name must be specified, as described in Using MSP - Using Data Collection. The Collection Module Name directly or indirectly selects a Collection Service that the Collection Manager will use to acquire Collection Samples for that Collection Metric. Not all Collection Modules are supported on all Device Classes. The Collection Modules supported by the available Data Collection Solution Varieties are shown in Table 1 below. Collection Module Name Windows Device Class = Mobile Device? Windows PC Device Class = Windows PC? SystemManager MotorolaTools Partial Partial RegistryData Partial WwanStats No Partial GPSInfo No Partial SmartBatteryInfo No No Android Device Device Class = Android Device? Table 1 Collection Module Support by Data Collection Solution Variety Where a Collection Module is shown as for a given Device Class, all of the APIs defined for that Collection Module are supported by the Motorola Data Collection Solution for that Device Class. Where a Collection Module is shown as No for a given Device Class, none of the APIs defined for that Collection Module are supported by the Motorola Data Collection Solution for that Device Class. Where a Collection Module is shown as Partial for a given Device Class, some of the APIs defined for that Collection Module are supported by the Motorola Data Collection Solution for that Device Class. Check the API table for that Collection Module to see which APIs are and are not supported for that Device Class. Collection APIs Within the Collection String for a specific Collection Metric, a Collection API Name must also be specified, as described in Using MSP - Using Data Collection. A Collection Module Name and a Collection API Name must be paired to determine the exact call that will be made into a Collection Service to acquire Collection Samples for that Collection Metric. Collection Services For Windows and Windows PC, Collection Services are DLLs that implement the ability to acquire Collection Samples for sets of Collection Metrics. Similarly, for Android collection services are implemented as Android services to acquire collection samples. A number of Collection Services are included as part of the Control Module that implements the Motorola Data Collection Solution. New Collection Services also can be developed and plugged into the Motorola Data Collection Solution. All Collection Services used with the Motorola Data Collection Solution must conform to the Collection Service Model defined as part of the Motorola Data Collection Solution. Within the Collection String for a Collection Metric, a Collection Module Name and a Collection API Name are paired to determine the Collection Service that will be used and the function within that Collection Service that will be called to acquire Collection Samples for that Collection Metric. There are two modes by which a Collection Module Name and Collection API Name pair can be used to identify a Collection Service; they are explicit naming and mapped naming.

17 Chapter 2 Understanding Data Collection -- 9 Explicit Naming A Collection Service can be specified by using a Collection Module Name that is the Explicit Name of the DLL (without the path or file extension) or Android Service name that implements the desired Collection Service in the device. In such a case, the Collection API Name must be the exact name of a function exposed by that Collection Service. This mode is commonly used to access Collection Services that are specific to the Motorola Data Collection Solution. It can also be used to access Collections Services implemented by other services that are plugged-into the Motorola Data Collection Solution. Table 2 below lists the Collection Services that are built-into the Control Module for the Motorola Data Collection Solution. Collection Service SystemManager MotorolaTools RegistryData WwanStats GPSInfo SmartBatteryInfo Description This Collection Service provides access to a variety of information about the Operating System of the device. This Collection Service provides access to a variety of information about the device. This Collection Service provides access to information from the Device Registry. This Collection Service provides access to a variety of information from the Wireless Wide Area Network (WWAN) subsystem on the device, if it has one. This Collection Service provides access to a variety of information from the Global Positioning System (GPS) subsystem on the device, if it has one. This Collection Service provides access to a variety of information from the Smart Battery System subsystem on the device, if it has one. Mapped Naming Table 2 Built-in Collection Services A Collection Service can also be specified by using a logical Collection Module Name paired with a Collection API Name. A mapping table maps the pair to a specific Collection Service Plug-In. In such a case, the Collection API Name must also be the exact name of a function exposed by that Collection Service Plugin. For Windows and Windows PC, this mapping information is contained within the Device Registry. In the case of Android devices, this information is stored in a flat file in the Android device. This mode is commonly used to access Collection Metrics that are pre-defined in MSP. If the name of the Collection Service Plug-In that implements a given Collection Metric is not named identically to the Collection Module Name used in the Collection String pre-defined within MSP, this mode allows mapping to the correct Collection Service.

18 10 -- Using the Motorola Data Collection Solution with MSP Table 3 below provides a list of the pairs of Collection Module Names and Collection API Names that are mapped to specific Collection Service Plug-Ins. Collection Module Name Collection API Name(s) Collection Service Plugin MotorolaTools MotorolaTools MotorolaTools SystemManager - Applicable for Android devices only GetRegistryValue GetRegistryValueDelta GetScanAttemptCount GetScanBeamOnTime GetScanCompleteCount GetWlanErrorDelta GetWlanRadioOnTime GetWlanReceiveByteDelta GetWlanReceivePacketDelta GetWlanRetryDelta GetWlanSignalQuality GetWlanTransmitByteDelta GetWlanTransmitPacketDelta ACLineStatus RegistryData ScannerInfo WlanStats MotorolaTools Table 3 Collection Module Name / Collection API Name Mappings Collection APIs The Collection Manager acquires Collection Samples for a given Collection Metric using a Collection API implemented within a Collection Service Plug-In. Collection APIs can be subdivided into the following types based on the format of the Collection String required to call them: Unparameterized Collection APIs that Return Scalar Data These Collection APIs are called by their name and take no parameters. The value returned is numeric and suitable for use as the value of any MSP Data Collection Metric with a data type of FLOAT. Unparameterized Collection APIs that Return Structured Data These Collection APIs are called by their name and take no parameters. The value returned is a structure containing multiple fields. Individual fields of the structure returned may be numeric and suitable for use as the value of any MSP Data Collection Metric with a data type of FLOAT. Parameterized Collection APIs that Return Scalar Data These Collection APIs are called by their name and require that one or more parameter/value pairs be supplied to qualify their operation. The value returned is numeric and suitable for use as the value of any MSP Data Collection Metric with a data type of FLOAT. The Collection APIs implemented by the Collection Service DLLs that are built-into the Control Module that implements the Motorola Data Collection Solution are described in the following sections, categorized by Collection Service.

19 Chapter 2 Understanding Data Collection SystemManager Collection APIs The SystemManager Collection Service Plug-In is generally supported on any Windows CE or Windows Mobile device that supports the relevant standard Microsoft-defined Win32 APIs or Android. The SystemManager Collection Service contains Collection APIs as described in the following sections. Unparameterized Collection APIs that Return Structured Data The SystemManager Collection Service contains an Unparameterized Collection API that returns Structured Data as listed in Table 4 below. API Name GetSystemInfo Description This Collection API returns Structured Data containing a variety of values related to the Operation System on the device. Explanations of the Fields contained within the Structured Data returned by this Collection API are listed in Table 5 below. Table 4 SystemManager Unparameterized Collection APIs that Return Structured Data The GetSystemInfo API in SystemManager Collection Service returns structured data. The fields that are available within the structured data are defined in Table 5 below. Field Name ACLineStatus AvailablePhysicalMemory Description This field returns a value of 1 if the device is currently connected to AC power (i.e. is charging) and a value of 0 if the device is currently running from battery power (i.e. is discharging) Note: This is not applicable for Android devices. In Android devices, this metric is collected as a part of MotorolaTools This field returns the total amount of Physical Memory (Program Memory) in bytes that is currently available for use (i.e. is not currently allocated to some program). Note: The definition of Physical Memory tends to be the same for all versions of Windows CE and Windows Mobile.

20 12 -- Using the Motorola Data Collection Solution with MSP Field Name AvailableStorageMemory Description This field returns the total amount of Storage Memory (a.k.a. File System Memory) in bytes that is currently available for use (i.e. is not currently allocated to hold files). Note that the definition of Storage Memory may be different between different versions of Windows CE and Windows Mobile. Note: In the case of Android devices, this includes the memory available in the SDCard and the phone memory. MemoryLoad TotalMemory TotalPhysicalMemory TotalStorageMemory This field returns the percentage of Total Memory that is currently allocated (i.e. is currently in use and hence is not available for use). This field returns the total amount of memory that is present in the device, and is generally the sum of the values of TotalPhysicalMemory and TotalStorageMemory. This field returns the total amount of Physical Memory (Program Memory) in bytes that is present in the device, whether it is currently available for use (i.e. is not currently allocated to some program) or is currently in use (i.e. is not available for use). Note that the definition of Physical Memory tends to be the same for all versions of Windows CE and Windows Mobile. This field returns the total amount of Storage Memory (File System Memory) in bytes that is present in the device, whether it is currently available for use (i.e. is not currently allocated to hold files) or is currently in use (i.e. is currently allocated to hold files). Note that the definition of Storage Memory may be different between different versions of Windows CE and Windows Mobile. In Android devices, this memory includes the memory in storage card and phone memory Table 5 SystemManager:GetSystemInfo API Structured Data Fields

21 Chapter 2 Understanding Data Collection MotorolaTools Collection APIs The MotorolaTools Collection Service is generally supported on any Windows CE or Windows Mobile device that supports the relevant proprietary Motorola-defined and/or standard Microsoftdefined Win32 APIs. This is also supported on Android. The MotorolaTools Collection Service contains Collection APIs as described in the following sections. Unparameterized Collection APIs that Return Scalar Data The MotorolaTools Collection Service contains Unparameterized Collection APIs as listed in Table 6 below. API Name Description Windows GetBatteryLevel This Collection API returns the current battery level of the device as a percentage of the total capacity of the battery. The value returned can range from 0% to 100%. Windows PCs Android GetWlanSignalQuality ACLineStatus If the device does not have a battery or the level of the battery cannot be determined, then no value will be returned. This Collection API returns the current WLAN signal quality on the device as a percentage of the best possible signal quality. The value returned can range from 0% to 100%. If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, then no value will be returned. This Collection API returns a value of 1 if the device is currently connected to AC power (i.e. is charging) and a value of 0 if the device is currently running from battery power (i.e. is discharging) Note: This metric is collected as a part of System Manager Plug-in in the case of Windows and Windows PC No Table 6 MotorolaTools Unparameterized Collection APIs that Return Scalar Data

22 14 -- Using the Motorola Data Collection Solution with MSP Parameterized Collection APIs that Return Scalar Data The MotorolaTools Collection Service contains Parameterized Collection APIs that return Scalar Data as listed in Table 7 below. API Name Description Windows GetAcChargeTime This Collection API returns the amount of elapsed time in seconds that the device has been connected to AC power (i.e. has been charging) since the last time this Collection API was called for the same named Collection Group. Windows PCs Android GetAcChargeCount Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. This Collection API returns the number of times that the device has been connected to AC power (i.e. has been charging) since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported.

23 Chapter 2 Understanding Data Collection API Name Description Windows GetBacklightOnCount This Collection API returns the number of times that the backlight on the device has been turned on since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. Windows PCs No No Android GetBacklightOnTime If the device does not have a backlight or it is not possible to track the state of the backlight on the device, then no value will be returned. This Collection API returns the amount of elapsed time in seconds that the backlight on the device has been on since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have a backlight or it is not possible to track the state of the backlight on the device, then no value will be returned. No No

24 16 -- Using the Motorola Data Collection Solution with MSP API Name Description Windows GetBatteryLevelDelta This Collection API returns the change in the battery level of the device since the last time this Collection API was called for the same named Collection Group. The value returned can range from -100% to 100%. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. Windows PCs Android GetDeviceCpuTimeDelta If the device does not have a battery or the change in the level of the battery cannot be determined, then no value will be returned. This Collection API returns the change in the amount of CPU time in seconds that has been accrued since the last time this Collection API was called for the same named Collection Group. The value returned can range from 0 to the Collection Frequency of the Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the amount of accrued CPU time cannot be measured, then no value will be returned. No

25 Chapter 2 Understanding Data Collection API Name Description Windows GetDeviceOnTime This Collection API returns the amount of elapsed time in seconds that the device has been powered on since the last time this Collection API was called for the same named Collection Group. Windows PCs No Android GetDisplayOnTime Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. This Collection API returns the amount of elapsed time in seconds that the display on the device has been on since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have a display or it is not possible to track the state of the display on the device, then no value will be returned. No

26 18 -- Using the Motorola Data Collection Solution with MSP API Name Description Windows GetKeylightOnCount This Collection API returns the number of times that the keylight on the device has been turned on since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. Windows PCs No No Android GetKeylightOnTime If the device does not have a keylight or it is not possible to track the state of the keylight on the device, then no value will be returned. This Collection API returns the amount of elapsed time in seconds that the keylight on the device has been on since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have a keylight or it is not possible to track the state of the keylight on the device, then no value will be returned. No No

27 Chapter 2 Understanding Data Collection API Name Description Windows GetPowerCycleCount This Collection API returns the number of times that the device has been powered on since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. Windows PCs No Android

28 20 -- Using the Motorola Data Collection Solution with MSP API Name Description Windows GetProcessCpuTimeDelta This Collection API returns the amount of elapsed CPU time (in seconds) for all processes or for a selected process since the last time this Collection API was called for the same process and the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. To acquire the CPU time for all processes, no additional parameters should be provided. To acquire the CPU time for a specific process, an additional parameter must be provided to supply the executable file name (with file extension but without path) for the process. For example, Process=30agent.exe would request the CPU time for the MSP Agent process. When the CPU time for a specified process is requested and that process is not running, then no value will be returned. Windows PCs Android

29 Chapter 2 Understanding Data Collection API Name Description Windows GetScanAttemptCount This Collection API returns the number of times that the Barcode scanner on the device has been activated (i.e. an attempt to scan a Barcode has been made) since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have a Barcode scanner or it is not possible to track the activation of the Barcode scanner on the device, then no value will be returned. If the device has more than one Barcode scanner, then no value will be returned. Windows PCs No No Android

30 22 -- Using the Motorola Data Collection Solution with MSP API Name Description Windows GetScanBeamOnTime This Collection API returns the amount of elapsed time in seconds that the Barcode scanner on the device has been activate (i.e. that Barcode scanning was being attempted) since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have a Barcode scanner or it is not possible to track the activation of the Barcode scanner on the device, then no value will be returned. If the device has more than one Barcode scanner, then no value will be returned. Windows PCs No No Android

31 Chapter 2 Understanding Data Collection API Name Description Windows GetScanCompleteCount This Collection API returns the number of times that the Barcode scanner on the device has resulted in the successful scanning of a Barcode since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have a Barcode scanner or it is not possible to track the success of Barcode scanning on the device, then no value will be returned. Windows PCs No No Android GetWlanErrorDelta If the device has more than one Barcode scanner, then no value will be returned. This Collection API returns the number of errors that have occurred during WLAN communications on the device since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, then no value will be returned. No No

32 24 -- Using the Motorola Data Collection Solution with MSP API Name Description Windows GetWlanRadioOnTime This Collection API returns the amount of elapsed time in seconds that the WLAN radio on the device has been powered on since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have a WLAN radio or it is not possible to track the operation of the WLAN on the device, then no value will be returned. Windows PCs No Android GetWlanReceiveByteDelta If the device has more than one WLAN radio, then no value will be returned. This Collection API returns the number of bytes that have been received as part of WLAN communications on the device since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, then no value will be returned. No

33 Chapter 2 Understanding Data Collection API Name Description Windows GetWlanReceivePacketDelt a This Collection API returns the number of packets that have been received as part of WLAN communications on the device since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. Windows PCs No Android GetWlanRetryDelta If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, then no value will be returned. This Collection API returns the number of retries that have occurred during WLAN communications on the device since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, then no value will be returned. No No

34 26 -- Using the Motorola Data Collection Solution with MSP API Name Description Windows GetWlanTransmitByteDelta This Collection API returns the number of bytes that have been transmitted as part of WLAN communications on the device since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. Windows PCs No Android GetWlanTransmitPacketDelt a If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, then no value will be returned. This Collection API returns the number of packets that have been transmitted as part of WLAN communications on the device since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WLAN support or it is not possible to track the operation of the WLAN on the device, then no value will be returned. No Table 7 MotorolaTools Parameterized Collection APIs that Return Scalar Data

35 Chapter 2 Understanding Data Collection RegistryData Collection APIs The RegistryData Collection Service Plug-in is generally supported on any Windows CE or Windows Mobile device that supports the relevant standard Microsoft-defined Win32 Registry APIs. In the case of Android devices, in the absence of registry, database is used to store attributes, which can be monitored and collected using the Registry Data Collection APIs. These APIs are not supported on Enterprise Android. Parameterized Collection APIs that Return Scalar Data The RegistryData Collection Service contains Parameterized Collection APIs that return Scalar Data as listed in Table 9 below. API Name GetRegistryValue Description This Collection API returns the value of a specified named REG_SZ or REG_DWORD value in a specified key within the Device Registry for windows devices. For Android, values stored in the Registry DB for the specified key name is returned The required parameters for these Collection APIs are listed in Table 7 below. If the specified named value does not exist in the specified key within the Device Registry or the value exists but is not of type REG_SZ or REG_DWORD, then no value will be returned. If the specified named value exists in the specified key within the Device Registry and is of type REG_DWORD, then the DWORD numeric value will be returned. If the specified named value exists in the specified key within the Device Registry and is of type REG_SZ, then the STRING value will be returned.

36 28 -- Using the Motorola Data Collection Solution with MSP API Name GetRegistryValueDelta Description This Collection API returns the change in the value of a specified named REG_SZ or REG_DWORD value in a specified key within the Device Registry or registry database Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. The additional required parameters for these Collection APIs are listed in Table 9 below. If the specified named value does not exist in the specified key within the Device Registry/ Registry Database or the value exists but is not of type REG_SZ or REG_DWORD, then no value will be returned. If the specified named value exists in the specified key within the Device Registry/Database and is of type REG_DWORD, then the DWORD numeric value will be converted to FLOAT and will be used to compute the delta from the prior sample. If the specified named value exists in the specified key within the Device Registry/Database and is of type REG_SZ, then the STRING value will be converted to FLOAT and will be used to compute the delta from the prior sample. If the STRING value cannot be successfully converted to a FLOAT (e.g. due to a non-numeric string value), then no value will be returned. Note: The change in the registry value will be returned in the first collection interval, after the start of the Motorola Data Collection Engine. The value will be returned in the first collection interval only if this registry value has been previously requested in the collection requests, during the earlier instance of running Motorola Data Collection Table 8 RegistryData Parameterized Collection APIs that Return Scalar Data Parameter Name KeyName Description This parameter identifies the full path to the desired Registry Key. For example, KeyName= HKEY_LOCAL_MACHINE\Comm. In the event that the specified Registry Key does not exist, then no value will be returned.

37 Chapter 2 Understanding Data Collection Parameter Name ValueName Description In the case of Android, the key name will be stored in the database. This parameter identifies the name of the value to be extracted from the specified Key. For example, ValueName=BootCount would get the number of times the device has rebooted. In the event that no value of the specified name exists under the specified Registry Key or a value exists but is not of type REG_SZ or REG_DWORD, then no value will be returned. Table 9 GetRegistryValue and GetRegistryValueDelta Parameters WwanStats Collection APIs The WwanStats Collection Service is generally supported on Android devices and on any WWAN-equipped Windows Mobile Phone Edition device that supports the relevant standard Microsoft-defined Win32 RIL APIs Unparameterized Collection APIs that Return Scalar Data The WwanStats Collection Service contains Unparameterized Collection APIs that return Scalar Data as listed in Table 10 below. API Name Description Windows WwanErrorRate This Collection API returns the bit error rate, in one hundreths of one percent, as of the time the call is made. Android If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, then no value will be returned. Note that this is not supported in CDMA based Android Phones. In GSM based phones, this metric will be reported if the specific model supports this feature

38 30 -- Using the Motorola Data Collection Solution with MSP API Name Description Windows WwanSignalQuality This Collection API returns the current WWAN signal quality on the device as a percentage of the best possible signal quality. The value returned can range from 0% to 100%. Android If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, then no value will be returned. Table 10 WwanStats Unparameterized Collection APIs that Return Scalar Data Parameterized Collection APIs that Return Scalar Data The WwanStats Collection Service contains Parameterized Collection APIs that return Scalar Data as listed in Table 11 below. API Name Description Windows Android WwanIncomingCallAttempts This Collection API returns the number of incoming call attempts that have been made since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, then no value will be returned.

39 Chapter 2 Understanding Data Collection API Name Description Windows WwanIncomingCallCompleti ons This Collection API returns the number of incoming calls that have been successfully connected since the last time this Collection API was called for the same named Collection Group. Android Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, then no value will be returned. WwanIncomingCallDuration This Collection API returns the amount of elapsed time in seconds that incoming calls have been in progress since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, then no value will be returned. WwanOnTime This Collection API returns the amount of elapsed time in seconds that the WWAN radio on the device has been powered on since the last time this Collection API was called for the same named Collection Group. Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have a WWAN radio or it is not possible to track the operation of the WWAN on the device, then no value will be returned. If the device has more than one WLAN radio, then no value will be returned.

40 32 -- Using the Motorola Data Collection Solution with MSP API Name Description Windows WwanOutgoingCallAttempts This Collection API returns the number of outgoing call attempts that have been made since the last time this Collection API was called for the same named Collection Group. Android Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, then no value will be returned. On some Android phones, support for trapping outgoing calls may not be available. On such phones, this metric may report no information (i.e. values of zero). WwanOutgoingCallCompleti ons This Collection API returns the number of outgoing calls that have been successfully connected since the last time this Collection API was called for the same named Collection Group. No No Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, then no value will be returned.

41 Chapter 2 Understanding Data Collection API Name Description Windows Android WwanOutgoingCallDuration This Collection API returns the amount of elapsed time in seconds that outgoing calls have been in progress since the last time this Collection API was called for the same named Collection Group. No Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. If the device does not have WWAN support or it is not possible to track the operation of the WWAN on the device, then no value will be returned. Table 11 WwanStats Parameterized Collection APIs that Return Scalar Data GPSInfo Collection APIs The GPSInfo Collection Service DLL is generally supported on any GPS-equipped Windows CE or Windows Mobile device that supports the relevant standard Microsoft-defined Win32 GPS APIs. Unparameterized Collection APIs that Return Scalar Data The GPSInfo Collection Service contains Unparameterized Collection APIs that return Scalar Data as listed in Table 12 below. API Name Description Windows Android GetDeviceState This Collection API returns the state of the GPS Device. GetServiceState This Collection API returns the state of the GPS Service. No Table 12 GPSInfo Unparameterized Collection APIs that Return Scalar Data

42 34 -- Using the Motorola Data Collection Solution with MSP Unparameterized Collection APIs that Return Scalar Data The GPSInfo Collection Service contains Unparameterized Collection APIs that return Scalar Data as listed in Table 13 below. API Name Description Windows GetDeviceStateOnTime This Collection API returns the time, in seconds, the GPS in Device has been active (i.e. is powered on). The GPS of Device could be powered on and off multiple times within a given time interval and the accumulated time spent active will be reported. Android Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. GetServiceStateOnTime This Collection API returns the time, in seconds, the GPS Intermediate Service has been active (i.e. is operative). The GPS Service could be activated and deactivated within a given time interval and the accumulated time spent active will be reported. No Since this Collection API is intended to acquire Collection Samples for Quantity Metrics, the name of the Collection Group must be passed as the first parameter. No other parameters are supported. Table 13 GPSInfo Parameterized Collection APIs that Return Scalar Data

43 Chapter 2 Understanding Data Collection Unparameterized Collection APIs that Return Structured Data The GPSInfo Collection Service contains an Unparameterized Collection API that returns Structured Data as listed in Table 14 below. API Name GetGPSPosition Description This Collection API returns Structured Data containing a variety of values related to the GPS Position of the device Explanations of the Fields contained within the Structured Data returned by this Collection API are listed in Table 13 above. Table 14 GPSInfo Unparameterized Collection APIs that Return Structured Data The GetGPSPosition API in GPSInfo Collection Service returns structured data. The fields that are available within the structured data are defined in Table 15 below. Field Name Description Windows GetAltitudeWRTEllipsoid GetAltitudeWRTSeaLevel GetHeading GetHorizontalDilutionOfPrecision GetGPSLocation GetMagneticVariation This field returns the height, in meters, above the reference ellipsoid used to approximate the earth s surface. This field returns the height, in meters, above Mean Sea Level (MSL). This field returns the direction of travel, expressed as an angle of motion, in degrees, relative to Magnetic North. This field returns the degree to which the horizontal position (latitude and longitude) is affected by horizontal dilution of position (HDOP). HDOP is caused by the location of the satellites providing the GPS fix. Lower numbers indicate a more accurate position. A value of 1.0 indicates the least dilution (highest accuracy); a value of 50.0 indicates the most dilution (lowest accuracy) This field returns the current position on the earth as a latitude and longitude pair, in decimal degrees. This field returns the angular difference, in decimal degrees, between True North and Magnetic Android No No No

44 36 -- Using the Motorola Data Collection Solution with MSP Field Name Description Windows GetPositionalDilutionOfPrecision GetSatellitesCount GetSatellitesInView GetSpeed GetUTCTime GetVerticalDilutionOfPrecision North. This field returns the degree to which the overall position is affected by positional dilution of position (PDOP). PDOP is caused by the location of the satellites providing the GPS fix. Lower numbers indicate a more accurate position. A value of 1.0 indicates the least dilution (highest accuracy); a value of 50.0 indicates the most dilution (lowest accuracy). This field returns the number of satellites used to calculate the position. This field returns the number of satellites in view of the GPS device. This field returns the speed of travel, in knots (nautical miles per hour). This field returns the time of the sample as reported by the GPS device, in the fixed format: MM/DD/YYYY HH:MM:SS. This field returns the degree to which the vertical position (altitude) is affected by vertical dilution of position (VDOP). VDOP is caused by the location of the satellites providing the GPS fix. Lower numbers indicate a more accurate position. A value of 1.0 indicates the least dilution (highest accuracy); a value of 50.0 indicates the most dilution (lowest accuracy). Android No No Table 15 GPSInfo: GetGPSPosition API Structured Data Fields

45 Chapter 2 Understanding Data Collection SmartBatteryInfo Collection APIs The SmartBatteryInfo Collection Service DLL is generally supported on any Windows CE or Windows Mobile device that supports the relevant proprietary Motorola-defined Smart Battery API. This is not applicable for Android devices. Unparameterized Collection APIs that Return Scalar Data The SmartBatteryInfo Collection Service contains Unparameterized Collection APIs that return Scalar Data as listed in Table 16 below. API Name BatteryChargeCyclesChange BatteryChargeCycles BatteryTemperatureChange BatteryTemperature Description This Collection API returns the change in the number of Battery Charge Cycles for the device. This Collection API returns the number of Battery Charge Cycles for the device. This Collection API returns the change in the Battery Temperature of the device. This Collection API returns the Battery Temperature of the device. Table 16 SmartBatteryInfo Unparameterized Collection APIs that Return Scalar Data Collection Log Files Collection Log Files are used to store Collection Samples on the device before they are converted into the format in which they will be delivered to the MSP Server via the Relay Server. Each Collection Log File is stored in a text format that is internal to the Motorola Data Collection Solution and not published for external use. There will be at most one Collection Log File created in a device at any one time for each Collection Group. Each Collection Log File is named based on the identifier of its associated Collection Group and is stored in the Data subfolder under the subfolder in the Device File System where the Control Module is installed. The Collection Log Files in the case of Consumer Android devices is stored in the external storage system (SD Card). For Enterprise Android, log files are placed in the enterprise/motoroladc folder. Typical file names for Collection Log Files are 1.nv, 2.nv, and 3.nv. When the Collection Sample Time arrives for a particular Collection Group, Collection Samples are acquired in accordance to the Collection String defined for each Collection Metric requested by that Collection Group. All data samples that were successfully acquired will be appended to the end of the Collection Log File for that Collection Group. Collection Documents When the time comes to deliver data to MSP via a Relay Server, the data samples stored in each Collection Log File is converted into a corresponding Collection Document. Collection Documents are stored in a compressed but unencrypted format that is defined by MSP and is described in Using MSP - Using Data Collection.

46 38 -- Using the Motorola Data Collection Solution with MSP Once all the data for a Collection Group in the Collection Log File has been converted into a Collection Document, then that Collection Log File is deleted. Collection Log File for each Collection Group will then be created as needed when the next Collection Sample Time for that Collection Group arrives.

47 Chapter 3 Security Considerations Overview This section considers the most common Security concerns that may be important to consider when using the Motorola Data Collection Solution. Sensitivity of Collected Data The Motorola Data Collection Solution is designed to collect information about the status, operation, and performance of devices. Since devices could be engaged in activities where proprietary or sensitive data is acquired or utilized by applications, it may be a natural concern whether any data being collected by the Motorola Data Collection Solution could be of a sensitive nature. The set of pre-defined Collection Metrics in MSP is described in Using MSP - Using Data Collection. These pre-defined Collection Metrics are all focused on physical aspects of the device as opposed to data or application aspects of the device. Collected data can include information on batteries and charging, device performance, and resource usage (memory, CPU, peripheral activity, WLAN activity, etc.). As can be seen, none of these pre-defined Collection Metrics deal directly with the content of any data collected by or used by applications, and hence would normally not be involved in the collection of sensitive information. The only possible exception might be device usage statistics which could reflect the performance of Device Users and could, under some circumstances, could be deemed to have Human Resources implications. Since the Motorola Data Collection Solution is extensible, it is possible to extend it to collect other information from the device. If such extensions are used to collect sensitive or proprietary data, then the handling of that data will be identical to the handling of all other data. It may therefore be advisable to understand the end-to-end handling of all data collected using the Motorola Data Collection Solution, as discussed in the following sections, and to assess whether that handling could in any way compromise the security of that data. When in doubt, it may be prudent to avoid the collection via the Motorola Data Collection Solution of any data that is considered sensitive.

48 40 -- Using the Motorola Data Collection Solution with MSP Storage of Data on Device As discussed elsewhere in this document, all Collection Samples for all Collection Metrics collected by the Motorola Data Collection Solution on a device are stored in Collection Log Files in the file system of that device or in external storage for Consumer Android devices or in enterprise/motoroladc folder for Enterprise Android devices. Such files are stored unencrypted and will reside on the device until the MSP Agent determines that it is time to deliver it. If any of the data being collected is considered sensitive in any way, as discussed in the prior section, then consideration should be given to whether the storage of that data unencrypted in Collection Log File could in any way compromise the security of that data. If the data comes from other locations in the device where it is stored unencrypted, then the storage of the additional storage of the data in unencrypted the Collection Log File should not materially affect the security of that data. However, the security of any data that is normally secured by encryption could be compromised if it is elected to be collected via the Motorola Data Collection Solution. Delivery of Data to Relay Server As discussed elsewhere in this document, when the MSP Agent decides it is time to deliver Collected Data, any Collection Log File containing Collection Samples are converted into compressed Collection Documents and stored in the file system of the device until they can be successfully delivered to the Relay Server. Like Collection Log Files, Collection Documents are stored unencrypted. Consequently, if it is deemed that storage of sensitive data in Collection Log Files is a security risk, then storage of that data in Collection Documents likely represents the same risk. Unlike Collection Log Files, which are only stored on the device, Collection Documents are intended to be transferred off the device. Consequently, any risk of compromising the security of potentially sensitive data stored in Collection Documents may be of more concern. The transfer of Collection Documents to the Relay Server is accomplished using the same protocol defined for all communications between the device and the Relay Server. If the protocol selected is FTP, then the unencrypted Collection Documents could be subject to interception and/or alteration during transfer. If the protocol selected is FTPS, then the Collection Documents would be protected against interception or alteration during transfer to the Relay Server. Storage of Data on Relay Server The three-tier architecture of MSP means that all communications between the MSP Server and any device happens via a Relay Server. In the case of Collected Data, Collection Documents are transferred from the device to the Relay Server and are stored on that Relay Server until they are asynchronously uploaded and deleted by the MSP Server. As such, if sensitive information is contained with an unencrypted Collection Document, it may be vulnerable while that Collection Document resides on that Relay Server. Since the FTP protocol is Inherently Non-Secure, if the Relay Server is configured to allow the use of the FTP protocol, then a malicious entity could intercept login credentials by sniffing the network while an authorized entity is accessing the Relay Server using the FTP protocol. Once in possession of valid login credentials, the malicious entity would have the same access to the Collection Documents stored on that Relay Server as the authorized entity. By configuring a Relay Server to disallow the FTP protocol and only allow the FTPS protocol, such vulnerabilities can be eliminated.

49 Chapter 3 Security Considerations - 41 If a Relay Server exposes any other protocols which might provide access to that portion of the file system in which Collection Documents are stored, then the security of the data in those Collection Documents might also be at risk. It would generally be advisable to disable or suitably secure any such protocols that might be used compromise the security of Collection Document if those Collection Documents may contain sensitive data. It should be noted that some Relay Servers may offer the option to encrypt data stored in the file system. Such encryption may provide some security against manually accessing or tampering with the data. But file system encryption generally cannot protect against access to the data using exposed protocols such as FTP or FTPS since they must, by definition, provide access to the unencrypted data. Uploading of Data to the MSP Server Periodically, the MSP Server connects to each Relay Server and uploads and then deletes Collection Documents. This process is subject to the same over-the-air security considerations previously described for delivery of data to the Relay Server. Use of the FTPS protocols is advised whenever the data contained within Collection Documents is considered sensitive. Storage of Data in the Collected Data Tables When the MSP Server processes uploaded Collection Documents, it extracts Collection Samples and stores them into the Collected Data Tables of the MSP Database. No means to encrypt or otherwise protect Collected Data stored in the MSP Database is provided. If the instance of SQL Server on which the MSP Database is hosted is remote from the MSP Server, all Collected Data will be transferred to the Collected Data Tables unencrypted using the SNI protocol and hence could be subject to interception and/or alteration. Further, once the data is in the MSP Database, it is subject to access by any entity that is in possession of the credentials needed to access that database. In addition, if the MSP Asset Reporting feature is turned on, then Collected Data will also be stored in a separate set of tables designed for ease of Asset Reporting using external applications (e.g. Crystal Reports). While the MSP Asset Reporting Tables can be highly valuable for providing access to Collected Data, they could also represent a serious security risk if any sensitive data is collected. Availability of Data via the MSP Console UI Once Collected Data is stored in the Collected Data Tables of the MSP Database, it is available for access to users of the MSP Console UI. The MSP Server treats all Collected Data equivalently and has no provision for treating any Collected Data as more sensitive than any other Collected Data. Consequently, any sensitive data collected from a device using the Motorola Data Collection Solution will be available to any user authorized to view Collected Data for that device via the MSP Console UI.

50 42 -- Using the Motorola Data Collection Solution with MSP

51 Chapter 4 Control Modules Required Control Modules MotorolaDC Purpose The MotorolaDC Control Module deploys the components necessary to implement the Motorola Data Collection Solution on supported Windows (Device Class Mobile Device ). Installation This Control Module is implemented by the Package MotorolaDC.APF. This Package should be deployed to a Windows Device if Motorola Data Collection functionality is required. Configuration This Control Module has no settings that are directly user-configurable. The Data Collection functionality of this Control Module will be indirectly configured by MSP to collect data as a result of one or more Data Collection Requests. Operation See Chapter 5 How the Motorola Data Collection Solution Works for information on the operation of this Control Module. Device Attributes This Control Module has no Control Module-specific Device Attributes that it uses to indicate what it has done. However, when the MSP Agent detects that this Control Module is installed, it changes the value of the Device Attribute Agent.Feature to have a value of control to indicate to MSP that the device can now support monitoring. If the Control Module is uninstalled, the MSP Agent changes the value of the Device Attribute Agent.Feature to have a value of provision to indicate to MSP that the device can no longer support monitoring.

52 44 -- Using the Motorola Data Collection Solution with MSP In addition, the MSP Server will create Device Attributes that report the most recent samples of Collection Metrics reported as a result of Data Collection. While those Device Attributes are not directly set by the Control Module, they are an indirect result of the Data Collection performed by the Control Module. PC_MotorolaDC Purpose This Control Module deploys the components necessary to implement the Motorola Data Collection Solution on supported Windows PCs (Device Class Windows PC ). Installation This Control Module is implemented by the Package PC_MotorolaDC.APF. This Package should be deployed to a Windows PC if Motorola Data Collection functionality is required. Configuration This Control Module has no settings that are directly user-configurable. The Data Collection functionality of this Control Module will be indirectly configured by MSP to collect data as a result of one or more Data Collection Requests. Operation See Chapter 5 How the Motorola Data Collection Solution Works for information on the operation of this Control Module. Device Attributes This Control Module has no Control Module-specific Device Attributes that it uses to indicate what it has done. However, when the MSP Agent detects that this Control Module is installed, it changes the value of the Device Attribute Agent.Feature to have a value of control to indicate to MSP that the device can now support monitoring. If the Control Module is uninstalled, the MSP Agent changes the value of the Device Attribute Agent.Feature to have a value of provision to indicate to MSP that the device can no longer support monitoring. In addition, the MSP Server will create Device Attributes that report the most recent samples of Collection Metrics reported as a result of Data Collection. While those Device Attributes are not directly set by the Control Module, they are an indirect result of the Data Collection performed by the Control Module. Android_MotorolaDC Purpose This Control Module deploys the components necessary to implement the Motorola Data Collection Solution on supported Android (Device Class Android Device ).

53 Chapter 4 Control Modules Installation This Control Module is implemented by the Package Android_MotorolaDC.APF. This Package should be deployed to an Android Device if Motorola Data Collection functionality is required. Configuration This Control Module has no settings that are directly user-configurable. The Data Collection functionality of this Control Module will be indirectly configured by MSP to collect data as a result of one or more Data Collection Requests. Operation See Chapter 5 How the Motorola Data Collection Solution Works for information on the operation of this Control Module. Device Attributes This Control Module has no Control Module-specific Device Attributes that it uses to indicate what it has done. However, when the MSP Agent detects that this Control Module is installed, it changes the value of the Device Attribute Agent.Feature to have a value of control to indicate to MSP that the device can now support monitoring. If the Control Module is uninstalled, the MSP Agent changes the value of the Device Attribute Agent.Feature to have a value of provision to indicate to MSP that the device can no longer support monitoring. In addition, the MSP Server will create Device Attributes that report the most recent samples of Collection Metrics reported as a result of Data Collection. While those Device Attributes are not directly set by the Control Module, they are an indirect result of the Data Collection performed by the Control Module.

54 Using the Motorola Data Collection Solution with MSP -- 46

55 Chapter 5 How the Motorola Data Collection Solution Works Note: Figure 1 Motorola Data Collection Solution High Level Architecture In the case of Android, Android APIs /notifications will be used to collect device metrics.

56 48 -- Using the Motorola Data Collection Solution with MSP Overview This section describes how the Motorola Data Collection Solution functions. While the information in this section will help provide a more complete understanding of the Motorola Data Collection Solution, readers may nonetheless choose to skip ahead to Chapter 6 Using the Motorola Data Collection Solution, to get started right away. High Level Architecture The high level architecture of the MSP Data Collection process, when the Motorola Data Collection Solution is used, is illustrated in Figure 1 above. As shown in Figure 1 above, the Data Collection process begins as follows: 1. One or more Collection Requests that are Applicable to the device are activated. 2. The MSP Policy Engine aggregates all Activated Collection Requests that are Applicable to the device to create a Collection Settings that describes one or more Collection Groups. 3. The MSP Policy Engine delivers the Collection Settings as a Settings Job to the Relay Server to which the device is assigned. 4. The MSP Agent checks-in with the Relay Server and pulls down and executes the Settings Job. 5. The MSP Agent extracts the Collection Settings from the Settings Job and passes them to the RD Client. 6. The RD Client passes the Collection Settings to the Collection Settings Plug-In. 7. The Collection Settings Plug-In processes the Collection Settings to determine which Collection Metrics should be collected at what Collection Frequencies and stores this information in the Collection Config File. Once the above steps have occurred, the Motorola Data Collection Solution has been configured to collect the requested data. The Data Collection process then proceeds as follows on the device: 1. When the Collection Sample Time for a Collection Group arrives, the Collection Manager wakes up and calls the appropriate Collection API in the appropriate Collection Service to acquire a Collection Sample for each Collection Metric defined in the Collection Group. 2. The Collection Manager adds the acquired Collection Samples to the Collection Log File for the Collection Group. 3. When the time to deliver Collected Data arrives, the MSP Agent wakes up and requests the Collection Manager to prepare all Collection Log Files for transmission. 4. The Collection Manager converts all the data in the Collection Log File for each Collection Group to a Collection Document and then deletes each Collection Log File. 5. The MSP Agent delivers the Collection Documents to the Relay Server. In parallel, the Data Collection process proceeds as follows on the MSP Server: 1. The MSP Collection Service wakes up and connects to the Relay Server. 2. The MSP Collection Service uploads a Collection Document. 3. The MSP Collection Service processes the Collection Samples in the Collection Document and stores them into the Collected Data Tables in the MSP Database.

57 Chapter 5 How the Motorola Data Collection Solution Works The MSP Collection Service deletes the Collection Document from the Relay Server. Key aspects of the above process are further detailed in the following sections. Receiving and Processing Settings Jobs The MSP Agent executes Settings Jobs just like any other Job. A Settings Job contains a Settings Object that is associated with the Collection Settings Plug-In that is part of the MotorolaDC Control Module. The Collection Settings Plug-In is responsible to process the Settings as appropriate to configure Collection Groups as requested by the MSP Server. Configuring Data to be Collected In particular, the Settings will specify a series of Collection Groups, each with a unique Collection Frequency. The Settings will specify the Collection String for each Collection Metrics that should be collected as part of each Collection Group. This information is all stored in the Collection Config File which will be used to direct the ongoing operation of the Motorola Log Manager. Collecting Data Based on the information stored in the Collection Config File, Collection Manager determines the next Collection Sample Time for each Collection Group. When the Collection Sample Time for a Collection Group arrives the Collection Manager wakes up to collect the appropriate data for that Collection Group. Collection Sample Acquisition Each Collection Sample is acquired by interpreting the Collection String defined for a given Collection Metric as indicated in the Collection Settings applied to the device. Based on the Collection String, a Collection Service is selected along with a Motorola Data Collection within it. Also, based on the Collection String, the need for any parameters to be passed to that API are determined. Once everything needed to call the API is prepared, the API is called and the return value of that API is acquired. If the return value is Scalar, then the value is recorded with the name supplied in the Collection String. If the return value is structured, then the value of the field specified in the Collection String is extracted from the returned structure and recorded with the name supplied in the Collection String. Handling Suspend and Resume Data Collection will only occur when a Windows Device or Windows PC is active (not suspended). This is intentional since waking up a device that is inactive just to collect data could cause a severe reduction in battery life. For Android devices, Data Collection will occur even when the device is in the sleep state. The Android OS generates notifications for battery, GPS etc even in the sleep state, which causes the plug-in services of MotorolaDC to wake up and act on them.

58 50 -- Using the Motorola Data Collection Solution with MSP Notes: The Motorola Data Collection Solution does not provide a means to wake up (resume) a windows device when the Collection Sample Time for a Collection Group arrives. The MSP Agent can be configured to wake up (resume) a device at a specified time to perform check-in. This feature could be used to indirectly cause periodic Data Collection to occur even if a device is suspended. This approach should be used with caution to avoid causing unacceptable battery drain. If a device is inactive when the Collection Sample Time for a Collection Group arrives, Data Collection for that Collection Sample Time will not occur since the device is suspended. When the device subsequently becomes active (resumes) for any reason, Data Collection will proceed as follows: Collection Samples for all Collection Metrics in the Collection Group will be acquired shortly after the resume and will be time stamped with the time of the first missed Collection Sample Time (i.e. the first Collection Sample time that would have occurred had the device remained active). No Collections Samples will be reported for any other missed Collection Sample Times. The first Collection Sample Time after the resume will include data from the time of the resume until that Collection Sample Time. Subsequent Collection Sample Times will proceed as normal so long as the device remains active. Storing Collected Data As Collection Samples are collected, they are stored into the Collection Log File for the Collection Group to which they belong. A separate Collection Log File is maintained on the device for each Collection Group, with one Collection Group for each Collection Frequency at which one or more Collection Metrics are being collected. At each Collection Sample Time for a given Collection Group, a Collection Sample is acquired for of all Collection Metrics being collected at that frequency is taken, if possible, and is appended into the Collection Log file for that frequency. Each sample is time-stamped in device local time to indicate when it was collected. This means that the date and time on a device must be set correctly for Collected Data to be properly reported. The DateAndTime Control Module, as described in Understanding MSP 3.3 Understanding Control Modules, can be used to ensure that the local time on the device is set appropriately. When Data Cannot be Collected There will times when data cannot be collected by a device, including: Collection Metric not Supported on Device Not all devices are created equal and not all devices are capable of collecting all Collection Metrics. All requested Collection Metrics will be collected, if possible, based on the device capabilities. If one or more Collection Metrics cannot be collected, those that can be collected will be. No error messages or other indications will be produced for Collection Metrics that could not be collected. Missing Control Module

59 Chapter 5 How the Motorola Data Collection Solution Works If none of the Control Modules that support Data Collection is installed on a device, then the device cannot be configured to collect any data. Device is Suspended As mentioned earlier, if a device is inactive (suspended) when the scheduled Collection Sample Time for a Collection Group arrives, then Data Collection will not occur on that device for that Collection Group at that time. This is applicable only for Windows Device and Windows PC Device Storage is Full If the storage space of a device becomes too full to permit additional samples to be stored, then the recording of Collection Samples for one or more scheduled Collection Sample Times may be missed for one or more Collection Groups. Motorola is configured to stop the storage of Collection Samples well before the point of adverse impact to other applications. Once storage of Collection Samples has stopped, device operation will generally continue even thought data reflecting that activity is no longer being sampled. When adequate storage space is again available on the device to permit sampling to be started again, the next Collection Sample Time will be able to sample the data reflecting the operation of the device. For Reading Metrics, the value reported will be the value at that time. For Quantity Metrics the value reported will be the total accumulated since the prior successful Collection Sample was taken. This means that the value reported may be quite large compared to values that have not been accumulated over multiple Sample Intervals. The help deal with this situation, the number of Sample Intervals over which the value was allowed to accumulate will be reported along with the value. This approach was deemed superior to losing the information altogether. At least it allows the total quantity of activity to be reported even when the exact distribution of that activity cannot be reported. MSP will be unable to accurately depict the distribution of the activity across the time when the data was collected. Instead, MSP will divide the total activity evenly across the number of Sample Intervals the data covers. For example, even if the Collection Frequency is 15 minutes, activity might end up being accumulated over several hours, because individual samples could not be collected. In such a case, the total activity would be evenly divided among the 15-minute Sample Intervals during which individual samples could not be collected. By reporting total activity, the ability to aggregate the data to the day, week, etc. is preserved. And lack of granularity generally becomes irrelevant to statistical evaluation based on longer time periods. USB Storage mode for Consumer Android USB Storage mode will interfere with the ability of MotorolaDC to access the external storage (SD Card) in case of Consumer Android. As a result, data cannot be collected when in USB Storage Mode and MotorolaDC application will be shutdown by the Android OS. When the USB storage is un-mounted, MotorolaDC will be restarted by the MSP Client and data collection will start as before Delivering Collection Documents Periodically, during check-in, the MSP Agent requests the Motorola Data Collection Solution to prepare all the samples in each Collection Log File. Each Collection Log File is compressed into a separate Collection Document. The Collection Log Files on the devices are then cleared to make room for future Collection Samples. This avoids a double footprint since any given sample is either in a Collection Log or a Collection Document, but not both.

60 52 -- Using the Motorola Data Collection Solution with MSP The MSP Agent will only ask for the preparation of Collection Documents when it is actually checking in with its assigned Relay Server. If a lack of connectivity or an unmet Check-In Condition prevents the MSP Agent from actually checking in with its assigned Relay Server, then Collection Documents will not be prepared and all samples will be left in the Collection Log files into which they were collected. The MSP Agent can be configured to prepare Collection Documents every time it successfully checks-in with its assigned Relay Server or only after a specified number of check-ins (from the last time a Collection Document was prepared). Once the MSP Agent has one or more Collection Documents, it delivers them to the Relay Server, if possible, during the same check-in during which they were prepared. Once a Collection Document is delivered, it will be deleted from the device to free up space for additional samples to be collected. It is possible that the MSP Agent could fail to successfully deliver one or more Collection Documents to its assigned Relay Server. This could occur due to a loss of connectivity or due to a constraint imposed by MSP on the number of Collection Documents that are allowed to be stored on a single Relay Server. If the MSP Agent fails to deliver one or more Collection Documents, it will continue to try and deliver them every time it checks-in with that Relay Server until has successfully delivered them. The MSP Agent will not ask for the preparation of additional Collection Documents until it has successfully delivered those it already has. A sustained inability to deliver prepared Collection Documents, combined with the continued growth of Collection Log Files will eventually result in an inability to collect further samples due to a lack of available storage space. This is handled as described in the previous section.

61 Chapter 6 Using the Motorola Data Collection Solution Overview This chapter describes how to use the Motorola Data Collection Solution. This chapter will focus only on usage factors that are unique to the Motorola Data Collection Solution. For a general description of using Data Collection from with MSP, see Using MSP Using Data Collection. For information on how to use all data collected, including that collected via the Motorola Data Collection Solution, see Using MSP Using Collected Data. Prerequisites This section details the prerequisites that must be met to successfully use the Motorola Data Collection Solution to collect data from devices. Suitable MSP Agent Version To support Data Collection using the Motorola Data Collection Solution, a device must have a version of the MSP Agent 5.00 or higher. If a device has an earlier version of the MSP Agent, then the MSP Agent must be updated to a suitable newer version before the Control Modules for any Data Collection Solution can be deployed and used to collect data from that device. Deployed Control Module To use the Motorola Data Collection Solution to collect data from a device, the device must have one of the Control Modules that implement the Motorola Data Collection Solution deployed. These Control Modules are described in Chapter 1 Introduction. The appropriate Control Module could be Staged into the device via a Staging Profile or could be sent to the device using a Provisioning Policy or Action. Once an appropriate Control Module has been deployed to the device, the device will report the Device Attribute Agent.Feature as having a value of control. This will indicate to MSP that the device is capable of performing Data Collection. It also will indicate to MSP that a Control Edition license must be allocated to support the functionality that is now supported for that device. It is thus advisable to avoid the deployment of the Control Module to support the Motorola Data

62 54 -- Using the Motorola Data Collection Solution with MSP Collection Solution to devices for which MSP Control Edition features will not be used. Activated and Applicable Collection Request Once a device has the appropriate Control Module deployed to support the Motorola Data Collection Solution and has reported to MSP that it is capable of performing Data Collection, an Activated Collection Request Object can become Applicable to that device. An Activated Collection Request Object that is Applicable to a device is a prerequisite to collecting data from that device and causes MSP to configure the device to collect data, as described in Using MSP Using Data Collection. Correct Device Local Time When using the Motorola Data Collection Solution to collect data for a device, all Collection Samples are time are stamped based on the local time and date on the device at the time they were collected. As discussed in Using MSP Using Data Collection, the MSP Server will discard any Collection Samples whose time stamp is nonsensical. This means that the local time and date on a device must be set reasonably correctly before any Collected Data acquired by the Motorola Data Collection Solution on that device will be accepted by MSP. For example, as described in Understanding MSP Understanding Device Reboots and Persistence, many devices will have their time and date reset to some pre-determined value in the event of a Restore Boot. This value is generally dependent on when the Operating System for the device was released. In most cases, such a time and date reversion will be seen as a nonsensical time stamp by MSP, resulting in Collection Samples being discarded. The MSP DateAndTime Control Module, as described in Understanding MSP Understanding Control Modules, is one method that could be used to set the date, time, and time zone of a device. Other methods might also be used to set the date, time, and time zone of a device, but are not part of MSP and hence will not be discussed here. Using Data Collection and Collected Data Once the prerequisites listed above have been met, Data Collection using the Motorola Data Collection Solution is under the control of the MSP Server and functions more or less the same as when any other Data Collection Solution. For more information on using Data Collection from MSP, see Using MSP Using Data Collection and Using MSP Using Collected Data. Data Collection Solutions Variations The primary differences between Data Collection Solutions revolve around the details of which devices they support and the exact details of how they operate on those devices. If two Data Collection Solutions support the same Collection Metrics, they should generally produce comparable results, within the limitation of the inherent deviations among the different devices they may support. For example, two Data Collection Solutions that support the BatteryLevel Collection Metric must report values in the range of 0% to 100%, as defined for that Collection Metric. Nonetheless, they may not be able to report values with the same accuracy or precision, depending on variations in the capabilities of the Data Collection Solutions and/or the devices they support.

63

64 Motorola Solutions, Inc. One Motorola Plaza Holtsville, New York 11742, USA Motorola Solutions, Inc E