Configuring the RVI Relay Service


The RVI Relay service is responsible for passing messages to the Executor Server from a channel running on the Proxy Server. To accomplish this, the service uses its service name to find a matching attachment point in the attachment point list. If there are several matching attachment points, the system applies a load balancing algorithm to select which attachment point to use. The RVI Relay service may be configured with the service name property defined as an expression, in which case the expression will be evaluated dynamically for each invocation (for example, for each message which will be relayed) prior to determining the attachment point.

The RVI Relay service is added to the iSM channel by implementing and assigning a corresponding process flow containing the service.

The RVI Relay service is synchronous. Depending on the timeout settings, this service will wait for a response document from the gateway before proceeding. The response document will include content, a header, and user special registers (SREGs). To return a SREG from the gateway, the SREG must be in message scope as local and flow scopes are cleared when the process flow running on the gateway ends.

Note: This section describes how to configure an RVI Relay service. To construct a fully populated iSM channel, incorporate the service into a process and then include the process as a route of the channel. For more information on how to design and build a channel, see the iWay Service Manager User's Guide.

To configure the RVI Relay service, you must create a process flow for your application project using iWay Integration Tools (iIT) and select RVI Relay: send message to gateway service (com.ibi.agents.RVIRelay) as the agent type for the Server Agent component. For more information, see Configuring a Service Using iWay Integration Tools.

For a complete description of the configuration parameters that are available for the RVI Relay service, see RVI Relay Service Configuration Parameters.

Reference: RVI Relay Service Configuration Parameters

The following table lists and describes parameters for the RVI Relay service.



Service Name (required)

Name of the service that is supported by an Executor Server attach point. Service names should be short and descriptive. Service names are case-sensitive and may not contain punctuation or other special characters. This service name must be identical to the service name that is specified during the configuration of the gateway listener, since it refers to the service offered by the gateway.


Period to wait for an Execution server offering the correct service to be available. The default value is 30 seconds.


Maximum time period to wait for a response from the executing service. The default value is 30 seconds.

Attempt Retry

If set to true, failed connections to the execution server will be retried. The default value is true.

Output On Failure

If the relay operation is unsuccessful, this determines whether the agent returns the standard error document or its input. If input is selected, the error document will be stored in the rvi.status register. The default value is error.

Method of compression to use (required)

The form of compression that should be used on the output:

  • none
  • smallest
  • fastest
  • standard
  • Huffman

The default value is none.