JsonExportRegistrationHandler (Json Export Registration Handler)

This component works with the JsonExportSetpointHandler to apply a unique identifier from an external system to an export marker.

This allows the cloud (or other external system) target to assign it’s own identifier or primary key to export-marked points in the Niagara station, which can be used to locate them in future, or included in exports to that cloud system.

Figure 72.   JsonExportRegistrationHandler properties
Image

To add this handler to a station, expand the ExportMarker folder in the palette and drag this component to the router folder in the Nav tree.

In addition to the standard property (Enabled), these properties support the JsonExportRegistrationHandler.

Property Value Description
Last Result read-only Reports the results of the alarm acknowledgment to allow for logging or post-processing activity. Example output:

Unable to find messagge key:

Problem parsing messageType

Last Result Time read-only Reports when the handler ran last.
Last Input read-only Reports the last JSON string input, which was routed through this component. This string either successfully altered a setpoint or failed as indicated by the Status property.
Remote Key text (defaults to platformId) Identifies the name of the JSON property that denotes the point's identifier in the remote system.
Local Key text (defaults to niagaraId) Identifies the name of the JSON property that denotes the point’s identifier in the Niagara station.

Syntax

The messages should be in this format:

{
  "messageType" : "registerId"
  "niagaraId" : "h:a032",
  "platformId" : "mooseForce123"
}

or

{
  "messageType" : "deregisterId"
  "platformId" : "mooseForce123",
}
 
NOTE: This class does not use the messageType, which would be used simply to route it to this handler and so can be changed as needed.
 

Example

This Wire Sheet and JSON loosely demonstrate some of the routers and selectors based upon a fictional point search JSON message.

Figure 73.   Json Export Registration Handler example Wire Sheet and JSON
Image