Docs Center

This documentation center focuses on deployment, operations, security and release management. Capability overview is in the Capabilities page.

IntroductionOverview
RapidSCADA is an open source industrial automation platform. The out of the box software provides tools for rapid creation of monitoring an...
ApplicationsOverview
Server manages the data archives, performs mathematical calculations and provides information to the client applications. Server writes data...
Software ArchitectureOverview
RapidSCADA software has a multi-tier architecture. Applications (services) included in the software interact with each other using the TCP ...
System RequirementsInstallation
Windows:
Install on WindowsInstallation
RapidSCADA requires Internet Information Services (IIS) and .NET Runtime to be installed. Depending on the version of Windows, the installa...
Install on Windows ManuallyInstallation
Manual RapidSCADA setup provides full control over the process of the software installation, update and uninstallation.
Install on LinuxInstallation
This article provides commands for Ubuntu and Debian operating systems. When installing RapidSCADA on other OS of the Linux family, use the...
Install ModulesInstallation
RapidSCADA supports additional modules which extend the software functionality. Module distributions are available in the Download section ...
Service ManagementInstallation
The Server, Communicator and Agent applications run as services. On Linux, the Webstation application also runs as a separate service. To ma...
Transfer to New ServerInstallation
This article describes how to migrate a running RapidSCADA instance from one server to another. The sequence of actions is as follows:
Safety RecommendationsInstallation
If RapidSCADA is used in a corporate environment, ensure that other users do not have access to the RapidSCADA installation directory . On...
Configuration BasicsConfiguration
Configuration of RapidSCADA is performed on a project basys. A project is a set of files in various formats that are stored in the project ...
Configuration DatabaseConfiguration
The configuration database is a part of the project, consisting of tables and common to all project instances. The applications included in ...
Device PollingConfiguration
Interaction with devices is performed by the Communicator application, which requests data and sends commands to devices, acting as a master...
ChannelsConfiguration
A channel is an entity that has a number and name, with which current and historical data, as well as events, are associated. Synonyms in ot...
Scripts and FormulasConfiguration
The Server application has a built-in engine for executing user scripts. Scripts are used to calculate channel values and statuses, as well ...
ViewsConfiguration
View is a form of data representation in the Webstation application. There are 3 types of views supported by default: table views, mimic dia...
Table ViewsConfiguration
A table view (see Figure 1) is designed to display historical data for a day with a specified period, as well as current data. Clicking a ta...
User ManagementConfiguration
Creating, editing and deleting users is performed in the Administrator application in the Users table (see Figure 1).
Chart Pro PluginModules
Chart Pro Plugin is the additional plugin for the Webstation application extends the capabilities of RapidSCADA charts: adds scaling, displ...
Dashboard PluginModules
Dashboard Plugin displays useful widgets on dashboards: charts, current data and arbitrary frames, for example, CCTV camera stream. Settings...
Elastic Report PluginModules
Elastic Report Plugin allows to generate reports according to a custom configuration. Using this plugin, you can build almost any desired re...
Map PluginModules
Map Plugin displays the status and parameters of stationary and moving objects on interactive OpenStreetMap maps. The plugin provides visual...
Notification PluginModules
Notification Plugin helps an operator to pay attention to the most important events. The plugin generates notifications based on events acco...
Automatic Control ModuleModules
Automatic Control Module is an additional module for the Server application that sends commands and generates events when certain conditions...
Database Export ModuleModules
Database Export Module provides real-time export of data received from devices to popular databases. Supported DBMS are Microsoft SQL Server...
Rapid Gate ModuleModules
Rapid Gate Module is designed to synchronize data between RapidSCADA instances. Download the module using the link . The following figure s...
Database Import DriverModules
Database Import Driver is designed to read current data from a third-party database, as well as to write to a third-party database using com...
Modbus Slave DriverModules
The driver implements the popular Modbus communication protocol and operates as a slave. Using the driver, Communicator waits for incoming r...
Telegram DriverModules
Telegram Driver is designed to send notifications using the popular Telegram messenger. The advantages of using Telegram is quickness of rec...
Auto ReportAdditional Applications
The Auto Report application is designed to automatically generate various reports according to a schedule, save them to disk and send them b...
Enterprise Edition OverviewEnterprise Edition
RapidSCADA Enterprise is proprietary software built on an open source core. RapidSCADA Enterprise is designed for large-scale implementati...
Audit Log PluginEnterprise Edition
Audit Log Plugin records the actions of Webstation application users in a PostgreSQL database. The following types of actions are recorded:
Guard PluginEnterprise Edition
Guard Plugin constantly monitors all user requests to the Webstation application, detects attempts to brute force attack the web application...
Development BasicsDevelopers
RapidSCADA is an open source project. Therefore, engineers and programmers can join the RapidSCADA community to develop software that comm...
Logic Module DevelopmentDevelopers
Logic modules have the following features:
Driver DevelopmentDevelopers
Advantages of RapidSCADA as a platform for driver creation:
Web Plugin DevelopmentDevelopers
Using web plugins you can create:
Module StoreDevelopers
RapidSCADA Module Store helps users find and download additional modules developed by various authors. For developers, Module Store is a pl...
History of RapidSCADAVersion History
History of RapidSCADA
Server HistoryVersion History
Server History
Communicator HistoryVersion History
Communicator History
Webstation HistoryVersion History
Webstation History
Agent HistoryVersion History
Agent History
Administrator HistoryVersion History
Administrator History
History of Additional ApplicationsVersion History
History of Additional Applications
ExtCodeEditor Admin Extension (Custom)Custom Admin Extensions
ExtCodeEditor admin extension docs with structure, dependencies, and deployment checklist.
ExtDepBundle Admin Extension (Custom)Custom Admin Extensions
ExtDepBundle admin extension docs with structure, dependencies, and deployment checklist.
ExtDepMySql Admin Extension (Custom)Custom Admin Extensions
ExtDepMySql admin extension docs with structure, dependencies, and deployment checklist.
ExtDepSqlServer Admin Extension (Custom)Custom Admin Extensions
ExtDepSqlServer admin extension docs with structure, dependencies, and deployment checklist.
ExtMapEditor Admin Extension (Custom)Custom Admin Extensions
ExtMapEditor admin extension docs with structure, dependencies, and deployment checklist.
MySqlStorage Admin Extension (Custom)Custom Admin Extensions
MySqlStorage admin extension docs with structure, dependencies, and deployment checklist.
SqlServerStorage Admin Extension (Custom)Custom Admin Extensions
SqlServerStorage admin extension docs with structure, dependencies, and deployment checklist.
DrvABPlc Driver (Custom)Custom Communicator Drivers
DrvABPlc: install, line/device config, DeviceTemplate, CustomOptions.
DrvBachmannSvi Driver (Custom)Custom Communicator Drivers
DrvBachmannSvi: install, line/device config, DeviceTemplate, CustomOptions.
DrvBACnet Driver (Custom)Custom Communicator Drivers
DrvBACnet: install, line/device config, DeviceTemplate, CustomOptions.
DrvBeckhoffPlc Driver (Custom)Custom Communicator Drivers
DrvBeckhoffPlc: install, line/device config, DeviceTemplate, CustomOptions.
DrvBrPvi Driver (Custom)Custom Communicator Drivers
DrvBrPvi: install, line/device config, DeviceTemplate, CustomOptions.
DrvCameraControl Driver (Custom)Custom Communicator Drivers
DrvCameraControl: install, line/device config, DeviceTemplate, CustomOptions.
DrvCnlDLMS Driver (Custom)Custom Communicator Drivers
DrvCnlDLMS: install, line/device config, DeviceTemplate, CustomOptions.
DrvDeviceInfo Driver (Custom)Custom Communicator Drivers
DrvDeviceInfo: install, line/device config, DeviceTemplate, CustomOptions.
DrvDLMS Driver (Custom)Custom Communicator Drivers
DrvDLMS: install, line/device config, DeviceTemplate, CustomOptions.
DrvDLT645 Driver (Custom)Custom Communicator Drivers
DrvDLT645: install, line/device config, DeviceTemplate, CustomOptions.
DrvGpiod Driver (Custom)Custom Communicator Drivers
DrvGpiod: install, line/device config, DeviceTemplate, CustomOptions.
DrvHikvisionCounter Driver (Custom)Custom Communicator Drivers
DrvHikvisionCounter: install, line/device config, DeviceTemplate, CustomOptions.
DrvHikvisionTool Driver (Custom)Custom Communicator Drivers
DrvHikvisionTool: install, line/device config, DeviceTemplate, CustomOptions.
DrvHJ212 Driver (Custom)Custom Communicator Drivers
DrvHJ212: install, line/device config, DeviceTemplate, CustomOptions.
DrvIEC102 Driver (Custom)Custom Communicator Drivers
DrvIEC102: install, line/device config, DeviceTemplate, CustomOptions.
DrvIEC103 Driver (Custom)Custom Communicator Drivers
DrvIEC103: install, line/device config, DeviceTemplate, CustomOptions.
DrvIEC104 Driver (Custom)Custom Communicator Drivers
DrvIEC104: install, line/device config, DeviceTemplate, CustomOptions.
DrvIEC61850 Driver (Custom)Custom Communicator Drivers
DrvIEC61850: install, line/device config, DeviceTemplate, CustomOptions.
DrvInfluxDbImportV1 Driver (Custom)Custom Communicator Drivers
DrvInfluxDbImportV1: install, line/device config, DeviceTemplate, CustomOptions.
DrvKeyencePlc Driver (Custom)Custom Communicator Drivers
DrvKeyencePlc: install, line/device config, DeviceTemplate, CustomOptions.
DrvLafei485 Driver (Custom)Custom Communicator Drivers
DrvLafei485: install, line/device config, DeviceTemplate, CustomOptions.
DrvMelsecFx Driver (Custom)Custom Communicator Drivers
DrvMelsecFx: install, line/device config, DeviceTemplate, CustomOptions.
DrvMelsecMc Driver (Custom)Custom Communicator Drivers
DrvMelsecMc: install, line/device config, DeviceTemplate, CustomOptions.
DrvMelsecPlc Driver (Custom)Custom Communicator Drivers
DrvMelsecPlc: install, line/device config, DeviceTemplate, CustomOptions.
DrvModbusGst Driver (Custom)Custom Communicator Drivers
DrvModbusGst: install, line/device config, DeviceTemplate, CustomOptions.
DrvModbusSlave Driver (Custom)Custom Communicator Drivers
DrvModbusSlave: install, line/device config, DeviceTemplate, CustomOptions.
DrvMouseControl Driver (Custom)Custom Communicator Drivers
DrvMouseControl: install, line/device config, DeviceTemplate, CustomOptions.
DrvOsiPi Driver (Custom)Custom Communicator Drivers
DrvOsiPi: install, line/device config, DeviceTemplate, CustomOptions.
DrvRedis Driver (Custom)Custom Communicator Drivers
DrvRedis: install, line/device config, DeviceTemplate, CustomOptions.
DrvResaveTextData Driver (Custom)Custom Communicator Drivers
DrvResaveTextData: install, line/device config, DeviceTemplate, CustomOptions.
DrvResetData Driver (Custom)Custom Communicator Drivers
DrvResetData: install, line/device config, DeviceTemplate, CustomOptions.
DrvRestGateway Driver (Custom)Custom Communicator Drivers
DrvRestGateway: install, line/device config, DeviceTemplate, CustomOptions.
DrvSharedMemory Driver (Custom)Custom Communicator Drivers
DrvSharedMemory: install, line/device config, DeviceTemplate, CustomOptions.
DrvSiemensS7 Driver (Custom)Custom Communicator Drivers
DrvSiemensS7: install, line/device config, DeviceTemplate, CustomOptions.
DrvSiemensS7Plus Driver (Custom)Custom Communicator Drivers
DrvSiemensS7Plus: install, line/device config, DeviceTemplate, CustomOptions.
DrvSocket Driver (Custom)Custom Communicator Drivers
DrvSocket: install, line/device config, DeviceTemplate, CustomOptions.
DrvUdpCameraControl Driver (Custom)Custom Communicator Drivers
DrvUdpCameraControl: install, line/device config, DeviceTemplate, CustomOptions.
DrvVirtualDevice Driver (Custom)Custom Communicator Drivers
DrvVirtualDevice: install, line/device config, DeviceTemplate, CustomOptions.
DrvVNode Driver (Custom)Custom Communicator Drivers
DrvVNode: install, line/device config, DeviceTemplate, CustomOptions.
DrvWeihenstephan Driver (Custom)Custom Communicator Drivers
DrvWeihenstephan: install, line/device config, DeviceTemplate, CustomOptions.
PlgBigScreen Plugin (Custom)Custom Extensions
Provides big-screen visualization editing and publishing, including module management, dynamic data sources, and dynamic datasets.
PlgCameraCenter Plugin (Custom)Custom Extensions
Documentation for PlgCameraCenter including entry points, APIs, deployment, and troubleshooting.
PlgCameraInspection Plugin (Custom)Custom Extensions
Documentation for PlgCameraInspection including entry points, APIs, deployment, and troubleshooting.
PlgChartExtra Plugin (Custom)Custom Extensions
Documentation for PlgChartExtra including entry points, APIs, deployment, and troubleshooting.
PlgCnlLimit Plugin (Custom)Custom Extensions
Documentation for PlgCnlLimit including entry points, APIs, deployment, and troubleshooting.
PlgComtradeStandard Plugin (Custom)Custom Extensions
Documentation for PlgComtradeStandard including entry points, APIs, deployment, and troubleshooting.
PlgDamonWcsPlc Plugin (Custom)Custom Extensions
Documentation for PlgDamonWcsPlc including entry points, APIs, deployment, and troubleshooting.
PlgEventLog Plugin (Custom)Custom Extensions
Documentation for PlgEventLog including entry points, APIs, deployment, and troubleshooting.
PlgEventMessage Plugin (Custom)Custom Extensions
Documentation for PlgEventMessage including entry points, APIs, deployment, and troubleshooting.
PlgInfluxReport Plugin (Custom)Custom Extensions
Documentation for PlgInfluxReport including entry points, APIs, deployment, and troubleshooting.
PlgInkscape Plugin (Custom)Custom Extensions
Documentation for PlgInkscape including entry points, APIs, deployment, and troubleshooting.
PlgMapCustom Plugin (Custom)Custom Extensions
Documentation for PlgMapCustom including entry points, APIs, deployment, and troubleshooting.
PlgMultiView Plugin (Custom)Custom Extensions
Documentation for PlgMultiView including entry points, APIs, deployment, and troubleshooting.
PlgResetData Plugin (Custom)Custom Extensions
Documentation for PlgResetData including entry points, APIs, deployment, and troubleshooting.
PlgScadaAPPDesigner Plugin (Custom)Custom Extensions
Documentation for PlgScadaAPPDesigner including entry points, APIs, deployment, and troubleshooting.
PlgSchBigScreenComp Plugin (Custom)Custom Extensions
Documentation for PlgSchBigScreenComp including entry points, APIs, deployment, and troubleshooting.
PlgSchDamonExtraComp Plugin (Custom)Custom Extensions
Documentation for PlgSchDamonExtraComp including entry points, APIs, deployment, and troubleshooting.
PlgSchEChartComp Plugin (Custom)Custom Extensions
Documentation for PlgSchEChartComp including entry points, APIs, deployment, and troubleshooting.
PlgSchSvgExtComp Plugin (Custom)Custom Extensions
Documentation for PlgSchSvgExtComp including entry points, APIs, deployment, and troubleshooting.
PlgSchWebCameraComp Plugin (Custom)Custom Extensions
Documentation for PlgSchWebCameraComp including entry points, APIs, deployment, and troubleshooting.
PlgSchYiNengKeComp Plugin (Custom)Custom Extensions
Documentation for PlgSchYiNengKeComp including entry points, APIs, deployment, and troubleshooting.
PlgSmartReport Plugin (Custom)Custom Extensions
Documentation for PlgSmartReport including entry points, APIs, deployment, and troubleshooting.
PlgSsoBridge Plugin (Custom)Custom Extensions
Documentation for PlgSsoBridge including entry points, APIs, deployment, and troubleshooting.
PlgStatisticsApi Plugin (Custom)Custom Extensions
Documentation for PlgStatisticsApi including entry points, APIs, deployment, and troubleshooting.
PlgSvgEditor Plugin (Custom)Custom Extensions
Documentation for PlgSvgEditor including entry points, APIs, deployment, and troubleshooting.
PlgTableStudio Plugin (Custom)Custom Extensions
Documentation for PlgTableStudio including entry points, APIs, deployment, and troubleshooting.
ModArcIoTDB Server Module (Custom)Custom Server Extensions
ModArcIoTDB server extension docs with routes, config, dependencies, and deployment checks.
ModArcKafka Server Module (Custom)Custom Server Extensions
ModArcKafka server extension docs with routes, config, dependencies, and deployment checks.
ModArcMySql Server Module (Custom)Custom Server Extensions
ModArcMySql server extension docs with routes, config, dependencies, and deployment checks.
ModArcRedis Server Module (Custom)Custom Server Extensions
ModArcRedis server extension docs with routes, config, dependencies, and deployment checks.
ModArcSqlServer Server Module (Custom)Custom Server Extensions
ModArcSqlServer server extension docs with routes, config, dependencies, and deployment checks.
ModArcTimescaleDB Server Module (Custom)Custom Server Extensions
ModArcTimescaleDB server extension docs with routes, config, dependencies, and deployment checks.
ModAutoControl Server Module (Custom)Custom Server Extensions
ModAutoControl server extension docs with routes, config, dependencies, and deployment checks.
ModBlockly Server Module (Custom)Custom Server Extensions
ModBlockly server extension docs with routes, config, dependencies, and deployment checks.
ModCalcCenter Server Module (Custom)Custom Server Extensions
ModCalcCenter server extension docs with routes, config, dependencies, and deployment checks.
ModCameraControl Server Module (Custom)Custom Server Extensions
ModCameraControl server extension docs with routes, config, dependencies, and deployment checks.
ModComtradeStandard Server Module (Custom)Custom Server Extensions
ModComtradeStandard server extension docs with routes, config, dependencies, and deployment checks.
ModDeviceAlarm Server Module (Custom)Custom Server Extensions
ModDeviceAlarm server extension docs with routes, config, dependencies, and deployment checks.
ModDnp3 Server Module (Custom)Custom Server Extensions
ModDnp3 server extension docs with routes, config, dependencies, and deployment checks.
ModDynamicEngine Server Module (Custom)Custom Server Extensions
ModDynamicEngine server extension docs with routes, config, dependencies, and deployment checks.
ModJiaTai Server Module (Custom)Custom Server Extensions
ModJiaTai server extension docs with routes, config, dependencies, and deployment checks.
ModOpcUaServer Server Module (Custom)Custom Server Extensions
ModOpcUaServer server extension docs with routes, config, dependencies, and deployment checks.
ModResaveTextData Server Module (Custom)Custom Server Extensions
ModResaveTextData server extension docs with routes, config, dependencies, and deployment checks.
ModRestGateway Server Module (Custom)Custom Server Extensions
ModRestGateway server extension docs with routes, config, dependencies, and deployment checks.
ModSample Server Module (Custom)Custom Server Extensions
ModSample server extension docs with routes, config, dependencies, and deployment checks.
ModServerIEC104 Server Module (Custom)Custom Server Extensions
ModServerIEC104 server extension docs with routes, config, dependencies, and deployment checks.
ModServerIEC104Multi Server Module (Custom)Custom Server Extensions
ModServerIEC104Multi server extension docs with routes, config, dependencies, and deployment checks.
ModServerIEC61850 Server Module (Custom)Custom Server Extensions
ModServerIEC61850 server extension docs with routes, config, dependencies, and deployment checks.
ModSmsFourFaithService Server Module (Custom)Custom Server Extensions
ModSmsFourFaithService server extension docs with routes, config, dependencies, and deployment checks.
ModSmsService Server Module (Custom)Custom Server Extensions
ModSmsService server extension docs with routes, config, dependencies, and deployment checks.
ModTransCdtByUdp Server Module (Custom)Custom Server Extensions
ModTransCdtByUdp server extension docs with routes, config, dependencies, and deployment checks.
PlgDynamicData Plugin (Custom)Custom Extensions
Web extension for dynamic data and intelligent query workflows.
PlgDynamicEngineEditor Plugin (Custom)Custom Extensions
Visual editor and management UI for dynamic engine rules.
PlgWorkflowEditor Plugin (Custom)Custom Extensions
Workflow orchestration with trigger validation and run history.
PlgGallery Plugin (Custom)Custom Extensions
Gallery asset management for Mimic and big-screen editors via /api/gallery/.
PlgReportStudio Plugin (Custom)Custom Extensions
Report studio for template design, publishing, and analytics export.
PlgSmsService Plugin (Custom)Custom Extensions
SMS alarm publishing with device mapping and delivery tracking.
PlgMimic Plugin (Custom)Custom Extensions
Mimic (.mim) authoring and runtime: PlgMimic, PlgMimicEditor, and component packs such as PlgMimBigScreenComp view jump.
ModWaveRecorder Server Module (Custom)Custom Server Extensions
Fault wave recording server module; web UI relies on PlgTableStudio wave pages.