agent/measures/AC_Aptima_TA3_measures

measures from message bus

← All message topics  ·  schema Measures/agent_measures.json  ·  matches spec topic agent/measures/+

header

FieldTypeRequiredAllowed valuesDescription
timestamp string ✓
message_type string ✓ agent
version string ✓ The message format version

msg

FieldTypeRequiredAllowed valuesDescription
experiment_id string ✓
trial_id string
timestamp string ✓
source string ✓
sub_type string ✓ measures
version string ✓
replay_parent_type string|null TRIAL REPLAY null
replay_parent_id string|null
replay_id string|null

data

FieldTypeRequiredAllowed valuesDescription
study_version string ✓ The study_version
elapsed_milliseconds number ✓ The elapsed_milliseconds
event_properties object ✓
event_properties.qualifying_event_type string ✓ The qualifying_event_type
measure_data object ✓
measure_data.measure_id string ✓ The measure_id
measure_data.datatype string ✓ The datatype
measure_data.measure_value ✓
measure_data.description string ✓ The description

Example messages

{
  "header" : {
    "timestamp" : "2021-05-27T16:23:36.1317Z",
    "version" : "3.0",
    "message_type" : "agent"
  },
  "msg" : {
    "sub_type" : "measures",
    "timestamp" : "2021-05-27T16:23:36.1317Z",
    "experiment_id" : "730527c7-c06d-4edf-906c-ac3996460faf",
    "trial_id" : "97e409cc-e1e1-4698-9154-14358d98f55f",
    "version" : "3.0",
    "source" : "AC_Aptima_TA3_measures"
  },
  "data" : {
    "study_version": "3",
    "elapsed_milliseconds": 927927,
    "event_properties": {
      "qualifying_event_type": "event",
      "qualifying_event_message_type": "Event",
      "qualifying_event_sub_type": "Event:VictimEvacuated",
      "time_delta": null,
      "mission_time": null
    },
    "measure_data" : [
      {
        "measure_id": "ASI-M3",
        "datatype": "double",
        "measure_value": 0.67,
        "description": "Error Rate",
        "additional_data": {
          "victims_rescued": 7,
          "victims_discovered": 12
        }      
      }
    ]
  }
}
{
  "header" : {
    "timestamp" : "2021-05-27T16:23:36.1317Z",
    "version" : "3.0",
    "message_type" : "agent"
  },
  "msg" : {
    "sub_type" : "measures",
    "timestamp" : "2021-05-27T16:23:36.1317Z",
    "experiment_id" : "730527c7-c06d-4edf-906c-ac3996460faf",
    "trial_id" : "97e409cc-e1e1-4698-9154-14358d98f55f",
    "version" : "3.0",
    "source" : "AC_Aptima_TA3_measures"
  },
  "data" : {
    "study_version": "3",
    "elapsed_milliseconds": 240000,
    "event_properties": {
      "qualifying_event_type": "time",
      "qualifying_event_message_type": "",
      "qualifying_event_sub_type": "",
      "time_delta": null,
      "mission_time": 240000
    },
    "measure_data" : [
      {
        "measure_id": "M123T",
        "datatype": "integer",
        "measure_value": 50,
        "description": "Current score",
        "additional_data": {}      
      }
    ]
  }
}
Raw JSON Schema (resolved) 
{
  "$id": "http://asist.aptima.com/schemas/agent_measures.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {},
  "properties": {
    "data": {
      "$id": "#/properties/data",
      "properties": {
        "elapsed_milliseconds": {
          "$id": "#/properties/data/properties/elapsed_milliseconds",
          "examples": [
            107777
          ],
          "pattern": "^[0-9]+$",
          "title": "The elapsed_milliseconds",
          "type": "number"
        },
        "event_properties": {
          "$id": "#/properties/data/properties/event_properties",
          "properties": {
            "qualifying_event_type": {
              "$id": "#/properties/data/properties/event_properties/properties/qualifying_event_type",
              "examples": [
                "event",
                "time"
              ],
              "pattern": "^(.*)$",
              "title": "The qualifying_event_type",
              "type": "string"
            }
          },
          "required": [
            "qualifying_event_type"
          ],
          "title": "The event_properties Schema",
          "type": "object"
        },
        "measure_data": {
          "$id": "#/properties/data/properties/measure_data",
          "properties": {
            "datatype": {
              "$id": "#/properties/data/properties/measure_data/properties/datatype",
              "examples": [
                "integer"
              ],
              "pattern": "^(.*)$",
              "title": "The datatype",
              "type": "string"
            },
            "description": {
              "$id": "#/properties/data/properties/measure_data/properties/description",
              "examples": [
                "Current score"
              ],
              "pattern": "^(.*)$",
              "title": "The description",
              "type": "string"
            },
            "measure_id": {
              "$id": "#/properties/data/properties/measure_data/properties/measure_id",
              "examples": [
                "ASI-M1"
              ],
              "pattern": "^(.*)$",
              "title": "The measure_id",
              "type": "string"
            },
            "measure_value": {}
          },
          "required": [
            "measure_id",
            "datatype",
            "measure_value",
            "description"
          ],
          "title": "The measure_data Schema",
          "type": "object"
        },
        "study_version": {
          "$id": "#/properties/data/properties/study_version",
          "examples": [
            "3"
          ],
          "pattern": "^(.*)$",
          "title": "The study_version",
          "type": "string"
        }
      },
      "required": [
        "study_version",
        "elapsed_milliseconds",
        "event_properties",
        "measure_data"
      ],
      "title": "The Scoreboard Data Schema",
      "type": "object"
    },
    "header": {
      "$id": "http://asist.aptima.com/schemas/common_header.json",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "definitions": {},
      "properties": {
        "message_type": {
          "$id": "#/properties/message_type",
          "const": "agent",
          "enum": [
            "control",
            "observation",
            "chat",
            "status",
            "trial",
            "event",
            "groundtruth",
            "experiment",
            "metadata",
            "agent"
          ],
          "examples": [
            "observation"
          ],
          "pattern": "^([a-z_]*?)$",
          "title": "The Message_type Schema",
          "type": "string"
        },
        "timestamp": {
          "$id": "#/properties/timestamp",
          "examples": [
            "2019-12-26T12:47:23.1234Z"
          ],
          "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[.]?[0-9]{0,}?Z",
          "title": "The Timestamp Schema",
          "type": "string"
        },
        "version": {
          "$id": "#/properties/version",
          "examples": [
            "1.0",
            "2.3.1"
          ],
          "pattern": "^([0-9]+\\.)?([0-9]+\\.)?([0-9]+)$",
          "title": "The message format version",
          "type": "string"
        }
      },
      "required": [
        "timestamp",
        "message_type",
        "version"
      ],
      "title": "ASIST message common header Schema",
      "type": "object",
      "version": "0.3"
    },
    "msg": {
      "$id": "http://asist.aptima.com/schemas/event_message.json",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "definitions": {},
      "properties": {
        "experiment_id": {
          "$id": "#/properties/experiment_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|Null|null)",
          "title": "The Experiment Id Schema",
          "type": "string"
        },
        "replay_id": {
          "$id": "#/properties/replay_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Replay Id Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "replay_parent_id": {
          "$id": "#/properties/replay_parent_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Replay Parent Id Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "replay_parent_type": {
          "$id": "#/properties/replay_parent_type",
          "enum": [
            "TRIAL",
            "REPLAY",
            null
          ],
          "title": "The Replay Parent Type Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "source": {
          "$id": "#/properties/source",
          "default": "",
          "examples": [
            "simulator"
          ],
          "pattern": "^(.*)$",
          "title": "The Source Schema",
          "type": "string"
        },
        "sub_type": {
          "$id": "#/properties/sub_type",
          "const": "measures",
          "default": "",
          "examples": [
            "equip",
            "triage"
          ],
          "pattern": "^([a-zA-Z0-9_:]*?)$",
          "title": "The Sub Type Schema",
          "type": "string"
        },
        "timestamp": {
          "$id": "#/properties/timestamp",
          "default": "",
          "examples": [
            "2019-12-26T14:05:02.3412Z"
          ],
          "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[.]?[0-9]{0,}?Z",
          "title": "The Timestamp Schema",
          "type": "string"
        },
        "trial_id": {
          "$id": "#/properties/trial_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Trial Id Schema",
          "type": "string"
        },
        "version": {
          "$id": "#/properties/version",
          "default": "",
          "examples": [
            "0.1",
            "1.0.1"
          ],
          "pattern": "^([.]*)|(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
          "title": "The Version Schema",
          "type": "string"
        }
      },
      "required": [
        "experiment_id",
        "timestamp",
        "source",
        "sub_type",
        "version"
      ],
      "title": "The Event Message Schema",
      "type": "object",
      "version": "0.5"
    }
  },
  "required": [
    "header",
    "msg",
    "data"
  ],
  "title": "The Measures Agent Schema",
  "type": "object",
  "version": "0.4"
}
Upstream spec documentation

agent subtype : measures Message Format

The measures published by various agents.

TOPICS

agent/measures/+ (agent/measures/AC_Aptima_TA3_measures)

Message Fields

Field Name Type Description
header object (required) From the Common Header Format section.
msg object (required) From the Common Message Format section.
data.study_version number (required) the current study.
data.elapsed_milliseconds number (required) the current elapsed milliseconds.
data.event_properties object (required) data which describes the event which triggers the measure.
data.event_properties.qualifying_event_type string (required) the event type one of ["event", "timedEvent", "time"].
data.event_properties.qualifying_event_message_type string the messagetype that triggered the measure calculation if qualifying_event_type is: "event" or "timedEvent".
data.event_properties.qualifying_event_sub_type string the message subtype that triggered the measure caclulation if qualifying_event_type is: "event" or "timedEvent". For example: "Event:VictimEvacuated", "Event:MissionState".
data.event_properties.time_delta number the time delta between the event that caused the measure to be calculated and the actual time the measure is calculated if qualifying_event_type is "timedEvent" In elapsed_milliseconds. For example 2000 milli-seconds after the transporter signal triggers.
data.event_properties.mission_time number A specific mission time in elapsed_milliseconds when the measure calculation was done if qualifying_event_type is "time". For example 300000 milliseconds (5 minutes) into the mission.
data.measure_data object array (required) an array of data for the current measure.
data.measure_data.datatype string (required) the datatype of the current measure.
data.measure_data.measure_id string (required) the id of the current measure.
data.measure_data.measure_value any (required) the value of the current measure.
data.measure_data.description string (required) a description of the current measure.
data.measure_data.additional_data object user defined object with any addiotional data needed.

Event Message Example

{
  "header" : {
    "timestamp" : "2021-05-27T16:23:36.1317Z",
    "version" : "3.0",
    "message_type" : "agent"
  },
  "msg" : {
    "sub_type" : "measures",
    "timestamp" : "2021-05-27T16:23:36.1317Z",
    "experiment_id" : "730527c7-c06d-4edf-906c-ac3996460faf",
    "trial_id" : "97e409cc-e1e1-4698-9154-14358d98f55f",
    "version" : "3.0",
    "source" : "AC_Aptima_TA3_measures"
  },
  "data" : {
    "study_version": "3",
    "elapsed_milliseconds": 927927,
    "event_properties": {
      "qualifying_event_type": "event",
      "qualifying_event_message_type": "Event",
      "qualifying_event_sub_type": "Event:VictimEvacuated",
      "time_delta": null,
      "mission_time": null
    },
    "measure_data" : [
      {
        "measure_id": "ASI-M3",
        "datatype": "double",
        "measure_value": 0.67,
        "description": "Error Rate",
        "additional_data": {
          "victims_rescued": 7,
          "victims_discovered": 12
        }      
      }
    ]
  }
}

Timed Message Example

{
  "header" : {
    "timestamp" : "2021-05-27T16:23:36.1317Z",
    "version" : "3.0",
    "message_type" : "agent"
  },
  "msg" : {
    "sub_type" : "measures",
    "timestamp" : "2021-05-27T16:23:36.1317Z",
    "experiment_id" : "730527c7-c06d-4edf-906c-ac3996460faf",
    "trial_id" : "97e409cc-e1e1-4698-9154-14358d98f55f",
    "version" : "3.0",
    "source" : "AC_Aptima_TA3_measures"
  },
  "data" : {
    "study_version": "3",
    "elapsed_milliseconds": 240000,
    "event_properties": {
      "qualifying_event_type": "time",
      "qualifying_event_message_type": "",
      "qualifying_event_sub_type": "",
      "time_delta": null,
      "mission_time": 240000
    },
    "measure_data" : [
      {
        "measure_id": "M123T",
        "datatype": "integer",
        "measure_value": 50,
        "description": "Current score",
        "additional_data": {}      
      }
    ]
  }
}