Replication transition properties are found after the [transition] directive in the OpenEdge Replication properties (db-name.repl.properties) file. A properties file can only have one [transition] section. The properties filemust be located in the same directory as the db-name.db file.

Property names and values are separated by an equal sign (for example, database-role=reverse).
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 summary of the transition properties. The table lists each property in the repl.properties file, identifies the property type, and provides a property description.

Table 1. Transition properties
Property name Value Description
replication-set 0 | 1 Specifies whether replication source and target databases transition together.

Possible values are:

  • 0—The source and targets do not transition together. This is the default value.
  • 1—The source and targets transition together.

For more information, see Transition of a Replication Set .
database-role reverse | normal Specifies the new replication role of the database once it is transitioned.

Possible values are:

  • reverse—The role of the database is reversed: A replication source database becomes a replication target database, and a replication target database becomes a replication source database.
  • normal—The role of the database becomes that of a normal database; the database is no longer enabled for replication. This is the default value.
responsibility primary | secondary Specifies a user-defined responsibility to the database.
This property is currently informational.
Note: Property value must be less than or equal to 14 characters long. Any value exceeding 14 characters will cause the database log entries describing repl.properties values to become corrupted.
restart-after-transition 0 | 1 Specifies whether the database broker is started following a transition.

The database broker can be started after transition is performed, depending on whether you want to control database startup or have the transition process start the database.

Possible values are:
  • 0—The database broker is not started following transition. This is the default value.
  • 1—The database broker is started following transition.
When restart-after-transition=1, the following *-startup-arguments properties must be supplied:
  • If database-role=normal, you must specify the normal-startup-arguments.
  • If the database-role=reverse, you must specify the source-startup-arguments and the target-startup-arguments.
Note: During online transition, database brokers stay online throughout the duration of the transition. Online transition changes the behavior of the restart-after-transition property to behave as follows:
  • 0—The database broker will be shut down following transition.
  • 1—The database broker will remain online following transition.
In addition, the following database startup properties will not be validated when restart-after-transition=1 and performing online transition:
  • source-startup-arguments
  • target-startup-arguments
  • normal-startup-arguments
This behavior applies to both source and target databases.

For more information, see Plan for transition and the online-transition property description.
start-secondary-broker 0 | 1 Specifies whether the transition process automatically starts a secondary database broker after database has transitioned to its new role.
Possible values are:
  • 0—Transition does not start a secondary database broker. This is the default value.
  • 1—Transition starts a secondary database broker.
Note: When start-secondary-broker=1, it is required that restart-after-transition=1.
source-startup-arguments character[256]

Specifies the database broker startup arguments to use when transition starts the database as a replication source database.

During the transition, the database may be shutdown and restarted as a replication source database for achieving synchronization or to act as the coordinator in the coordination phase of the replication-set recovery transition.

Additionally, when restart-after-transition=1 and the database is being transitioned to a replication source database, the database is restarted as a replication source database at the end of the transition.

The arguments will be appended to the PROSERVE command, which starts the database.

In most cases, the only argument specified here should be -pf, followed by a parameter file name. For example: -pf db-name.source.pf.
Note: This property must be set if restart-after-transition=1 and transition is not an online transition..

If restart-after-transition=0, the property should be set in cases where transition starts the database broker as a replication source database.

Although the property value is not validated in this case, not setting this property can lead to unspecified behavior causing transition failure such as failure to start the database broker or failure to establish network connection to another replication database involved in the transition.
target-startup-arguments character[256]

Specifies the database broker startup arguments to use when the transition starts the database as a replication target database.

During the transition, the database may be shutdown and restarted as a replication target database following the coordination phase of the replication-set recovery transition.

Additionally, when restart-after-transition=1 and the database is being transitioned to a replication target database, the database is restarted as a replication target database at the end of the transition.

The arguments will be appended to the PROSERVE command, which starts the database.

In most cases, the only argument specified here should be -pf, followed by a parameter file name. For example: -pf db-name.target.pf.
Note: This property must be set if restart-after-transition=1 and transition is not an online transition..

If restart-after-transition=0, the property should be set in cases where transition starts the database broker as a replication target database.

Although the property value is not validated in this case, not setting this property can lead to unspecified behavior causing transition failure, such as failure to start the database broker or failure to establish a network connection to another replication database involved in the transition.
normal-startup-arguments character[256]

Specifies the database broker startup arguments to use when the transition process starts the database as a non-replication-enabled database.

The transition process uses these arguments to start the database after it transitions to a normal database.

The arguments will be appended to the PROSERVE command, which starts the database.

In most cases, the only argument specified here should be -pf, followed by a parameter file name. For example:

-pf db-name.normal.pf
Note: This property must be set if

restart-after-transition=1, database-role=normal, and transition is not an online transition.
source-secondary-broker-startup-arguments character[256] Specifies the database broker startup arguments to use when the transition process starts a secondary database broker after the database has been transitioned to a replication source database.

If the database is transitioned to a source database and start-secondary-broker=1, these arguments are used when the secondary database broker is started by the transition process.

The arguments will be appended to the PROSERVE command, which starts the secondary broker.

In most cases, the only argument specified here should be -pf, followed by a parameter file name. For example: -pf db-name.second-source.pf.
Note: This property must be set if start-secondary-broker=1.
target-secondary-broker-startup-arguments character[256] Specifies the database broker startup arguments to use when the transition process starts a secondary database broker after the database has been transitioned to a replication target database.

If the database is transitioned to a target database and start-secondary-broker=1, these arguments are used when the secondary database broker is started by the transition process.

The arguments will be appended to the PROSERVE comman, which starts the secondary broker.

In most cases, the only argument specified here should be -pf, followed by a parameter file name. For example: -pf db-name.second-target.pf.
Note: This property must be set if start-secondary-broker=1.
normal-secondary-broker-startup-arguments character[256] Specifies the database broker startup arguments to use when the transition process starts a secondary database broker after the database has been transitioned to a non-replication-enabled database.

If the database is transitioned to a normal database and start-secondary-broker=1, these arguments are used when the secondary database broker is started by the transition process.

The arguments will be appended to the PROSERVE command, which starts the secondary broker.

In most cases, the only argument specified here should be -pf, followed by a parameter file name. For example: -pf db-name.second-normal.pf.
Note: This property must be set if start-secondary-broker=1 and database-role=normal.
auto-begin-ai 0 | 1

Specifies whether the transition process automatically enables the database for after-imaging.

After imaging can be enabled for a database that has AI areas.

Validation of this property occurs at the start of the transition process:
  • If database-role=reverse and the database is a replication target database that is not enabled for after-imaging, it is required that auto-begin-ai=1.
  • If auto-begin-ai=1 and the database does not have AI areas, it is required that auto-add-ai-areas=1 and ai-structue-file be set to a valid AI structure file.
This property is ignored if the database is already enabled for after-imaging.
Possible values are:
  • 0—Do not enable the database for after-imaging during the transition. This is the default value.
  • 1—Enable the database for after-imaging during transition.
transition-to-agents agent_name[, agent_name] Specifies an ordered list of replication agent names for transition.

At the time of transition, transition to the first agent in the list. If the first agent is not available, transition to the second agent in the list.

If replication-set=1, the target database of the first agent in the transition-to-agents list is selected to become the new replication source.

A valid value for this property is any configured agent name; separate the names by a comma if you are listing more than one. For example:agent1,agent2.

Note: If both dr-transition-to-agents and transition-to-agents are defined, dr-transition-to-agents is used in recovery transition and transition-to-agents is used for failover transition. If dr-transition-to-agents is not defined, transition-to-agents is used for both types of transition.
dr-transition-to-agents agent_name[, agent_name] For Recovery Transition only.

Specifies an ordered list of replication agent names for recovery transition.

Transition to the first agent in the list when a failure occurs. If the first agent is not available, transition to the second agent in the list.

If replication-set=1, the first agent in the dr-transition-to-agents list is selected to become the new source.

A valid value for this property is any configured agent name; separate the names by a comma if you are listing more than one. For example:

agent1,agent2

Note: If both dr-transition-to-agents and transition-to-agents are defined, dr-transition-to-agents is used in recovery transition and transition-to-agents is used for failover transition. If dr-transition-to-agents is not defined, transition-to-agents is used for both types of transition.
auto-add-ai-areas 0 | 1 Specifies whether the transition process automatically adds AI areas to the database during transition.

Adding AI areas during transition is required when both of the following conditions are met:

  • The database is being transitioned to a replication source database.
  • There are currently no AI areas for the database.

This property is ignored if the database is already enabled for after-imaging.

Possible values are:

  • 0—Do not add AI areas during the transition. This is the default value.
  • 1—Add AI areas during the transition.
Note: It is required that auto-add-ai-areas=1 when auto-begin-ai=1 and the database does not already have AI areas. In addition, when auto-add-ai-areas=1, the ai-structure-file property must be set to a valid ai structure filename.
ai-structure-file (.st)filename

Specifies the filename of the structure file that contains the list of AI areas to add during transition.

This property is ignored if auto-add-ai-areas=0.
Note: When auto-add-ai-areas=1 and ai-structure-file is specified, the existence of the structure file is verified.
backup-method mark | full-offline | full-online Specifies the backup method performed after the database has been transitioned to its new role.

Possible values are:

  • mark—The database is internally marked as backed up (without running the rfutil db- name -C mark backedup command).
  • full-offline—The backup is performed in two steps. The first backup is a full backup that is performed either:

    a. Before enabling AI for databases that are not yet enabled for AI or

    b. After switching the AI extent for databases that are already enabled for AI.

    The second backup is an incremental backup, which is performed after AI is enabled or switched and after the role of the database is changed.

  • full-online—The backup is performed online, after the database is restarted, which occurs after the database has been transitioned. It is required that restart-after-transition=1 when backup-method=full-online.
Note:
During online transition, database brokers stay online throughout the duration of the transition. Online transition changes the behavior of the backup-method property to behave as follows:
  • full-offline—If restart-after-transition=1, the designated backup method will not be honored, and the backup will be performed as a full-online backup.
  • full-online—An online backup is performed after the database has been transitioned. It is required that restart-after-transition=1 when backup-method=full-online.
backup-arguments character[256] Specifies the list of backup command line arguments required for the full online and offline database backups that are performed by the transition process.

These parameters are required if the backup-method property is not set to mark.

At a minimum, the backup file or device must be specified in the arguments list.

The arguments should begin with device-name.

Do not use backup validation parameters (such as -vp and -vf).

To avoid overwriting a backup, do not use the same backup file or device in any of the backup-arguments, the incremental-backup-arguments, or the recovery-backup-arguments properties.
incremental-backup-arguments character[256] Specifies the list of backup command line arguments required for the incremental backups that are performed after the database has been transitioned to its new role.

These parameters are required if the backup-method property is set to full-offline.

At a minimum, the backup file or device must be specified in the arguments list.

The arguments should begin with device-name.

Do not use backup validation parameters (such as -vp and -vf).

To avoid overwriting a backup, do not use the same backup file or device in any of the backup-arguments, the incremental-backup-arguments, or the recovery-backup-arguments properties.
recovery-backup-arguments character[256] Specifies the list of backup command line arguments for the transition recovery backup that is performed at the start of the transition process.

Not setting this property will disable the transition recovery backup from being performed.

At a minimum, the backup file or device must be specified in the arguments list.

The arguments should begin with device-name.

Do not use backup validation parameters (such as -vp and -vf).

To avoid overwriting a backup, do not use the same backup file or device in any of the backup-arguments, the incremental-backup-arguments, or the recovery-backup-arguments properties.
apply-streaming-data 0 | 1 For auto-transition only. Specifies whether the replication agent will discard or apply AI Blocks in the RSB cache to the target database before moving forward with auto-transition.

Possible values are:

  • 0—Discard all AI Blocks in the RSB cache before auto-transition. This is the default value.
  • 1—Apply all AI blocks in the RSB cache to the target database cache before auto-transition.
Note: Replication AI Streaming is enabled by default.
online-transition 0 | 1

Specifies whether the replication source and replication target database brokers remain online during failover transition.

Online transition reduces the duration of transition by allowing the database broker to remain online throughout the transition process. Any database synchronization or changes made to the database are carried out online through new transition operations.

Possible values are:
  • 0—Disables online failover transition.
  • 1—Enables online failover transition. This is the default value.
online-manual-transition 0 | 1

Specifies whether the replication target database brokers remain online during manual recovery transition.

Online transition reduces the duration of transition by allowing the database broker to remain online throughout the transition process. Any database synchronization or changes made to the database are carried out online through new transition operations.

Possible values are:
  • 0—Disables online manual recovery transition.
  • 1—Enables online manual recovery transition. This is the default value.
online-auto-transition 0 | 1 Specifies whether the replication target database brokers remain online during automatic recovery transition.

Online transition reduces the duration of transition by allowing the database broker to remain online throughout the transition process. Any database synchronization or changes made to the database are carried out online through new transition operations.

Possible values are:
  • 0—Disables online automatic recovery transition.
  • 1—Enables online automatic recovery transition. This is the default value.
transition-end-trigger 0 | 1 Specifies whether transition will run a custom defined script at the end transition.

Possible values are:

  • 0—Do not run a custom defined script at the end of transition. This is the default value.
  • 1—Run a custom defined script at the end of transition.

For more information, see Transition End Trigger .