Custom Corrective Actions & guidance
- Brent Meriwether (Unlicensed)
Supported added October 2021
Templates support a custom_corrective_action_options attribute that enables a custom corrective action list and guidance text to be set for each data capability (e.g. separate corrective action lists alerts for Probe, Temperature & Humidity). This allows us to set default Guidance and Corrective Actions seen by all users of this hardware (if using this custom template).
{
"action_text": "Presence unknown: TSU replaced.",
"guidance": "Guidance text here",
"type": 3
}
Guidance and actions can be set based on the type which refers to the event type (such as device_offlince or gateway_offline) as well as based on Channel (such as Channel 3: Temperature alert).
device offline example:
{
"action_text": "Battery depleted: e-Box replaced; matrix reused.",
"guidance": "It might be because of a gateway is unplugged or someone took the sensor.",
"type": "device_offline"
},
{
"action_text": "Obstacle blocking TSU: obstacle removed.",
"type": "device_offline"
},
{
"action_text": "TSU in comms dead zone: repositioned.",
"type": "device_offline"
},Channel 3: Temperature example:
{
"action_text": "Presence confirmed: in treatment, TSU removed.",
"guidance": "Upon receiving an alert, monitor the internal food temperature of 3 different foods.\n\nIf the food has been > 40°F for less than 2 hours, move the food to a refrigerator that can maintain the food ≤ 40 °F, quickly cool the food in a blast chiller, or immediately cook the food.\n\nIf the food has been > 40°F for more than 2 hours, discard the food.\n\nIf the food temperature is below < 40 °F, continue monitor the air temperature of the unit.\n\nDetermine the root cause for the elevated temperature and correct immediately (adjust thermostat, request service for the refrigeration unit, etc.)",
"type": 3
},
{
"action_text": "Presence unknown: TSU replaced.",
"type": 3
}
]Example
Usage Notes
You only have to add a guidance blurb once per “type”. It will pick the first guidance it finds per type, so no need to repeat it for the same type.
Formatting blocks of text
Do not manually insert line breaks into paragraphs of text. Use character line breaks to introduce formatting to text.
A single line break (no space between paragraphs) is a single \n
for double line break (empty line between paragraphs) double \n\n
So a formatted text would look like:
You can insert line breaks and formatting by inserting appropriate characters (e.g. “------\n\nsometext”).