routes.conf

This file defines routes between this TIBCO Enterprise Message Service server and other TIBCO Enterprise Message Service servers.

Note: Routes may only be configured administratively, using the administration tool (see Using the EMS Administration Tool), or the administration APIs (see com.tibco.tibjms.admin.RouteInfo in the online documentation). Directly editing the routes.conf file causes errors.

The format of the file is: 

[route-name] # mandatory -- square brackets included.
  url=url-string
  zone_name=zone_name
  zone_type=zone_type
  topic_prefetch=value
  [selector]*
  [tls-prop = value]*
  [oauth2-prop = value]*
Parameter Name Description
[route-name] [route-name] is the name of the passive server (at the other end of the route); it also becomes the name of the route. Note that the square brackets [ ] DO NOT indicate that the
route-name is an option; they must be included around the name.
url The URL of the server to and from which messages are routed.
zone_name The route belongs to the routing zone with this name. When absent, the default value is default_mhop_zone.

You can set this parameter when creating a route, but you cannot subsequently change it.

For further information, see these sections:

zone_type The zone type is either 1hop or mhop. When omitted, the default value is mhop.

You can set this parameter when creating a route, but you cannot subsequently change it.

The EMS server will refuse to start up if the zone type in the routes.conf file does not match the zone type already created in the $sys.meta file that holds the shared state for the primary and secondary server.

topic_prefetch A prefetch value for the route. Setting a prefetch at the route level allows you to assign larger values for WAN routing functions.

If topic_prefetch is not set, the route uses the prefetch value specified for the destination. If a topic_prefetch is set for the route and a different prefetch is set for the destination, the topic_prefetch value overrides the destination prefetch.

See the prefetch destination property for valid settings.

selector Topic selectors (for incoming_topic and outgoing_topic parameters) control the flow of topics along the route.

For syntax and semantics, see Selectors for Routing Topic Messages.

tls-prop TLS properties for this route.

For further information on TLS, refer to TLS Parameters for Routes.

oauth2-prop

OAuth 2.0 authentication properties for this route. These properties will be used to obtain the OAuth 2.0 access tokens that will be used to authenticate with the server at the other end of the route.

For further information on OAuth 2.0, refer to Authentication and Authorization for Routes.

Example

[test_route_2]
url = tcp://server2:7222
ssl_verify_host = disabled