N4A Device Manager 4.6.0

Transcription

1 N4ACMSX-UG460 N4A Device Manager User Guide Version 1.0 October 30, 2015

2 NOVATEL WIRELESS COPYRIGHT STATEMENT 2015 Novatel Wireless, Inc. All rights reserved. The information contained in this document is subject to change without notice and should not be construed as a commitment by Novatel Wireless, Inc. NOVATEL WIRELESS TRADEMARKS AND SERVICE MARKS Novatel Wireless is a trademark of Novatel Wireless, Inc., and the other trademarks, logos, and service marks (collectively the Trademarks ) used in this user manual are the property of Novatel Wireless or their respective owners. Nothing contained in this user manual should be construed as granting by implication, estoppel, or otherwise, a license or right of use of Novatel Wireless or any other Trademark displayed in this user manual without the written permission of Novatel Wireless or its respective owners. Novatel Wireless, and the Novatel Wireless logo are all trademarks of Novatel Wireless, Inc. MiFi and the MiFi logo are registered trademarks of Novatel Wireless, Inc. GENERAL DISCLAIMER - TERMS OF USE OF NEW MATERIALS From time to time, Novatel Wireless, in its sole discretion, may make available for download on its website ( or may transmit via mail or , updates or upgrades to, or new releases of, the firmware, software or documentation for its products (collectively, 'New Materials'). Use of such New Materials is subject to the terms and conditions set forth below, and may be subject to additional terms and conditions as set forth in Novatel Wireless's Technical Support Policy (posted on its website) and/or any written agreement between the user and Novatel Wireless. All New Materials are provided AS IS. Novatel Wireless makes no warranty or representation with respect to the merchantability, suitability, functionality, accuracy or completeness of any such New Materials. The user of such New Materials assumes all risk (known or unknown) of such use. Novatel Wireless reserves all rights in such New Materials. The user shall have only a revocable and limited license to use such New Materials in connection with the products for which they are intended. Distribution or modification of any New Materials without Novatel Wireless's consent is strictly prohibited. IN NO EVENT WILL NOVATEL WIRELESS BE RESPONSIBLE FOR ANY INCIDENTAL, INDIRECT, CONSEQUENTIAL OR SPECIAL DAMAGES AS A RESULT OF THE USE OF ANY NEW MATERIALS. NOVATEL WIRELESS'S MAXIMUM LIABILITY FOR ANY CLAIM BASED ON THE NEW MATERIALS SHALL NOT EXCEED FIFTY U.S. DOLLARS ($50). Version Verification Please ensure you have the latest version of this document by downloading it from

3 Contents Introduction 1 N4A Software Platform Overview 2 System Architecture 4 Distributor Model 5 Understanding User Roles 10 Software and Device Licensing 12 Interface Elements and Features 13 Account Login 14 User Info Bar 15 User Profile 16 Navigation 17 Filtering 18 Content Frame 19 Administration Tree 20 CSV Export Option 21 Accessing Online Help 22 Getting Started 23 Stand-Alone Companies (Hosted Environment) 24 Distributors (Hosted Environment) 25 Companies (Hosted Environment) 26 On-Premise Installations 27 System Administration 31 Overview 32 Viewing Deployments Status 33 Editing System Settings 35 Viewing System Statistics 38 Distributors 39 Viewing the List of Distributors or Companies 40 Editing Distributor or Company Information 41 Adding a Distributor or Company 43 Users (System Admins) 45 Viewing the List of Users 46 Adding a User 48 Editing a User 49 3

4 Changing a User Password 50 Activating or Deactivating a User 51 Device Config 53 Configuring Device Communications 54 Events 56 Viewing the List of Event Configurations 57 Editing Event Configuration Details 59 Adding an Event Configuration 60 Probes 61 Viewing Probes 62 Editing Simple Probe Details 64 Editing Compound Probe Details 65 Adding a Simple Probe 68 Adding a Compound Probe 70 Alerts 72 System Alerts Overview 73 Viewing System Alerts 75 Editing System Alerts 76 Device Types 77 Viewing Device Types 78 Shipments 80 Viewing the List of Shipments 81 Viewing Shipment Details 83 Viewing Device Batch Upload Details 84 Adding Shipments 85 Logs 87 Viewing System Log Files 88 Printing System Log Files 90 Super Admin Tasks at Other Levels 92 Setting a Distributor to Trusted Status 93 Activating Device Features for Client Companies 96 Editing Client Company Settings 98 Moving Devices to Client Companies 101 Enabling OBD Action Commands for Client Companies 103 Changing Device Type 106 Editing the MSISDN for a SIM 108 Sending Commands to a Device 110 Distributor Management 113 Company Info 114 Viewing Client Companies 115 4

5 Editing Distributor Company Information 116 Inventory 117 Viewing Device Inventory 118 Moving Devices 119 Reclaiming Devices 121 Activating Device Features for Client Companies 123 Deleting Devices 125 Device Uploads 126 Viewing the List of Device Uploads 127 Uploading Device Information 128 Viewing Device Batch Upload Details 130 Clients 131 Viewing the List of Distributors or Companies 132 Editing Distributor or Company Information 133 Adding a Distributor or Company 135 Users (Distributor Admins) 137 Viewing the List of Users 138 Adding a User 140 Editing a User 141 Changing a User Password 142 Activating or Deactivating a User 143 Settings (Distributor) 145 Editing Client Company Settings 146 Editing Client Company Settings as a Trusted Distributor 148 License 151 Redeeming a License 152 Uploading a License 154 Viewing the License 155 Updating a License 156 Deleting a License 157 Journal (Distributor) 158 Viewing the Company Activity Log 159 Company Management 161 Devices 162 Device Inventory 163 Viewing Device Inventory 163 Viewing Device Details 164 Viewing Event Details 165 Deleting Devices 166 Grouping Devices 167 5

6 Deploying Services to Devices 168 Checking In Devices 171 OBD Inventory 172 Viewing OBD Device Inventory 172 Viewing OBD Device Details 174 Viewing OBD Vehicle Data 175 Viewing OBD Configuration History 176 Sending an OBD Configuration to a Device 176 Sending OBD Action Commands 177 Device Groups 180 Viewing Device Group Inventory 180 Editing a Device Group 181 Adding a Device Group 182 Services 184 Viewing Service Inventory 185 Editing Service Details 186 Cloning a Service 188 Uploading a Service 189 Adding a Custom Service 190 Deployments 192 Viewing Deployments 193 Viewing Deployment Details 194 Aborting Deployments 195 Suspending Deployments 197 SIMs 199 Inventory 200 Viewing SIM Inventory 200 Viewing SIM Details 201 Activating or Deactivating a SIM 202 Removing a SIM Provisioning Service 202 Add 204 Adding a SIM 204 Credentials 206 Viewing SIM Provisioning Service Credentials 206 Editing SIM Provisioning Service Credentials 207 Adding SIM Provisioning Service Credentials 208 Administration 209 Company Info 210 Editing Distributor or Company Information 210 Users (Company) 212 Viewing the List of Users 212 6

7 Adding a User 214 Editing a User 215 Changing a User Password 216 Activating or Deactivating a User 217 Device Uploads 219 Viewing the List of Device Uploads 219 Uploading Device Information 220 Viewing Device Batch Upload Details 221 Settings (Company) 222 Editing Company Settings 222 Probes 224 Viewing Probes 224 Editing Simple Probe Details 226 Editing Compound Probe Details 227 Adding a Simple Probe 229 Adding a Compound Probe 230 Alerts 233 Company Alerts Overview 233 Viewing Company Alerts 235 Editing Company Alerts 235 Journal 238 Viewing the Company Activity Log 238 LBS 240 Editing LBS Configuration 241 7

8

9 1 Introduction N4A Software Platform Overview System Architecture Distributor Model Understanding User Roles Software and Device Licensing 1

10 N4A Software Platform Overview The N4A Device Manager (DM) solution is a robust environment for the management, configuration, and self-care and support of Novatel Wireless devices. The solution includes the following capabilities: Device configuration and management Upgrades with firmware-over-the-air (FOTA) Management of single devices or device groups Complete device history to assist in self-care and issue resolution Device health and operational status monitoring Device check-in and event data reporting Additionally, the solution allows you to manage user accounts and device privileges to extend selfservice device management capabilities to customers. Hosted and on-premise versions are available providing complete integration flexibility. Special Features Special features include: Multi-distributor architecture model that supports distributor-company and distributor-subdistributor-company relationships Completely hosted device management with the ability to report event data to your own servers Dynamic device management capability for complete flexibility Device check-in for expedited device communication Focused device configuration and FOTA management Hosted version deployed in the Amazon Web Services Elastic Cloud environment with % availability Optional on-premise version Common Functions Common functions include: Remotely provision and configure Novatel Wireless devices Easily configure and manage large numbers of deployed devices N4A Device Manager User Guide 2

11 Monitor device status and health Manage devices by groups or by IMEI Track device shipments Manage configuration files and scripts Schedule and deploy FOTA updates Manage permissions based on user account level Remotely troubleshoot and diagnose issues N4A Device Manager User Guide 3

12 System Architecture The N4A Software Platform is a high-throughput, transactional application that manages device communication and collects, parses, and stores device information. The following image shows the overall N4A Software Platform architecture. Messages are transmitted by the wireless network to the N4A Software Platform, where they are parsed and stored. The N4A Software Platform also provisions and sends updates to the devices. Users are assigned roles and can access the N4A Software Platform through a secure browser-based interface. N4A Device Manager User Guide 4

13 Distributor Model Beginning with N4A 4.4 Device Manager (DM), Novatel Wireless implemented a multi-level distributormodel for device management support. This model provides support to companies that distribute and resell devices to their client companies and allows them to manage licensing and billing for those devices. Key functions remain the same, such as managing devices, deployments, and users. The new model provides customized access by user role and some features are only available to each role. The distributor model has three primary areas of activity: System Administration Distributor Company System Administration The first interface area in N4A DM is System Administration. This area gives a full view of the system. Only the super admin role has access to this area. Super admins create distributors and distributor administrators and can perform tasks at all levels. In addition, super admins manage device feature activation unless they designate distributors as Trusted. In that case, Distributors manage device feature activation for their inventory. NOTE: In a hosted deployment, Novatel Wireless acts as the super admin for its customers. In an onpremise installation, the company manages its own system administration. Distributor Management The second interface area is Distributor Management. The super admin and distributor admin roles have access to this area. The Distributor Admin creates sub-distributors and companies as well as administrators for those companies. They manage the device allocation within their inventory and assign devices to companies. If designated a Trusted distributor, they can manage feature activations for all devices in their inventory. They can also reclaim devices not yet deployed and re-assign those devices to other companies or sub-distributors. They have a limited view of their client companies information. Company Management The third interface area is Company Management. The Company admin and company user roles have access to this area. Company admins create additional administrators and regular users for the company. They also manage devices, services, and deployments. Regular users can view the inventory and deploy services to devices. N4A Device Manager User Guide 5

14 N4A Software Platform Deployment Scenarios There are various system setup scenarios that can occur. The following examples illustrate three common scenarios. Here is a color-coding key. N4A Device Manager User Guide 6

15 Stand-Alone Company The second scenario occurs when the Novatel Wireless customer is a stand-alone company that manages both distributor and company activities. The following image shows an example of this scenario. In this case, the company has access to both the distributor level to carry out required tasks as well as access to the company level to carry out lower-level tasks. This requires the company to have separate administrator log-ins to access the two levels. NOTE: In a hosted environment, Novatel Wireless handles the system administration function and in an on-premise installation the company manages system administration. N4A Device Manager User Guide 7

16 Distributor with Sub-Distributor and Client Companies The first scenario shows a distributor with client companies and (optional) sub-distributors. The following image shows an example of this scenario. NOTE: In a hosted environment, Novatel Wireless handles the system administration function and in an on-premise installation the company manages system administration. N4A Device Manager User Guide 8

17 Sub-Distributor within a Distributor Hierarchy The third scenario occurs when a company is a device distributor but receives devices it resells from a primary, or top-level distributor. The following image shows an example of this scenario. In this example, Super Cellular Resale is a sub-distributor under Fleet Management International. As a sub-distributor, it has access only to its distributor level information. It cannot see the distributor information above him and has a limited view of its client companies information below. However, the main distributor, in this case, Fleet Management International, can access Super Cellular and perform limited activities. Fleet cannot access Super Cellular s client companies. The Super Admin can access all levels. NOTE: In a hosted environment, Novatel Wireless handles the system administration function and in an on-premise installation the company manages system administration. See Also Administration Tree Software and Device Licensing Stand-Alone Companies in a Hosted Environment Distributors in a Hosted Environment Companies in a Hosted Environment On-Premise Installations N4A Device Manager User Guide 9

18 Understanding User Roles There are different user roles or log-in levels within the N4A Software Platform. These user roles have different access and function privileges within the software depending on their user type. For example, only the Distributor Administrator and Super Administrator can create companies and only the Super Administrator, Distributor Administrator, and Company Administrator can add and edit other administrators or users. The N4A user roles are: Super Administrator (super admin) Distributor Administrator (distributor admin) Company Administrator (company admin) Company User (company user) Super Administrator The super administrator is the highest level role. A user with this role can view all data in the system and perform all activities. By default, there is a single user profile and login with this role created at installation. This user can create additional super admins, if needed. The super admin creates top level distributor companies in the system and sets up the initial distributor admins. They can also perform distributor admin activities. In addition, the super admin can act as a company admin or a company user for a client company. NOTE: Super admins can activate licensed features for devices. Distributor Administrator The distributor administrator has access to the distributor company and limited access to client companies. A distributor admin can add client companies and sub-distributor companies. The distributor admin can move devices within their client companies and also assign devices. The distributor admin also adds the license which then applies to all of their clients. NOTE: Trusted Distributor admins can activate licensed features for devices. Company Administrator Company administrators can view all data associated with their company and can perform all companyrelated activities, such as managing devices and adding other admins or users. N4A Device Manager User Guide 10

19 Company User A company user can view most company data, but can edit only the items specifically assigned to them. They can also create deployments for device groups and services allocated to them. The following table lists the role types, the areas they can access within their hierarchy, and the user types they can add or edit. User Role Areas Accessible in Hierarchy User Type that Role can Add or Edit Super Admin System Administration Super Admin Distributor Company Distributor Admin Company Admin, Company User Distributor Admin Distributor Distributor Admin Company Company Admin Company Admin Company Company Admin, Company User N4A Device Manager User Guide 11

20 Software and Device Licensing Novatel Wireless N4A Device Manager is a licensed software application. Whether you purchase access to the hosted application or buy the software and install it on your own network, a license must exist in the Novatel Wireless license server before you can log in and begin using the software. Licenses apply to distributors and stand-alone companies. The license agreement contains the various features purchased by the Novatel Wireless customer. The software and features available to license include: Device Manager (DM) CMS Location-Based Services (LBS) Maps Services In addition, there is a per device charge for each device activated for DM. You can set the device activation to renew annually, or you can purchase a lifetime activation for a higher rate. Which method you choose depends on how long you plan for the device to be active in your inventory. These charges roll up to the distributor, who is responsible for paying Novatel Wireless on a monthly basis for activated devices. In turn, the distributor bills the client company. Or, the company is responsible if it is a standalone company handling both distributor and company roles. Other charges can apply when additional licensed options are activated for a device. These are: DM Advanced Diagnostics NOTE: This feature is only available on MT 3060 devices at this time. Garmin Fleet Management Interface (GFMI) NOTE: This feature is only available on MT 4000 and MT 4100 devices at this time. For more information about the various licensed features, contact your Novatel Wireless sales representative. See Also License Activating Device Features for Client Companies Editing Client Company Settings as a Trusted Distributor N4A Device Manager User Guide 12

21 2 Interface Elements and Features Account Login User Info Bar User Profile Navigation Filtering Content Frame Administration Tree CSV Export Option Accessing Online Help 13

22 Account Login To log into your account: 1. In your browser, navigate to the N4A Software Platform home page. The N4A Software Platform home page opens. 2. Enter your Username and Password and click Login. NOTE: For username and password information, contact your distributor or company admin. Super admins can contact their Novatel Wireless representative. N4A Device Manager User Guide 14

23 User Info Bar The User Info bar is located in the top right corner of every page when you are logged into the N4A Software Platform. The User Info Bar appears for every role. The elements within the user info bar are: Username link Opens the Edit User page where you can edit your profile information. Home button Opens the page you first see when you log in. o o o System Admin home page is the System Administration Overview page. Distributor Admin home page is the Distributor Overview page. Company Admin home page is the Device Inventory page. Help button Opens the online help. Exit button Logs you out of the system. N4A Device Manager User Guide 15

24 User Profile The User Profile is accessible on the User Info bar and provides the ability to change your name, , phone, or password information. This page is available to all user types. To edit your profile: 1. In the User Info bar, click your username link. The Edit User page opens. 2. On the Edit User page, edit your information or change your password, if needed. 3. Click Save. Other Options To clear all fields and start over at any point before saving, click Reset. N4A Device Manager User Guide 16

25 Navigation Navigation Bar The Navigation Bar allows the user to select all areas of the system through a set unique to each user role. NOTE: Individual options may vary based on your user role permissions or type of license. Contact your administrator for questions regarding your account permissions. The following images are views of the navigation bar one with a subnavigation bar and one without. NOTE: Certain features, such as Maps and Reports tab, are licensed separately. This can affect whether the related tabs appear on a navigation bar. Contact your Novatel Wireless sales representative for more information about licensed features. Subnavigation Bar The subnavigation bar contains a set of additional tabs that appear when you click on a tab in the navigation bar. Tabs that have a set of subtabs are indicated with a down arrow. N4A Device Manager User Guide 17

26 Filtering The N4A interface provides a filtering function on pages where lists or tables of data appear. This function allows you to find specific information more quickly. The Filter section is located between the Navigation Bar and the Content Frame. The Filter section contains fields related to the data in the table. You can enter specific values in one or more fields to locate specific information or narrow the results. Where more than one filter field is available, the filter uses a logical "AND" statement. Individual filter fields automatically apply a wild card character (*) before and after text. To filter information: 4 Enter filtering information into one or more of the provided fields and click Refresh. The content displayed in the Content Frame updates to show the filtered results. N4A Device Manager User Guide 18

27 Content Frame The Content Frame appears on each page below the Filter section. This area contains the key information for the page. The following image shows the content frame for Device Inventory. When the content frame contains a table, you can: Control the number of items displayed per page by selecting a number from the View... on a page list. Sort the columns by clicking on the bolded text in the column header. Click on a link in the table to view more information about that item. Click CSV to export the table data to a Comma-Separated Values (CSV) file. Interact with the table data by selecting items and then clicking one of the buttons below the table. N4A Device Manager User Guide 19

28 Administration Tree The Administration Tree appears in the System Administration and Distributor areas and provides a hierarchical view of the distributors and client companies that currently exist in the system. Super admins can view the overall system through this tree. Distributor admins can view the sub-distributors and client companies in the distributor s hierarchy. Click a distributor or company to view its data. Administration Tree Color Key Text Color Black Blue Green Red Gray Account Status System Administration Account Active Distributor or Sub-Distributor Active Company Unlicensed Distributor Inactive Distributor, Sub-Distributor, or Company Click a distributor, sub-distributor, or company to navigate to that entity s information. Click the Home button located in the User Info Bar (top right of page) to return to the home page for your role. N4A Device Manager User Guide 20

29 CSV Export Option Most data presented in tables on the N4A pages can be exported to a comma-separated values (CSV) file. If this option is available, it appears as a link at the bottom of the page. The CSV file can be opened, viewed, and modified in Microsoft Excel file. To export data to a CSV file: 1. Locate the CSV link on the page, typically below the data table. 2. Click CSV. The Save As window opens. 3. Navigate to and select the folder where you want to place the file. 4. In File name, enter a name for the file and click OK. The file is downloaded to your computer. N4A Device Manager User Guide 21

30 Accessing Online Help Online help is available throughout the N4A Software Platform. To access Help: 4 Click the Help button in the User Info Bar. A new browser tab containing an HTML version of this document opens. N4A Device Manager User Guide 22

31 3 Getting Started Stand-Alone Companies (Hosted Environment) Distributors (Hosted Environment) Companies (Hosted Environment) On-Premise Installations 23

32 Stand-Alone Companies (Hosted Environment) Use this road map to get started using the N4A Software Platform. 1. Log in as distributor admin. 2. Redeem your license. 3. Verify distributor company information. 4. Confirm device inventory. 5. [Optional] Activate device features. 6. Move devices to the client company. 7. Verify client company information. 8. Add company admins and users. 9. Confirm device inventory. N4A Device Manager User Guide 24

33 Distributors (Hosted Environment) Use this road map to get started using the N4A Software Platform. 1. Log in as a distributor administrator. 2. Redeem your license. 3. Verify distributor company information. 4. Add distributor admins. 5. Edit client company setting defaults. 6. Add one or more client companies. 7. Add company admins for each client company. 8. Confirm device inventory. 9. Move devices to client companies. N4A Device Manager User Guide 25

34 Companies (Hosted Environment) Use this road map to get started using the N4A Software Platform. 1. Log in as a company administrator. 2. Verify client company information. 3. Verify client company settings. 4. Add company admins and users. 5. Confirm device inventory. N4A Device Manager User Guide 26

35 On-Premise Installations Use this road map to get started using the N4A Software Platform. N4A Device Manager User Guide 27

36 1. Log in as a super admin. 2. Edit system settings. 3. Edit communication configuration. 4. Add one or more distributors. 5. [Optional] Set one or more distributors to Trusted status. 6. [Optional] Activate device features. 7. Add a shipment to a distributor. 8. Navigate to a distributor. 9. Redeem the distributor s license. 10. Verify distributor company information. 11. Confirm client company default settings. 12. Add one or more client companies. 13. Add a company admin for each client company. 14. Confirm device inventory. N4A Device Manager User Guide 28

37 15. [Optional] If a Trusted Distributor, activate device features. 16. Move devices to the client company. 17. Navigate to the client company. 18. Verify client company information. 19. Add company admins and users. 20. Confirm device inventory. N4A Device Manager User Guide 29

38 N4A Device Manager User Guide 30

39 4 System Administration Overview Distributors Users (System Admins) Device Config Events Probes Alerts Device Types Shipments Logs Super Admin Tasks at Other Levels 31

40 Overview Clicking the Overview tab on the navigation bar opens the Overview page. This is also the page that opens when you log in as a super admin. Tasks available from this page include: Viewing Deployments Status Editing System Settings Viewing System Statistics N4A Device Manager User Guide 32

41 Viewing Deployments Status The top portion of the Overview page contains Deployments Status information about service deployments status in the system. On the left side of the page, you can view various statuses such as number of activated devices and total number of devices. The right side of the page shows overall deployment status in a pie chart graphic and includes such statuses as number of scheduled deployments, deployments in progress, and successful deployments. To view deployments status: 4 On the navigation bar, click the Overview tab. The Overview page opens and the top portion of the page displays the Deployments Status. N4A Device Manager User Guide 33

42 See Also Viewing Deployments Deploying Services to Devices Editing System Settings Viewing System Statistics N4A Device Manager User Guide 34

43 Editing System Settings System Settings are located under the Deployment Status on the Overview page. The top portion of the System Settings section contains system-related information including options for server setup and license server setup. The bottom portion of the page contains other system settings that you can set as the defaults for distributors you create. These settings include device license options, date formatting, and page list length (table settings). When you create a new Distributor, its company settings default to these settings. The Distributor Admin can modify the settings, if needed. To view and edit system settings: 1. On the Deployments Status page, click System Settings. N4A Device Manager User Guide 35

44 The System Settings area expands. 2. Select the appropriate options and enter information as needed to set the Distributor defaults. N4A Device Manager User Guide 36

45 3. Click Save. Other Options To clear all fields and start over at any point before saving, click Reset. See Also Editing Client Company Settings Editing Company Settings N4A Device Manager User Guide 37

46 Viewing System Statistics System Statistics are located under the System Settings on the Overview page. The statistics include software versions, available memory, server information, and so on. You can also export this information to a text file. To view the System Statistics: 1. On the Deployments Status page, click System Statistics. The System Statistics area expands. 2. [Optional] Click Export to save the system statistics to a text file. N4A Device Manager User Guide 38

47 Distributors Clicking the Distributors tab on the navigation bar opens the Distributors page. Tasks available from this page include: Viewing the List of Distributors or Companies Editing Distributor or Company Information Adding a Distributor or Company N4A Device Manager User Guide 39

48 Viewing the List of Distributors or Companies Depending on your role and the area accessed, the Company Management page displays either the list of distributors or list of client companies and sub-distributors. From this page you can access company details or click Add to add a new company. NOTE: Companies and sub-distributors managed by a distributor are referred to as client companies. To view the Company Management page: 4 Depending on your location, you can access the Company Management page by one of the following methods: System Administration On the navigation bar, click the Distributors tab. Distributor On the navigation bar, click the Clients tab. The Company Management page opens and displays the distributors or client companies. See Also Editing Distributor or Company Information Adding a Distributor or Company N4A Device Manager User Guide 40

49 Editing Distributor or Company Information On the Edit Company page, you can view and edit a company's address and contact information. Additionally, depending on your access level, you can activate or deactivate the company in the system. To edit the company information: 1. Depending on your location, you can access this page by one of the following methods: System Administration On the Distributors page, locate the distributor company and click the Distributor Name link. Distributor On the Company Management page, locate the client company and click the Company link. Company On the Admin subnavigation bar, click the Company Info tab. The Edit Company page opens. 2. Edit the information as needed. 3. Click Save. N4A Device Manager User Guide 41

50 Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. To activate or deactivate the client or company, select the appropriate radio button and click Save. NOTE: The Edit Company page contains Status options for making a Company either active or inactive in the system. This allows you to keep a company inactive until you are ready to go live with the account. Alternatively, if you need to deactivate the company, you can move them from active to inactive. See Also Viewing the List of Distributors or Companies Adding a Distributor or Company N4A Device Manager User Guide 42

51 Adding a Distributor or Company Depending on your level and purpose, you can add a distributor or company. The distributor administrator user level is required for assigning devices to client companies. The distributor is also responsible for the license for their client companies. Only distributor companies can be created directly from the system administration area. These are referred to as top-level distributors. All other companies and sub-distributors are created under individual top-level distributors. To add a distributor: 1. Depending on your location, you can access the Company Management page by one of the following methods: System Administration On the navigation bar, click the Distributors tab. Distributor On the navigation bar, click the Clients tab. 2. Click Add. The Add Distributor (or Add Company) page opens. 3. Enter information in the fields provided. 4. Click Save. N4A Device Manager User Guide 43

52 The page reopens and displays a success message. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. To activate or deactivate the client or company, select the appropriate radio button and click Save. NOTE: The Add Company page contains Status options for making a Company either active or inactive in the system. This allows you to keep a company inactive until you are ready to go live with the account. Alternatively, if you need to deactivate the company, you can move them from active to inactive. See Also Viewing the List of Distributors or Companies Editing Distributor or Company Information N4A Device Manager User Guide 44

53 Users (System Admins) Clicking the System Admins tab on the navigation bar opens the User Management page. Tasks available from this page include: Viewing the List of Users Adding a User Editing a User Changing a User Password Activating or Deactivating a User N4A Device Manager User Guide 45

54 Viewing the List of Users The User Management page contains a list of the users currently in the system. From this page, a Super Admin, Distributor Admin, and Company Admin can view the list of users in their access areas. They can also add, edit, or deactivate users. However, the user types and users appearing in the list vary by the area and admin viewing it. The following table lists the role types, the areas they can access within their hierarchy, and the user types they can add or edit. User Role Areas Accessible in Hierarchy User Type that Role can Add or Edit Super Admin System Administration Super Admin Distributor Company Distributor Admin Company Admin, Company User Distributor Admin Distributor Distributor Admin Company Company Admin Company Admin Company Company Admin, Company User To view the list of users: 4 On the Navigation bar, click the Users tab. N4A Device Manager User Guide 46

55 The User Management page opens displaying the users for system administration, the distributor, or company. See Also Adding a User Editing a User Changing a User Password Activating or Deactivating a User Understanding User Roles N4A Device Manager User Guide 47

56 Adding a User To add a user: 1. On the User Management page, click Add. The Add User page opens. 2. Enter information in the fields provided. 3. Select the User Type. NOTE: The available user types change depending on which area you access the Add User page from. See the user role table in Viewing the List of Users. 4. Click Save. The User Management page reopens with the new user displayed in the list. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Editing a User Changing a User Password Activating or Deactivating a User N4A Device Manager User Guide 48

57 Editing a User The Super Admin, Distributor Admin, and the Company Admin roles have access to view and edit the users within their area or company. To view and edit a user: 1. On the User Management page, locate the user and click the Username link. The Edit User page opens. 2. Edit the information as needed. 3. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Adding a User Changing a User Password Activating or Deactivating a User N4A Device Manager User Guide 49

58 Changing a User Password To change a password: 1. On the User Management page, locate the user and click the Username link. The Edit User page opens. 2. In the Password field, enter a new password. 3. In the Confirm Password field, enter the new password again to confirm it. 4. Click Save immediately below the password fields. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Adding a User Editing a User Activating or Deactivating a User N4A Device Manager User Guide 50

59 Activating or Deactivating a User The Edit User page contains Status options for setting a user account to either active or inactive in the system. This allows you to keep a user inactive until you are ready to go live with the account. Alternatively, if you need to deactivate the user, you can move them from active to inactive. To activate or deactivate a user: 1. On the User Management page, locate the user and click the Username link. The Edit User page opens. 2. In Status, select either Active or Inactive to set the user s status within the system. 3. Click Save. A success message appears. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Adding a User N4A Device Manager User Guide 51

60 Editing a User Changing a User Password N4A Device Manager User Guide 52

61 Device Config Clicking the Device Config tab on the navigation bar opens the Device Communication Configuration page. Tasks available from this page include: Configuring Device Communications N4A Device Manager User Guide 53

62 Configuring Device Communications The Device Communication Configuration page contains the settings that control how the CMS responds to and communicates with devices. These settings affect the entire system. To edit the device communication configuration: 1. On the navigation bar, click the Device Config tab. The Device Communication Configuration page opens. 2. Enter the specified information in the fields provided on the Device Communication Configuration page. 3. Click Save. Field Definitions You can configure the following device tracking parameters: Online Timeout The milliseconds to delay between probes sent to devices for information. Probe Command Delay The milliseconds to wait before marking a sent probe as timed out. In most cases, the probe timeout should be significantly longer than the online timeout. Probe Command Timeout The probe command timeout is the setting that is used to determine how long after sending a probe command to the device to wait for a response before assuming that the device did not get the command and it should be resent. Device Unreachable Timeout The time in milliseconds to wait before unreachable devices are allowed to expire. Expired devices are automatically deleted from the memory cache and the active status column STATUS of database table N4A_DEVICE is set to N. Setting the device timeout too short can cause the server to send excessive amounts of data to devices and heavily load the database. The default is 5 minutes. N4A Device Manager User Guide 54

63 DB Update Rate The length in seconds of the window available to update the device properties (N4A_DEVICE and N4ADEVICE_PROP tables) in the database after the first probe has been sent. Other Options To clear all fields and start over at any point before saving, click Reset. See Also Viewing Probes N4A Device Manager User Guide 55

64 Events NOTE: Event processing management is a licensed feature and is only available for full-cms on-premise installations. It is not available in a hosted environment at this time. Clicking the Events tab on the navigation bar opens the Event Configuration page. Tasks available from this page include: Viewing the List of Event Configurations Editing Event Configuration Details Adding an Event Configuration N4A Device Manager User Guide 56

65 Viewing the List of Event Configurations Event configurations are used for processing device events for CMS. Use this page to view the list of event configurations and access event configuration details. The super admin can view, add, and edit events. To view the list of event configurations: 4 On the navigation bar, click the Events tab. The Event Configuration page opens. N4A Device Manager User Guide 57

66 See Also Editing Event Configuration Details Adding an Event Configuration N4A Device Manager User Guide 58

67 Editing Event Configuration Details The Event configurations settings are set as a default, but they can be edited by the Super Admin. To edit an event configuration: 1. On the navigation bar, click the Events tab. The Event Configuration page opens. 2. From the Event Configuration page, locate the event and click Event Name link. The Edit Event Configuration page opens. 3. Edit the information as needed. 4. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Event Configurations Adding an Event Configuration N4A Device Manager User Guide 59

68 Adding an Event Configuration The Super Admin has the ability to add an Event Configuration. To add an event configuration: 1. On the Event Configuration page, click Add. The Add Event Configuration page opens. 2. On the Add Event Configuration page, enter information in the fields provided. 3. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Event Configurations N4A Device Manager User Guide 60

69 Probes Clicking the Probes tab on the navigation bar opens the Device Probe Configuration page. Tasks available from this page include: Viewing Probes Viewing and Editing Simple Probe Details Viewing and Editing Compound Probe Details Adding Simple Probes Adding Compound Probes N4A Device Manager User Guide 61

70 Viewing Probes The N4A software platform provides a set of default device probe configurations. Device probes are files containing one or more query commands that can be sent to devices the first time they check in to the CMS servers. Responses to the queries are stored in the server database and displayed in the Device Details page. When you add a new distributor, the current set of device probes are copied to the database and when the distributor adds a client company, that set is used for the company s default set of probes. When you add or edit probes in system administration, existing company s probes are not affected. There are two types of probes: simple and compound. A simple device probe populates a single device property in the database when a device responds to the probe. A device responding to a compound probe results in multiple properties being set in the database record for the device. To view probes: 4 On the navigation bar, click the Probes tab. N4A Device Manager User Guide 62

71 The Device Probe Configuration page opens. See Also Editing Simple Probe Details Editing Compound Probe Details Adding a Simple Probe Adding a Compound Probe N4A Device Manager User Guide 63

72 Editing Simple Probe Details WARNING! The Device Probe settings can impact your data usage plan. Make sure you set these correctly for your company. To edit a device probe: 1. On the navigation bar, click the Probes tab. 2. On the Device Probe Configuration page, locate a device probe and click the device probe Name link. The Edit Device Probe page opens. 3. Edit the information as needed. 4. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing Probes Adding a Compound Probe N4A Device Manager User Guide 64

73 Editing Compound Probe Details WARNING! The Device Probe default settings can impact your data usage plan. Make sure you set these correctly for your company. To edit a device probe: 1. On the navigation bar, click the Probes tab. 2. On the Device Probe Configuration page, locate a device probe and click the device probe Name link. N4A Device Manager User Guide 65

74 The Edit Device Probe page opens. 3. Edit the information as needed. 4. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. N4A Device Manager User Guide 66

75 See Also Viewing Probes Editing Simple Probe Details Adding a Simple Probe Adding a Compound Probe N4A Device Manager User Guide 67

76 Adding a Simple Probe Simple probes return a single data field. Tip: You can change a probe from a simple to a compound configuration by changing the probe type prior to clicking Save. To add a simple probe: 1. On the Device Probe Configuration, click Add Simple. The Add Device Probe Configuration page opens. 2. Enter information in the fields provided. NOTE: Select one or more Device Types from the list. 3. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Adding a Compound Probe Editing Simple Probe Details N4A Device Manager User Guide 68

77 Viewing Probes N4A Device Manager User Guide 69

78 Adding a Compound Probe Compound probes consist of multiple data elements. Tip: You can change a probe from a compound to a simple configuration by changing the probe type prior to clicking Save. To add a compound probe: 1. Click Add Compound. The Add Compound Device Probe page opens. N4A Device Manager User Guide 70

79 2. Enter the specified information in the fields listed on the Add Device Probe Configuration page. NOTE: Select one or more Device Types from the list. 3. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Adding a Simple Probe Editing Compound Probe Details Viewing Probes N4A Device Manager User Guide 71

80 Alerts Clicking the Alerts tab on the navigation bar opens the System Alerts page. Tasks available from this page include: System Alerts Overview Viewing System Alerts Editing System Alerts N4A Device Manager User Guide 72

81 System Alerts Overview The N4A software platform provides a set of default system alerts for issues with system-level networking and devices such as database connections and utilization thresholds. When an alert is triggered, the system notifies the admin that an area needs attention. Super admins can modify the settings for a system alert including the triggering event value, frequency, and recipient (super admin and/or company admin). Super admins can modify the recipient settings to send notifications to one or both admin types (super admins or company admins) or turn notifications off altogether by setting each type to No. In addition to system alerts, there are also company-level alerts that cover a particular company. See the Company Alerts section for more information. The following table contains a list of the system alerts delivered with the N4A software platform. System Alerts Alert Name DATABASE CONNECTION ACTIVEMQ CONNECTION LBS CONNECTION CPU THRESHOLD-CMS RAM THRESHOLD-CMS CPU THRESHOLD-DM RAM THRESHOLD-DM SERVER APPLICATION START Description Monitors connection to CMS database and issues an alert when the connection fails for any reason. Monitors the connection to the message queues used in the CMS and Device Manager applications, and issues an alert when access to any of the queues fails. Issues an alert when access to the external hosts used by the location-basedservices fails. Monitors the CPU utilization of the CMS server and issues an alert whenever the utilization exceeds the percentage indicated by the triggering value. (Default is 95%). The CPU utilization is checked every minute. Monitors the available RAM of the CMS server and issues an alert whenever the available memory falls below the number of megabytes indicated by the triggering value. (Default is 95 MB). The available RAM value is checked every minute. Monitors the CPU utilization of the Device Manager server and issues an alert whenever the utilization exceeds the percentage indicated by the triggering value. (Default is 95%). The CPU utilization is checked every minute. Monitors the available RAM of the Device Manager server and issues an alert whenever the available memory falls below the number of megabytes indicated by the triggering value. (Default is 95 MB). The available RAM value is checked every minute. An alert is issued whenever the CMS or Device Manager application is started. N4A Device Manager User Guide 73

82 Alert Name SERVER APPLICATION STOP Description An alert is issued whenever the CMS or Device Manager application is stopped. Note: If the JBOSS application server is running as a system service (WIndows only), then there is no guarantee that a a shutdown event be surfaced by JBOSS in the event their server is terminated. In this case, a "server application stop" alert will not be issued. See Also Company Alerts Overview Edit Company Alerts Edit System Alerts N4A Device Manager User Guide 74

83 Viewing System Alerts To view system alerts: 4 On the navigation bar, click the Alerts tab. The System Alerts page opens. See Also Viewing and Editing Site Alert Details System Alerts Overview N4A Device Manager User Guide 75

84 Editing System Alerts To edit system alerts: 1. On the navigation bar, click the Alerts tab. The System Alerts page opens. 2. Locate a system alert, and click the Name link. The Edit Site Alert page opens. 3. On the Edit Site Alert page, enter the specified information in the fields provided. Tip: You can also check Yes or No to the super admin and company admin. 4. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing System Alerts System Alerts N4A Device Manager User Guide 76

85 Device Types Clicking the Device Types tab on the navigation bar opens the Device Types page. Tasks available from this page include: Viewing Device Types N4A Device Manager User Guide 77

86 Viewing Device Types The N4A Software Platform supports all Novatel Wireless IoT/M2M device types both those currently sold as well as legacy devices still owned and used by customers. The Device Types page contains the list of supported devices along with other information. This list is only available at the System Administration level. To view device types: 4 On the navigation bar, click the Device Types tab. N4A Device Manager User Guide 78

87 The Device Types page opens. N4A Device Manager User Guide 79

88 Shipments Clicking the Shipments tab on the navigation bar opens the Shipments page. Tasks available from this page include: Viewing the List of Shipments Adding Shipments N4A Device Manager User Guide 80

89 Viewing the List of Shipments The Shipments page contains a list of the shipments of devices that have been uploaded to the system. This function is only available for a Distributor accessed from the System Administration level. When the super admin selects a Distributor from the System Administration tree, the Shipments option becomes available on the menu. The super admin receives the shipment notification and creates a shipment record with all the available information about the shipment and the devices it contains. Once the shipment is uploaded to the system for the Distributor, the distributor admin can move devices to its client companies in preparation for activation. To view shipments: 1. On the administration tree, click on a distributor name to view N4A through a distributor level view. 2. On the navigation bar, click the Shipments tab. The Shipments page opens. 3. Locate a shipment to view, and click the Purchase Order link. N4A Device Manager User Guide 81

90 The Shipment Detail page opens. Other Options Deploy devices within this shipment by clicking the Deploy button on this page. View detailed upload results by clicking the Upload link on this page. Re-upload a shipment file for this shipment through this page on the Upload a Shipment File section and click Upload. See Also Adding Shipments N4A Device Manager User Guide 82

91 Viewing Shipment Details To view shipment details: 1. On the administration tree, click on a distributor name to view N4A through a distributor level view. 2. On the navigation bar, click the Shipments tab. The Shipments page opens. 3. Locate a shipment to view, and click the Purchase Order link. The Shipment Detail page opens. 4. Click Cancel to return to the Shipments page. N4A Device Manager User Guide 83

92 Viewing Device Batch Upload Details The Device Batch Upload Detail page displays information about an uploaded device or batch of devices. To view Device Batch Upload Details: 1. On the Device Batch Uploads page, locate the Device Batch and click the Batch File link. The Device Batch Upload Detail page opens where you can view the batch upload information. 2. Click Cancel to return to the Device Batch Uploads page. See Also Uploading Devices N4A Device Manager User Guide 84

93 Adding Shipments To add a shipment: 1. On the administration tree, click a distributor name to view N4A through a distributor level view. 2. On the navigation bar, click the Shipments tab. The Shipments page opens. 3. Click Add. The Create a Shipment page opens. 4. Enter the specified information in the fields provided and click Browse to upload the shipment file. 5. Click Create. Other Options To clear all fields and start over at any point before saving, click Reset. N4A Device Manager User Guide 85

94 See Also Viewing Shipments N4A Device Manager User Guide 86

95 Logs Clicking the Logs tab on the navigation bar opens the View System Log Files page. Tasks available from this page include: Viewing System Log Files Printing System Log Files N4A Device Manager User Guide 87

96 Viewing System Log Files You can view three types of Device Manager systems logs: DM Errors Only (dm.error.log) Contains critical errors that have occurred in the system. This log should normally have few entries. DM Main Log (dm.debug.log) Contains basic tracing and information about the normal operation of the system. JBOSS Boot (boot.log) Contains information from JBoss during the startup of the application server. NOTE: This function is available to Super Admins only. To view the system log files: 1. On the top navigation bar, click the Logs tab. The View System Log Files page opens and defaults to the DM Main Log. 2. In Select a file to view, select the log you want to view. N4A Device Manager User Guide 88

97 3. Click Pause to pause the streaming so you can read the log files. The Pause button toggles to Resume. 4. Click Resume to continue the streaming update of the log files. See Also Printing System Log Files N4A Device Manager User Guide 89

98 Printing System Log Files In addition to viewing the system log files, you can also download and print them. NOTE: This function is available to Super Admins only. To download and print a system log file: 1. On the top navigation bar, click the Logs tab. The View System Log Files page opens and defaults to the DM Main Log. 2. In Click to Download, click the system log file you want to download or print. Depending on your computer configuration, the system log file may open in a new browser window or a Notepad file or other text-type reader. 3. Save or print the system log file in the usual manner using the functions available. N4A Device Manager User Guide 90

99 See Also Viewing System Log Files N4A Device Manager User Guide 91

100 Super Admin Tasks at Other Levels The Super Admin can perform tasks at all levels as needed. However with the distributor model, there are some tasks that are important for activating features on devices. Those tasks are: Setting a Distributor to Trusted Status Activating Device Features for Client Companies Editing Client Company Settings Moving Devices to Client Companies Enabling OBD Action Commands for Client Companies Changing Device Type Editing the MSISDN for a SIM Sending Commands to a Device N4A Device Manager User Guide 92

101 Setting a Distributor to Trusted Status The only role with the ability to activate device features is the super admin. However, the super admin can designate one or more distributors as having Trusted status. To set a distributor to trusted status: 1. On the administration tree, click a distributor name to view N4A through a distributor level view. 2. On the navigation bar, click the Settings tab. N4A Device Manager User Guide 93

102 The Default Settings for Clients page opens. 3. In the Device License Options section of the page, select Yes for the "Distributor may set activations" field. 4. Make other changes as needed. 5. Click Save. N4A Device Manager User Guide 94

103 See Also Administration Tree N4A Device Manager User Guide 95

104 Activating Device Features for Client Companies From the Device Inventory page, you can activate various features on selected devices. To activate one or more devices: 1. On the administration tree, click a client company name to view N4A through a company administrator level view. 2. Click the Devices tab. The Device Inventory page opens. 3. On the Device Inventory page, select the devices you want to activate. 4. In the Activation area, select the features to activate for the devices. 5. Click Activate. A confirmation message appears. 6. Click OK to continue with activation. A success message appears. 7. [Optional] Select devices and click Activate GFMI. NOTE: This features is only available for MT 4000 and MT 4100 models. N4A Device Manager User Guide 96

105 A confirmation message appears. 8. [Optional] Click OK to continue with activation. A success message appears. See Also Software and Device Licensing Editing Client Company Settings as a Trusted Distributor Administration Tree N4A Device Manager User Guide 97

106 Editing Client Company Settings The top portion of the Clients Settings section contains options for server setup. The bottom portion of the page contains other settings that you can set as the defaults for Client Companies you create. These settings include date formatting and page list length (table settings). When you create a new Client Company, the company settings default to these settings. The Company Admin can modify the settings, if needed except for the device license options section of this page. To edit client company settings: 1. On the administration tree, click a client company name to view N4A through a company administrator level view. 2. On the navigation bar, click the Settings tab. N4A Device Manager User Guide 98

107 The Company Settings page opens. 3. Select the appropriate options and enter information in the fields provided to set the Client Company defaults. 4. Click Save. N4A Device Manager User Guide 99

108 Other Options To clear all fields and start over at any point before saving, click Reset. To test recipients, in the Test Recipients field, enter an and click Test. See Also Administration Tree N4A Device Manager User Guide 100

109 Moving Devices to Client Companies NOTE: Only devices that are currently present in the distributor s inventory can be moved. Devices that have been assigned to client companies (or sub-distributors) may not be moved unless they are first reclaimed from the client companies. To move devices in the Device Inventory: 1. On the administration tree, click a distributor name to view N4A through a distributor level view. 2. Click the Inventory tab. The Device Inventory page opens. 3. Locate and select the devices to move. 4. In the Move list, select the company or sub-distributor you are moving the devices to. 5. Click Move. N4A Device Manager User Guide 101

110 See Also Reclaiming Devices Viewing Device Inventory Deleting Devices Administration Tree N4A Device Manager User Guide 102

111 Enabling OBD Action Commands for Client Companies NOTE: This feature requires licensing for Advanced Diagnostics. See Software and Device Licensing. OBD Action Commands are commands a Company Admin can send to a device in a vehicle to unlock its doors or open and close its windows. The Super Admin has to enable this feature for a company. From the Company Settings page, you can enable OBD Action Commands for a Client Company in the Device License Options section. NOTE: Changes to the Device License Options section of this page could affect the billing to your company from Novatel Wireless. Ensure that you are making the appropriate changes for your company before editing the settings. To enable OBD Action Commands: 1. On the administration tree, click a client company name to view N4A through a company administrator level view. 2. Click the Settings tab. N4A Device Manager User Guide 103

112 The Company Settings page opens. 3. In the Device License Options section, select Yes for the OBD Action Commands. 4. Click Save. Other Options To clear all fields and start over at any point before saving, click Reset. See Also Viewing OBD Device Inventory Editing OBD Device Details N4A Device Manager User Guide 104

113 Sending OBD Action Commands Administration Tree N4A Device Manager User Guide 105

114 Changing Device Type If needed, you can change the Device Type for one or more specific devices. This feature allows you to update device types that were uploaded to Device Manager with incorrect information. There are two methods for changing the device type from the Device Inventory page: Selecting one or more devices Clicking the Device ID link for one device NOTE: This function is available to Super Admins only. To change the device type by selecting one or more devices: 1. On the administration tree, click a client company name to view N4A through a company administrator level view. 2. Click the Devices tab. The Device Inventory page opens. 3. Select one or more devices that have the wrong device type. 4. In the Set Device Type list, select the correct Device Type. 5. Click Set Device Type. N4A Device Manager User Guide 106

115 To change the device type by clicking the Device ID link: 1. On the administration tree, click a client company name to view N4A through a company administrator level view. 2. Click the Devices tab. The Device Inventory page opens. 3. Locate the device that has the wrong device type and click the Device ID link. The Device Details window opens. 4. In the Device Type list, select the correct Device Type. 5. Click Save. See Also Viewing Device Details Administration Tree N4A Device Manager User Guide 107

116 Editing the MSISDN for a SIM The Mobile Station International Subscriber Directory Number (MSISDN) for the SIM in a device is populated or overwritten in Device Manager in the following ways: During the upload of information to Device Manager for a device with a SIM When a CNUM probe is run on the device to set the MSISDN value If SIM provisioning is used, during provisioning setup or updates NOTE: If SIM provisioning is used, the MSISDN value it writes takes precedence over any other update method. If SIM provisioning is not used and you need to add or edit the MSISDN for the SIM in a device, you can edit the field on the Device Details page for that device. If the SIM was previously managed by a SIM provisioner, you must remove the provisioning for the SIM in the device before you can edit the MSISDN field. NOTE: The probe can occasionally return an MSISDN number that is not fully qualified and cannot be used for sending an SMS. In this case, you can either edit the MSISDN manually or turn off the probe and make sure to put the MSISDN information into the shipping file and upload it again to set it. NOTE: This function is available to Super Admins only. To edit the MSISDN: 1. On the administration tree, click a client company name to view N4A through a company administrator level view. 2. Click the Devices tab. The Device Inventory page opens. 3. Locate the device and click the Device ID link. The Device Details page opens. 4. On the Device Details page, click the Device tab. N4A Device Manager User Guide 108

117 The Device tab opens. 5. In MSISDN, enter the MSISDN number. 6. Click Save. Other Options To return to the previous page without saving, click Cancel. See Also Removing a SIM Provisioning Service Viewing Device Details Viewing Probes Administration Tree N4A Device Manager User Guide 109

118 Sending Commands to a Device You can send AT commands to a device from Device Manager. This feature provides the ability to remotely debug a device when it is having issues in the field. The device must be online with Device Manager for you to send commands to it. Device Manager assumes the device is online up to five minutes after its last transmission. The timeout setting is configurable. If Device Manager considers the device offline, you can send a forced check-in message by SMS to bring it back online and begin sending commands. After you enter the commands, the responses should display immediately along with any errors. If the device does not respond within the configured command timeout period, the system displays a timeout response. The default command timeout is 30 seconds. CAUTION! The system does not validate the AT commands for syntax or suitability for sending over the air. NOTE: This function is available to Super Admins only. To send commands to devices: 1. On the administration tree, click a client company name to view N4A through a company administrator level view. 2. Click the Devices tab. The Device Inventory page opens. 3. Locate the device to send AT Commands to and click the Device ID link. The Device Details page opens. 4. Click the Chat tab. N4A Device Manager User Guide 110

119 The Chat tab opens. 5. If the device is not online (the stoplight light is RED), click Wakeup to send a check-in request to the device. NOTE: The device must be online for you to send commands to it. When the device is communicating with Device Manager (the stoplight light is GREEN), then the message box becomes enabled and you can type in the commands to send them to the device. 6. Type a command and press Enter. NOTE: Pressing Enter sends the command. Enter one command per line. A successful response or an error appears. 7. Repeat step 6 for each command to be entered. Other Options To clear the message box at any time, click Clear Console. To return to the Device Inventory, click Cancel. N4A Device Manager User Guide 111

120 See Also Viewing Device Details Administration Tree N4A Device Manager User Guide 112

121 5 Distributor Management Company Info Inventory Device Uploads Clients Users (Distributor Admins) Settings (Distributor) License Journal (Distributor) 113

122 Company Info Clicking the Company Info tab on the navigation bar opens the Overview page. This page contains two parts. The top portion displays the distributor s client companies and assigned and activated devices. The bottom portion contains the distributor s company information including address and contact information. This is also the page that opens when you log in as a Distributor Admin. Tasks available from this page include: Viewing Client Companies Editing Distributor Company Information N4A Device Manager User Guide 114

123 Viewing Client Companies The top portion of the Overview page contains a summary of the client companies belonging to the distributor. The left side of the page contains a graphic that visually shows the number of devices allotted per company. The right side shows the same information in a table format along with the company type and number of activated devices. You can click Home at anytime to return to this page. To view the client company Info: 4 On the navigation bar, click the Company Info tab. The Overview page opens displaying the client company information. N4A Device Manager User Guide 115

124 Editing Distributor Company Information The lower half of the Overview page contains address and contact information for the distributor, which can be modified by the Distributor Admin. To edit Company Information: 1. On the navigation bar, click the Company Info tab. The Overview page opens. 2. On the Overview page, scroll down until the Edit Company Information section appears. 3. Enter the information in the fields provided. 4. Click Save. Other Options To clear all fields and start over at any point before saving, click Reset. N4A Device Manager User Guide 116

125 Inventory Clicking the Inventory tab on the navigation bar opens the Overview page. Tasks available from this page include: Viewing Device Inventory Moving Devices Reclaiming Devices Activating Device Features for Client Companies Deleting Devices N4A Device Manager User Guide 117

126 Viewing Device Inventory All of the devices belonging to a distributor are listed on the Device Inventory page. From the Device Inventory page, you can move devices and assign them to your client companies. To view the Device Inventory: 4 On the navigation bar, click the Devices tab. The Device Inventory page opens. See Also Moving Devices Deleting Devices N4A Device Manager User Guide 118

127 Moving Devices The Distributor's view of the Device Inventory contains all of the devices owned by the Distributor. From this page, the Distributor Admin can move devices to a client company or to other subdistributors. Once moved, the client company manages them. NOTE: Only devices that are currently present in the distributor s inventory can be moved. Devices that have been assigned to client companies (or subdistributors) may not be moved. (They must first be reclaimed from the client companies.) To move devices in the Device Inventory: 1. Click the Inventory tab. The Device Inventory page opens. 2. Locate and select the devices to move. 3. In the Move list, select the company or sub-distributor you are moving the devices to. 4. Click Move. N4A Device Manager User Guide 119

128 See Also Reclaiming Devices Viewing Device Inventory Deleting Devices N4A Device Manager User Guide 120

129 Reclaiming Devices As a distributor admin, you can reclaim devices from a company in your hierarchy and move them back into distributor inventory. The devices are then available to assign to another company. The Reclaiming Devices function is available from the company s Device Inventory page. To reclaim devices: 1. On the administration tree, click the client company name. The client company info page opens. 2. On the navigation bar, click the Inventory tab. The Device Inventory page opens. 3. Locate and select the devices to move. 4. Click Reclaim. N4A Device Manager User Guide 121

130 The devices you selected appear in the distributor device inventory. See Also Moving Devices Deleting Devices Viewing Device Inventory N4A Device Manager User Guide 122

131 Activating Device Features for Client Companies If your company is designated a Trusted distributor, you can activate device features for selected devices. To activate one or more devices: 1. On the administration tree, click a client company name to view N4A through a limited company administrator level view. 2. Click the Inventory tab. The Device Inventory page opens. 3. On the Device Inventory page, select the devices you want to activate. 4. In the Activation area, select the features to activate for the devices. 5. Click Activate. N4A Device Manager User Guide 123

132 A confirmation message appears. 6. Click OK to continue with activation. A success message appears. 7. [Optional] Select devices and click Activate GFMI. NOTE: GFMI is only available for MT 4000 and MT 4100 models. A confirmation message appears. 8. Click OK to continue with activation. A success message appears. See Also Software and Device Licensing N4A Device Manager User Guide 124

133 Deleting Devices To delete devices from the Device Inventory: 1. Click the Inventory tab. The Device Inventory page opens. 2. Locate and select the devices to delete. 3. Click Delete. See Also Reclaiming Devices Moving Devices Viewing Device Inventory N4A Device Manager User Guide 125

134 Device Uploads Clicking the Device Uploads tab on the navigation bar opens the Device Batch Uploads page. Tasks available from this page include: Viewing the List of Device Uploads Uploading Device Information N4A Device Manager User Guide 126

135 Viewing the List of Device Uploads From the Device Batch Uploads page, you can upload devices into your inventory. To view device uploads: 4 On the Admin subnavigation bar, click the Device Uploads tab. The Device Batch Uploads page opens. See Also Viewing Device Batch Upload Details Uploading Device Information N4A Device Manager User Guide 127

136 Uploading Device Information Device information must be uploaded to the system before the devices can communicate with the N4A software platform. There are two ways to upload device information: Uploading a DCU batch file NOTE: A DCU file is a CSV formatted file of device information line items. Uploading an IMEI for a single device To upload a batch of devices using Upload a Device file: 1. On the Device Batch Uploads page, click Browse. 2. Locate and select the DCU file from your computer. 3. Click Upload. To upload a single device by using IMEI information: 1. On the Device Batch Uploads page, in IMEI/IMEID, enter the IMEI. 2. In Modem ID, enter the Modem ID. NOTE: If the Modem ID is not provided, re-enter the IMEI. 3. In the Device Type list, select the correct device type. 4. Click Upload. N4A Device Manager User Guide 128

137 A success message appears. See Also Viewing Device Batch Upload Details Viewing Device Inventory N4A Device Manager User Guide 129

138 Viewing Device Batch Upload Details The Device Batch Upload Detail page displays information about an uploaded device or batch of devices. To view Device Batch Upload Details: 1. On the Device Batch Uploads page, locate the Device Batch and click the Batch File link. The Device Batch Upload Detail page opens where you can view the batch upload information. 2. Click Cancel to return to the Device Batch Uploads page. See Also Uploading Devices N4A Device Manager User Guide 130

139 Clients Clicking the Clients tab on the navigation bar opens the Company Management page. Tasks available from this page include: Viewing the List of Distributors or Companies Editing Distributor or Company Information Adding a Distributor or Company N4A Device Manager User Guide 131

140 Viewing the List of Distributors or Companies Depending on your role and the area accessed, the Company Management page displays either the list of distributors or list of client companies and sub-distributors. From this page you can access company details or click Add to add a new company. NOTE: Companies and sub-distributors managed by a distributor are referred to as client companies. To view the Company Management page: 4 Depending on your location, you can access the Company Management page by one of the following methods: System Administration On the navigation bar, click the Distributors tab. Distributor On the navigation bar, click the Clients tab. The Company Management page opens and displays the distributors or client companies. See Also Editing Distributor or Company Information Adding a Distributor or Company N4A Device Manager User Guide 132

141 Editing Distributor or Company Information On the Edit Company page, you can view and edit a company's address and contact information. Additionally, depending on your access level, you can activate or deactivate the company in the system. To edit the company information: 1. Depending on your location, you can access this page by one of the following methods: System Administration On the Distributors page, locate the distributor company and click the Distributor Name link. Distributor On the Company Management page, locate the client company and click the Company link. Company On the Admin subnavigation bar, click the Company Info tab. The Edit Company page opens. 2. Edit the information as needed. 3. Click Save. N4A Device Manager User Guide 133

142 Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. To activate or deactivate the client or company, select the appropriate radio button and click Save. NOTE: The Edit Company page contains Status options for making a Company either active or inactive in the system. This allows you to keep a company inactive until you are ready to go live with the account. Alternatively, if you need to deactivate the company, you can move them from active to inactive. See Also Viewing the List of Distributors or Companies Adding a Distributor or Company N4A Device Manager User Guide 134

143 Adding a Distributor or Company Depending on your level and purpose, you can add a distributor or company. The distributor administrator user level is required for assigning devices to client companies. The distributor is also responsible for the license for their client companies. Only distributor companies can be created directly from the system administration area. These are referred to as top-level distributors. All other companies and sub-distributors are created under individual top-level distributors. To add a distributor: 1. Depending on your location, you can access the Company Management page by one of the following methods: System Administration On the navigation bar, click the Distributors tab. Distributor On the navigation bar, click the Clients tab. 2. Click Add. The Add Distributor (or Add Company) page opens. 3. Enter information in the fields provided. 4. Click Save. N4A Device Manager User Guide 135

144 The page reopens and displays a success message. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. To activate or deactivate the client or company, select the appropriate radio button and click Save. NOTE: The Add Company page contains Status options for making a Company either active or inactive in the system. This allows you to keep a company inactive until you are ready to go live with the account. Alternatively, if you need to deactivate the company, you can move them from active to inactive. See Also Viewing the List of Distributors or Companies Editing Distributor or Company Information N4A Device Manager User Guide 136

145 Users (Distributor Admins) Clicking the Users tab on the navigation bar opens the User Management page. Tasks available from this page include: Viewing the List of Users Adding a User Editing a User Changing a User Password Activating or Deactivating a User N4A Device Manager User Guide 137

146 Viewing the List of Users The User Management page contains a list of the users currently in the system. From this page, a Super Admin, Distributor Admin, and Company Admin can view the list of users in their access areas. They can also add, edit, or deactivate users. However, the user types and users appearing in the list vary by the area and admin viewing it. The following table lists the role types, the areas they can access within their hierarchy, and the user types they can add or edit. User Role Areas Accessible in Hierarchy User Type that Role can Add or Edit Super Admin System Administration Super Admin Distributor Company Distributor Admin Company Admin, Company User Distributor Admin Distributor Distributor Admin Company Company Admin Company Admin Company Company Admin, Company User To view the list of users: 4 On the Navigation bar, click the Users tab. N4A Device Manager User Guide 138

147 The User Management page opens displaying the users for system administration, the distributor, or company. See Also Adding a User Editing a User Changing a User Password Activating or Deactivating a User Understanding User Roles N4A Device Manager User Guide 139

148 Adding a User To add a user: 1. On the User Management page, click Add. The Add User page opens. 2. Enter information in the fields provided. 3. Select the User Type. NOTE: The available user types change depending on which area you access the Add User page from. See the user role table in Viewing the List of Users. 4. Click Save. The User Management page reopens with the new user displayed in the list. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Editing a User Changing a User Password Activating or Deactivating a User N4A Device Manager User Guide 140

149 Editing a User The Super Admin, Distributor Admin, and the Company Admin roles have access to view and edit the users within their area or company. To view and edit a user: 1. On the User Management page, locate the user and click the Username link. The Edit User page opens. 2. Edit the information as needed. 3. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Adding a User Changing a User Password Activating or Deactivating a User N4A Device Manager User Guide 141

150 Changing a User Password To change a password: 1. On the User Management page, locate the user and click the Username link. The Edit User page opens. 2. In the Password field, enter a new password. 3. In the Confirm Password field, enter the new password again to confirm it. 4. Click Save immediately below the password fields. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Adding a User Editing a User Activating or Deactivating a User N4A Device Manager User Guide 142

151 Activating or Deactivating a User The Edit User page contains Status options for setting a user account to either active or inactive in the system. This allows you to keep a user inactive until you are ready to go live with the account. Alternatively, if you need to deactivate the user, you can move them from active to inactive. To activate or deactivate a user: 1. On the User Management page, locate the user and click the Username link. The Edit User page opens. 2. In Status, select either Active or Inactive to set the user s status within the system. 3. Click Save. A success message appears. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Adding a User N4A Device Manager User Guide 143

152 Editing a User Changing a User Password N4A Device Manager User Guide 144

153 Settings (Distributor) Clicking the Settings tab on the navigation bar opens the Default Settings for Clients page. Tasks available from this page include: Editing Client Company Settings N4A Device Manager User Guide 145

154 Editing Client Company Settings The top portion of the Clients Settings section contains options for server setup. The bottom portion of the page contains other settings that you can set as the defaults for Client Companies you create. These settings include date formatting and page list length (table settings). When you create a new Client Company, the company settings default to these settings. The Company Admin can modify the settings, if needed. To edit client company settings: 1. On the navigation bar, click the Settings tab. The Default Settings for Clients page opens. 2. Select the appropriate options and enter information in the fields provided to set the Client Company defaults. 3. Click Save. N4A Device Manager User Guide 146

155 Other Options To clear all fields and start over at any point before saving, click Reset. To test recipients, in the Test Recipients field, enter an and click Test. N4A Device Manager User Guide 147

156 Editing Client Company Settings as a Trusted Distributor The Client Company Settings page contains options for server setup, device license options, date formatting, and page list length (table settings) that you can set as the defaults for new companies. NOTE: Changes to the Device License Options section of this page could affect the billing to your company from Novatel Wireless. Ensure that you are making the appropriate changes for your company before editing the settings. To edit client company settings: 1. On the navigation bar, click the Settings tab. N4A Device Manager User Guide 148

157 The Default Settings for Clients page opens. 2. Select the appropriate options and enter information in the fields provided to set the Client Company defaults. 3. Click Save. N4A Device Manager User Guide 149

158 Other Options To clear all fields and start over at any point before saving, click Reset. To test recipients, in the Test Recipients field, enter an and click Test. N4A Device Manager User Guide 150

159 License Clicking the License tab on the navigation bar opens the License Management page. Tasks available from this page include: Redeeming a License Uploading a License Viewing the License Updating a License Deleting a License N4A Device Manager User Guide 151

160 Redeeming a License As a top-level distributor, you must redeem your license before you can use the N4A Software Platform interface. When you receive the license GUID code from Novatel Wireless, visit the License Management page to redeem it. NOTE: To automatically redeem a license, the Device Manager must be able to communicate with the Novatel Wireless CMS Installation Manager. The connection criteria for this communication is set up in the System Administration area in the System Settings section. A top-level distributor s license applies to all client companies and sub-distributors in the distributor s hierarchy. To redeem a license: 1. On the navigation bar, click the License tab. The License Management page opens. 2. In the Redeem a License section, type the License GUID in the field provided. 3. Click the Redeem button. See Also Uploading a License Updating the License N4A Device Manager User Guide 152

161 Deleting a License Viewing the License Software and Device Licensing N4A Device Manager User Guide 153

162 Uploading a License You can add your license on the License Management page. To add a license: 1. On the navigation bar, click the License tab. The License Management page opens. 2. Click on Browse. 3. Navigate to the file you want to choose from your computer. 4. Click on the Filename. 5. Click Open. The filename now appears to the left of the Browse button. 6. Click Upload. See Also Redeeming a License Deleting a License Software and Device Licensing N4A Device Manager User Guide 154

163 Viewing the License To view the license: 4 On the navigation bar, click the License tab. The License Management page opens. See Also Redeeming a License Uploading a LIcense Updating a License Deleting a License Software and Device Licensing N4A Device Manager User Guide 155

164 Updating a License Updating a license triggers DM to connect to the N4A CMS installation Manager database to retrieve an updated version of the license, if any. NOTE: The CMS Installation Manager database is updated daily with new licenses. To update a license: 1. On the navigation bar, click the License tab. The License Management page opens. 2. In the License GUID field, type in the new GUID code containing your new license information. 3. Click Update. See Also Redeeming a License Uploading a License Viewing the License Deleting a License Software and Device Licensing N4A Device Manager User Guide 156

165 Deleting a License WARNING! Deleting a license deactivates all of your companies and causes clients to be unable to log in again to the N4A Software Platform. Having an active license is needed for your clients to log in. To delete a license: 4 On the License Management page, click Delete. See Also Viewing the License Redeeming a License Updating a License Uploading a License Software and Device Licensing N4A Device Manager User Guide 157

166 Journal (Distributor) Clicking the Journal tab on the navigation bar opens the Company Activity Log page. Tasks available from this page include: Viewing the Company Activity Log N4A Device Manager User Guide 158

167 Viewing the Company Activity Log User activity is monitored and presented in the company journal. The Company Activity Log displays a running list of actions that users have performed in the system for the Distributor or Company you are currently logged into. Select/de-select the Include Logins/Logouts option to toggle the view. To view the Company Activity Log: 4 On the navigation bar, click the Journal tab. The Company Activity Log page opens. N4A Device Manager User Guide 159

168 N4A Device Manager User Guide 160

169 6 Company Management Devices Services Deployments SIMs Administration LBS 161

170 Devices Clicking the Devices tab on the navigation bar opens the Device Inventory page. Tasks available from this page include: Device Inventory OBD Inventory Device Groups N4A Device Manager User Guide 162

171 Device Inventory Clicking the Inventory tab on the Device tab opens the Device Inventory page. Tasks available from this page include: Viewing Device Inventory Viewing Device Details Viewing Event Details Deleting Devices Grouping Devices Deploying Services to Devices Checking In Devices Viewing Device Inventory The Device Inventory page contains all of the devices that are assigned to a company. From this page, you can search for specific devices using filtering, group devices, deploy services, check-in devices, or view device details. The Device Inventory is also the homepage for the company admin. To view the Device Inventory: 4 On the navigation bar, click the Devices tab. N4A Device Manager User Guide 163

172 The Device Inventory page opens. See Also Viewing Device Details Deleting a Device Grouping Devices Deploying Services to Devices Checking In Devices Filtering Viewing Device Details The Device Details page contains various tabs you can click to view more information about an individual device. To view device details: 1. On the Device Inventory page, locate the device and click the Device ID link. N4A Device Manager User Guide 164

173 The Device Details page opens. 2. Click the various tabs available to view more device details. 3. Click Cancel. See Also Viewing Device Inventory Viewing Event Details Editing the MSISDN for a SIM Changing Device Type Viewing Event Details The Event Details page contains various tabs you can click to view more information about the Event, GPS, GPIO, UVAR, Accelerometer, PCELL, and OBD II. To view a device's event details: 1. From the Device Inventory page, click the Device ID link. N4A Device Manager User Guide 165

174 The Device Details page opens. 2. Click the Events tab. The Device Events page opens. 3. Click the Device Event Id link. The Event Details page opens. See Also Viewing Device Details Viewing Device Inventory Deleting Devices You can delete devices within your device inventory. N4A Device Manager User Guide 166

175 To delete a device: 1. On the Device Inventory page, locate and select the device. 2. Click Delete. See Also Viewing Device Inventory Uploading Device Information Grouping Devices From the Device Inventory page, you can create a device group from selected devices. Device Groups are useful for deployments and managing your devices. A device group must contain the same type of devices and a device can only belong to one group. To group devices: 1. On the Device Inventory page, select the devices you want to group or add to a group. 2. Click Group. N4A Device Manager User Guide 167

176 The Device Group Edit page opens. The selected devices appear under Devices in this Group. In addition, the system finds similar devices that you may also want to add to the group. These devices are shown under Add Devices to Group. 3. In Device Group, enter a name for the group. 4. In Description, enter a description for the group. 5. [Optional] Select one or more of the additional devices and click Add. 6. [Optional] Select one or more of the original devices and click Remove. 7. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing Device Inventory Deploying Services to Devices Viewing Device Groups Adding a Device Group Deploying Services to Devices From the Device Inventory page, you can deploy services to selected devices. To deploy services to devices: 1. On the Device Inventory page, select the devices you want to deploy devices to. N4A Device Manager User Guide 168

177 2. Click Deploy. The Prepare a Deployment page opens. 3. In Deployment Name, enter a name for the deployment. 4. In Description, enter a description for the deployment. 5. Click Deploy. The Deployment Detail page opens to show the deployment has been scheduled. Other Options To suspend the deployment until a later time, click Suspend. To abort the deployment, click Abort. N4A Device Manager User Guide 169

178 See Also Viewing Device Inventory Grouping Devices Uploading a Service N4A Device Manager User Guide 170

179 Checking In Devices From the Device Inventory page, you can send a check in request to selected devices. To send a check in request: 1. On the Device Inventory page, select the devices you want to send a check in request to. 2. Click Check In. See Also Viewing Device Inventory N4A Device Manager User Guide 171

180 OBD Inventory Clicking the OBD Inventory tab on the Device tab opens the OBD Device Inventory page. NOTE: This feature requires licensing for Advanced Diagnostics. See Software and Device Licensing or contact your Novatel Wireless sales representative. Tasks available from this page include: Viewing OBD Device Inventory Viewing OBD Device Details Viewing OBD Vehicle Data Viewing OBD Configuration History Sending OBD Action Commands Viewing OBD Device Inventory NOTE: For a device to appear in the OBD Inventory, it must be activated for Advanced Diagnostics by a Super Admin or Trusted Distributor Admin. This feature also requires licensing for Advanced Diagnostics. The OBD Device Inventory displays the devices that report a VIN (Vehicle Identification Number). On this page, you can filter the list of devices to narrow your search for information such as Device ID, Device Type, and Vehicle Year/Make/Model/Trim. Summary information is provided for each device in the list. Click a Device ID link to view device details. To view the OBD Device Inventory: 4 On the Devices subnavigation bar, click the OBD Inventory tab. N4A Device Manager User Guide 172

181 The OBD Device Inventory page opens. See Also Viewing OBD Device Details Viewing OBD Vehicle Data Viewing OBD Configuration History Sending OBD Action Commands Filtering N4A Device Manager User Guide 173

182 Viewing OBD Device Details The OBD Device Details pages provide OBD-related information about a device and the vehicle it is attached through a series of tabs. The default tab is Device (OBD Device Data). The Device Data tab includes information about the device such as Device Type, IMEI/MEID, MSISDN, and Last Checkin Requested date and time. To view OBD Device Details: 4 On the OBD Device Inventory page, locate a device and click the Device ID link. The OBD Device Details page opens and displays device data. Other Options To return to the OBD Device Inventory page, click Cancel. See Also Viewing OBD Device Inventory Viewing OBD Vehicle Data Viewing OBD Configuration History Sending OBD Action Commands N4A Device Manager User Guide 174

183 Viewing OBD Vehicle Data The OBD Vehicle Data page provides OBD-related information for the vehicle to which the device is attached. This page lists the vehicle VIN number, Year, Make, Model, Trim, and Engine information as well as the VRM, PID Mask, and OBD Protocol. Additionally, you can set the VIN manually for a device that has not reported into Device Manager. NOTE: Use care when using the Set VIN feature. For assistance, contact your Novatel Wireless representative. To view OBD Vehicle Data: 1. On the OBD Device Inventory page, locate a device and click the Device ID link. The OBD Device Details page opens. 2. Click the OBD Vehicle Data tab. The OBD Vehicle Data page opens. Other Options To return to the OBD Device Inventory page, click Cancel. See Also Viewing OBD Device Inventory Viewing OBD Device Details Viewing OBD Configuration History Sending OBD Action Commands N4A Device Manager User Guide 175

184 Viewing OBD Configuration History The OBD Configuration History page provides the history of vehicle configuration file deployments to this device. For example, when you move a device from one vehicle to another vehicle model, it requires a new configuration file to be sent to it. The history page shows each configuration deployed since it became active on Device Manager. In addition, you can also manually send a configuration to the device. To view OBD Configuration History: 1. On the OBD Device Inventory page, locate a device and click the Device ID link. The OBD Device Details page opens. 2. Click the OBD Configurations tab. The OBD Configuration History page opens. See Also Sending an OBD Configuration to a Device Viewing OBD Device Inventory Viewing OBD Device Details Viewing OBD Vehicle Data Sending OBD Action Commands Sending an OBD Configuration to a Device From the OBD Configuration History page you can manually send an OBD configuration file to a device. N4A Device Manager User Guide 176

185 NOTE: OBD configuration files can be specified for one region or all geographic regions. The system uses the geographic region along with the vehicle information to determine which configuration to send to the device. To send a configuration file to the device: 1. From the OBD Configuration History page, under Select Config to send to device, select the Year, Make, Region, and Model (if required). 2. Click Set Config. The OBD Configuration is sent to the device upon the vehicle s next ignition cycle. If successful, a confirmation message appears and the status shows Successful and is highlighted green. Other Options To return to the OBD Device Inventory page, click Cancel. See Also Viewing OBD Configuration History Viewing OBD Device Inventory Viewing OBD Device Details Viewing OBD Vehicle Data Sending OBD Action Commands Sending OBD Action Commands NOTE: This feature requires licensing for Advanced Diagnostics. See Software and Device Licensing. N4A Device Manager User Guide 177

186 If enabled, you can send OBD Action Commands to a device to control vehicle features from the OBD Device Details page. To send OBD Action Commands to a device: 1. On the OBD Device Details page, click the OTA tab. The OTA page opens. The image map that appears corresponds to the vehicle in which your OBD device is installed. 2. Click on the windows or doors on the vehicle image map to select the area to control. N4A Device Manager User Guide 178

187 The areas you select highlight to confirm the location and type of command. 3. When you have selected your commands on the image map, click Send Commands. A message appears at the bottom of the screen stating that the commands have been sent. NOTE: An error message appears if the command could not be sent. Other Options To return to the OBD Device Inventory page, click Cancel. See Also Viewing OBD Device Inventory Editing OBD Device Details Enabling OBD Action Commands for Client Companies N4A Device Manager User Guide 179

188 Device Groups Clicking the Groups tab on the Device tab opens the Device Group Inventory page. Tasks available from this page include: Viewing Device Group Inventory Editing a Device Group Adding a Device Group Viewing Device Group Inventory Device Groups are useful for deployments and managing your devices. A device group must contain the same type of devices and a device can only belong to one group. To view and edit a device group: 4 On the Device Group Inventory page, locate the device group and click the Device Group Name link. The Device Group Inventory page opens. See Also Editing Device Groups Adding a Device Group Grouping Devices N4A Device Manager User Guide 180

189 Editing a Device Group On the Device Group Edit page, you can add devices to or remove devices from a device group. You also have the option to deploy the device group from this page. To view and edit a device group: 1. On the Device Group Inventory page, locate the device group and click the Device Group Name link. The Device Group Edit page opens. 2. Edit device group information as needed. 3. [Optional] You can remove or add devices into the group by clicking on the checkbox for a device and then clicking the Remove or Add buttons. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. To Deploy the device group you are editing, click Deploy. See Deploying Services to Devices for more information. N4A Device Manager User Guide 181

190 See Also Viewing Device Group Inventory Adding a Device Group Grouping Devices Adding a Device Group On the Device Group Add page, you can add a device group that you can later add devices to. Also on this page, you can upload a list of devices and simultaneously add a new group to assign them to. To add a device group: 1. On the Device Group Inventory page, click Add. The Device Group Add page opens. 2. In the Device Group Name, type in a name for your device group. 3. In the Device Type list, select the appropriate device type. 4. [Optional] In the Description, type in a description of the group. 5. [Optional] Upload a list of devices. 6. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. N4A Device Manager User Guide 182

191 See Also Viewing Device Group Inventory Editing Device Groups Grouping Devices N4A Device Manager User Guide 183

192 Services Clicking the Services tab on the navigation bar opens the Service Inventory page. Tasks available from this page include: Viewing Service Inventory Editing Service Details Cloning a Service Uploading a Service Adding a Custom Service N4A Device Manager User Guide 184

193 Viewing Service Inventory Services are scripts sent (deployed) from N4A Software Platform to the device to allow communication between them. The Service Inventory page displays a list of the services that have been added to the system for deployment. To view the Service Inventory: 4 On the navigation bar, click the Services tab. The Service Inventory page opens. See Also Editing Service Details Uploading a Service Adding a Custom Service Deploying Services to Devices N4A Device Manager User Guide 185

194 Editing Service Details From the Edit Service page, you can edit service details. To edit service details: 1. On the Service Inventory page, locate the service and click the Service Name. The Edit Service page opens. 2. Edit the service information as needed. NOTE: You can only edit a service when there are no active deployments for the service. 3. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. To deactivate a service, select Inactive and click Save. N4A Device Manager User Guide 186

195 See Also Cloning a Service Viewing Service Inventory N4A Device Manager User Guide 187

196 Cloning a Service A service can be cloned or duplicated to be deployed to a different device group. To clone a service: 1. Open the Edit Service page you want to duplicate, click Clone. A warning message appears asking you to make sure you want to perform the cloning. 2. Click OK. A success message appears along with the assigned name for the new service. 3. [Optional] Edit the service and click Save. 4. Click Cancel to return to the Service Inventory page. See Also Editing Service Details Uploading a Service Adding a Custom Service Viewing Service Inventory N4A Device Manager User Guide 188

197 Uploading a Service From the Upload Service page, you can upload a new Service to the system. You have the option to assign a service to one of the system users. To upload a service: 1. On the Services subnavigation bar, click the Upload tab. The Upload Service page opens. 2. Enter information in the fields provided and select options as needed. 3. In Service File, click Choose File and select the service file from your computer. 4. Click Upload. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing Service Inventory Adding a Custom Service Cloning a Service N4A Device Manager User Guide 189

198 Adding a Custom Service You can create a custom service using the templates provided in the Custom Service page. There is a FOTA template for each device type. In addition, the Spider AT devices have additional templates available. You can also assign the service to a specific user. To add a custom service: 1. On the Services subnavigation bar, click the Customize tab. The Custom Service page opens. 2. Select a product. 3. Select a service template. 4. Enter information in the fields provided. 5. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. N4A Device Manager User Guide 190

199 See Also Viewing Service Inventory Uploading a Service N4A Device Manager User Guide 191

200 Deployments Clicking the Deployments tab on the navigation bar opens the Deployments page. Tasks available from this page include: Viewing Deployments Viewing Deployment Details Aborting Deployments Suspending Deployments N4A Device Manager User Guide 192

201 Viewing Deployments As a company admin, you can view service deployments and related information. The deployments page also provides the options to suspend, resume, or abort active deployments. On this page, you can filter the list of deployments to narrow your search for information such as Deployment Name, Date Range, Service, Service Types, and Status. Summary information is provided for each deployment in the list. Click a Deployment Name link to view deployment details. To view deployments: 4 On the navigation bar, click the Deployments tab. The Deployments page opens. See Also Deploying Services to Devices Viewing Deployment Details Suspending Deployments Aborting Deployments Filtering N4A Device Manager User Guide 193

202 Viewing Deployment Details The Deployment Detail page displays information about a single deployment. You can view the list of devices that were included within the deployment and the current deployment status. To view deployment details: 1. On the Deployments page, locate a deployment and click the deployment Name. The Deployment Detail page opens. 2. To return to the Deployments page, click Cancel. See Also Viewing Deployments Aborting Deployments Suspending Deployments N4A Device Manager User Guide 194

203 Aborting Deployments You can stop or abort deployments while they are active. The Deployments page displays all of the active deployments within the system and their status. To abort a deployment: 1. On the Deployments page, locate and select the deployment to abort. 2. Click Abort. The Deployments page opens to show the deployment has been canceled. N4A Device Manager User Guide 195

204 See Also Suspending Deployments Viewing Deployment Details Viewing Deployments N4A Device Manager User Guide 196

205 Suspending Deployments You can temporarily suspend active deployments and resume them at a later time. To suspend deployments: 1. On the deployments page, locate the deployment and select the checkbox corresponding to the deployment Name. 2. Click Suspend. The Deployments page opens to show the deployment has been suspended. N4A Device Manager User Guide 197

206 Other Options When you suspend a deployment, you can choose to resume it. To resume a deployment: 1. Locate and select the suspended deployment. 2. Click Resume. See Also Aborting Deployments Viewing Deployments N4A Device Manager User Guide 198

207 SIMs Clicking the SIMS tab on the navigation bar opens the SIMs page. Tasks available from this page include: Inventory Add Credentials N4A Device Manager User Guide 199

208 Inventory Clicking the Inventory tab on the navigation bar opens the SIMs page. Tasks available from this page include: Viewing SIM Inventory Viewing SIM Details Activating or Deactivating a SIM Viewing SIM Inventory From the SIMs inventory page, you can choose to activate or deactivate a SIM after it has been added or view SIM details. To view the SIM Inventory: 4 In the navigation bar, click the SIMs tab. The SIMs inventory page opens. See Also Viewing SIM Details Activating or Deactivating a SIM N4A Device Manager User Guide 200

209 Adding a SIM Viewing SIM Details The SIM Details page contains tabs to view more information about the SIM. You can also choose to set a provisioning service for your SIM or a rate plan. To view SIM details: 1. On the SIMs inventory page, locate the SIM and click the ICCID link. The SIM ICCID page opens. 2. [Optional] On the SIM Provisioning Service drop down list, select another provisioning service for the SIM and click Save. Other Options To return to the previous page without saving, click Cancel. See Also Viewing SIM Inventory Activating or Deactivating a SIM N4A Device Manager User Guide 201

210 Activating or Deactivating a SIM You can activate or deactivate a SIM from the SIMs Inventory page. To activate or deactivate a SIM: 1. On the SIMs inventory page, select one or more SIMs. 2. Click either Activate or Deactivate. A message appears asking you to confirm whether to activate or deactivate the SIM. 3. Click OK to continue. See Also Viewing SIM Inventory Adding a SIM Removing a SIM Provisioning Service If you no longer are using a provisioning service or need to remove it from a single SIM, you can manually remove it on the SIM Details page. To remove SIM Provisioning: 1. On the SIMs subnavigation bar, click the Inventory tab. N4A Device Manager User Guide 202

211 The SIMs Inventory page opens. 2. On the SIM Inventory page, locate the SIM and click the SIM ICCID link. The SIM Details page opens. 3. In the SIM Provisioning Service list, select Remove Provisioning Service. 4. Click Save. Other Options To return to the previous page without saving, click Cancel. See Also Viewing SIM Provisioning Service Credentials Editing the MSISDN for a SIM N4A Device Manager User Guide 203

212 Add Clicking the Add tab on the navigation bar opens the Add SIMs page. Tasks available from this page include: Adding a SIM to the System Adding a SIM You can add a SIM one at a time or by uploading a file with the list of SIM ICCIDs. There are two methods for adding a SIM: Add a SIM and Attach a Device Upload a File of SIM ICCIDs To add a SIM using Add a SIM and Attach to a Device: 1. On the SIMs subnavigation bar, click the Add tab. The Add SIMs page opens. 2. In the ICCID field, enter the SIM ICCID. 3. In the SIM Type list, select the SIM type. 4. [Optional] Select a device to attach to the SIM. N4A Device Manager User Guide 204

213 5. Click Add. To add a SIM using Upload a File of SIM ICCIDs: 1. On the SIMs subnavigation bar, click the Add tab. The Add SIMs page opens. 2. In File, click Browse and select the file from your computer. 3. In the SIM Type list, select the SIM type. 4. [Optional] Select a device to attach to the SIM. 5. Click Add. See Also Viewing SIM Inventory Activating or Deactivating a SIM N4A Device Manager User Guide 205

214 Credentials Clicking the Credentials tab on the navigation bar opens the SIM Provisioning Service Credentials page. Tasks available from this page include: Viewing SIM Provisioning Service Credentials Editing SIM Provisioning Service Credentials Adding SIM Provisioning Service Credentials Removing a SIM Provisioning Service Viewing SIM Provisioning Service Credentials From the SIM Provisioning Credentials page you can view the details about the credentials needed to connect to SIM provisioning services. To view the SIM Provisioning Service Credentials: 4 On the SIMs subnavigation bar, click the Credentials tab. The SIM Provisioning Service Credentials page opens. See Also Editing SIM Provisioning Service Credentials Adding SIM Provisioning Service Credentials Removing a SIM Provisioning Service N4A Device Manager User Guide 206

215 Editing SIM Provisioning Service Credentials From the SIM Provisioning Credentials page, you can view or edit SIM Provisioning Credential details. You can also choose to deactivate the Provisioning Credential from this page. To view and edit the SIM Provisioning Credentials: 1. On the SIMs subnavigation bar, click the Credentials tab. The SIM Provisioning Service Credentials page opens. 2. On the Provisioning Credentials page, locate the SIM and click the SIM Provisioning Service Credential Name. The Edit SIM Provisioning Credentials page opens. 3. Enter the specified information in the fields provided. 4. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. To deactivate the Provisioning Service Credential, select Inactive and click Save. See Also Viewing SIM Provisioning Service Credentials Adding SIM Provisioning Credentials N4A Device Manager User Guide 207

216 Adding SIM Provisioning Service Credentials From the SIM Provisioning Credentials page, you have the option to add custom provisioning service credentials for your SIM. NOTE: Novatel Wireless currently has SIM provisioning integration capabilities with Jasper and AT&T EOD. To add SIM Provisioning Service Credentials: 1. On the SIM Provisioning Service Credentials page, click Add. The Add SIM Provisioning Service Credentials page opens. 2. Enter the information provided. 3. Click Add. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing SIM Provisioning Service Credentials Editing Provisioning Credentials N4A Device Manager User Guide 208

217 Administration Clicking the Admin tab on the navigation bar opens the Company Info page. There are many tabs available in the Admin subnavigation bar. Tasks available from this tab include: Editing Company Information Users (Company) Device Uploads Settings (Company) Probes Alerts Journal N4A Device Manager User Guide 209

218 Company Info Clicking the Company Info tab on the Admin subnavigation bar opens the Company Management page where you can edit your company information. Editing Distributor or Company Information On the Edit Company page, you can view and edit a company's address and contact information. Additionally, depending on your access level, you can activate or deactivate the company in the system. To edit the company information: 1. Depending on your location, you can access this page by one of the following methods: System Administration On the Distributors page, locate the distributor company and click the Distributor Name link. Distributor On the Company Management page, locate the client company and click the Company link. Company On the Admin subnavigation bar, click the Company Info tab. The Edit Company page opens. 2. Edit the information as needed. 3. Click Save. N4A Device Manager User Guide 210

219 Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. To activate or deactivate the client or company, select the appropriate radio button and click Save. NOTE: The Edit Company page contains Status options for making a Company either active or inactive in the system. This allows you to keep a company inactive until you are ready to go live with the account. Alternatively, if you need to deactivate the company, you can move them from active to inactive. See Also Viewing the List of Distributors or Companies Adding a Distributor or Company N4A Device Manager User Guide 211

220 Users (Company) Clicking the Users tab on the navigation bar opens the User Management page. Tasks available from this page include: Viewing the List of Users Adding a User Editing a User Changing a User Password Activating or Deactivating a User Viewing the List of Users The User Management page contains a list of the users currently in the system. From this page, a Super Admin, Distributor Admin, and Company Admin can view the list of users in their access areas. They can also add, edit, or deactivate users. However, the user types and users appearing in the list vary by the area and admin viewing it. The following table lists the role types, the areas they can access within their hierarchy, and the user types they can add or edit. User Role Areas Accessible in Hierarchy User Type that Role can Add or Edit Super Admin System Administration Super Admin Distributor Company Distributor Admin Company Admin, Company User Distributor Admin Distributor Distributor Admin Company Company Admin Company Admin Company Company Admin, Company User To view the list of users: 4 On the Navigation bar, click the Users tab. N4A Device Manager User Guide 212

221 The User Management page opens displaying the users for system administration, the distributor, or company. See Also Adding a User Editing a User Changing a User Password Activating or Deactivating a User Understanding User Roles N4A Device Manager User Guide 213

222 Adding a User To add a user: 1. On the User Management page, click Add. The Add User page opens. 2. Enter information in the fields provided. 3. Select the User Type. NOTE: The available user types change depending on which area you access the Add User page from. See the user role table in Viewing the List of Users. 4. Click Save. The User Management page reopens with the new user displayed in the list. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Editing a User Changing a User Password Activating or Deactivating a User N4A Device Manager User Guide 214

223 Editing a User The Super Admin, Distributor Admin, and the Company Admin roles have access to view and edit the users within their area or company. To view and edit a user: 1. On the User Management page, locate the user and click the Username link. The Edit User page opens. 2. Edit the information as needed. 3. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Adding a User Changing a User Password Activating or Deactivating a User N4A Device Manager User Guide 215

224 Changing a User Password To change a password: 1. On the User Management page, locate the user and click the Username link. The Edit User page opens. 2. In the Password field, enter a new password. 3. In the Confirm Password field, enter the new password again to confirm it. 4. Click Save immediately below the password fields. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Adding a User Editing a User Activating or Deactivating a User N4A Device Manager User Guide 216

225 Activating or Deactivating a User The Edit User page contains Status options for setting a user account to either active or inactive in the system. This allows you to keep a user inactive until you are ready to go live with the account. Alternatively, if you need to deactivate the user, you can move them from active to inactive. To activate or deactivate a user: 1. On the User Management page, locate the user and click the Username link. The Edit User page opens. 2. In Status, select either Active or Inactive to set the user s status within the system. 3. Click Save. A success message appears. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing the List of Users Adding a User N4A Device Manager User Guide 217

226 Editing a User Changing a User Password N4A Device Manager User Guide 218

227 Device Uploads Clicking the Device Uploads tab on the navigation bar opens the Device Batch Uploads page. Tasks available from this page include: Viewing the List of Device Uploads Uploading Device Information Viewing the List of Device Uploads From the Device Batch Uploads page, you can upload devices into your inventory. To view device uploads: 4 On the Admin subnavigation bar, click the Device Uploads tab. The Device Batch Uploads page opens. See Also Viewing Device Batch Upload Details Uploading Device Information N4A Device Manager User Guide 219

228 Uploading Device Information Device information must be uploaded to the system before the devices can communicate with the N4A software platform. There are two ways to upload device information: Uploading a DCU batch file NOTE: A DCU file is a CSV formatted file of device information line items. Uploading an IMEI for a single device To upload a batch of devices using Upload a Device file: 1. On the Device Batch Uploads page, click Browse. 2. Locate and select the DCU file from your computer. 3. Click Upload. To upload a single device by using IMEI information: 1. On the Device Batch Uploads page, in IMEI/IMEID, enter the IMEI. 2. In Modem ID, enter the Modem ID. NOTE: If the Modem ID is not provided, re-enter the IMEI. 3. In the Device Type list, select the correct device type. 4. Click Upload. N4A Device Manager User Guide 220

229 A success message appears. See Also Viewing Device Batch Upload Details Viewing Device Inventory Viewing Device Batch Upload Details The Device Batch Upload Detail page displays information about an uploaded device or batch of devices. To view Device Batch Upload Details: 1. On the Device Batch Uploads page, locate the Device Batch and click the Batch File link. The Device Batch Upload Detail page opens where you can view the batch upload information. 2. Click Cancel to return to the Device Batch Uploads page. See Also Uploading Devices N4A Device Manager User Guide 221

230 Settings (Company) Clicking the Settings tab under Admin opens the Company Settings page. Tasks available from this page include: Editing Company Settings Editing Company Settings The Company Settings page contains options for server setup, date formatting, and page list length (table settings). You can edit these settings as needed. To edit company settings: 1. On the Admin subnavigation bar, click the Settings tab. The Company Settings page opens. 2. Edit the information in the fields provided. N4A Device Manager User Guide 222

231 3. Click Save. Other Options To clear all fields and start over at any point before saving, click Reset. N4A Device Manager User Guide 223

232 Probes Clicking the Probes tab on the navigation bar opens the Device Probe Configuration page. Tasks available from this page include: Viewing Probes Viewing and Editing Simple Probe Details Viewing and Editing Compound Probe Details Adding Simple Probes Adding Compound Probes Viewing Probes The N4A software platform provides a set of default device probe configurations. Device probes are files containing one or more query commands that can be sent to devices the first time they check in to the CMS servers. Responses to the queries are stored in the server database and displayed in the Device Details page. When you add a new distributor, the current set of device probes are copied to the database and when the distributor adds a client company, that set is used for the company s default set of probes. When you add or edit probes in system administration, existing company s probes are not affected. There are two types of probes: simple and compound. A simple device probe populates a single device property in the database when a device responds to the probe. A device responding to a compound probe results in multiple properties being set in the database record for the device. To view probes: 4 On the navigation bar, click the Probes tab. N4A Device Manager User Guide 224

233 The Device Probe Configuration page opens. See Also Editing Simple Probe Details Editing Compound Probe Details Adding a Simple Probe Adding a Compound Probe N4A Device Manager User Guide 225

234 Editing Simple Probe Details WARNING! The Device Probe settings can impact your data usage plan. Make sure you set these correctly for your company. To edit a device probe: 1. On the navigation bar, click the Probes tab. 2. On the Device Probe Configuration page, locate a device probe and click the device probe Name link. The Edit Device Probe page opens. 3. Edit the information as needed. 4. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing Probes Adding a Compound Probe N4A Device Manager User Guide 226

235 Editing Compound Probe Details WARNING! The Device Probe default settings can impact your data usage plan. Make sure you set these correctly for your company. To edit a device probe: 1. On the navigation bar, click the Probes tab. 2. On the Device Probe Configuration page, locate a device probe and click the device probe Name link. N4A Device Manager User Guide 227

236 The Edit Device Probe page opens. 3. Edit the information as needed. 4. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. N4A Device Manager User Guide 228

237 See Also Viewing Probes Editing Simple Probe Details Adding a Simple Probe Adding a Compound Probe Adding a Simple Probe Simple probes return a single data field. Tip: You can change a probe from a simple to a compound configuration by changing the probe type prior to clicking Save. To add a simple probe: 1. On the Device Probe Configuration, click Add Simple. The Add Device Probe Configuration page opens. 2. Enter information in the fields provided. NOTE: Select one or more Device Types from the list. 3. Click Save. N4A Device Manager User Guide 229

238 Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Adding a Compound Probe Editing Simple Probe Details Viewing Probes Adding a Compound Probe Compound probes consist of multiple data elements. Tip: You can change a probe from a compound to a simple configuration by changing the probe type prior to clicking Save. To add a compound probe: 1. Click Add Compound. N4A Device Manager User Guide 230

239 The Add Compound Device Probe page opens. 2. Enter the specified information in the fields listed on the Add Device Probe Configuration page. NOTE: Select one or more Device Types from the list. 3. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. N4A Device Manager User Guide 231

240 See Also Adding a Simple Probe Editing Compound Probe Details Viewing Probes N4A Device Manager User Guide 232

241 Alerts Clicking the Alerts tab under Admin opens the Company Alerts page. Tasks available from this page include: Company Alerts Overview Viewing Company Alerts Editing Company Alerts Company Alerts Overview The N4A software platform provides a set of default alerts for issues with company-level functions such as no incoming device traffic or nearing limit on device activations. When an alert is triggered, the system notifies the admin that an area needs attention. Super admins and company admins can modify the settings for a company alert including the triggering event value, frequency, and recipients (super admin and/or company admin). Both super admins and company admins can modify the recipient settings to send notifications to one or both admin types or turn notifications off altogether by setting each type to No. In addition to company alerts, there are also system-level alerts that cover a particular company. See the System Alerts Overview section for more information. The following table contains a list of the company alerts delivered with the N4A software platform. Company Alerts License Name NO DEVICE EVENTS LICENSE EXPIRATION 1, 2, 3 Description Monitors incoming traffic from all devices belonging to the company. If no traffic is received for an amount of time greater than the triggering value (in minutes), then an alert notification is issued. Note: The system checks for this condition (Test Interval) every 60 minutes and is not configurable by the user. These three alerts allow you to issue a notification when the company license is set to expire within a set number of days. The default times are (Expiration minus 30 days, 7 days and 1 day). Note: The system checks for this condition (Test Interval) every 60 minutes and is not configurable by the user. Expiration time windows are expressed in minutes: 1 day = 1440 minutes 7 days = minutes 14 days = minutes 30 days = minutes N4A Device Manager User Guide 233

242 License Name DEVICE LIMIT NEAR GOOGLE MAPS PROVIDER GOOGLE REVERSE GEOCODER FAILURE Description Monitors the addition of devices to the company and issues an alert whenever the number of devices in the company approaches within the threshold set of the license limit. This is an event-based alert, so you may not set a testing frequency. An alert is issued whenever the system tries to access the Google Maps API without a proper Google license registered. An alert is issued whenever the system encounters an error while attempting to access the Google reverse geocoding API. When an attempt to send an from within the Device Manager application fails, an alert may be issued. Note: If a company does not have its SMTP settings configured, then will fail. However, an alert will not be issued in these cases as this is considered a configuration choice made by the company administrators. NOTE: Alerts for Google Maps Provider and Google Reverse Geocoder are only applicable if you have purchased and installed the Maps and Reports license. See Also Viewing Company Alerts Editing Company Alerts N4A Device Manager User Guide 234

243 Viewing Company Alerts The Alerts section displays various company and system alerts. These can be modified for your company's preferences. To access Alerts: 4 On the Admin subnavigation bar, click the Alerts tab. The Company Alerts page opens. See Also Editing Company Alerts Editing Company Alerts Company alerts are delivered as part of the N4A software platform, but the thresholds can be modified by the Company Admin. To edit a company alert: 1. On the Admin subnavigation bar, click the Alerts tab. N4A Device Manager User Guide 235

244 The Company Alerts page opens. 2. Locate the alert and click the alert Name link. The Edit Company Alert page opens. 3. Edit the information as needed. N4A Device Manager User Guide 236

245 NOTE: Check Yes or No to send alert notifications to the super admin and/or company admin. 4. Click Save. Other Options To return to the previous page without saving, click Cancel. To clear all fields and start over at any point before saving, click Reset. See Also Viewing Company Alerts N4A Device Manager User Guide 237

246 Journal Clicking the Journal tab under Admin opens the Company Activity Log page. Tasks available from this page include: Viewing the Company Activity Log Viewing the Company Activity Log User activity is monitored and presented in the company journal. The Company Activity Log displays a running list of actions that users have performed in the system for the Distributor or Company you are currently logged into. Select/de-select the Include Logins/Logouts option to toggle the view. To view the Company Activity Log: 4 On the navigation bar, click the Journal tab. N4A Device Manager User Guide 238

247 The Company Activity Log page opens. N4A Device Manager User Guide 239