Message Status
Any message generated by OFSC at any moment of time has a Message Status. Message statuses define the flow of message processing. Message statuses are divided into:
Final:
This status means that the message processing is finished and requires no further processing. OFSC will neither send any further requests nor expect any incoming requests regarding this message.
Non-final:
These statuses notify the system that the message processing is not finished.
Message Statuses may be changed by Middleware and by OFSC internal processes. The processing ends when the message reaches one of the final message statuses.
List of message statuses:
falsemethod (final) – set by OFSC if the message itself or an associated object (activity, for example) has no fields required for processing by the appropriate method. For example, there is no e-mail address defined for the E-mail method. This status is not applied to the Outbound API messages.
obsolete (final) – set by OFSC if the message is no longer relevant. For example, the day before a message was generated to inform the customer about an activity, but the activity had been cancelled before such message was delivered.
delivered (final) – set by Middleware to signify that the message processing is finished. While 'sent' and 'delivered' statuses are very similar, in most cases 'sent' is used when there is no evidence that the final recipient (person or system) received the message while 'delivered' is used when the receipt is confirmed.
failed (final unless 'attempts' > 1) – set by Middleware to signify that the message delivery has failed, may be set by OFSC when an error occurs and the message did not reach its recipient.
sent (final) – set by Middleware to signify that the message was received by Middleware and there will be no further status updates.
new (non-final) – initial status after a message is created, processing has not started.
sending (non-final) – set by Middleware to signify that the message was received by Middleware but its processing is not finished and there will be further status updates.
Note: messages with the 'failed' status can be returned to the 'new' status and resent for processing (configurable in the 'Step' properties). The 'failed' status is only considered final when there are no retries (default – no retries).
Following diagram reflects state transitions and also includes the final statuses which are set by OFSC itself – gray arrows.
Not all statuses may be used in a specific OFSC implementation.