Skip to navigation

Entities overview

The data model, platform types, and how entities power your common operating picture

An entity is an interoperable data structure that powers the Lattice common operational picture (COP).

An entity consists of components. The presence or absence of components, rather than a strict type hierarchy, determines what an entity is and how it should be interacted with. Think of an entity as a bag of components that you can mix and match as needed. Entities might be incomplete at various points in time, reflecting the real-time state of the COP. Partial states are valuable for situational awareness, so your code must handle missing components robustly.

Composition principles

  • Components must not be duplicative: Avoid modeling the same underlying data on two different components.
  • Components are non-hierarchical: The data model is composable and not an inheritance tree.

Entity model

An entity requires the following components:

entity_id
StringRequired

Unique string identifier. Can be a Globally Unique Identifier (GUID).

is_live
BooleanRequired

When set to true, creates or updates the entity. When set to false on a live entity, triggers a DELETE event.

expiry_time
DatetimeRequired

The future time, less than 30 days, at which the entity expires. When the expiry_time has passed, Lattice deletes the entity.

provenance.integration_name
stringRequired

The name of the integration that created this entity.

aliases.name
string

Human-readable string that represents the name of an entity.

For more information, see Entities in the Lattice API Reference.

Entity templates

Although there is no strict type hierarchy, a user interface could group entities according to its ontology component. Lattice supports the following three top-level entity shapes:

Asset

An asset is an entity under your control, or under the control of another operator or system. Assets may accept tasks such as search or tracking. To create an asset, add the following components in addition to the required components:

ontology
OntologyRequired

Add the ontology component and set template to TEMPLATE_ASSET to render an asset in Lattice.

location
LocationRequired

Add the location component and set the asset’s position using its latitude and longitude details.

milView
MilViewRequired

Add the milView component and set the disposition, environment, and nationality of the asset.

To publish cameras, radars, and uncrewed vehicles with health, sensors, and motion, see Create an asset.

Example entity models:

asset.json
{
"entityId": "UNIQUE_ENTITY_ID",
"description": "Asset",
"ontology": {
"template": "TEMPLATE_ASSET",
"platform_type": "Submarine"
},
"location": {
"position": {
"latitudeDegrees": 50.91402185768586,
"longitudeDegrees": 0.79203612077257,
"altitudeHaeMeters": 2994,
"altitudeAglMeters": 2972.8
}
},
"milView": {
"disposition": "DISPOSITION_FRIENDLY",
"environment": "ENVIRONMENT_SUB_SURFACE"
},
"aliases": {
"name": "Dive"
},
"provenance": {
"integrationName": "your_integration_name",
"dataType": "your_data_type",
"sourceUpdateTime": "2025-04-07T00:19:47.706196Z"
},
"isLive": true,
"createdTime": "2024-12-07T00:09:42.816877Z",
"expiryTime": "2024-12-17T00:09:42.816878Z"
}
asset.json
{
"entityId": "UNIQUE_ENTITY_ID",
"description": "Asset",
"ontology": {
"template": "TEMPLATE_ASSET",
"platform_type": "Radar"
},
"location": {
"position": {
"latitudeDegrees": 50.91402185768586,
"longitudeDegrees": 0.79203612077257
}
},
"milView": {
"disposition": "DISPOSITION_FRIENDLY",
"environment": "ENVIRONMENT_SURFACE"
},
"aliases": {
"name": "Tower"
},
"provenance": {
"integrationName": "your_integration_name",
"dataType": "your_data_type",
"sourceUpdateTime": "2025-04-07T00:19:47.706196Z"
},
"isLive": true,
"createdTime": "2024-12-07T00:09:42.816877Z",
"expiryTime": "2024-12-17T00:09:42.816878Z"
}
asset.json
{
"entityId": "UNIQUE_ENTITY_ID",
"description": "Asset",
"ontology": {
"template": "TEMPLATE_ASSET",
"platform_type": "UAV"
},
"location": {
"position": {
"latitudeDegrees": 50.91402185768586,
"longitudeDegrees": 0.79203612077257,
"altitudeHaeMeters": 2994,
"altitudeAglMeters": 2972.8
}
},
"milView": {
"disposition": "DISPOSITION_FRIENDLY",
"environment": "ENVIRONMENT_AIR"
},
"aliases": {
"name": "UAV"
},
"provenance": {
"integrationName": "your_integration_name",
"dataType": "your_data_type",
"sourceUpdateTime": "2025-04-07T00:19:47.706196Z"
},
"isLive": true,
"createdTime": "2024-12-07T00:09:42.816877Z",
"expiryTime": "2024-12-17T00:09:42.816878Z"
}

Track

A track represents any entity tracked by an asset or integration connected to Lattice. Tracks are not directly under the control of friendly forces. This includes aircraft tracks from radar or sensors, signal detections, vehicles, people, or animals detected through cameras.

To publish tracks that the Lattice fusion engine can correlate with other sources, see Create a track. Lattice supports the following track types:

ontology
Required

Add the ontology component and set template to TEMPLATE_TRACK to render a generic track.

location
Required

Add the location component to set the latitude and longitude of the track.

milView
Required

Add the milView component to set the disposition, environment, and nationality of the track.

Example entity models:

track.json
{
"entityId": "UNIQUE_ENTITY_ID",
"description": "Airplane",
"ontology": {
"template": "TEMPLATE_TRACK",
"platform_type": "Airplane"
},
"location": {
"position": {
"latitudeDegrees": 50.91402185768586,
"longitudeDegrees": 0.79203612077257,
"altitudeHaeMeters": 46.214997987295234
}
},
"milView": {
"disposition": "DISPOSITION_FRIENDLY",
"environment": "ENVIRONMENT_AIR"
},
"aliases": {
"name": "Friendly Airplane"
},
"provenance": {
"integrationName": "your_integration_name",
"dataType": "your_data_type",
"sourceUpdateTime": "2025-04-07T00:19:47.706196Z"
},
"isLive": true,
"createdTime": "2024-12-07T00:19:46.706195Z",
"expiryTime": "2024-12-07T00:24:46.706196Z"
}
track.json
{
"entityId": "UNIQUE_ENTITY_ID",
"description": "Animal",
"ontology": {
"template": "TEMPLATE_TRACK",
"platform_type": "Animal"
},
"location": {
"position": {
"latitudeDegrees": 50.91402185768586,
"longitudeDegrees": 0.79203612077257,
"altitudeHaeMeters": 46.214997987295234
}
},
"milView": {
"disposition": "DISPOSITION_NEUTRAL",
"environment": "ENVIRONMENT_AIR"
},
"provenance": {
"integrationName": "your_integration_name",
"dataType": "your_data_type",
"sourceUpdateTime": "2025-04-07T00:19:47.706196Z"
},
"aliases": {
"name": "Bird"
},
"isLive": true,
"createdTime": "2024-12-07T00:19:46.706195Z",
"expiryTime": "2024-12-07T00:24:46.706196Z"
}

Geo-entity

A geo-entity is a shape, region, or point of interest drawn on the map. Use geo-entities to represent geographical areas of interest, such as airfields or control zones, for autonomous vehicles to operate in. Set ontology.template to TEMPLATE_GEO, and describe the shape with the geo_details and geo_shape components:

geo.json
{
"entityId": "UNIQUE_ENTITY_ID",
"description": "Geo point",
"isLive": true,
"noExpiry": true,
"aliases": {
"name": "Point"
},
"ontology": {
"template": "TEMPLATE_GEO"
},
"geoDetails": {
"type": "GEO_TYPE_GENERAL"
},
"geoShape": {
"point": {
"position": {
"latitudeDegrees": 50.91402185768586,
"longitudeDegrees": 0.79203612077257
}
}
},
"provenance": {
"integrationName": "your_integration_name",
"dataType": "your_data_type",
"sourceUpdateTime": "2025-04-07T00:19:47.706196Z"
}
}

To publish points, lines, polygons, and ellipses, see Draw geo shapes.

Platform types

The ontology component on an entity carries two free-form strings that drive entity iconography in the Lattice COP: platformType and specificType. Lattice renders a built-in 2D icon and 3D model only when the value matches one of the recognized strings in this section. Any other string falls back to a generic icon based on milView.environment.

How Lattice resolves icons

When rendering an entity, the Lattice UI walks the following order and stops at the first match:

  • ontology.specificType is checked first, so a recognized specificType wins over the entity’s platformType.
  • ontology.platformType is checked next when specificType is empty or unrecognized.
  • milView.environment falls back to a generic icon for the environment: AIR, LAND, SPACE, SURFACE, or SUB_SURFACE.
  • Unknown is the final fallback: Lattice renders a generic “unknown” icon when nothing matches.

Always set milView.environment alongside platformType. Environment is the safety net that keeps your entity recognizable when the platformType string is misspelled, environment-specific, or not yet on this page.

Matching rules

  • Matching is case-insensitive: bird, Bird, and BIRD all resolve to the same icon.
  • Matches must be exact: partial and fuzzy matches do not work, so CESSNA does not match CESSNA 172.
  • Whitespace and punctuation are significant: HELICOPTER (HELO) and HELICOPTER are different keys.
  • A few types vary by milView.environment: set environment accurately alongside platformType for the best rendering result.

Example

Set platformType to a recognized string for a generic icon, and optionally narrow it with a more specific specificType:

"ontology": {
"template": "TEMPLATE_TRACK",
"platformType": "UAV",
"specificType": "GROUP 3"
},
"milView": {
"environment": "ENVIRONMENT_AIR"
}

Because specificType is checked first, GROUP 3 overrides the generic UAV icon and renders the Group 3 model instead.

Example icons

The following recognized types render these icons for a friendly entity. Lattice adjusts the frame and color of each icon according to the entity’s milView.disposition:

ontology
"ontology": {
"template": "TEMPLATE_TRACK",
"platformType": "AIRPLANE"
}
Shows the airplane platform type icon.

Recognized types

The following strings produce a recognized icon when used as platformType or specificType. Strings are listed alphabetically within each category.

  • ADS-B AIRPLANE
  • ADS-B AIRPLANE: FIXED WING
  • ADS-B AIRPLANE: ROTARY WING
  • AIR VEHICLE
  • AIRBORNE UNIT
  • AIRPLANE
  • AIRPLANE: FIXED WING
  • AIRPLANE: ROTARY WING
  • BOMBER
  • CESSNA 172
  • FIGHTER
  • FIXED WING
  • HELICOPTER (HELO)
  • MH-60
  • R44
  • ROTARY WING
  • TILTROTOR
  • UNKNOWN AIR VEHICLE
  • GROUP 1
  • GROUP 1-2
  • GROUP 1-2: FIXED WING
  • GROUP 1-2: ROTARY WING
  • GROUP 1: FIXED WING
  • GROUP 1: ROTARY WING
  • GROUP 2
  • GROUP 2: FIXED WING
  • GROUP 2: ROTARY WING
  • GROUP 3
  • GROUP 3-4
  • GROUP 3-5
  • GROUP 3-5: FIXED WING
  • GROUP 3-5: ROTARY WING
  • GROUP 3: FIXED WING
  • GROUP 3: ROTARY WING
  • GROUP 4
  • GROUP 4: FIXED WING
  • GROUP 4: ROTARY WING
  • GROUP 5
  • GROUP 5: FIXED WING
  • GROUP 5: ROTARY WING
  • GRP 1-2 UAS
  • GRP 3-4 UAS
  • GRP 5 UAS
  • REMOTELY PILOTED VEHICLE (RPV)
  • UAS FIXED WING
  • UAS ROTARY WING
  • UAV
  • UNMANNED AERIAL VEHICLE (UAV)
  • AEROSTAT
  • HALE BALLOON
  • MISSILE
  • MORTAR
  • POINT OF IMPACT
  • POINT OF ORIGIN
  • ROCKET
  • AIRCRAFT CARRIER
  • BARGE
  • BOAT
  • DESTROYER
  • FAST PATROL BOAT
  • HOST VESSEL
  • RHIB
  • SAILDRONE EXPLORER
  • SUPPORT VESSEL
  • SURFACE VESSEL
  • SURVEY VESSEL
  • UNMANNED SURFACE VEHICLE
  • USV
  • WATER VEHICLE
  • SUBMARINE
  • SUBMARINE PROPULSION UNKNOWN
  • AGNOSTIC GUN TRUCK
  • BICYCLE
  • CAR
  • HIMARS
  • HMETT
  • JLTV
  • POSSIBLE CAR
  • POSSIBLE SURFACE VEHICLE
  • UNKNOWN VEHICLE
  • VEHICLE
  • ANIMAL
  • BIRD
  • PERSON
  • POSSIBLE PERSON
  • SOLDIER
  • AN/MPQ-64
  • AN/TPQ-50
  • AN/TPQ-53
  • ANTENNA
  • CAMERA
  • CPJ100
  • CPJ100-SR
  • ENCLOSED_RADAR
  • FLAT_PLATE_RADAR
  • LMR-COMMS
  • MOTION
  • OWL
  • PARABOLIC_RADAR
  • PULSAR
  • RADAR
  • RADAR SITE
  • RADAR_PANEL
  • RSCENE
  • SIGNAL
  • TELESCOPE
  • TPS_RADAR
  • BUOY
  • COMMS BUOY
  • NOAA BUOY
  • WEATHER BUOY
  • BRIDGE
  • COMMUNICATION SITE
  • FENCE
  • FLAG
  • FLIGHT_DECK
  • GCS
  • LANDING
  • MARITIME HEADQUARTERS
  • STACKS
  • SURFACE-TO-AIR MISSILE (SAM) SITE
  • TOWER
  • ATAK
  • BOW
  • ELLIPSE
  • LINE
  • PLUS
  • POINT
  • POLYGON
  • SATELLITE
  • UNKNOWN

Entity lifecycle

Entities have a well-defined lifecycle of create, update, and delete. On each lifecycle update, Lattice emits the state change event back to Lattice:

1

Create

When an app or integration publishes an entity, Lattice emits a state change event, setting the entity state to CREATE.

2

Update

When data in the entity changes, Lattice emits the state change as an update event. To optimize performance, Lattice relies on changes to provenance.source_update_time to trigger an update. It does not compare the full proto definitions to set the state change.

3

Delete

Lattice deletes an entity when its expiry_time lapses or when you send an update with the is_live component set to false. Alternatively, you can use the noExpiry flag to create entities that persist indefinitely. Use noExpiry only when the entity contains information that should be available to other tasks or integrations beyond its immediate operational context, such as long-living geographical entities.

Persistence

  • Don’t set both noExpiry and expiryTime. Lattice rejects an entity that sets both.

  • If a service restart occurs and an entity hasn’t been republished within the previous 5 minutes, the entity isn’t restored, regardless of the noExpiry setting.

Handle a delete event by removing all references to the entity in memory or discarding it from your user interface.

Choose a workflow

The following pages show how to publish and consume entities for common integration scenarios:

What’s next?