RelativeJsonSchema (Relative Json Schema)

This schema enables the scaling of JSON payload generation, which provides faster processing than the speed available using multiple simple schemata.

Figure 42. RelativeJsonSchema properties

You add a relative schema to a station by dragging a RelativeJsonSchema from the palette to the Config folder in the Nav tree. From there, to access schema properties, expand the Config folder and double-click the schema.

In addition to the standard properties (Enabled, Status, and Fault Cause), these properties are unique to JSON.

Property	Value	Description
Last Updated	read-only (defaults to null)	Reports when the relative schema was updated last.
Config	folder	Contains properties for configuring the relative schema.
Queries	folder	Contains the search arguments.
Base Query	additional properties	Defines a query that is intended to resolve targets in the station one at a time. An example might be all BACnet devices. The base query returns the objects that the schema resolves against. The schema objects (below the query) then pick out appropriate values.

Buttons

These actions are available when you click an icon and name to the right of the Output property on the schema Property Sheet.

Figure 43. Relative JSON Schema action buttons on the right side

Generate requests a rebuild and update of schema output. For relative schemata, this evaluates the Base Query and publishes results.
Copy copies the selected JSON to the clipboard.
Clear Output sets the Out slot of this component to an empty string.
Output History displays a history of the most recent schema output values in a new tab. This information is useful to confirm output contents if the schema changes rapidly due to subscribed points, and to have timestamps show how frequently it changes.
Metrics reports information used to size and provision capacity as well as debug performance problems.
Indented Display toggles the Output display between the underlying JSON string (which does not have extraneous whitespace) and a syntax highlighted and indented version that is easier to understand. It defaults to the latter.

Actions

These actions are available when you right-click the JsonSchema node in the Nav tree.

Generate Json executes the JSON code.
Force Generate Json forces the generate action regardless of the current tuning settings.
Clear Cache discards the last known values of bindings and cached query results.
Clear Output sets the Out slot of this component to an empty string.
Execute Queries forces an immediate execution of all the schemas queries. You can link this action to some appropriate logic to trigger execution when needed.
Unregister And Unsubscribe All (relative schema only) unsubscribes the registration from any base items that the relative schema monitors for updates and removes cloud registration from all export-marked entities in the station.