alerts
http://www.sifassociation.org/infrastructure/3.2
Documentation
Alerts form a system wide log that can be protected, as it may contain sensitive data. Ideally an Alert should contain as much identifying information about the problem being reported as possible.
Tree
Table
Name | Mandatory | Characteristics | Type | Description | XPath | Format |
---|---|---|---|---|---|---|
@id | uuidType | /alerts/alert/@id | [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[14][a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} | |||
reporter | * | M | token | External identification of the Application (Consumer or Provider) reporting this Alert. | /alerts/alert/reporter | |
cause | O | token | External identification of the cause of the Alert. | /alerts/alert/cause | ||
exchange | * | M | string | The exchange (or lack of exchange) responsible for generating the Alert. | /alerts/alert/exchange | REQUEST, RESPONSE, EVENT, TIMEOUT, OTHER |
level | * | M | string | The level of the Alert. | /alerts/alert/level | INFO, STATECHANGE, WARNING, ERROR |
description | O | normalizedString | A description of the reason for the Alert. | /alerts/alert/description | ||
messageID | C | token | If available, the ID of the Message causing the problem. | /alerts/alert/messageID | ||
body | O | string | The internals of the offending message or a more complete description of the information or state change. Usage of the CDATA designation is recommended in order to make the XML contents more readable to humans. | /alerts/alert/body | ||
error | O | string | Detailed error results such as a stack trace. | /alerts/alert/error | ||
xpath | O | normalizedString | An indicator of the specific element that was in error (or contributed to the problem. [NEEDS TO BE CHANGED TO the SIF XPATH TYPE] | /alerts/alert/xpath | ||
category | MC | unsignedInt | If the Alert Level is an error, this value must be the SIF 3.0.1 Error Category corresponding to the type of Error being reported | /alerts/alert/category | ||
code | MC | unsignedInt | If the Alert Level is an error, this value must be the SIF 3.0.1 Error Code corresponding to the type of Error being reported. | /alerts/alert/code | ||
internal | O | token | Code internal to the reporter. | /alerts/alert/internal |
Download: .xlsx
XML Structure
Download: .xml