...
Templates support a custom_corrective_actionsaction_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).
| Code Block |
|---|
{
"action_text": "Presence unknown: TSU replaced.",
"guidance": "Guidance text here",
"type": 3
} |
| Table of Contents |
|---|
...
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:
| Code Block |
|---|
{
"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:
| Code Block |
|---|
{
"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
| Code Block |
|---|
[
{
"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"
},
{
"action_text": "TSU physically damaged: replaced.",
"type": "device_offline"
},
{
"action_text": "TSU troubleshooting: rebooted.",
"type": "device_offline"
},
{
"action_text": "Defective TSU: replaced.",
"type": "device_offline"
},
{
"action_text": "Internet troubleshooting: under investigation.",
"guidance": "It might be because of an electrical outage, the gateway is unplugged, or a bad internet connection.",
"type": "gateway_offline"
},
{
"action_text": "Internet troubleshooting: router rebooted.",
"type": "gateway_offline"
},
{
"action_text": "Internet troubleshooting: ISP network addressed.",
"type": "gateway_offline"
},
{
"action_text": "Ethernet cable troubleshooting: cable reconnected.",
"type": "gateway_offline"
},
{
"action_text": "Ethernet cable physically damaged: cable replaced.",
"type": "gateway_offline"
},
{
"action_text": "Gateway troubleshooting: gateway rebooted.",
"type": "gateway_offline"
},
{
"action_text": "Defective gateway: gateway replaced.",
"type": "gateway_offline"
},
{
"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
}
] |
...
Usage Notes
You only have to add it a guidance blurb once per “type”. It will pick the first guidance it find per finds per type, so no need to repeat it for the same type.
Formatting blocks of text
...
| Code Block |
|---|
"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.)", |
You can insert line breaks and formatting by inserting appropriate characters (e.g. “------\n\nsometext”).