Schema Version 6 Change Notice

Change Notes

The following changes are included in schemaVersion=6 implementation:

1. Traveler Information Message (TIM) broadcast requests are published into a new topic.J2735TimBroadcastJson. These messages comply with SAE J2735 2016 standard definition of TIM messages. The existing topic.OdeTimBroadcastJson still provides the TIM message broadcast request made by the Transportation Management Center (TMC), received, processed and broadcast by ODE to all designated recipients, i.e. Road Side Unit (RSU), and/or U.S. DOT Situation Data Warehouse (SDW). The schema for the new topic is described in docs/ODE_Output_Schema_Reference.docx. In summary, new request data structure has been included in the output metadata. See Sample topic.J2735TimBroadcastJson https://github.com/usdot-jpo-ode/jpo-ode/wiki/_new#sample-topicj2735timbroadcastjson.
2. request structure has also been added to topic.OdeTimBroadcastJson metadata structure.
3. index element has been removed from the payload/data structure. In its stead, rsuIndex element has been added to metadata/request/ode structure. It provides the same semantics as the prior payload/data/index element.
4. docker-compose.yml file has been upgraded to version: '3'
5. jpo-cvdp submodule and correspondingly a new docker-compose-ppm-nsv.yml file has been provided which does not utilize a docker shared volume for accessing PPM module config and map file. This version was produced to work around potential network restrictions behind corporate firewalls which may not allow sharing files between the docker host and the containers.
6. docs/ODESwagger.yaml and docs/ODE_Output_Schema_Reference.docx were updated to reflect the new and modified elements in the ODE output schema, specifically for the new topic.J2735TimBroadcastJson. The only change to the REST API schema is the repositioning of payload/data/index into metadata/request/ode/rsuIndex.
7. ODE timestamp format was modified to be fully compliant with ISO date/time format by eliminating the non-standard [ZoneID] component following the ISO timestamp.
8. jpo-s3-deposit and jpo-security-svcs submodules’ Maven build scripts were updated to perform the build inside the docker image process and enable it to be occur when the parent module jpo-ode docker image is being built. Previously, the submodules needed to be compiled separately and manually before the container image were to be built and that caused issues with old image being deployed in the container if the separate build was not done in advance.

Sample topic.J2735TimBroadcastJson

{
  "metadata": {
    "request": {
      "ode": {
        "verb": "POST",
        "version": 2,
        "rsuIndex": 10
      },
      "rsus": [
        {
          "rsuTarget": "127.0.0.1",
          "rsuUsername": "username",
          "rsuRetries": 0,
          "rsuTimeout": 2000,
          "rsuPassword": "password"
        }
      ],
      "snmp": {
        "mode": 1,
        "deliverystop": "2018-01-01T17:47:11-05:15",
        "rsuid": "00000083",
        "deliverystart": "2017-06-01T17:47:11-05:00",
        "enable": 1,
        "channel": 178,
        "msgid": 31,
        "interval": 2,
        "status": 4
      }
    },
    "recordGeneratedBy": "TMC",
    "schemaVersion": 6,
    "payloadType": "us.dot.its.jpo.ode.model.OdeTimPayload",
    "serialId": {
      "recordId": 0,
      "serialNumber": 0,
      "streamId": "957ed6d1-ea50-4e22-92f1-86e0e7ec72d3",
      "bundleSize": 1,
      "bundleId": 0
    },
    "sanitized": false,
    "recordGeneratedAt": "2017-03-13T06:07:11Z",
    "odeReceivedAt": "2018-11-09T20:52:28.846Z"
  },
  "payload": {
    "data": {
      "MessageFrame": {
        "messageId": 31,
        "value": {
          "TravelerInformation": {
            "timeStamp": 102607,
            "packetID": "EC9C236B0000000000",
            "urlB": null,
            "dataFrames": {
              "TravelerDataFrame": {
                "regions": {
                  "GeographicalPath": {
                    "closedPath": {
                      "false": ""
                    },
                    "anchor": {
                      "elevation": 9171,
                      "lat": 416784730,
                      "long": -1087827750
                    },
                    "name": "bob",
                    "laneWidth": 700,
                    "directionality": {
                      "both": ""
                    },
                    "description": {
                      "geometry": {
                        "extent": 1,
                        "laneWidth": 3300,
                        "circle": {
                          "center": {
                            "elevation": 9171,
                            "latitude": 416784730,
                            "longitude": -1087827750
                          },
                          "units": 7,
                          "radius": 15
                        },
                        "direction": 1010101010101010
                      }
                    },
                    "id": {
                      "id": 33,
                      "region": 23
                    },
                    "direction": 1010101010101010
                  }
                },
                "sspMsgRights1": 2,
                "duratonTime": 22,
                "sspMsgRights2": 3,
                "startYear": 2017,
                "msgId": {
                  "roadSignID": {
                    "crc": "0000",
                    "viewAngle": 1010101010101010,
                    "mutcdCode": {
                      "warning": ""
                    },
                    "position": {
                      "elevation": 9171,
                      "latitude": 416784730,
                      "longitude": -1087827750
                    }
                  }
                },
                "priority": 0,
                "url": null,
                "content": {
                  "advisory": {
                    "SEQUENCE": [
                      {
                        "item": {
                          "itis": 125
                        }
                      },
                      {
                        "item": {
                          "text": "some text"
                        }
                      },
                      {
                        "item": {
                          "itis": 250
                        }
                      },
                      {
                        "item": {
                          "text": 98765
                        }
                      }
                    ]
                  }
                },
                "sspTimRights": 0,
                "sspLocationRights": 3,
                "frameType": {
                  "advisory": ""
                },
                "startTime": 482027
              }
            },
            "msgCnt": 13
          }
        }
      }
    },
    "dataType": "TravelerInformation"
  }
}