PTAGIS Data Specification

 

 

Usage Scenarios

 

The following use case scenarios describe how and why interrogation data is formatted into the M5 format for eventual submission to PTAGIS.

 

Automated Submission of Data from M5

M5 is software developed to run unattended at an interrogation site for collecting and submitting interrogation data, and, in some cases, controlling diversion gates in support of Separation-by-Code (SbyC).

 

Data collected on a local machine is:

1.Formatted as an M5 file

2.Submitted to PTAGIS on a user-defined schedule

3.Processed into the PTAGIS database and reporting servers

4.Archived in the PTAGIS Data File Repository

5.Archived on the local machine as a backup

 

M5 is a direct replacement for M4 software used at PTAGIS interrogation sites and the legacy MiniMon software still in use at various agency sites. It was released for production use at PTAGIS managed sites in September 2021 and will be released to the larger PTAGIS community during the fourth quarter of 2021.

 

Automated Submission of Raw Data

An agency creates an automated system to pull or push raw data from a remote data logger connected to a FS1001M transceiver on a periodic basis. The raw data might look something like the below snippet.

 

"TOA5","CR1000","CR1000","45888","CR1000.Std.22","CPU:Biomark9.01_COM1.CR1","39801","Tags"

"TIMESTAMP","RECORD","TagLoc","InStringTag"

"2017-06-21 10:14:50",61909,0,"C0 C2 3E7.0000001DC0 21-06-2017 10:51:53"

"2017-06-21 10:14:50",61910,0,"C0 C3 3E7.0000001DC0 21-06-2017 10:51:53"

"2017-06-21 10:14:50",61911,0,"C0 C4 3E7.0000001DC0 21-06-2017 10:51:53"

"2017-06-21 10:14:50",61912,0,"C0 C1 3E7.0000001DC0 21-06-2017 10:51:53"

"2017-06-21 11:14:50",61913,0,"C0 C3 3E7.0000001DC0 21-06-2017 11:51:52"

 

The raw data would be passed to a service that would convert it to a standard M5 file format that looks something like this.

Note the following:

Records with fieldSource = Transceiver and fieldDataType = Raw will be parsed during processing to extract the timestamp, PIT Tag code, Transceiver ID and Antenna ID

Records with fieldSource = Extraneous will be ignored during processing

 

Once the raw data has been properly formatted, the resulting file can be submitted through the PTAGIS API.

 

{

  "schema": "https://ptagis.org/content/schemas/interrogation/2022-04/schema.json",

  "fileName": "TST-2017-172-P-002.json",

  "siteCode": "TST",

  "fileCreated": "2017-06-21T10:00:00-07:00",

  "fileClosed": "2017-10-19T15:30:00-07:00",

  "dataRole": "Primary",

  "systemDescription": "MyConverter 1.0",

  "interrogationFieldData": [

    {

      "fieldDataType": "Raw",

      "fieldData": "\"TOA5\",\"CR1000\",\"CR1000\",\"45888\",\"CR1000.Std.22\",\"CPU:Biomark9.01_COM1.CR1\",\"39801\",\"Tags\"",

      "fieldSource": "Extraneous"

    },

    {

      "fieldDataType": "Raw",

      "fieldData": "\"TIMESTAMP\",\"RECORD\",\"TagLoc\",\"InStringTag\"",

      "fieldSource": "Extraneous"

    },

    {

      "fieldDataType": "Raw",

      "timestamp": "2017-06-21T10:14:50-07:00",

      "fieldData": "C0 C2 3E7.0000001DC0 21-06-2017 10:51:53",

      "fieldSource": "Transceiver",

      "systemID": "C0"

    },

    {

      "fieldDataType": "Raw",

      "timestamp": "2017-06-21T10:14:50-07:00",

      "fieldData": "C0 C3 3E7.0000001DC0 21-06-2017 10:51:53",

      "fieldSource": "Transceiver",

      "systemID": "C0"

    },

    {

      "fieldDataType": "Raw",

      "timestamp": "2017-06-21T10:14:50-07:00",

      "fieldData": "C0 C4 3E7.0000001DC0 21-06-2017 10:51:53",

      "fieldSource": "Transceiver",

      "systemID": "C0"

    },

    {

      "fieldDataType": "Raw",

      "timestamp": "2017-06-21T10:14:50-07:00",

      "fieldData": "C0 C1 3E7.0000001DC0 21-06-2017 10:51:53",

      "fieldSource": "Transceiver",

      "systemID": "C0"

    },

    {

      "fieldDataType": "Raw",

      "timestamp": "2017-06-21T11:14:50-07:00",

      "fieldData": "C0 C3 3E7.0000001DC0 21-06-2017 11:51:52",

      "fieldSource": "Transceiver",

      "systemID": "C0"

    }

  ]

}

Automated Submission of Parsed Data

This scenario describes a researcher downloading raw data from a transceiver or Master Controller; parsing the data to extract the Timestamp, Tag Code, Transceiver ID, and Antenna ID; formatting the records into an M5 file; and submitting that file through the PTAGIS API.

 

The following sample raw data is from the memory of a Biomark IS1001 Master Controller:

 

INF: Download Tags Memory

INF: Searching Records...

*TAG: 01 09 05/27/2017 09:21:46.210 3E7.0000001D09

*TAG: 01 01 05/27/2017 09:21:46.320 3E7.0000001D01

*TAG: 01 03 05/27/2017 09:21:46.480 3E7.0000001D03

*TAG: 01 05 05/27/2017 09:21:46.560 3E7.0000001D05

 

The resulting M5 formatted file would look like this. Note that if the fieldDataType is set to Tag the values loaded into PTAGIS will be taken from the timestamp, systemID, subsystemID, and tagCode fields and the fieldData field will be ignored.

{

  "schema": "https://ptagis.org/content/schemas/interrogation/2022-04/schema.json",

  "fileName": "TST-2017-147-P-001.json",

  "siteCode": "TST",

  "fileCreated": "2017-05-27T08:43:28.8613534-07:00",

  "fileClosed": "2017-05-27T10:43:28.8639192-07:00",

  "dataRole": "Primary",

  "systemDescription": "MyParser 1.0",

  "interrogationFieldData": [

    {

      "fieldDataType": "Tag",

      "timestamp": "2017-05-27T09:21:46-07:00",

      "fieldData": "*TAG: 01 09 05/27/2017 09:21:46.210 3E7.0000001D09",

      "fieldSource": "Transceiver",

      "systemID": "01",

      "subsystemID": "09",

      "tagCode": "3E7.0000001D09"

    },

    {

      "fieldDataType": "Tag",

      "timestamp": "2017-05-27T09:21:46-07:00",

      "fieldData": "*TAG: 01 01 05/27/2017 09:21:46.320 3E7.0000001D01",

      "fieldSource": "Transceiver",

      "systemID": "01",

      "subsystemID": "01",

      "tagCode": "3E7.0000001D01"

    },

    {

      "fieldDataType": "Tag",

      "timestamp": "2017-05-27T09:21:46-07:00",

      "fieldData": "*TAG: 01 03 05/27/2017 09:21:46.480 3E7.0000001D03",

      "fieldSource": "Transceiver",

      "systemID": "01",

      "subsystemID": "03",

      "tagCode": "3E7.0000001D03"

    },

    {

      "fieldDataType": "Tag",

      "timestamp": "2017-05-27T09:21:46-07:00",

      "fieldData": "*TAG: 01 05 05/27/2017 09:21:46.560 3E7.0000001D05",

      "fieldSource": "Transceiver",

      "systemID": "01",

      "subsystemID": "05",

      "tagCode": "3E7.0000001D05"

    }

  ]

}

 

Manual Submission of Data Using I5

This scenario describes a researcher downloading directly from a transceiver or Master Controller using PTAGIS interrogation file utility I5. I5 will parse the raw transceiver data to extract the Timestamp, Tag Code, Transceiver ID, and Antenna ID. The researcher can review the parsed data, perform some data management tasks such as filtering the data to a specific time period, and/or adjusting IDs or timestamps. Selected data can then be formatted into an M5 file and submitted to PTAGIS for inclusion into the database.

 

The following sample raw data is from the memory of a Biomark IS1001 Master Controller:

 

INF: Download Tags Memory

INF: Searching Records...

*TAG: 01 09 05/27/2017 09:21:46.210 3E7.0000001D09

*TAG: 01 01 05/27/2017 09:21:46.320 3E7.0000001D01

*TAG: 01 03 05/27/2017 09:21:46.480 3E7.0000001D03

*TAG: 01 05 05/27/2017 09:21:46.560 3E7.0000001D05

 

The resulting M5 formatted file would look like this. Note that I5 has parsed the message in Field Data and extracted the Timestamp, Tag Code and Antenna IDs (which are reported as Subsystem ID in the file). The message in Field Data will be ignored by the PTAGIS file load process and the parsed values will be used instead.

{

  "schema": "https://ptagis.org/content/schemas/interrogation/2022-04/schema.json",

  "fileName": "TST-2017-147-P-001.json",

  "siteCode": "TST",

  "fileCreated": "2017-05-27T08:43:28.8613534-07:00",

  "fileClosed": "2017-05-27T10:43:28.8639192-07:00",

  "dataRole": "Primary",

  "systemDescription": "I5 0.1.1",

  "interrogationFieldData": [

    {

      "fieldDataType": "Tag",

      "timestamp": "2017-05-27T09:21:46-07:00",

      "fieldData": "*TAG: 01 09 05/27/2017 09:21:46.210 3E7.0000001D09",

      "fieldSource": "Transceiver",

      "systemID": "01",

      "subsystemID": "09",

      "tagCode": "3E7.0000001D09"

    },

    {

      "fieldDataType": "Tag",

      "timestamp": "2017-05-27T09:21:46-07:00",

      "fieldData": "*TAG: 01 01 05/27/2017 09:21:46.320 3E7.0000001D01",

      "fieldSource": "Transceiver",

      "systemID": "01",

      "subsystemID": "01",

      "tagCode": "3E7.0000001D01"

    },

    {

      "fieldDataType": "Tag",

      "timestamp": "2017-05-27T09:21:46-07:00",

      "fieldData": "*TAG: 01 03 05/27/2017 09:21:46.480 3E7.0000001D03",

      "fieldSource": "Transceiver",

      "systemID": "01",

      "subsystemID": "03",

      "tagCode": "3E7.0000001D03"

    },

    {

      "fieldDataType": "Tag",

      "timestamp": "2017-05-27T09:21:46-07:00",

      "fieldData": "*TAG: 01 05 05/27/2017 09:21:46.560 3E7.0000001D05",

      "fieldSource": "Transceiver",

      "systemID": "01",

      "subsystemID": "05",

      "tagCode": "3E7.0000001D05"

    }

  ]

}