boehnenelton2024

This document provides the formal guidelines for external systems to register a custom BEJSON 104db format variant. Compliance with these instructions is mandatory for ensuring interoperability and successful validation by the BEJSON Manager.

Key Specifications

Registration is a two-step process: an in-schema declaration and the submission of a technical report to the BEJSON standards body.

In-Schema Declaration

Every schema file that represents a variant MUST include specific declarations to be recognized by our validation systems. If these declarations are present, the file is considered a valid variant, and strict 104db validation is bypassed.

A. Record Type Declaration

Your schema's "Records_Type" array must include the string "Format_Variation_ID".

B. Identification Record

Your schema's "Values" array must contain a single, dedicated record for identification. In this record, the value corresponding to the "Record_Type_Name" field must be "Format_Variation_ID", and the value for the "Record_Name" field must be your unique, human-readable format identifier (e.g., "MyCompany_Logistics_Format_v1.3").

Example of In-Schema Declaration

Below is an example for a variant named "Acoustic_Waveform_Data_v2.1". Note the two key declarations.

{
  "Format": "BEJSON",
  "Format_Version": "104db",
  "Records_Type": [
    "Format_Variation_ID",
    "Waveform",
    "Sensor"
  ],
  "Fields": [
    { "name": "Record_Type_Name", "type": "string" },
    { "name": "Record_Name", "type": "string" },
    // ... other fields for your format
  ],
  "Values": [
    [
      "Format_Variation_ID",
      "Acoustic_Waveform_Data_v2.1",
      // ... other fields are null for this system record
    ],
    // ... other data records for your format
    [ "Waveform", "waveform_123", "..." ],
    [ "Sensor", "sensor_ABC", "..." ]
  ]
}
      

Required Technical Report

In addition to the in-schema declaration, you must provide a technical report to the BEJSON standards body that we will use to configure our internal systems. This report must be a machine-readable document (e.g., Markdown) containing details about your variant, such as its purpose, structural deviations from standard 104db, and a complete schema example.