task_processing_failure.md
1.39 KB
Task processing failure notification templatization
Notification subject and message fields support templatization. The list of available templatization parameters depends on the template type. See the available types and parameters below:
Available template parameters:
-
taskType- the task type, e.g. 'telemetry deletion'; -
taskDescription- the task description, e.g. 'telemetry deletion for device c4d93dc0-63a1-11ee-aa6d-f7cbc0a71325'; -
error- the error stacktrace -
tenantId- the tenant id; -
entityType- the type of the entity to which the task is related; -
entityId- the id of the entity to which the task is related; -
attempt- the number of attempts processing the task
Parameter names must be wrapped using ${...}. For example: ${entityType}.
You may also modify the value of the parameter with one of the suffixes:
-
upperCase, for example -${entityType:upperCase} -
lowerCase, for example -${entityType:lowerCase} -
capitalize, for example -${entityType:capitalize}
Examples
Let's assume that telemetry deletion failed for some device. The following template:
Failed to process ${taskType} for ${entityType:lowerCase} ${entityId}
{:copy-code}
will be transformed to:
Failed to process telemetry deletion for device c4d93dc0-63a1-11ee-aa6d-f7cbc0a71325