This documentation is for WSO2 Enterprise Integrator version 6.1.1 . View documentation for the latest release in the 6.x.x family and the latest release in the 7.x.x family.

All docs This doc

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


Table of Contents


XML configuration


You can configure the Failover endpoint using XML. Click on Switch to source view link in the Failover Group page.

Code Block
    <endpoint .../>+


UI configuration

The following page is opened by clicking Failover Group in the Add Endpoint tab of the Manage Endpoints page.


  1. Enter a name for the failover group endpoint, and if you want to add any properties, click Add Property and specify the properties.
  2. To add a child endpoint to the failover endpoint, click Add Child, and then select the required endpoint type from the list.
  3. Do the following:
    1. Enter the basic details for the child endpoint, such as the name and address.
    2. Click Show Advanced Options and specify the advanced options you want for this endpoint. 
    3. To add properties to the child endpoint, click Add Property and specify the properties.
    4. Click Update.
  4. Add more child endpoints as needed, and then save the failover group endpoint.

Handling errors in failover endpoints

An endpoint can be in one of the following states: Active, Timeout or Suspended. You can handle errors and configure the looping between the failover child endpoints via the <timeout><suspendOnFailure> and <markForSuspension> properties based on these states. For more information about these states and properties, see Endpoint Error Handling.

Table of Contents

Sample failover with one address endpoint

When message failure is not tolerable even though there is only one service endpoint, then failovers are possible with a single endpoint as shown in the below configuration.


In this configuration, we assume that these errors are rare and if they happen once in a while, it is okay to retry again. If they happen frequently and continuously, it means that it requires immediate attention to get it back to normal state.

Sample failover with multiple address endpoints

When a message reaches a failover endpoint with multiple address endpoints, it will go through its list of endpoints to pick the first one in Active or Timeout state (not in the Suspended state). Then, it will send the message using that particular endpoint.