message.getRetryCount¶

Signature: message.getRetryCount()

Returns: Integer count - the number of consecutive send failures recorded for the current message

Get the number of consecutive failed send attempts recorded for the current message by message.retryDestination(). Returns 0 before the first failure.

Note

Intended for a Destination Custom Script's retry loop.

Note

The count is per script execution -- it resets to 0 each time the script runs, so it does not accumulate across whole-script re-runs triggered by an uncaught error/throw. Use it only within a single script's own retry loop.

Note

This method only applies to the following formatted messages: HL7, ASTM, Binary, CSV, DICOM, EDIFACT, Old Fxd Width, Fxd Length, ISO 8583, JSON, Text, X12, XML.

Parameters¶

None

Example¶

// Example: read how many consecutive send failures have been
// recorded for the current message (0 before the first failure).
var retries = message.getRetryCount(); // Integer