trial

Trial Start and Stop messages (Creates and Starts a Trial --> stored in metadata db)

← All message topics  ·  schema Trial/trial.json

header

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

msg

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

data

FieldTypeRequiredAllowed valuesDescription
name string ✓
date string ✓
experimenter string ✓
subjects array<string> ✓
trial_number string
group_number string
study_number string
condition string
notes array<string>
testbed_version string ✓
experiment_name string ✓
experiment_date string ✓
experiment_author string ✓
experiment_mission string ✓
map_name string The Map Name
intervention_agents array<string>
map_block_filename string The Map Block file to use during trial
client_info array<object> ✓
client_info[].playername string ✓ The Player Name Logged in to Client Map
client_info[].callsign string ✓ The Call Sign Assigned to the Player
client_info[].participant_id string ✓ The Player's Participant ID
client_info[].staticmapversion string ✓ The Static Map Assigned to the Player
client_info[].markerblocklegend string ✓ The Marker Block Legend Assigned to the Player
client_info[].unique_id string ✓ The Player's Unique ID

Example message

{
  "header": {
    "timestamp": "2019-12-26T14:05:02.3412Z",
    "message_type": "trial",
    "version": "1.1"
  },
  "msg": {
    "sub_type": "start",
    "source": "gui",
    "experiment_id": "946d4567-ab65-cfe7-b208-426305dc1234",
    "trial_id": "123e4567-e89b-12d3-a456-426655440000",
    "timestamp": "2019-12-26T15:01:00.325Z",
    "version": "0.4",
	"replay_id": null,
    "replay_parent_id": null,
	"replay_parent_type": null
  },
  "data": {
    "name": "Experiment 5 trial 2",
    "date": "2019-12-26T15:01:00.325Z",
    "experimenter": "Scientist Name",
    "subjects": [
      "s312",
      "s429",
      "s12",
      "s734"
    ],
    "trial_number": "0001",
    "group_number": "555",
    "study_number": "Study_01",
    "condition": "An experimental condition.",
    "notes": [
      "line1",
      "line2",
      "line3",
      "line4"
    ],
    "testbed_version": "0.5",
    "experiment_name": "Experiment 5",
    "experiment_date": "2019-12-26T15:01:00.325Z",
    "experiment_author": "Scientist Name",
    "experiment_mission": "mdf_load_singleplayer.py",
    "map_name": "Falcon",
    "map_block_filename": "MapBlocks_Easy.csv",
    "intervention_agents": [ "AgentName1" ],
    "client_info" : [ {
      "playername" : "Scouter_B",
      "callsign" : "Alpha",
      "participant_id" : "hi",
      "staticmapversion" : "SaturnA_base",
      "markerblocklegend" : "A_Anne",
      "unique_id" : "id"
      }, {
      "playername" : "testplayer",
      "callsign" : "Bravo",
      "participant_id" : "foo",
      "staticmapversion" : "SaturnA_64",
      "markerblocklegend" : "B_Sally",
      "unique_id" : "id-2"
    } ]
  }
}
Raw JSON Schema (resolved) 
{
  "$id": "http://example.com/root.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {},
  "properties": {
    "data": {
      "$id": "#/properties/data",
      "properties": {
        "client_info": {
          "$id": "#/properties/data/properties/client_info",
          "items": {
            "$id": "http://asist.aptima.com/schemas/client_info.json",
            "$schema": "http://json-schema.org/draft-07/schema#",
            "definitions": {},
            "properties": {
              "callsign": {
                "$id": "#/properties/data/properties/callsign",
                "examples": [
                  "Alpha",
                  "Bravo",
                  "Delta",
                  "Red",
                  "Green",
                  "Blue"
                ],
                "pattern": "^(.*)$",
                "title": "The Call Sign Assigned to the Player",
                "type": "string"
              },
              "markerblocklegend": {
                "$id": "#/properties/data/properties/markerblocklegend",
                "examples": [
                  "B_Sally"
                ],
                "pattern": "^(.*)$",
                "title": "The Marker Block Legend Assigned to the Player",
                "type": "string"
              },
              "participant_id": {
                "$id": "#/properties/data/properties/participant_id",
                "examples": [
                  "1234aBcD"
                ],
                "pattern": "^(.*)$",
                "title": "The Player\u0027s Participant ID",
                "type": "string"
              },
              "playername": {
                "$id": "#/properties/data/properties/playername",
                "examples": [
                  "Player123"
                ],
                "pattern": "^(.*)$",
                "title": "The Player Name Logged in to Client Map",
                "type": "string"
              },
              "staticmapversion": {
                "$id": "#/properties/data/properties/staticmapversion",
                "examples": [
                  "SaturnA_64"
                ],
                "pattern": "^(.*)$",
                "title": "The Static Map Assigned to the Player",
                "type": "string"
              },
              "unique_id": {
                "$id": "#/properties/data/properties/unique_id",
                "examples": [
                  "1234aBcD"
                ],
                "pattern": "^(.*)$",
                "title": "The Player\u0027s Unique ID",
                "type": "string"
              }
            },
            "required": [
              "playername",
              "callsign",
              "participant_id",
              "staticmapversion",
              "markerblocklegend",
              "unique_id"
            ],
            "title": "The Client Info Schema",
            "type": "object",
            "version": "0.5"
          },
          "title": "The Client Info Schema",
          "type": "array"
        },
        "condition": {
          "$id": "#/properties/data/properties/condition",
          "default": "",
          "examples": [
            "My Experimental Condition"
          ],
          "pattern": "^(.*)$",
          "title": "The Condition Schema",
          "type": "string"
        },
        "date": {
          "$id": "#/properties/data/properties/date",
          "default": "",
          "examples": [
            "2019-12-26T12:47:23.123Z"
          ],
          "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 Date Schema",
          "type": "string"
        },
        "experiment_author": {
          "$id": "#/properties/data/properties/experiment_author",
          "default": "",
          "examples": [
            "My Experiment Author"
          ],
          "pattern": "^(.*)$",
          "title": "The Experiment Author Schema",
          "type": "string"
        },
        "experiment_date": {
          "$id": "#/properties/data/properties/experiment_date",
          "default": "",
          "examples": [
            "2019-12-26T12:47:23.123Z"
          ],
          "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 Experiment Date Schema",
          "type": "string"
        },
        "experiment_mission": {
          "$id": "#/properties/data/properties/experiment_mission",
          "default": "",
          "examples": [
            "My Experiment Mission"
          ],
          "pattern": "^(.*)$",
          "title": "The Experiment Mission Schema",
          "type": "string"
        },
        "experiment_name": {
          "$id": "#/properties/data/properties/name",
          "default": "",
          "examples": [
            "My Experiment Name"
          ],
          "pattern": "^(.*)$",
          "title": "The Experiment Name Schema",
          "type": "string"
        },
        "experimenter": {
          "$id": "#/properties/data/properties/experimenter",
          "default": "",
          "examples": [
            "The experimenter"
          ],
          "pattern": "^(.*)$",
          "title": "The Experimenter Schema",
          "type": "string"
        },
        "group_number": {
          "$id": "#/properties/data/properties/group_number",
          "default": "",
          "examples": [
            "Group-Number"
          ],
          "pattern": "^(.*)$",
          "title": "The Group Number Schema",
          "type": "string"
        },
        "intervention_agents": {
          "$id": "#/properties/data/properties/intervention_agents",
          "default": "",
          "examples": [
            "[\"AgentName1\"]"
          ],
          "items": {
            "type": "string"
          },
          "pattern": "^(.*)$",
          "title": "The Intervention Agents Schema",
          "type": "array"
        },
        "map_block_filename": {
          "$id": "#/properties/data/properties/map_block_filename",
          "default": "",
          "examples": [
            "MapBlocks_Easy.csv"
          ],
          "pattern": "^(.*)$",
          "title": "The Map Block file to use during trial",
          "type": "string"
        },
        "map_name": {
          "$id": "#/properties/data/properties/map_name",
          "default": "",
          "examples": [
            "Falcon"
          ],
          "pattern": "^(.*)$",
          "title": "The Map Name",
          "type": "string"
        },
        "name": {
          "$id": "#/properties/data/properties/name",
          "default": "",
          "examples": [
            "My Experiment Trial"
          ],
          "pattern": "^(.*)$",
          "title": "The Name Schema",
          "type": "string"
        },
        "notes": {
          "$id": "#/properties/data/properties/notes",
          "default": "",
          "examples": [
            "[\"Line 1\", \"Line 2\", \"Line 3\"]"
          ],
          "items": {
            "type": "string"
          },
          "pattern": "^(.*)$",
          "title": "The Notes Schema",
          "type": "array"
        },
        "study_number": {
          "$id": "#/properties/data/properties/study_number",
          "default": "",
          "examples": [
            "My Study Number"
          ],
          "pattern": "^(.*)$",
          "title": "The Study Number Schema",
          "type": "string"
        },
        "subjects": {
          "$id": "#/properties/data/properties/subjects",
          "default": "",
          "examples": [
            "[\"Subject 1\", \"Subject 2\", \"Subject 3\"]"
          ],
          "items": {
            "type": "string"
          },
          "pattern": "^(.*)$",
          "title": "The Subjects Schema",
          "type": "array"
        },
        "testbed_version": {
          "$id": "#/properties/data/properties/testbed_version",
          "default": "",
          "examples": [
            "0.5"
          ],
          "pattern": "^(.*)$",
          "title": "The Testbed Schema",
          "type": "string"
        },
        "trial_number": {
          "$id": "#/properties/data/properties/trial_number",
          "default": "",
          "examples": [
            "Trial-Number"
          ],
          "pattern": "^(.*)$",
          "title": "The Trial Number Schema",
          "type": "string"
        }
      },
      "required": [
        "name",
        "date",
        "experimenter",
        "subjects",
        "testbed_version",
        "experiment_name",
        "experiment_date",
        "experiment_author",
        "experiment_mission",
        "client_info",
        "role_text"
      ],
      "title": "The Trial 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": "trial",
          "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",
          "default": "",
          "enum": [
            "start",
            "stop"
          ],
          "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"
  ],
  "title": "The Root Schema",
  "type": "object"
}
Upstream spec documentation

Trial Message Format

A trial message describes the characteristics of a trial.

TOPICS

trial

Message Fields

Field Name Type Description
header object From the Common Header Format section.
msg object From the Common Message Format section.
data.name string A user friendly name for the trial.
data.date string The date and time the trial was run.
data.experimenter string A name of the experimenter performing the trial.
data.subjects string array A list of the names or ids of the subjects in the trial.
data.trial_number string Sequentially numbered trial run.
data.group_number string Data organization identifier.
data.study_number string Study identifier.
data.condition string The experimental condition used for the trial.
data.notes string array A list of notes for the trial.
data.testbed_version string The testbed version used for the trial.
data.experiment_name string A user friendly name for the experiment.
data.experiment_date string The date and time the experiment was created.
data.experiment_author string The name of the author of the experiment.
data.experiment_mission string The mission associated with this experiment.
data.map_name string The Map Name.
data.map_block_filename string The Map Block file to use during trial.
data.intervention_agents string array A list of agent names which can show interventions to the users
data.client_info object array client info parameters assigned by experimenter.
data.role_text object role specific text to be displayed on the client map.

Message Examples

{
  "header": {
    "timestamp": "2019-12-26T14:05:02.3412Z",
    "message_type": "trial",
    "version": "1.1"
  },
  "msg": {
    "sub_type": "start",
    "source": "gui",
    "experiment_id": "946d4567-ab65-cfe7-b208-426305dc1234",
    "trial_id": "123e4567-e89b-12d3-a456-426655440000",
    "timestamp": "2019-12-26T15:01:00.325Z",
    "version": "0.4",
    "replay_id": null,
    "replay_parent_id": null,
    "replay_parent_type": null
  },
  "data": {
    "name": "Experiment 5 trial 2",
    "date": "2019-12-26T15:01:00.325Z",
    "experimenter": "Scientist Name",
    "subjects": [
      "s312",
      "s429",
      "s12",
      "s734"
    ],
    "trial_number": "0001",
    "group_number": "555",
    "study_number": "Study_01",
    "condition": "An experimental condition.",
    "notes": [
      "line1",
      "line2",
      "line3",
      "line4"
    ],
    "testbed_version": "0.5",
    "experiment_name": "Experiment 5",
    "experiment_date": "2019-12-26T15:01:00.325Z",
    "experiment_author": "Scientist Name",
    "experiment_mission": "mdf_load_singleplayer.py",
    "map_name": "Falcon",
    "map_block_filename": "MapBlocks_Easy.csv",
    "intervention_agents": [ "AgentName1" ],
    "client_info" : [ {
      "playername" : "Scouter_B",
      "callsign" : "Alpha",
      "participant_id" : "hi",
      "staticmapversion" : "SaturnA_base",
      "markerblocklegend" : "A_Anne",
      "unique_id" : "id"
      }, {
      "playername" : "testplayer",
      "callsign" : "Bravo",
      "participant_id" : "foo",
      "staticmapversion" : "SaturnA_64",
      "markerblocklegend" : "B_Sally",
      "unique_id" : "id-2"
    } ]
  }
}