Routes
Routes are specific paths that define one or more destination servers, and optionally one or more waypoints. You configure routes to use the same servers in multiple staging projects. By referencing these routes in other projects, you do not have to manually specify the source and destination properties for each server in the route for every Staging (CSS) project.
Note
A license for CSS is required for each server that is defined in a route. This includes those whose role is that of a waypoint.
Routes are useful for projects that are replicated to multiple destinations or to stage projects across multiple domains. A project, when it is associated with a route, will transfer data to be staged to each server that is defined for the route.
You use the CReplicationRoute object to create routes on a server.
Route Properties
Routes have only one property assigned to them. This property, CReplicationRoute.BaseDirectory, defines the local directory to use for storing temporary files. This directory should be created on each server where the route is defined before you create the route.
Referencing the Route Table
The default setting on all CSS servers is to reference the route table. The Route flag is set. Referencing the route table can be disabled by setting the NoRoute flag for a project replication. If you disable reference to the route table, any routes added as destinations for a project do not receive replicated data.
Note
We recommend that you do not use the NoRoute flag. If you disable reference to the route table and a project specifies routes, the destination servers that are defined in the routes will be ignored.
For more information about how to set this flag, see CSS API Flags.
Defining a Route
You create a same-named route on each server in the route staging topology. The destinations defined for each route differ depending on the role played by the server. All destinations must be available by a single hop from the server.
For each route that you must have, you perform the following sequence of tasks:
Create the same named local directory on each server in the route path. This directory will be used to store temporary staging files.
Create the same named route on each server in the route path.
For each route you create, add only those destinations to the route that represent the next hop in the route path. For example:
For the source staging server, specify the immediate waypoints and endpoint servers that are connected to the source staging server.
For waypoints, specify any secondary waypoints or endpoint servers that are connected to the waypoint.
For each endpoint server, do not designate any destinations.
Configure the directory you created in step 1 to be the BaseDirectory for the route.
For more information about how to create a route, see How to Manage Routes. To use the route, add the route as a destination to a project.
Retrieving Route Information
To retrieve the routes defined on a server, use the method CReplicationServer.EnumRoutes. This method returns a CReplicationRoute object for each route defined on the server. One object each is returned until all routes have been enumerated.
To retrieve the names of the destinations defined for a route, use the CReplicationRoute.EnumDestination method.