Rapid Gate Module
Overview
Rapid Gate Module is designed to synchronize data between Rapid SCADA instances. Download the module using the link. The following figure shows the form for configuring the module.
The module is used to implement the following functions:
- Transferring data from a downstream Rapid SCADA server to an upstream server in distributed automation systems.
- Synchronization of data between the primary and backup Rapid SCADA server.
The main function of the module is the transfer of current data, historical data, events and commands from the server on which the module is running to the Rapid SCADA server specified in the settings. The module supports any number of independent gateways for exchanging information with multiple Rapid SCADA servers. The data to be transmitted is added to the queue by the module. This approach ensures reliable operation even with an unstable network connection.
Information about the module operation is recorded in the ModRapidGate.log file. Information about the operation of each gateway is written in ModRapidGate_*.log and ModRapidGate_*.txt files.
Installation
Rapid Gate Module is installed according to the instructions. No additional actions are required during installation.
Configuring
To open the module configuration form, go to the Server > Modules page, select the ModRapidGate module and click the Properties button. The module should be in the list of active modules. The module configuration is saved in the ModRapidGate.xml file.
Add a new gateway to the module configuration using the 
button. Next, let's look at the pages containing various groups of gateway settings. The screenshots below show the default parameter values.
Specify the Command code if users plan to manually send commands to synchronize archives. Specify archive masks if the gateway should transfer data to specific archives. If the archive masks are equal to -1, the gateway transfers data to the default archives defined in the configuration database. The queue options are set experimentally depending on the expected time of loss of connection with the remote server.
Specify the options for connecting to the remote server. In the firewall settings of the remote server, allow incoming connections on the TCP port being used (10000). It is recommended to create a separate RapidGate user with the Application role in the configuration database for use by the module. Copy the Secret key from the remote server listener options.
If different projects are running on the local and remote servers and have different identifiers in the configuration database tables, fill in the ID mapping options. If the IDs are the same, leave the mapping options blank.
Current data can be transferred by the gateway to the remote server On Receive by the local Server from Communicator or On Timer. Transferring data when received ensures that new data is displayed on the remote server as quickly as possible. Timer-based data transfer saves network traffic.
Transfer of historical data refers to data transferred with a timestamp, for example, archives that are downloaded by Communicator from metering devices and transferred to Server.
When transferring events and acknowledgements, it is theoretically possible that the acknowledgement will be transmitted before the event. In this case, the event on the remote server will remain unacknowledged. It is important to ensure time synchronization between the local and remote servers, otherwise the latest sent events may not be displayed by the Webstation application on the remote server.
The gateway requests commands from the remote server at a frequency specified in the settings. To reduce network traffic, increase the polling rate value.
When transferring outcoming commands, commands intended for an application are not sent. On the remote server, the output formula of the channel to which the command relates is applied to the command value.
Archive replication ensures that archives on the local and remote servers are identical. Replication can be performed from a local server to a remote one and vice versa. The direction of data transfer is determined automatically based on data availability. The data availability channel is intended to unambiguously determine the presence of data on the local server. If the channel is not specified, the gateway checks for any data in the archive for the time period corresponding to the replication step. The replication state is saved while the module is running and is loaded when the Server service is restarted.
Commands
Rapid Gate Module supports receiving commands. To send commands to the module, create output type channels in the configuration database. The Tag code of the channel must match the Command code specified in the general gateway options. A command can be sent via the Webstation application web interface or using another client interacting with the Server application.
When a valid command is received, a task is created and added to the gateway task queue. The maximum length of a task queue is 10. If the queue is full, new commands will be ignored.
An example of a command that transfers data from the local server to the remote server:
cmd=UploadArchive
startDT=2025-12-31 10:00:00
endDT=2025-12-31 11:00:00Download an archive from the remote server to the local server:
cmd=DownloadArchive
startDT=2025-12-31 10:00:00
endDT=2025-12-31 11:00:00Synchronize (upload and download) archives:
cmd=SyncArchive
startDT=2025-12-31 10:00:00
endDT=2025-12-31 11:00:00Clear the gateway task queue:
cmd=ClearTaskQueueThe command arguments specify UTC time.