Ticket Addendums

Overview

Ticket Addendums allow additional, arbitrary data points to be included with a Ticket. This enables the augmentation of Bushel’s Ticket data model to support your specific business needs. Data points included in Addendums are displayed in the Ticket Detail. In addition, the Ticket List can be filtered by one or more Addendum fields.

Adding Addendums to a Ticket

Ticket Addendums are free-form key-value pairs sent as part of the standard Scale Ticket payload. Each Addendum entry consists of a string key with a string value. Any number of Addendums entries may be sent with a Ticket.

A minimal Scale Ticket with attached Addendum.

{
    "data": [
        {
            "update-tickets": {
                "tickets": [
                    {
                        "addendum": {
                            "lot_id": "123958",
                            "another_custom_field": "A useful Value"
                        },
                        "id": "tic-1235",
                        "commodity_id": "CRN",
                        "elevator_id": "ELV",
                        "primary_gross_weight": 0,
                        "remarks": [],
                        "created_at": "2019-03-30T17:42:35Z",
                        "updated_at": "2020-02-15T15:42:35Z",
                        "version": "1.1.0"
                    }
                ]
            }
        }
    ]
}

Display

Ticket Addendums are displayed within on the Ticket Details alongside the standard detail information such as Commodity and Driver and Truck information.

Figure 1. Ticket Addendum fields displayed within Ticket Details

Configurations

Addendum Display Names

Bushel can to modify any key sent in Ticket Addendums for display purposes, allowing technical field names to be used in the addendum data without concern for how it is presented to the user.

The Addendum portion of a Ticket object

{
    ...
    "addendum": {
        "crop_year": "2021",
        "farm_name": "Farm C",
        "field_name": "South 40",
        "lot_id": "933523"
    }
    ...
}

For example, lot_id in this addendum sent to Bushel can be configured to display to users as Lot Number.

As this configuration applies at display-time, any modifications take effect immediately and no data reloading is necessary.

Allowlist

Entries in Ticket Addendums are by default hidden from view. This configuration allows for any number of Addendums to be displayed with rest of the Tickets Details

As this configuration applies at display-time, any modifications take effect immediately and no data reloading is necessary.

Filter Allowlist

Any key sent in Ticket Addendums can also be added to the list of available filters in the Ticket List view. Similar to built-in filters, an addendum filter value will only be presented to the user if one or more of the users Tickets contain that value. This prevents unintentional data disclosure and ensures that each filter value presented to the user will return at least one Ticket.

Figure 2. Ticket Addendums enabled as Filters

As this configuration applies at display-time, any modifications take effect immediately and no data reloading is necessary.