Configuration

Device Tracker 5.1

Overview

The web portal provides the capability for administrators to manage assets (devices, access points, and sites), configure Device Tracker and generate reports. Administrators must register devices, access points (AP) and sites for Device Tracker operation. This is performed manually or by uploading data through a .CSV file; keep in mind the following:

  • Maximum device support: 100,000 devices
  • Maximum web portal support: 500 sites and 25,000 devices
  • Maximum .CSV import: 25,000 records
    Note: When importing .CSV files with 25,000 or more, expect it to take some time. To import files quicker, Zebra recommends to import 1,000 records at a time.

Device Tracker supports 3 user roles: administrator, manager and user/associate. Functions and capabilities of the user varies based on the assigned role:

image       image       image
Administrator
View status of devices
across all locations
      Manager
View status of devices
within their location
      User/Associate
View misplaced devices
that need to be found


Note: Secondary Bluetooth Low Energy (BLE) configuration is part of the Install & Setup.

Administrator Role

Administrator functions and capabilties:

Manager Role

Manager functions and capabilities:

User/Associate Role

User/Associate functions and capabilties:


SSO

Integrate single sign-on (SSO) with Device Tracker to authenticate users with their SSO credentials. SSO activation allows administrators and managers to login to Device Tracker with their SSO credentials and gain access to their respective dashboards on the device and web portal. For other users, there is no change in Device Tracker client app access when logging in with their SSO credentials - for these users, the To Be Found screen is seen when the client app is launched. Only SSO OAuth 2.0 is supported.

To activate SSO, follow the SSO integration steps and then create SSO users. If SSO is activated, only SSO users can login; non-SSO users cannot login. Only activate SSO when all devices have Device Tracker 5.1 or higher.

After activating SSO, if Checkin/Checkout is enabled, user accountability does not take place and there is no difference in behavior compared to if this option is disabled.

Notes:

  • To use SSO, Device Tracker 5.1 or higher is required on the device. Otherwise, a server connection failed error may occur. To recover, clear the Device Tracker application cache either manually through Android settings or using App Manager through MX.

  • When using Chrome for the first time on the device and attempting to login with SSO, the following steps are required before proceeding to login:

    1. Accept the Google Terms of Service.
    2. Select the desired option when prompted to turn on sync.

    If the device is running Android 8, the SSO login page appears again after logging in sucessfully. Tap the back button to open the Device Tracker dashboard.

SSO Integration

Follow these steps to integrate SSO with Device Tracker - it is important to perform the step to create an SSO user:

  1. In the browser, launch the Device Tracker web portal using the URL supplied.
  2. Login using the super administrator credentials provided by Zebra. Enter the User ID and Password. Click Log In. image
  3. After login, click Settings > Single Sign On Integration (SSO). image
  4. Toggle Disabled to enable SSO integration with OAuth 2.0 Protocol. The SSO configuration page appears. image
  5. The Device Tracker Mobile Client must be registered with the SSO identity provider (IdP). When registered, the Client ID and Client Redirect URI fields are automatically populated.
  6. Enter the appropriate information for all fields based on the SSO server settings. Scroll to the bottom of the page and click Validate.
  7. Make sure pop-up windows are not blocked in the browser. During the validation process, a status window appears followed by a login prompt - it is important to enter your login credentials to complete the validation process.
  8. When validation is successful, a confirmation prompt appears asking if you would like to activate SSO.
  9. Click Yes.
  10. A confirmation message appears indicating successful SSO configuration activation. image
  11. Important: The admin must add at least one SSO admin user. See Add SSO User. Otherwise, if the admin logs out before adding the SSO admin user, no admin user can login due to the lack of an SSO admin user registered.
  12. Logout from the non-SSO session. In the top right, click on the logout icon. image
  13. The SSO login page appears. Enter the user credentials to login. Click Sign In.
  14. Click on Settings > Single Sign On Integration (SSO). The SSO Activation Status shows Activated. image

Manage Users

To access the Device Tracker web portal, user accounts are managed through Manage Users. Add, edit or delete admin and manager user accounts based on SSO or non-SSO access:

  • Non-SSO - If SSO is not activated, only non-SSO users can be added, requiring an email address as the user ID. When logging in for the first time, the user must click Forgot your password in the web portal login screen. After entering the user email address, an email message is sent with a link for the user to set their password.
  • SSO - If SSO is activated, only SSO users can be added based on the same user ID as that given by the SSO provider.

Each user is designated a Device Tracker role: manager or admin. For managers, a site must be assigned for the manager to oversee.

Important:

  • Although SSO can be deactivated after it is activated, Zebra recommends to maintain the same users based on whether SSO is activated. If SSO is not activated, only keep non-SSO users. If SSO is activated, only keep SSO users.

For first-time use as a administrator in non-SSO mode, action is required to set the password. Click Forgot Your Password in the web portal and enter the email address when prompted. The admin is registered as a user in the system during onboarding. An email will be sent to the administrator with a link to set the password.

Access the web portal by entering the URL provided by Zebra in a supported browser and select Manage Users from the left menu.

image

Device Tracker web portal

Add User

Follow one of the procedures below to add a user based on whether or not SSO is activated.

SSO User

If SSO is activated, follow these steps to add admin or manager user accounts as SSO users:

  1. Log in to the web portal as an administrator.
  2. In the web portal, click Manage Users in the left menu.
  3. Click Add user from the top right.
  4. A message appears at the top indicating that SSO is active.
  5. Select the user role:
  6. Enter the User ID. This must match the user ID from the SSO provider.
  7. If adding a Manager role, in the Select Site dropdown, select the site to assign.
  8. Click Add user. The new user is added to the user table.

Non-SSO User

If SSO is not activated, follow these steps to add admin or manager user accounts as non-SSO users:

  1. Log in to the web portal as an administrator.
  2. In the web portal, click Manage Users in the left menu.
  3. Click Add user from the top right.
  4. A message appears at the top indicating that SSO is inactive.
  5. Select the user role:
  6. Enter the User ID based on the following guidelines:
    • Must be a valid email
    • Maximum length: 255 characters
    • Special characters allowed prior to '@': ! ~ # $ % ^ & * - _ + = {} | ' / ?
    • Characters allowed after '@': . -
    • Spaces are not allowed
    • '@' character is only allowed once
    • '.' is only allowed in the middle of alphanumeric characters before and after '@'.
  7. If adding a Manager role, in the Select Site dropdown, select the site to assign.
  8. Click Add user. The new user is added to the user table.

Delete User

To delete an admin or manager user account:

  1. Log in to the web portal as an administrator.
  2. From the web portal, tap Manage Users in the left menu.
  3. From the list of users, locate the user to delete and click on the delete icon next to the user.
  4. Click OK in the confirmation message.

Edit User

To edit the site to which a manager is assigned:

  1. Log in to the web portal as an administrator.
  2. From the web portal, tap Manage Users in the left menu.
  3. From the list of users, locate the manager to edit and click on the edit icon next to the user.
  4. From the dropdown, select the new site to assign the manager. Click Save.
  5. The table displays the new site the manager is assigned.

Search User

Administrators or managers can be searched based on user ID. To search for a user:

  1. Log in to the web portal as an administrator or manager.
  2. From the web portal, tap Manager Users in the left menu.
  3. Enter the user ID to search for in the search field located below the Add User button from the top right of the page. Press the enter key.
  4. The search results are displayed. If searching for an email address for non-SSO users, the entire email address must be entered.


Reset Password

The password is set or reset through the web portal.

Steps to set or reset the password:

  1. From the web portal login page, click Forgot your password. image
  2. Enter your email address then click Reset Password.
  3. A message appears indicating a password reset email is sent.
  4. Open the email and click on the link.
  5. Enter the new password based on the following guidelines:
    • Minimum length: 6 characters
    • Any combination of letters, numbers and symbols (ASCII-standard characters) are accepted.
  6. The password is reset with the new password.

Manage Sites

Administrators register sites to designate specific locations within an organization. Add, modify, or delete sites by importing a .CSV file with the site information. Or, add sites manually through the dashboard.

CSV File

A sample .CSV file is supplied by Zebra for the administrator to populate with the appropriate data. Importing data either modifies or adds entries to the existing database, unless deleting a site, which removes the site record. The data fields are:

Data Description Required
SiteName Site name or location.
Supported characters are alphanumeric. Special supported characters: _-@%&*!+^()=?:
Yes
timeZone Time zone of site location Yes
scheduledReportTime Specified time to generate daily End of Day Report based on cron time expression format: * * * * *, where only the first 2 parameters specifying the minute and hour respectively are required. The report is sent on a daily basis to the specified recipients in the emailList field. For example 30 21 * * * generates a report at 9:30 PM. Yes
EmailSubscribed Indicates whether users are subscribed to receive the End of Day Report: True/False Optional
emailList A comma separated list of email addresses to receive the End of Day Report. Optional

Sample .CSV file content:

    
        SiteName,timeZone,scheduledReportTime,EmailSubscribed,emailList
        New York,America/New York,30 21 * * *,True,admin@zebra.com
    

When modifying the .CSV file, keep the header information intact and replace the sample data with the appropriate data desired. It is particularly important for the AP location friendly name to be easily understood for users to determine the location within the facility when finding a device. The .CSV file cannot be UTF-8 encoded, otherwise an error can occur; it must be saved in a normal comma separated values format.

Add Sites

Register sites either manually or by uploading the .CSV file.

Manual

To register sites manually:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Sites.
  3. Click Manage. From the dropdown, select Add. image
  4. Select Manual and click Continue. image
  5. Provide the following:
    • Site - Enter the site name
    • Timezone - Select the local time zone of the site
    • Scheduled Report Time - Select the local time for the End of Day report to be generated
    • Email subscribed - If enabled, sends an email with the End of Day report to designated managers and administrators * Email List - Enter the email addresses of the recipients to receive the End of Day report, each email address separated by a comma image
  6. Click Confirm. The new site is added.

Upload CSV

To register sites by uploading the .CSV file:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Sites.
  3. Click Manage. From the dropdown, select Add. image
  4. Select Upload CSV and click Continue. image
  5. Click Select files and browse to the desired .CSV file, or drag and drop the .CSV file. image
  6. The selected file name is displayed. Click Import.
  7. If successful, a message appears indicating the import was successful.

Modify Sites

Modify sites either manually or by uploading the .CSV file.

Manual

To modify a site manually:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Sites.
  3. Check the box next to the site to modify. The Actions menu appears. Click Actions and from the dropdown, select Modify Details. image
  4. Provide the following:
    • Time Zone - Select the local time zone of the site
    • Scheduled Report Time - Select the local time for the End of Day report to be generated
    • Email subscribed - If enabled, sends an email with the End of Day report to designated managers and administrators
    • Email List - Enter the email addresses of the recipients to receive the End of Day report, each email address separated by a comma image
  5. Click Confirm. The site is updated.

Upload CSV

Modify sites by uploading the .CSV file containing the modified information:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Sites.
  3. Click Manage. From the dropdown, select Modify. image
  4. Select Upload CSV and click Continue. image
  5. Click Select files and browse to the desired .CSV file, or drag and drop the .CSV file. image
  6. The selected file name is displayed. Click Import.
  7. If successful, a message appears indicating the import was successful.

Delete Sites

Delete sites either manually or by uploading the .CSV file.

Manual

To delete a site manually:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Sites.
  3. Check the box next to the site to modify. The Actions menu appears. Click Actions and from the dropdown, select Delete. image
  4. Click Confirm. The site is deleted.

Upload CSV

To delete sites from the database, upload a .CSV file containing one or more AP sites information to remove.

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Access Points.
  3. Click Manage. From the dropdown, select Delete. image
  4. Select Upload CSV and click Continue. image
  5. Click Select files and browse to the desired .CSV file, or drag and drop the .CSV file. image
  6. The selected file name is displayed. Click Import.
  7. If successful, a message appears indicating the import was successful.

Manage Access Points

Register access points with friendly names to aid in identifying device location within a site when finding devices. Add, modify, or delete APs either manually or by importing a .CSV file with the AP information through the web portal.

CSV File

A sample .CSV file is supplied by Zebra for the administrator to populate with the appropriate data. Importing data either modifies or adds entries to the existing database, unless deleting an AP, which removes the AP record. The data fields are:

Data Description Required
SiteName Site name or location.
Supported characters are alphanumeric. Special characters supported: _-@%&*!+^()=?:
Yes
BSSID Access point MAC address Yes
AssetName Name used by IT admin for drawings, labeling of hardware, etc.
Optional
LocationFriendlyName Access point location friendly name, useful to identify general device location.
Supported characters are alphanumeric. Special supported characters:: ><:_-@#$%&*!+.^()[]=?
Yes

Sample AP .CSV file content:

    
        SiteName,BSSID,AssetName,LocationFriendlyName
        New York,14:a7:2b:24:cc:a5,Inventory#1,Back Area
    

When modifying the .CSV file, keep the header information intact and replace the sample data with the appropriate data desired. It is particularly important for the AP location friendly name to be easily understood for users to determine the location within the facility when finding a device. The .CSV file cannot be UTF-8 encoded, otherwise an error can occur; it must be saved in a normal comma separated values format.

Add Access Points

Register access points either manually or by uploading the .CSV file.

Manual

To register access points manually:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Access Points.
  3. Click Manage. From the dropdown, select Add. image
  4. Click Manual. image
  5. Provide the following information:
    • Site - Select site location of AP or enter the site name in the search field. A limited number of sites is listed in the dropdown. If needed, see Manage Sites for the site name.
    • MAC Address - Enter MAC address of AP
    • Asset Name - (Optional) Enter asset name used by IT admin for drawings, labeling of hardware, etc.
    • AP Location - Enter location friendly name, useful to identify general device location image
  6. Click Continue. The AP is added.

Upload CSV

To register access points, add the AP information to the .CSV file then follow these steps to import the file:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Access Points.
  3. Click Manage. From the dropdown, select Add. image
  4. Select Upload CSV and click Continue. image
  5. Click Select files and browse to the desired .CSV file, or drag and drop the .CSV file. image
  6. The selected file name is displayed. Click Import.
  7. If successful, a message appears indicating the import was successful.

Modify Access Points

Modify access points either manually or by uploading the updated .CSV file.

Manual

To modify an access point manually:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Access Points.
  3. Check the box next to the AP to modify. The Actions menu appears. Click Actions and select one of the following from the dropdown depending on the desired action:
    • Modify Site - Select the site to reassign the AP
    • Modify Details - Modify AP information. image
  4. If Modify Site is selected, select or enter the site to reassign the AP. A limited number of sites are listed. For the full site list, see Manage Sites. image
  5. If Modify Details is selected, perform the following:
    • Asset Name - Enter the new asset name for the AP
    • AP Location - Enter the new location name for the AP image
  6. Click Confirm. The AP is modified.

Upload CSV

To modify existing access points, upload a .CSV file containing one or more APs with the modified information.

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Access Points.
  3. Click Manage. From the dropdown, select Modify. image
  4. Select Upload CSV and click Continue. image
  5. Click Select files and browse to the desired .CSV file, or drag and drop the .CSV file. image
  6. The selected file name is displayed. Click Import.
  7. If successful, a message appears indicating the import was successful.

Delete Access Points

Delete access points either manually or by uploading the modified .CSV file.

Manual

To delete an access point manually:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Access Points.
  3. Check the box next to the AP to delete. The Actions menu appears. Click Actions and selete Delete from the dropdown.
    image
  4. Click Confirm. The AP is updated.

Upload CSV

To delete APs from the database, upload a .CSV file containing one or more AP information to remove.

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Access Points.
  3. Click Manage. From the dropdown, select Delete. image
  4. Select Upload CSV and click Continue. image
  5. Click Select files and browse to the desired .CSV file, or drag and drop the .CSV file. image
  6. The selected file name is displayed. Click Import.
  7. If successful, a message appears indicating the import was successful.

Manage Devices

Administrators register device information along with friendly names and site assignments to aid in identifying, tracking and locating devices. Device registration can be performed manually or by uploading a .CSV file. An alternative to assign a device to a site is throughautomatic assignment of a device to a site based on the AP the device is connected to.

CSV File

Add, modify, or delete devices by importing a .CSV file with the device information through the web portal. Or manually add devices through the dashboard. A sample .CSV file is supplied by Zebra for the administrator to populate with the appropriate data. Importing data either modifies or adds entries to the existing database, unless deleting a device, which removes the device record. The data fields are:

Data Description Required
ModelNumber Device model Yes
SerialNumber Device serial number Yes
DeviceFriendlyName Name used to identify device.
Supported characters are alphanumeric. The following are supported special characters: _-@#$%&*!+.^()[]=?><:
Optional
SiteName Site name or location where the device is assigned, useful when finding a device. Alternatively, automatically assign sites based on the AP the device is connected to, see Device-to-Site Assignment.
Supported characters are alphanumeric. The following are supported special characters: _-@%&*!+^()=?><:
Optional


Sample device .CSV file content:

    
        ModelNumber,SerialNumber,DeviceFriendlyName,SiteName
        TC51,17009522509812,Inventory1,Chicago
        TC51,17009522509813,Inventory2,Los Angeles
    

When modifying the .CSV file, keep the header information intact and replace the sample data with the appropriate data desired. The .CSV file cannot be UTF-8 encoded, otherwise an error can occur; it must be saved in a normal comma separated values format.

Add Devices

Register devices either manually or by uploading the .CSV file.

Manual

To register devices manually:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Mobile Devices.
  3. Click Manage. From the dropdown, select Add. image
  4. Select Manual and click Continue. image
  5. Provide the following information:
    • Site - Select the site to assign the device
    • Model Number - Enter the model number of the device
    • Serial Number - Enter the unique serial number of the device
    • Device Name - Enter the friendly name used to identify the device e.g. this can be based on user role image
  6. Click Confirm. The device is added.

Upload CSV

To register devices by uploading the .CSV file, add the device information to the .CSV file then follow these steps to import the file:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Mobile Devices.
  3. Click Manage. From the dropdown, select Add. image
  4. Select Upload CSV and click Continue. image
  5. Click Select files and browse to the desired .CSV file, or drag and drop the .CSV file. image
  6. The selected file name is displayed. Click Import.
  7. If successful, a message appears indicating the import was successful.

Modify Devices

Modify devices either manually or by uploading the .CSV file.

Manual

To modify a device manually:

  1. Login to the web portal as an administrator.

  2. From the left menu, under Dashboard select Mobile Devices.

  3. Check the box next to the device to modify. The Actions menu appears.

  4. From the Actions dropdown, select the desired action based on the Edit or Tracking category (options may vary depending on the state of the device): image Edit:

    • Site - Assign the device to a selected site.
    • Access Point Friendly Name - Change the friendly name of the access point the device is connected to.
    • Device Name - Change the user friendly device name.
    • Delete Device - Delete the device record.

    Tracking:

    • Mark Device for Finding - This changes the device(s) status to To Be Found, placing the device in the To Be Found list used in the device search process.
    • Mark Device as InService - The device status is changed from To Be Found back to In Service.
    • Checkin Device - Checks in the checked out device(s).
    • Add Notes - A dialog box appears prompting to enter notes or comments for the selected device(s).
    • Decommission Device - Removes the device(s) from the active device pool and places it out-of-service with the Decommissioned status.
    • Recommission Device - Changes the device(s) status from the Decommissioned state (i.e. removed from the active device license pool) and recommissions the device back to the In Service state.
    • Start Finding - Begins the device search process. Refer to Find a Device. This is visible only if the device is marked To Be Found. During the device search, click one of the following when appropriate:
      • Stop Finding - Stops the device search process; changes the state of the device from Being Found back to To Be Found so another device can initiate the finding process.
      • Play Sound - Emits a sound from the device being located; listen and follow the sound to locate the device.
      • Found - Indicates the device is successfully located after conducting the device search.
      • Cannot Find - Indicates the device could not be found after the search was conducted

  5. Click Confirm. The device is updated.

Upload CSV

To modify existing registered devices, upload a .CSV file containing one or more devices with the modified information.

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Mobile Devices.
  3. Click Manage. From the dropdown, select Modify. image
  4. Select Upload CSV and click Continue. image
  5. Click Select files and browse to the desired .CSV file, or drag and drop the .CSV file. image
  6. The selected file name is displayed. Click Import.
  7. If successful, a message appears indicating the import was successful.

Delete Devices

Delete devices either manually or by uploading the .CSV file.

Manual

To delete a device manually:

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Mobile Devices.
  3. Check the box next to the device to delete. The Actions menu appears.
  4. From the Actions dropdown, select the Delete Device: image
  5. Click Confirm. The device is deleted.

Upload CSV

To delete devices from the database, upload a .CSV file containing the device(s) information to remove. Device Tracker should be uninstalled before deleting the device record.

  1. Login to the web portal as an administrator.
  2. From the left menu, under Dashboard select Mobile Devices.
  3. Click Manage. From the dropdown, select Modify. image
  4. Select Upload CSV and click Continue. image
  5. Click Select files and browse to the desired .CSV file, or drag and drop the .CSV file. image
  6. The selected file name is displayed. Click Import.
  7. If successful, a message appears indicating the import was successful.

Registration

Registration of devices, access points, and sites is required for device tracking. Options are available to control device-to-site assignment and restrict managers from modifying devices and access points.

To access Registration options:

  1. Log in to the web portal as an administrator.
  2. Click on Settings.
  3. Under Settings, click Registration.

image

Registration screen

Registration options:

  • Allow managers to modify Device Name - If enabled, permits managers to edit device names through their dashboard.
  • Allow managers to modify Access Points - If enabled, permits managers to edit access points through their dashboard.

Shortcut links:

  • Add or modify Mobile Devices - Opens Dashboard > Mobile Devices view from the left menu in the web portal.
  • Add or modify Access Points - Opens Dashboard > Access Points view from the left menu in the web portal.
  • Add or modify Sites - Opens Dashboard > Sites view from the left menu in the web portal.

Device-to-Site Assignment

Devices can be assigned to sites either manually, based on the CSV file upload, or automatically, based on the AP the device is connected to.

To select the method of device registration:

  1. Log in to the web portal as an administrator.
  2. Click Settings from the left menu.
  3. Under Settings, click Registration. image
  4. Under Device-to-Site Assignment. select the desired device registration method:
    a. Manually assign devices to a site via CSV upload (default)
    Manually assign sites to devices by uploading a CSV file that includes the site name for the device to be assigned, see Import Devices.
    b. Automatically assign devices to a Connected AP's site
    Prerequisite: Register the site to an AP.
    When the device connects to an AP, the device is automatically assigned a site name based on the AP it is connected to, provided the AP is registered with a site. If there is no site assigned to the AP, then no site name is assigned to the device and the device is listed under Unassigned Devices in the site list.
  5. Click Save.

Note: If the option to automatically assign devices is enabled, it overwrites the sites that are manually assigned via CSV file upload and any further CSV uploads cannot take into effect.



Checkin/Checkout Device

Device Checkin/Checkout is an optional feature that displays an overlay on top of the screen to enforce the user to scan their unique barcode, maintaining user accountability of the device. When enabled, users cannot access the device until they scan their user barcode in the device checkout screen. By default, all barcodes are accepted if no barcode prefix is defined. Specify a checkout barcode prefix to restrict checkout to only barcodes that begin with the specified prefix.

Checkin/Checkout scenarios:

  • Checkout: At the start of a work shift, the user checks-out the device by scanning their unique barcode. This associates the user with the device, which is visible in the device information.
  • Checkin: At the end of a work shift, the user checks-in the device depending on the Device Checkin Option selected. After checkin, the user is no longer associated with the device.

Note: If any other app also uses a screen overlay, the checkin/checkout feature may conflict with the other app. For example, this feature cannot be used with Zebra’s MotionWorks Proximity application.

Enable Checkin/Checkout

To enable device checkout, access the web portal by entering the URL provided by Zebra in a supported browser.

  1. Log in to the web portal as an administrator.
  2. Click Settings in the left menu.
  3. Under Settings, click Checkin/Checkout.
  4. Enable Checkin/Checkout. Related options are displayed and described in the sections that follow.

image

Configure Checkin/Checkout

Note: For Android 10 and higher, if "Display over other apps" permission is not granted, the user needs to manually launch the app once and grant "Display over other apps" permission for checkout functionality to work.

Checkout Barcode Prefix

(Optional) Specify a barcode prefix to restrict checkout to only scan barcodes that begin with the specified prefix in the form of a character string. If the barcode scanned does not contain the prefix, checkout is not successful. Checkin/Checkout must be enabled. Keep this field blank to accept all barcodes without a prefix.

When generating a barcode with the prefix, the specified prefix is followed by the username identifier. The following is a sample barcode containing prefix “NGDTRK-” and username “JohnDoe”: image Sample barcode with prefix and username: "NGDTRK-JohnDoe"

Maximum Checkout Time

(Optional) Enter the maximum time (in hours) for the device to be checked out when Checkin/Checkout is enabled. When the specified time elapses, the device is automatically checked back in. Maximum Checkout Time is affected by the following options:

  • Automatically Mark Devices For Retrieval, if Maximum Checkout Time is selected.
  • On the dashboard, the user of the checked out device is flagged if the device is not returned before the Maximum Checkout Time is reached.

Device Checkin Options

Select one or more of the Device Checkin Options to specify the action that triggers a device checkin after a device is checked out:

  • Manual - the user navigates to the options menu (top right) from the main screen of Device Tracker and selects Check-In Device.
  • Cradle - the user places the device on a powered cradle to checkin the device.
  • Reboot - the user reboots the device to checkin.

After device checkin from any of the above methods, the checkout screen appears prompting the user to scan a barcode to gain device access. By default, all 3 options are selected.


Automation

Device Tracker can be configured to automatically change device states when specific conditions are met or certain thresholds are reached. For example, devices can be automatically marked "To Be Found" if they are checked out, low in battery, and not charging. This proactively allows the device to be located prior to completely losing battery power and while potentially actively in use, preventing the need for an administrator to continually monitor devices and manually mark the devices.

The device must be connected to the Device Tracker server to receive automation settings. Changes to automation settings on the server cannot be applied to disconnected devices.

Configure Automation Settings

To enable automation, set the related device thresholds and configuration:

  1. Log in to the web portal as an administrator.

  2. Click on Settings.

  3. In Settings, click on Automation. image

  4. Set the Device Thresholds:

    • Low battery threshold - Specify the percentage (%) of battery capacity when the device reaches the Low Battery condition. If no value is specified, it defaults to the device’s low battery threshold.
    • Device idle - Enable this option to track a device when it is stationary, or it has not physically moved. Specify the amount of time (in minutes) for the device to remain stationary before it is considered Idle. Default value: 15; minimum value: 5; maximum value: 10000.
    • Maximum checkout time - Set the maximum checkout time (in hours) before the device is automatically checked in. See Maximum Checkout Time.
  5. Automatically mark devices for retrieval - Enable this option and select the state(s) or combination of states for the device to be automatically marked "To be Found" when the selected state(s) is reached, rather than performing this manually. If a combination of states are selected, all conditions must be met for the device to be automatically marked "To Be Found." If the selected state(s) is not reached, the device remains off the "To Be Found" list. Available states and combination of states:

    • Checked out, low battery and not charging
    • Checked out, low battery, not charging and idle
    • Checked out and maximum checkout time reached
    • Checked in, low battery and not charging
    • Low battery and not charging
    • Low battery, idle and not charging
    • Idle and not charging
    • Disconnected

    After a device has been automatically marked "To Be Found" based on the above selection, if the device state changes and no longer satisfies the selected state(s), then "To Be Found" is removed from the device.

Important: During the finding process, before marking the device as "Found," make sure one of the selected conditions is NOT satisfied (e.g. checkin the device if "Checked out" is selected, or charge the device if "not charging" is selected). Otherwise, the device will return back to the "To Be Found" state after it is marked "Found."

  1. Automatically clear found device's state - Enable this option to automatically place the device back “In Service” after it is located and marked “Found”. This eliminates the need to manually perform this action.
  2. Click on Save.


Reports

Reports are provided in the web portal for managers and administrators to monitor device performance, user activity and site activity. All data reports are logged in America/Chicago time (CST). If multiple days are selected for the report, the report is provided in a single .ZIP file containing multiple .CSV files, one .CSV file per day. If the data report exceeds 1 GB in size for any day, the report is split into multiple files. Data history remains for up to 3 months.

Events By Site

Events By Site provides a report of event counts per site based on the date range selected. An event is considered as a state change from one device state to another, regardless of the duration the device remains in the new state. The events for this report are based on the device finding process, device charging and low battery. The device count for the states are cumulative, incrementing each time a device reaches that state. Data is collected every day at 3 am America/Chicago time (CST) no matter which region the user is located.

To view Events By Site:

  1. Login to the web portal as an administrator or manager.
  2. Click Reports in the left menu and click Events By Site.
  3. For administrators, in the Site dropdown, select the specific site to generate the report for or select All to generate a report for all sites. For managers, only the data for their assigned site can be viewed.
  4. Select the start date and end date to generate the report.
  5. The data is displayed.
  6. To download the displayed data in .CSV format, click Download Data. image

Data displayed (all device counts are cumulative):

  • Dashboard Views - Number of times the manager has viewed the dashboard, providing an indication on how often managers are tracking devices.
  • Disconnected – Number of devices that lost connection to the server at one point in time for at least 12 minutes or more.
  • To Be Found – Number of devices that were marked "To Be Found," which initiated the device search. This provides an indication on how often devices are becoming misplaced at a site.
  • Found – Number of devices that are successfully found after a device search.
  • Being Found – Number of devices that are being searched. This is triggered when a user initiates a device search.
  • Not Found – Number of devices that could not be found after a search was conducted.
  • Charging – Number of devices that are powered on and in the charging state.
  • Low Battery – Number of devices that have reached the low power threshold, requiring attention for it to be charged prior to battery depletion.

End of Day Device Summary

End of Day Device Summary provides a snapshot of device counts based on their status at that moment in time. The data is not cumulative. This summary report helps managers to identify and track the accountability of devices at the end of the day on a daily basis. Managers and administrators can display data based on site location, or administrators can display data across all sites.

End of Day Device Summary reports can be sent by email to managers and administrators. The email recipients and scheduled report time are configured either manually or through .CSV file import. The report is sent by email each day when the specified scheduled report time is reached. It is sent from email address zdtrksupport@zebra.com to the list of email recipients. Each site can be configured with different scheduled report times. Data is not available for the current date until the scheduled report time elapses.

To view End of Day Device Summary:

  1. Login to the web portal as an administrator or manager.

  2. Click Reports in the left menu and click End of Day Device Summary.

  3. For administrators, in the Site dropdown, select the specific site to generate the report for or select All to generate a report for all sites. For managers, only the data for their assigned site can be viewed.

  4. Select the date to generate the report.

  5. The data is displayed.

  6. To download the displayed data in .CSV format, click Download Data.

    image

To identify the devices that are still checked out, see End of Day Device Detail.

Data displayed:

  • Site - Site name
  • Registered - Number of devices registered with the cloud server
  • Connected - Number of devices connected to the server
  • Disconnected - Number of devices that lost connection to the server
  • Checked Out - Number of devices checked out by users and presumed to be in use
  • Low Battery - Number of devices that have reached the low power threshold, requiring attention for it to be charged prior to battery depletion.
  • Charging - Number of devices currently charging and therefore not in use
  • To Be Found - Number of devices set to "To Be Found"

Diagnostics

For diagnostic purposes, logging can be enabled in Device Tracker to capture application and system information to Android logcat. RxLogger is a built-in tool on Zebra Android devices that collects data and event logs from logcat and stores them in a single location. If issues are encountered, a Zebra representative may request for the log files to be collected and supplied. There are 2 methods to capture logging: StageNow or EMM.

Using StageNow

To use StageNow to capture logging:

  1. Open StageNow on the device.

  2. Scan the barcode to enable Device Tracker logging and start RxLogger log capture: image

  3. Reproduce the issue.

  4. Scan the barcode to disable Device Tracker logging and stop RxLogger log capture: image

Logs are located in the RxLogger folder (default location: /sdcard/RxLogger).

Using EMM

To use EMM to capture logging, refer to the following XML content:

  • To enable logging:

    <wap-provisioningdoc>
        <characteristic version="1.0" type="com.zebra.mdna.devicetrackercloud">
            <parm name="EnableLog" value="1" />
        </characteristic>
    </wap-provisioningdoc>
    
  • To disable logging:

    <wap-provisioningdoc>
        <characteristic version="1.0" type="com.zebra.mdna.devicetrackercloud">
            <parm name="EnableLog" value="0" />
        </characteristic>
    </wap-provisioningdoc>
    

Send the desired XML content to the EMM using either OEMConfig or MX to configure the app.


See Also