Zebra Zebra MotionWorks Enterprise Platform Software MotionWorks Enterprise User Guide v2.0
MotionWorks
Enterprise
2.0
User Guide
P1123395-03EN
ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in
many jurisdictions worldwide. All other trademarks are the property of their respective owners.
© 2022 Zebra Technologies Corporation and/or its affiliates. All rights reserved.
Information in this document is subject to change without notice. The software described in this document
is furnished under a license agreement or nondisclosure agreement. The software may be used or copied
only in accordance with the terms of those agreements.
For further information regarding legal and proprietary statements, please go to:
SOFTWARE:zebra.com/linkoslegal
COPYRIGHTS:zebra.com/copyright
WARRANTY:zebra.com/warranty
END USER LICENSE AGREEMENT: zebra.com/eula
Terms of Use
Proprietary Statement
This manual contains proprietary information of Zebra Technologies Corporation and its subsidiaries
(“Zebra Technologies”). It is intended solely for the information and use of parties operating and
maintaining the equipment described herein. Such proprietary information may not be used, reproduced,
or disclosed to any other parties for any other purpose without the express, written permission of Zebra
Technologies.
Product Improvements
Continuous improvement of products is a policy of Zebra Technologies. All specifications and designs are
subject to change without notice.
Liability Disclaimer
Zebra Technologies takes steps to ensure that its published Engineering specifications and manuals are
correct; however, errors do occur. Zebra Technologies reserves the right to correct any such errors and
disclaims liability resulting therefrom.
Limitation of Liability
In no event shall Zebra Technologies or anyone else involved in the creation, production, or delivery of the
accompanying product (including hardware and software) be liable for any damages whatsoever
(including, without limitation, consequential damages including loss of business profits, business
interruption, or loss of business information) arising out of the use of, the results of use of, or inability to
use such product, even if Zebra Technologies has been advised of the possibility of such damages. Some
jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so the above
limitation or exclusion may not apply to you.
Publication Date
November 2021
2
Contents
Term List .......................................................................................................................... 3
Launching the MWE Web Client ..................................................................................... 4
UI Basics......................................................................................................................... 6
Menu Items and Reports .......................................................................................... 6
Report Interface...................................................................................................... 10
Dashboard .............................................................................................................. 12
Users ...................................................................................................................... 13
Login Account Menu............................................................................................... 14
Prerequisites .................................................................................................................. 15
Web Client Common Tasks .......................................................................................... 16
Viewing Sites and Site Maps......................................................................................... 17
Managing ZLA Appliances ............................................................................................. 19
Viewing Tag Status and Location.................................................................................. 20
Open The Tags Report........................................................................................... 20
Select a View.......................................................................................................... 21
View Tag Data ........................................................................................................ 22
The Details Column ................................................................................................ 23
Map Window .................................................................................................................. 24
Report Filters.................................................................................................................. 25
Customizing a Report.................................................................................................... 27
Saving a Custom Report................................................................................................ 31
Exporting a Report.................................................................................................. 32
Data Import .................................................................................................................... 33
Report Auto-refresh ................................................................................................ 34
Live Data Streaming....................................................................................................... 35
Map Autozoom............................................................................................................... 35
Map Data Clustering ..................................................................................................... 39
Defining a Resource Type............................................................................................. 40
Associating a Tag ID with a Resource ID...................................................................... 44
Resource Type Filters................................................................................................... 49
Tag Offset Filter...................................................................................................... 49
1
Contents
Median Filter........................................................................................................... 49
Zone Lockdown Filter ............................................................................................. 53
Rate Filter ............................................................................................................... 54
Keeping Location History ............................................................................................... 55
Viewing and Replaying Location History....................................................................... 57
Viewing Zones............................................................................................................... 59
Business Rules Alerts ................................................................................................... 61
Resource Alerts ...................................................................................................... 62
Pickup/Dropoff ........................................................................................................ 65
Resource Parent-Child Grouping.................................................................................. 67
Child Resources with No Tags ............................................................................... 67
Child Resources with Tags..................................................................................... 69
Releasing Child Resources .................................................................................... 71
Dynamic Locate Fusion.................................................................................................. 72
System Device Alerts.................................................................................................... 75
Contacts......................................................................................................................... 76
Alert Notification............................................................................................................. 77
MWE Health.................................................................................................................. 79
Device Manager............................................................................................................ 81
2
MotionWorks Enterprise
2.0
This user guide focuses on the features and functionality of the MotionWorks Enterprise 2.0 web client, the
main tool for users to view and interact with the data provided by the real-time asset tracking MotionWorks
Enterprise (MWE) system from Zebra Technologies Corporation.
Zebra Technologies offers world-class real-time asset tracking and management software solutions to
optimize the flow of goods in complex logistical operations, increasing productivity, lowering operational
costs, and improving safety and security. Zebra Technologies uses a wide range of scalable RTLS (Real
Time Locating Systems) technologies to generate accurate, on-demand information about the physical
location and status of assets.
MWE is a software suite that provides tools for designing, configuring, operating, and troubleshooting
RTLS solutions. MWE serves as the central repository for all the real-time location and communication
data captured by the RTLS-tracking infrastructure. MWE also provides tools for integrating RTLS data with
customers and third-party applications.
Some of the location and telemetry RFID technologies supported by MWE include:
• Passive RFID
• UWB
• Bluetooth Low-Energy
• WiFi
• ISO 24730
• GPS
The diagram below provides an overview of some of the RTLS system components and data flow. The
over-the-air RF transmissions from tags (RF transmitters) are detected by sensors connected to a network.
This connection can be wired or wireless. The data generated by the sensors flow across the network to a
Zebra Location Appliance (ZLA) and then to a MWE server. Multiple sites are supported, each with its own
ZLA.
1
MotionWorks Enterprise 2.0
A ZLA can collect, process, and filter location and telemetry data from multiple sensing devices and can
also run a variety of location algorithms. A ZLA can be a virtual appliance or physical appliance. A physical
ZLA is 1U rackmount box installed on-site feeding tag blink and location data to MWE server installed on
site or remotely at a data centre.
MWE 2.0 also supports direct communication from passive RFID readers to MWE running locally or in the
cloud. No ZLA appliance is required in this case
.
The MWE software is installed on a Linux server (Red Hat or CentOS). The diagram below illustrates the
various MWE software components hosted on the MWE Linux server and their relation within the MWE
software.
This guide assumes that the MWE software is previously installed and properly configured. Consult the
following documents for details on MWE installation and configuration:
• MWE 2.0 Installation Guide
• MWE 2.0 Configuration Guide
2
Term List
MotionWorks Enterprise 2.0
The table below provides a brief overview of the terms used in the MWE documentation:
Table 1 MWE Definitions
Term Definition
Tag An active or passive RFID transmitter. It can be a WhereNet tag, DART (UWB) tag,
GPS tag, EPC (passive RFID) tag, BLE tag.
Resource An object, equipment, vehicle, etc. whose location and status is to be tracked.
Asset Synonym with Resource.
Tag ID A unique tag identifier that is included in every tag transmission.
Resource ID A unique identifier that identifies the resource being tracked.
Asset ID Same as Resource ID.
Resource Type A type or category of resources as defined within the MWE software. Examples of
resource types are printer, trailer, container, truck, airplane, etc. Every resource
within the MWE software belongs to a resource type.
Tagged
Resource
Unassigned Tag A tag whose Tag ID is not associated with a Resource ID within the MWE software.
Tag Blink A tag transmission (one or multiple bursts of electromagnetic waves in the RFID
Location Sensor A device that captures tag blinks and forwards them across the network to a server
ZLA Zebra Location Appliance. A physical or virtual appliance that receives data from a
A resource whose Resource ID is associated with a Tag ID in the MWE software.
part of the spectrum).
or ZLA.
variety of sensors and runs location algorithms. The resulting coordinates x,y or
latitude/longitude are forwarded to the MWE server.
3
MotionWorks Enterprise 2.0
Launching the MWE Web Client
To launch the client, open a web browser (Chrome, Edge, Firefox) on a client machine or server on the
network, and point it to http://MWE_Server_Name or https://MWE_Server_Name, where
MWE_Server_Name is the Linux (Red Hat) server name or IP address.
The login page is displays:
Next, enter the login credentials. This could be a local account created and stored in the local MWE SQL
database, or it could be a domain account authenticated by an OpenLDAP, Active Directory, or ADFS
server. See the MWE Configuration Guide on how to configure authentication modes and login accounts.
NOTE: Depending on the MWE version, you may see some differences between the screens depicted in
this document and the screens in your MWE version.
Enter your login credentials. This could be a local account created and stored in the local MWE SQL
database, or it could be a domain account authenticated by an OpenLDAP, Active Directory, OIDC, or
ADFS server. Please see the MWE Configuration Guide on how to configure authentication modes and
login accounts.
Note that the browser may display a not secure or certificate error or similar warning in the URL bar when
using https. This is because the MWE installation script installs a default self-signed certificate on the
MWE Linux server. Refer to the MWE Configuration Guide for instructions on installing your own valid
certificate on the MWE Linux server.
4
MotionWorks Enterprise 2.0
After logging in, view the landing page with a menu bar at the top of the page containing several items:
Dashboard, Reports, History, Alerts, Infrastructure, Configuration, Users, and admin (the name of the
account currently logged in).
The menu items that are visible on menu bar depend on the access level granted to your login account. If
you have full access, you should see the 8 menu items listed above.
To sign out, click the down arrow in the rightmost (account name) menu item and select Sign Out.
5
UI Basics
This section provides an overview of the MWE web client user interface. Note that depending on
your MWE version, you may see some differences between the screens and menus depicted in this
document and those in your MWE version.
Menu Items and Reports
Hovering the mouse over a menu item on the menu bar displays a list of available reports under that menu
item in alphabetical order, as in the following figure.
MotionWorks Enterprise 2.0
6
MotionWorks Enterprise 2.0
The following table lists the reports under each menu item and a brief explanation for each report. These
reports will be explained in greater detail later in this guide.
Table 2 Menu Items
Menu Item Report Description
Dashboard This tab includes reports that present summary information in
graphical form.
Resources Graphical summary of number of tracked resources, listed by
type, site, zone, and custom properties.
System Health Graphical summary of open system alerts per site, including ZLA,
sensor, tag, and other alerts.
Alert Manager Tool for configuring alerts related to the health of the MWE Linux
server. It is meant only for advanced users and system
administrators.
Grafana System Health
Kibana Application
History Data
Kibana Application
Logs
Prometheus Tool for building queries on the MWE Linux server health. It is
Reports Includes reports (in table form) with status information on tags
Import Includes the import data entry form and shows a history of import
Resources Displays status information about each resource being tracked at
Tags Displays status information about each resource or asset being
History Reports that provide historical data on tags, resources, locations,
Call History Shows shows every blink from any WhereNet Call Tag. These
Resource
Event History
Resource
Zone
Correlation
History
This tool presents pre-defined dashboards showing health and
status of the MWE Linux server.
While the MWE web client offers out-of-the box reports that
display application historical data, this tool allows direct access to
the application historical data in the MWE Elastic Search
database.
This page allows access to the different logs generated by MWE
microservices. It is typically used for diagnostics and
troubleshooting.
meant only for advanced users and system administrators.
and resources being tracked at a site. It also includes a report on
import data entry operations.
transactions done via the MWE web client
a site.
tracked at a site, regardless of tag association.
events, system alerts, and more. Each report has purging and/or
archiving settings that are discussed later in this document.
blinks have TagStatus=2 in the blink packet (as opposed to
TagStatus=0 for blinks from regular WhereNet tags).
Displays all events generated by the MWE system related to
resources being located and tracked, including Zone Change,
Resource Alert, Pickup, Dropoff, Shipped, Received.
Displays a history report that shows when 2 different resources
were in the same zone over a specified time window. The report
will show every occurrence and dwell time over that time window.
7
MotionWorks Enterprise 2.0
Table 2 (Continued)Menu Items
Menu Item Report Description
System Alert
History
Tag Blink
History
Alerts This tab includes a single report.
Alert
Notifications
Configuration
Open System
Alerts
Infrastructure The reports under this tab allow users to monitor and manage
Appliances Allows users to monitor and manage location appliances.
Devices
(Device
Manager)
Hardware
Devices
Site Manager This is where users define sites and site groups, and upload site
WherePorts Lists all WherePorts defined in System Builder. WherePorts are
Configuration This tab lists reports that are used to configure different aspects of
Keeps a record of every system alert that has been opened and
closed.
Keeps track of every single tag blink processed by the system.
Data is only kept for the most recent 7 days.
This report lists the people (from the Contacts report) that will be
notified via email when a specified alert is triggered.
Lists all system alerts that are currently open.
location appliances, define sites and site groups, and upload site
maps.
Allows adding, configuring, and managing devices directly from
this page. No ZLA appliance is required for devices added in this
page. In MWE 2.0, only passive RFID readers (FX7500, FX9600,
ATR) are supported; must be running firmware v.3.7.26 or higher,
and must have the R2C (Reader to Cloud) application installed.
Lists all of the hardware installed at a site as part of the location
infrastructure. This report gets populated when System Builder (a
MWE system design tool) performs a publish operation. Refer to
the MWE Configuration Guide for more details.
maps.
also listed in the Hardware Devices report, however, this report
provides additional information about the configuration of each
WherePort.
the MWE software. Entries in these reports can be created,
modified, or deleted using data entry.
8
MotionWorks Enterprise 2.0
Table 2 (Continued)Menu Items
Menu Item Report Description
Contacts Users can manage the list of contacts to be used in emailing
alerts and scheduled reports.
Resource
Alert Settings
Resource
Type Settings
System Alert
Settings
Virtual Tag
Settings
WherePort
Dissociate
Zone Group
Settings
Zone Settings Displays Zones published by Zone Builder tool and provides data
Users
(logged in
account)
This menu item opens a web page where one can define resource
alerts (business rules).
This is where resource types are defined. Examples include car,
trailer, printer, or any other resource type. Each resource type has
a set of properties and filters that are specified in this report.
Individual resource/asset of this resource type can then be
entered into the system with unique resource ID and associated
with a tag ID. This can be done using data entry in the Resources
report (under Reports tab), data import, or via the API.
Lists all available system alerts. This report allows customization
of alert messages and the specification of email distribution list for
each alert.
Define virtual tags using this setting. Several real tags can be
associated with a virtual tag (in the Virtual Tag Assignment
Settings report). The tag blink data reported by MWE for a virtual
tag is a configurable combination of the data from the real tags
associated to that virtual tag.
Associating or dissociating tag ID’s to or from asset ID’s are done
using data entry, data import, or the API. Tag dissociation can be
done automatically when a tagged asset crosses the field of a
WherePort device (a magnetic exciter). In this report, enter the
WhererPort ID’s that being used to perform this task.
Displays Zone Groups published by Zone Builder tool and
provides data entry to change some zone group parameters.
entry to change some zone parameters.
This tab includes two sub-tabs or pages, namely, USER
GROUPS and USERS. The USER GROUPS page is the place
where to add User Groups and specify the permissions for each
group. If using a domain server for authentication, the name of
domain groups can be added here. The USERS page is where
one can create local user accounts (stored in a local MWE
database) and assign them to User Groups. Domain login
accounts do not need to be added here.
The last tab shows the name of the account currently logged in to
the web client, and includes items to change user settings and to
sign out. A local account can also change password here.
9
Report Interface
All reports under the Reports, History, Alerts, and Configuration menu items have a similar user
interface. In addition to the main menu bar, there is a report tool bar in lighter gray color, a report/map
window, and a filter’s column. The following figure shows the Reports > Tags report.
NOTE: Depending on what version of MWE you are running, the name and order of menu items shown in
the figures below may differ slightly from your version.
MotionWorks Enterprise 2.0
10
MotionWorks Enterprise 2.0
The following figure provides additional details on the filter’s column.
NOTE: Not every column in a report has a filter associated with it.
11
Dashboard
The Dashboard > System Health page presents a graphical summary of the health of the system,
including servers, appliances, sensors, and tags.
MotionWorks Enterprise 2.0
NOTE: Depending on your MWE version, you may see a different version of this dashboard where the
graphs have been replaced by tables, but the meaning of the panels is still the same.
12
MotionWorks Enterprise 2.0
The Dashboard > Resources page provides several counters related to the location and status of
resources being tracked across multiple sites.
Users
The Users page includes two tabs, namely, User Groups and Users.
The USER GROUPS tab is the place where to add User Groups and specify the permissions for each group.
Only the administrator user group is created at installation time. If using LDAP/ADFS/OIDC authentication,
the name of groups on the LDAP/ADFS/OIDC server can be added here. If using MWE database
authentication, newly added groups will exist only on the local MWE SQL database.
13
MotionWorks Enterprise 2.0
The USERS tab is where a user can create local user accounts (stored in the MWE database) and assign
them to User Groups. Domain login accounts do not need to be added here.
It is possible to configure the system to do only LDAP or ADFS or OIDC user authentication, or only MWE
local account (in MWE SQL database) authentication, or a mixed mode allowing both MWE local
authentication and one of the LDAP/ADFS/OIDC authentication methods. This configuration is done in the
.env configuration file on the MWE Linux server. Refer to the MWE 2.0 Configuration Guide for details.
Login Account Menu
The last item on the menu bar has the name of the login account currently logged into the web client. In the
example below, it is admin:
In this example, a local user (a login account stored in the local MWE database) can change their
password. The Change Password menu item is not enabled for domain accounts, which are controlled by
a domain controller on the network.
14
The User Settings item provides web client settings that are applied only to the account currently logged
in. Lastly, the Sign Out item allows a user to sign out.
Prerequisites
The MWE Installation Guide and MWE Configuration Guide explain the MWE software installation and
configuration steps that must be completed before a user launches and uses the MWE web client.
The main installation and configuration procedures are listed below:
MWE Installation Procedures
1. Install MWE software on Windows server.
2. If deployment includes ZLA appliances:
a. Register ZLA appliances with MWE Linux server.
b. Upgrade ZLA appliance firmware.
3. Upgrade sensor (if any) firmware.
4. Upgrade MWE software.
MotionWorks Enterprise 2.0
MWE Configuration Procedures
1. Add Site Groups, Sites, and load site maps in the Infrastructure > Site Manager report.
2. Calibrate maps (define x,y coordinate system) in the Site Manager report.
3. If deployment includes ZLA appliances:
a. Register ZLA appliances with MWE Linux server, if not done at installation time.
b. Associate each ZLA appliance with a site.
c. Use System Builder tool to add location sensor devices and define location algorithms.
4. Define zones on top of each map. This is done in the Configure Zones tab in the Site Manager report.
5. Configure authentication mode: local MWE database, LDAP, ADFS, OIDC, or a combination of these.
This is done in the .env configuration file on the MWE Linux server.
6. Add LDAP/ADFS/OIDC User Groups to MWE for LDAP/ADFS/OIDC authentication
7. Create local User Groups and Users, and define permissions
Once the above steps are complete, a user can use the MWE web client to view and enter data about tags
and resources being tracked by the RTLS (Real Time Location System) and perform many other tasks as
listed in the following section.
15
MotionWorks Enterprise 2.0
Web Client Common Tasks
This document explains the most common tasks performed with the web client. The tasks listed below are
explained in various sections of this guide.
• Launch MWE web client
• Navigate the MWE web client UI
• View sites on a world map where tags and assets are being tracked
• View site maps
• View appliances installed at each site, and their status
• Define location filters (rate filter, median filter, …) per appliance
• View tags status and current location
• View tag blink history
• View tag data in reports and on maps
• Define resource types
• Define location filters (rate filters, median filter, ….) per resource type
• Associate resource ID’s to tag ID’s
• View resource status, current location, and location history in reports and on maps
• Customize reports (columns displayed, column names, column order, filter data)
• Customize report filters (filters displayed, filter names, filter order)
• Save customized reports
• Export reports (CSV and HTML formats)
• Import data
• Define business rules alerts (resource alerts, pick-up/drop-off alerts)
• Configure automatic email notification or resource alerts
• Check system health
• Configure automatic email notification of system alerts
• Configure tag low battery alert
• View alert history and alert notification history
• Enable/disable system alerts
• View available system events (zone change, object association, alerts, etc)
• Specify system events to be stored
16
MotionWorks Enterprise 2.0
• View history of system events
Viewing Sites and Site Maps
The sites and site maps where asset locations are being tracked can be viewed in the Infrastructure >
Site Manager report, as shown in the following figure. After installing the MWE software, only the Default
site group will be present. Refer to the MWE Configuration Guide for additional information on how to add
site groups, sites, and upload site maps.
Clicking on a site group in the tree-view, such as Company Sites in the example below, displays a map in
the map window containing all the sites under that site group. In our example the sites under the Company
Sites group are Detroit, Los Angeles, and San Jose.
NOTE: Depending on your MWE version, you may see a different color scheme than the figures below
show, but the meaning of the items is still the same.
17
MotionWorks Enterprise 2.0
Hovering over a site name in the tree view using the mouse causes the corresponding blue pin on the map
to be highlighted by increasing in size:
Clicking on a map name in the tree view displays the corresponding site map in the map window:
18
Managing ZLA Appliances
The status of the ZLA (Zebra Location Appliance) device deployed at multiple sites can be seen in the
Infrastructure > Appliances report. This report also makes several tasks available for managing
ZLAs.
MotionWorks Enterprise 2.0
Refer to the MWE Installation Guide and MWE Configuration Guide for additional details on this report.
19
MotionWorks Enterprise 2.0
Viewing Tag Status and Location
The status and location of tags blinking across multiple sites can be viewed in the Reports > Tags report.
The data is displayed in table form on a map, and can be filtered, sorted, exported, and more. All
supported tag types are seen here, regardless of technology, such as WhereNet tag, DART (UWB) tags,
passive RFID (EPC) tags, GPS tags, and BLE receivers.
The information displayed for each tag ID may include x and y coordinates, latitude and longitude, zone
and site where the tag is currently located, battery status, last time the tag blinked and last time it located,
resource ID (if any) associated with the tag, telemetry data included in the tag transmission (temperature,
speed, etc), and more.
Any tag blink (transmission) captured by a sensor feeding data to the MWE software causes the tag ID to
be displayed in the Tags report. It is also possible to manually add a tag to this report before that tag has
blinked; when the tag blinks, the data in the Tags report is automatically updated.
Open The Tags Report
Open the report by selecting Tags in the Reports tab:
See UI Basics on page 6 for the meaning of each tool button on the report toolbar.
NOTE: Depending on your MWE version, you may see slight differences in the report menu bar and filter
column between what the figures show and your MWE version.
20
Select a View
Select different views, such as Report View, Report & Map Vertical, and Report & Map Horizontal
by using the column filter. The column filter can be hidden, as shown in the following figures.
MotionWorks Enterprise 2.0
21
View Tag Data
When the Tags report is initially opened, the report window, the map window, and the filter column are
displayed.
MotionWorks Enterprise 2.0
Scroll right and left in the report windows to view all the report columns, including the site and zone where
each tag is being located.
The map window displays a wide area map, each blue pin corresponds to a site where tags are being
located.
When one or more tags are selected in the report window, the following occurs:
• A checkmark appears in the square checkbox in the first column for each selected tag.
• Each selected line is highlighted with a light blue background.
• If map autozoom is enabled, the map window automatically zooms into a smaller area containing
the selected tags. See Map Autozoom for additional details.
• If map autozoom is not enabled, the map window does not show the full map for the site
containing the selected tags, and the map window does not automatically zoom in. See Map
Autozoom for details.
22
Loading...