SetPointHandler (Json Set Point Handler)
This handler sets incoming setpoint values to control writable control points.
Override, duration, the status parameter and nested keys are not supported.
Figure 96. SetpointHandler properties
You add this handler to a station by expanding the folder in the palette and dragging this component to a message router in the Nav tree.
NOTE: The
Run As User property in the JsonSchemaService is required to use the SetPointHandler.In addition to the standard property (Enabled), these properties support the SetPointHandler:
| Property | Value | Description |
|---|---|---|
| Last Result | read-only | Reports the results of the alarm acknowledgment to allow for logging or post-processing activity. Example output:
|
| Last Result Time | read-only | Reports when the handler ran last. |
| Last Input | read-only | Reports the last message routed to a component. |
| Status | read-only | Reflects the current status of the component.
Ok indicates the JSON processed successfully. fault indicates the JSON did not process for any reason, such as invalid JSON or missing expected values in the JSON. |
| Id Key | text | Defines which top-level key in the JSON payload represents the point Id. |
| Value Key | text (defaults to value) | Defines which top-level key in the JSON payload represents the value to set. |
| Slot Name Key | text (defaults to slotName) | Defines the optional top-level key in the JSON payload that represents the slot name to write to. |
| Default Write Slot | text | Defines the slot to write to by default if the payload does not specify the slot. |
Actions
These actions are available when you right-click on the SetPointHandler.
Figure 97. SetPointHandler action buttons
- Route causes this component to process the
Stringparameter and update the Out slot. - Run Last Input executes the last input again.
- Clear Output sets the Out slot of this component to an empty string.