Skip to main content Skip to complementary content

cLoadBalancer Standard properties

These properties are used to configure cLoadBalancer running in the Standard Job framework.

The Standard cLoadBalancer component belongs to the Routing family.

Basic settings


Select between Random, Round Robin, Sticky, Topic, Failover, and Custom. Each method is described below.


The receiving endpoint is chosen randomly at each exchange.

Round Robin Messages are distributed according to the round robin method which distributes the load evenly.


Language: Select the language of the expression to use in the Expression field to distribute the messages from None, Bean, Constant, CorrelationID, EL, Groovy, Header, JoSQL, JSonPath, JXPath, MVEL, OGNL, PHP, Property, Python, Ruby, Simple, SpEL, SQL, XPath, and XQuery.

For more information about how to use the languages to create an expression, see the site

Expression: Type in the expression that will be used to calculate a correlation key that will determine the endpoint to choose.


Select this option to send all the messages to all the endpoints.


Basic mode: By default, the failover load balancing always sends the messages to the first endpoint. If the first endpoint fails, the messages are sent to subsequent endpoints.

Specify exceptions: Specify the exceptions to which the failover should react to in the Exception table.

Use with Round robin: Select this option to use failover with advanced options.

From the Maximum failover attempt list, select the number of attempt to be proceed before giving up the transfer:

-Attempt forever: always attempts to transfer the messages and always try to failover.

-Never failover: gives up immediately the transfer of messages and never try to failover.

-A number of attempts: attempts n number of time to transfer messages, specify that number in the Number of attempts field.

Inherit error handler: Select true if you want Camel error handler to be used. If you select false, the load balancer will immediately failover when an exception is thrown.

Use Round robin: Select true if you want to combine failover with round robin. Failover load balancing with round robin mode distributes the load evenly between the services, and it provides automatic failover.


Load balancer: Type in the name of your custom load balancer.


Usage rule

cLoadBalancer is used as a middle component in a Route.

Connections Load Balance: Select this link to route messages to the next endpoint according to the selected load-balancing strategy.
  Route: Select this link to route all the messages from the sender to the next endpoint.



Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!