Definitions

  • BCT section name: Name of the BCT section where data needs to be updated in BCT.
    • Supported sections at present are: "customer-data-unsigned" or "customer-data-signed".
  • allowed-offset-ranges: Array of allowed offset ranges for a section type where each range is specified as an array of [start of the range, end of the range].
  • Data field name: Field name for the data.
  • parser-metadata: Metadata used to parse the user input value and convert them into list of words represented by their schema given in "schema".
    • data-separator-string: Separator characters to allow separating user input data into individual words.
    • number-of-words: Expected number of words after data-separator-string is applied to the user input.
  • schema: Schema to interpret input data words and covert input data to bytes.
    • version: Version for the data item (defaults to 1)
      • Version schema object is optional and only need to be specified for the data items that requires version information.
    • value
      • List of schema objects in sequence to allow interpreting each word in user input value for the data field.
        Note:

        If the multiple format is supported for each word, schema for a word can be a list of schema objects.

      • Each schema object is of the following format:

        Type

        Type

        Interpretation

        "decimal"

        Used for integer formats "I", "H" and "Q"

        "char"

        Used for character format "c"

        "string"

        Used for string format "s"

      • format-string:

        Format String

        Interpretation

        "I"

        Four bytes unsigned integer

        "H"

        Two bytes unsinged short integer

        "Q"

        Eight bytes unsigned integer

        "c"

        One byte characters

        "s"

        Null terminated string
      • offset: Offset where value needs to be stored in the BCT section

        • Offset values must be within the allowed range specified by "allowed-offset-ranges" for each section.

      • min-len
        • Minimum required input value length
        • Only required for "c" and "s" format types
      • max-len
        • Maximum required input value length.
        • Only required for "c" and "s" format types.