System Interface Offline and Online Status

For example, let's say that you have a number of callouts that normally send a request to a third party's /activation endpoint. One day, that company tells you that the activation system will be down for two hours of scheduled maintenance. Rather than have all of those callouts fail during those two hours, you can set the relevant system interface to Offline.

Doing so moves those callouts to the On Hold state. When the system goes back online, change the system interface back to Online. The callouts move to the Ready state where they're picked up and orchestrated as usual.

Offline Status

• A callout is moved to the On Hold state only when it's either ready to execute or it's retrying a failed attempt. For example, if you've scheduled the callout to run later, then it remains in a Scheduled state until it's ready to run. Only then does it change to On Hold (if the system interface is still set to Offline).

• If an order amendment is submitted while a callout is on hold, then the callout is frozen, and then treated as any other frozen item.

Online Status and the Integration Retry Job

The Integration Retry job is responsible for changing the state of a callout after its system interface is back online.

• The Integration Retry job checks callouts in the On Hold state to see whether their associated system interface statuses are set to Online. If so, then the job moves the callout to the Ready state.

• The Integration Retry job runs every minute by default, but you can edit the custom settings to change that setting, and others. See Custom Settings for Integration Retry and System Interface Online Mode

• Before the Integration Retry job can run the first time, you "schedule" it. Scheduling the job just means clicking the Start button next to the Schedule Integration Retry Job option on the admin panel. See Schedule the Integration Retry Job in Order Management Standard