Entities overview
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.
- 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:
Unique string identifier. Can be a Globally Unique Identifier (GUID).
When set to true, creates or updates the entity.
When set to false on a live entity, triggers a
DELETE event.
The future time, less than 30 days, at which the entity expires. When the expiry_time
has passed, Lattice deletes the entity.
The name of the integration that created this entity.
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:
Add the ontology component and set template
to TEMPLATE_ASSET to render an asset in Lattice.
Add the location component and set the asset’s position using its latitude and longitude details.
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:
Submarine
Radar
UAV
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:
Track
Sensor point-of-interest (SPI)
Signal of interest (SOI)
Add the ontology component and set template
to TEMPLATE_TRACK to render a generic track.
Add the location component
to set the latitude and longitude of the track.
Add the milView component
to set the disposition, environment, and nationality of the track.
Example entity models:
Airplane
Bird
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:
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.specificTypeis checked first, so a recognizedspecificTypewins over the entity’splatformType.ontology.platformTypeis checked next whenspecificTypeis empty or unrecognized.milView.environmentfalls back to a generic icon for the environment:AIR,LAND,SPACE,SURFACE, orSUB_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, andBIRDall resolve to the same icon. - Matches must be exact: partial and fuzzy matches do not work, so
CESSNAdoes not matchCESSNA 172. - Whitespace and punctuation are significant:
HELICOPTER (HELO)andHELICOPTERare different keys. - A few types vary by
milView.environment: set environment accurately alongsideplatformTypefor the best rendering result.
Example
Set platformType to a recognized string for a generic icon, and optionally
narrow it with a more specific specificType:
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:
Airplane
Animal
Car
Person
Radar
Satellite
Submarine
UAV
Vehicle

Recognized types
The following strings produce a recognized icon when used as platformType or
specificType. Strings are listed alphabetically within each category.
Crewed aircraft
ADS-B AIRPLANEADS-B AIRPLANE: FIXED WINGADS-B AIRPLANE: ROTARY WINGAIR VEHICLEAIRBORNE UNITAIRPLANEAIRPLANE: FIXED WINGAIRPLANE: ROTARY WINGBOMBERCESSNA 172FIGHTERFIXED WINGHELICOPTER (HELO)MH-60R44ROTARY WINGTILTROTORUNKNOWN AIR VEHICLE
Uncrewed aerial systems
GROUP 1GROUP 1-2GROUP 1-2: FIXED WINGGROUP 1-2: ROTARY WINGGROUP 1: FIXED WINGGROUP 1: ROTARY WINGGROUP 2GROUP 2: FIXED WINGGROUP 2: ROTARY WINGGROUP 3GROUP 3-4GROUP 3-5GROUP 3-5: FIXED WINGGROUP 3-5: ROTARY WINGGROUP 3: FIXED WINGGROUP 3: ROTARY WINGGROUP 4GROUP 4: FIXED WINGGROUP 4: ROTARY WINGGROUP 5GROUP 5: FIXED WINGGROUP 5: ROTARY WINGGRP 1-2 UASGRP 3-4 UASGRP 5 UASREMOTELY PILOTED VEHICLE (RPV)UAS FIXED WINGUAS ROTARY WINGUAVUNMANNED AERIAL VEHICLE (UAV)
Lighter-than-air
AEROSTATHALE BALLOON
Munitions and effects
MISSILEMORTARPOINT OF IMPACTPOINT OF ORIGINROCKET
Surface vessels
AIRCRAFT CARRIERBARGEBOATDESTROYERFAST PATROL BOATHOST VESSELRHIBSAILDRONE EXPLORERSUPPORT VESSELSURFACE VESSELSURVEY VESSELUNMANNED SURFACE VEHICLEUSVWATER VEHICLE
Subsurface
SUBMARINESUBMARINE PROPULSION UNKNOWN
Ground vehicles
AGNOSTIC GUN TRUCKBICYCLECARHIMARSHMETTJLTVPOSSIBLE CARPOSSIBLE SURFACE VEHICLEUNKNOWN VEHICLEVEHICLE
People and animals
ANIMALBIRDPERSONPOSSIBLE PERSONSOLDIER
Sensors, radars, and antennas
AN/MPQ-64AN/TPQ-50AN/TPQ-53ANTENNACAMERACPJ100CPJ100-SRENCLOSED_RADARFLAT_PLATE_RADARLMR-COMMSMOTIONOWLPARABOLIC_RADARPULSARRADARRADAR SITERADAR_PANELRSCENESIGNALTELESCOPETPS_RADAR
Buoys
BUOYCOMMS BUOYNOAA BUOYWEATHER BUOY
Sites and structures
BRIDGECOMMUNICATION SITEFENCEFLAGFLIGHT_DECKGCSLANDINGMARITIME HEADQUARTERSSTACKSSURFACE-TO-AIR MISSILE (SAM) SITETOWER
Map markers and geometry
ATAKBOWELLIPSELINEPLUSPOINTPOLYGON
Space
SATELLITE
Unknown
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:
Create
When an app or integration publishes an entity, Lattice emits a
state change event, setting the entity state to CREATE.
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.
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.
-
Don’t set both
noExpiryandexpiryTime. 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
noExpirysetting.
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?
- Learn more about the Entities API in REST and gRPC.
- Learn how to create an asset in Lattice.
- Check out the Lattice sample apps.