Mission Tracking

Configure how mission progress and performance are monitored

Mission tracking allows you to observe and measure robot performance while executing tasks. Missions can represent picking objects, delivering items, cleaning areas, or any task-based workflow. This configuration controls how mission data is captured, processed, and stored.

Mission Tracking is an advanced feature available in certain editions. Contact us for questions and pricing.

Unlike most configuration kinds, MissionTracking is a global config—only one per scope. The only accepted id value is "all".

When to Use

• Performance analytics: Track mission duration, success rates, and completion percentages
• Custom mission data: Map robot data sources to mission metadata fields
• Integration with proprietary systems: Capture missions reported via API or inferred from data changes
• Multi-floor/multi-location: Configure coordinate systems and waypoint tolerances

Processing Types

Type	Description
"api"	Missions are created/updated via REST API calls or JSON-encoded data source messages
"derived"	Missions are inferred from data source value changes (e.g., state transitions)

You can use both: processingType: ["api", "derived"]

Top-Level Fields

Field	Type	Required	Description
processingType	string/array	Yes	"api", "derived", or both.
autoClosePreviousMission	boolean	No	If true (default), automatically closes open missions when a new one starts.
dataBackfill	object	No	Configuration for backfilling data to missions.
attributes	object	No	Maps data source attributes to mission fields.
missionFields	object	No	Default values and behaviors for mission fields.
stateDefinitions	object	No	Maps state strings to status values.
execution	object	No	Execution behaviors (locks, modes, waypoints).
executor	object	No	Where missions execute: "cloud" or "edge".

Attributes Mapping

Maps data source values to mission fields. Keys are attribute IDs; values are mapping configurations.

Attribute Mapping Fields

Field	Type	Description
type	string	Mapping type (see below).
path	string	JSON path to extract from complex data sources.
values	array	For "mission" type: values that indicate an active mission.
label	string	For "data" type: key name in mission’s data object.
acceptBeforeStart	number	Seconds to look back for attribute updates when mission starts.
acceptAfterEnd	number	Seconds to accept attribute updates after mission ends.
highwatermark	number	Only accept values higher than this threshold.

Attribute Types

Type	Description
"mission"	Defines mission boundaries (for derived) or JSON API payloads (for API).
"label"	Sets the mission display name.
"state"	Sets the current mission state (e.g., “in-progress”, “completed”).
"status"	Sets mission status: "ok", "error", or "warn".
"data"	Adds metadata to the mission’s data object.
"percent"	Sets completion percentage (0-1).
"startTs"	Sets mission start timestamp (epoch milliseconds).
"endTs"	Sets mission end timestamp.

Examples

Basic API-Based Tracking

kind: MissionTracking
apiVersion: v0.1
metadata:
  scope: account/<accountId>
  id: "all"
spec:
  processingType: "api"
  autoClosePreviousMission: true

Derived Mission Tracking

Infer missions from data source changes:

kind: MissionTracking
apiVersion: v0.1
metadata:
  scope: account/<accountId>
  id: "all"
spec:
  processingType: "derived"
  autoClosePreviousMission: true
  attributes:
    stateEvent:
      - type: "mission"
        path: "currentTask"
        values: ["delivery", "pickup", "cleaning"]
      - type: "data"
        path: "targetRoom"
        label: "Room"
    navigationStatus:
      type: "state"
      acceptBeforeStart: 20
    pathCompletion:
      type: "percent"
      acceptAfterEnd: 60
  missionFields:
    state:
      defaultInitialValue: "planning"
      defaultFinalValue: "completed"
  stateDefinitions:
    completed:
      defaultStatus: "ok"
    stuck:
      defaultStatus: "error"
    waiting:
      defaultStatus: "warn"

With Execution Configuration

kind: MissionTracking
apiVersion: v0.1
metadata:
  scope: account/<accountId>
  id: "all"
spec:
  processingType: ["api", "derived"]
  execution:
    modes:
      start: "executing-mode-tag"
      end: "idle-mode-tag"
    useLocks: true
    waypoints:
      distanceTolerance: 0.5
      angularTolerance: 0.1
  executor:
    type: "cloud"

Edge Executor Configuration

kind: MissionTracking
apiVersion: v0.1
metadata:
  scope: account/<accountId>
  id: "all"
spec:
  processingType: "api"
  executor:
    type: "edge"
    options:
      coordinateSystem: "map"

Execution Settings

Field	Description
modes.start	Tag ID assigned when mission starts.
modes.end	Tag ID assigned when mission ends.
useLocks	If true, lock robot during mission execution.
waypoints.distanceTolerance	Distance (meters) to consider waypoint reached.
waypoints.angularTolerance	Angle (radians) to consider waypoint reached.

Data Backfill

Control which attributes can update missions retroactively:

dataBackfill:
  acceptAttributes:
    - "missionSummary"
    - "pathCompletion"

Related Documentation

• Mission Definitions — Define missions to dispatch
• KPI Definitions — Aggregate mission metrics