Agent properties define the configuration of the local agent running for the target database.

Agent properties are found after the [agent] directive in the agent properties file. A properties file can only have one [agent] section. The properties file must be stored in the directory where the target database resides.

Note: Although you may create a source database without an [agent] section, it is recommended that every replication database include an [agent] section to allow the database to become a named target.

Property names and values in the section are separated by an equal sign (for example, name=agent1).

Note: When you add comments to a properties file, place them on a new line that begins with the pound sign (#). Do not specify a comment on the same line as a property value definition.

The following table provides a list of agent properties and their values.

Table 1. Agent properties
Property name Value Description
ai-streaming 0 | 1 Specifies whether AI Streaming is enabled.

When AI Streaming is enabled, the replication agent uses multi-threading to divide the tasks of receiving and caching AI blocks sent from the replication server and applying the cached AI blocks to the target database.

Possible values are:
  • 0 — AI Streaming is disabled.
  • 1 — AI Streaming is enabled. This is the default value.
connect-timeout seconds Specifies how many seconds the replication agent will wait for the initial connection from the replication server before the replication agent shuts itself down.

seconds is an integer greater than or equal to 120 and less than or equal to 86,400; the default value is 1800.

This property configures the replication agent so that you do not have to perform a forced shutdown on your target database in the event that the replication server never contacts the replication agent. If the replication agent does not receive a connection attempt from the replication server before the number of seconds specified have elapsed, the replication agent will terminate and allow for some limited system-level target database connections.

database db_name Specifies the replication target database name.
ipver ipv4 | ipv6 Specifies whether the replication agent uses IPv4 or IPv6 for network communication.

Possible values are:

  • ipv4—IPv4 is used for network communication. This is the default value.
  • ipv6—IPv6 is used for network communication with the replication server.
Note: If the target database broker is using IPv6, OpenEdge Replication must also use IPv6.
listener-maxport port-number Specifies the maximum port number of the replication agent's TCP listening port.

port-number must be greater than the value of listener-minport+1 and less than the maximum allowable port number on the system.

For UNIX the maximum port number is 65534. For Windows the maximum port number is 32765.

listener-minport port-number Specifies the minimum port number of the replication agent's TCP listening port.

The replication agent selects a listening port in a range between the values specified by listener-minport and listener-maxport.

port-number must be greater than 1024 and less than the value of listener-maxport.

maximum-polling-delay milliseconds Specifies the maximum value, in milliseconds (ms), for the message polling delay.

By default, the maximum polling delay is 500 ms.

Set milliseconds to a value between 500 and 1000, inclusive.

minimum-polling-delay milliseconds Specifies the minimum value, in milliseconds, for the message polling delay.

By default, the minimum message polling delay is 5 ms.

Set milliseconds to a value between 1 and 30, inclusive.

The message polling delay starts at the minimum, as specified by minimum-polling-delay. During periods of inactivity, the message polling delay increases by 5 ms increments to the maximum delay, specified by maximum-polling-delay. The message polling delay resets to the minimum-polling-delay value once activity occurs during message polling.

name agent_name Specifies the replication agent name.

By convention, the agent-name must match the name specified in the replication source database properties file.

ALL is not allowed as a replication agent name. Each replication agent must have a unique name.
Note: Only OpenEdge Explorer uses this property.
rsb-cache-size cache-size Specifies the size of the Replication Streaming Block cache in units of an AI block, when AI Streaming is enabled (ai-streaming=1).

If AI Streaming is not enabled, this property is ignored.

cache-size is a non-negative integer that sets the size of the cache. The default is 5000, with a maximum value of 10,000,000.