Skip to main content

Retry Configuration

A retry configuration, called a retry policy where a fallout definition refers to it, governs the automatic retries Engage makes before handing a fallout to an operator. One policy can serve many fallout definitions, so a small set of well-named policies is easier to reason about than one per definition.

Before you begin

  • Decide the scope. Policies created under Settings > Retry Config belong to the organisation. Policies created from an application's Configuration tab > Fallouts > Retry Config belong to that application; its list shows organisation-level policies too while Organization Scope is on.
  • If the policy should apply only to certain errors, define those errors first under Error definitions.

Create a retry configuration

  1. Open Settings > Retry Config, or the application-scoped tab.
  2. Select Add Retry Configuration. The Retry Configuration drawer opens.
  3. Complete the sections below and select Save.

Basic information

FieldRequiredNotes
NameYesUnique within its scope
DescriptionNo
ActiveNoOn by default. Fallout definitions at application scope can only select active policies.

Retry settings

FieldRequiredNotes
Retry TypeYesFixed Interval waits the same time before every attempt. Exponential Back Off multiplies the wait after each attempt.
Max RetriesYesAt least 1. Once this many automatic attempts have failed, the fallout is exhausted and waits for an operator.
Retry After (Sec)YesThe wait before the first attempt, in seconds. 0 or more.
Max Delay (Sec)YesThe longest wait Engage will use between attempts, in seconds. At least 1.
Backoff MultiplierWith exponential back offShown only when Retry Type is Exponential Back Off. Between 0.01 and 9.99.

The two delay fields are labelled in seconds and stored in seconds. Their placeholder text mentions milliseconds; ignore it.

Schedule configuration

FieldNotes
Active Start Time24-hour HH:MM:SS. Retries run only from this time.
Active End Time24-hour HH:MM:SS. Retries stop at this time.
Active DaysWhole Week or any set of Monday to Sunday

Leave all three empty for a policy that retries at any time.

Additional settings

FieldNotes
Eligible Error TypesThe error codes this policy applies to. Leave it empty to apply the policy to every error.

Manage retry configurations

The table lists Name, Strategy, Max Retries, Initial Delay, Active, Scope, and Actions. Strategy shows the retry type, and Initial Delay the first wait in seconds.

  • The Active switch enables or disables a policy in place after a Status Update Confirmation prompt; confirm with Enable or Disable.
  • Select the edit control to reopen the drawer, then Update.
  • Select the delete control and confirm Delete in the Delete Retry Configuration prompt.

A policy that a fallout definition still uses cannot be deleted. Engage shows a Deletion Blocked panel listing the definitions that reference it.

How you know it worked

Engage confirms with Retry Created Successfully and the row appears in the table, which reports Total N Retry Configurations. The policy is now offered in the Retry Policy list of the fallout definition form, with its description on hover and an eye icon that opens it as View Retry Configuration.

When it does not work

SymptomCauseWhat to do
Max retries must be at least 1Max Retries is 0Enter 1 or more
Initial delay must be 0 or greaterRetry After (Sec) is negativeEnter 0 or more
Max delay must be greater than 0Max Delay (Sec) is 0Enter 1 or more
Backoff multiplier Range 0.01 to 9.99The multiplier is outside that rangeEnter a value inside it
Failed To Save or Failed To UpdateThe service rejected the saveCheck the name is unique in its scope and try again
Deletion BlockedA fallout definition references this policyPoint those definitions at another policy, then delete
The policy is missing from a fallout definition's Retry Policy listIt is inactiveSwitch Active on in the table

Next steps

Fallout definitions, which choose this policy for a given error.