Difference between revisions of "EventNotification Processing Feedback"
(Created page with "= EventNotification Processing Feedback = EventNotifications inform UBIK about changes to synchronised objects in external systems. Because a single notification may affect o...") |
(→NotificationLog) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 17: | Line 17: | ||
No <code>NotificationLog</code> is persisted for successful notifications. Instead, the successful processing result is provided dynamically: | No <code>NotificationLog</code> is persisted for successful notifications. Instead, the successful processing result is provided dynamically: | ||
| − | < | + | <pre> |
{ | { | ||
"Status": "SuccessfullyProcessed", | "Status": "SuccessfullyProcessed", | ||
"Errors": [] | "Errors": [] | ||
} | } | ||
| − | </ | + | </pre> |
| + | |||
=== PartlyProcessed === | === PartlyProcessed === | ||
| Line 43: | Line 44: | ||
Detailed failure information is stored in the EventNotification's <code>NotificationLog</code> property as JSON. | Detailed failure information is stored in the EventNotification's <code>NotificationLog</code> property as JSON. | ||
| − | < | + | <pre> |
{ | { | ||
"Status": "PartlyProcessed", | "Status": "PartlyProcessed", | ||
| Line 60: | Line 61: | ||
] | ] | ||
} | } | ||
| − | </ | + | </pre> |
Each error provides: | Each error provides: | ||
| Line 78: | Line 79: | ||
=== Historic Notifications === | === Historic Notifications === | ||
Historic notifications may not contain a <code>NotificationLog</code>. In this case, a fallback <code>NotificationProcessingResult</code> consists of the notification's existing status and an empty <code>Errors</code> collection. | Historic notifications may not contain a <code>NotificationLog</code>. In this case, a fallback <code>NotificationProcessingResult</code> consists of the notification's existing status and an empty <code>Errors</code> collection. | ||
| + | |||
== Failure Reasons and Troubleshooting == | == Failure Reasons and Troubleshooting == | ||
Latest revision as of 15:05, 29 October 2026
Contents
EventNotification Processing Feedback
EventNotifications inform UBIK about changes to synchronised objects in external systems. Because a single notification may affect one or multiple objects, UBIK provides processing feedback indicating both the overall processing state and, in case of failures, detailed information about what went wrong.
Detailed processing information is represented by NotificationProcessingResult. Error details are persisted in the EventNotification property NotificationLog only when processing encounters an error.
Processing States
NotProcessed
The notification has been received and stored, but processing has not yet taken place.
There is therefore no processing result or error information yet.
SuccessfullyProcessed
The notification was processed successfully and all affected objects were successfully imported, updated or deleted.
No NotificationLog is persisted for successful notifications. Instead, the successful processing result is provided dynamically:
{
"Status": "SuccessfullyProcessed",
"Errors": []
}
PartlyProcessed
The notification was processed and at least one affected object was processed successfully, while processing of at least one other object failed.
The NotificationLog contains details about the failed objects and the reason for each failure.
ProcessedWithError
Processing was attempted, but none of the affected objects could be processed successfully.
The NotificationLog contains the available error information for the failed processing operations.
NoProcessorFound
UBIK could not determine the necessary processing configuration for the notification. Object processing therefore could not be performed.
The NotificationLog contains details explaining why the notification could not be processed.
NotificationLog
Detailed failure information is stored in the EventNotification's NotificationLog property as JSON.
{
"Status": "PartlyProcessed",
"Errors": [
{
"Object": {
"SystemType": 8,
"SystemUid": "A5EWSOMYK6",
"DbKey": "db1",
"ProjectUid": "A3X1DY8S10",
"WorkingOverlayId": "A43NKY92H4"
},
"Code": "ObjectProcessingFailed",
"Message": "Description of the processing problem."
}
]
}
Each error provides:
-
Code: the type of processing error. -
Message: a human-readable description of the problem. -
Object: identification of the affected object, where the error can be assigned to a specific object.
The object identifier consists of:
-
SystemType -
SystemUid -
DbKey -
ProjectUid -
WorkingOverlayId
For errors that apply to the notification as a whole rather than an individual object, Object may be omitted.
Historic Notifications
Historic notifications may not contain a NotificationLog. In this case, a fallback NotificationProcessingResult consists of the notification's existing status and an empty Errors collection.
Failure Reasons and Troubleshooting
No Matching Login Found
Reason: NoMatchingLoginFound
UBIK could not find a configured Service Login (ComosLogin) matching the notification's DbKey, ProjectUid and WorkingOverlayId.
How to resolve: Verify that an appropriate Service Login is configured for this combination.
No Template/CDevice/DocumentType Information Found
Reason: NoTemplateCDeviceInfoFound
UBIK attempted to resolve the template, CDevice or DocumentType for the referenced object, but the required data could not be retrieved from Comos via the REST API.
How to resolve: Check the ServiceLogs for additional information.
Multiple InterfaceAdministrations Found
Reason: MultipleInterfaceAdministrationsFound
More than one InterfaceAdministration matches the login and template/CDevice/DocumentType of the referenced object, making the processing configuration ambiguous.
How to resolve: Check the configured InterfaceAdministration objects and ensure the affected object can be assigned unambiguously to one configuration.
No InterfaceAdministration Found
Reason: NoInterfaceAdministrationsFound
No InterfaceAdministration configured to process the referenced object could be found for the relevant login and template/CDevice/DocumentType.
How to resolve: Check the InterfaceAdministration configuration and ensure an appropriate configuration exists.
Proxy Not Imported
Reason: ProxyNotImported
The object was processed, but the resulting proxy did not receive a ComosUID. The corresponding proxy is still in creation state because its first export has not finished.
How to resolve: Check the ServiceLogs for more information.
Unexpected Error
Reason: UnexpectedError
An unexpected exception occurred while evaluating the notification.
How to resolve: Review the error Message for more information.
Quick Troubleshooting Overview
| Failure reason | What to check |
|---|---|
NoMatchingLoginFound
|
Service Login / ComosLogin configuration for DbKey, ProjectUid and WorkingOverlayId
|
NoTemplateCDeviceInfoFound
|
ServiceLogs and Comos REST API data retrieval |
MultipleInterfaceAdministrationsFound
|
Ambiguous InterfaceAdministration configuration
|
NoInterfaceAdministrationsFound
|
Missing InterfaceAdministration configuration
|
ProxyNotImported
|
ServiceLogs and proxy import/export |
UnexpectedError
|
Error Message for exception details
|
Summary
Successfully processed EventNotifications do not generate persistent log data. If processing fails completely or partially, the EventNotification's NotificationLog contains structured feedback identifying the failure and, where possible, the affected object.
