SIMATIC WinCC Open Architecture

https://www.winccoa.com/documentation/WinCCOA/latest/en_US/
Admin
SIMATIC WinCC Open Architecture (WinCC OA) is a SCADA system providing powerful tools for process...
Tokens:1,246,460
Snippets:19,658
Trust Score:8.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Starting WinCC OA HTTP Server CTRL Manager

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/HTTP_Server/http1-01

This command initiates the WinCC OA CTRL Manager with the HTTP server script. Ensure the WinCC OA base package is installed and the script `_rs_http.ctl_` is available.

```bash
WCCOActrl rs_http.ctl
```

--------------------------------

### Start SINAUT Driver Manager (WinCC OA Console)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Treiber_SINAUT/sinaut_example

This command starts the SINAUT driver manager with a specified driver number in the WinCC OA console. Ensure the Simulator driver WCCILsim is not running when starting the SINAUT driver.

```shell
WCCOAsinaut -num 1
```

--------------------------------

### Setting up Visual Studio Development Environment

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started

This command sets up the environment for the Visual Studio 64-bit compiler, which is necessary for building WinCC OA projects on Windows.

```batch
"C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Auxiliary\Build\vcvarsall.bat" x64 -vcvars_ver=14.4x
```

--------------------------------

### Start WinCC OA Services Script

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/video_oa/grundlagen/video_grundlagen_system_configuration

This demonstrates how to start WinCC OA services using a script. It's typically executed from the 'video management system' group as an administrator.

```Shell
Vimacc StartServices
```

--------------------------------

### Batch Script to Start Display Monitors

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/video_oa/grundlagen/Video_grundlagen-03

Provides an example of a batch script used to start the display monitors. Users can add multiple start lines for each monitor and comment out existing lines with 'rem'.

```batch
rem Start the first display monitor
start vimaccStartDisplays.bat display1

rem Start the second display monitor
start vimaccStartDisplays.bat display2
```

--------------------------------

### Install and Connect HTTP Server (WinCC OA CTRL)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/ControlE_R/httpConnect_2

Installs the HTTP server and connects a specific resource path to a CTRL function that returns an HTML string. This is a basic setup for serving simple HTML content.

```CTRL
main()
{
  httpServer();
/* installs the HTTP Server */
  httpConnect("example", "/firstExample");
}
string example()
{
  return "<html><head><title>Erstes Beispiel</title></head>"
  "<body>Das ist mein erstes HTML-Beispiel</body></html>";
}
```

--------------------------------

### Display WinCC OA Setup Command Line Options

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/Installation-32

This command displays a help summary of all available command-line options for the WinCC OA setup executable. These options allow for various installation behaviors including installing, repairing, uninstalling, and managing installation dialogs and logging.

```command line
WinCC_OA_3.20_Setup_x64.exe /help
```

--------------------------------

### Create Project Scripts (Windows)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started_2

Command to create a new WinCC OA project on Windows using a specified template script. Replace `<scriptname>` with the desired script (e.g., newWCCILManager) and `<projectname>` with your project's name.

```batch
%API_ROOT%\new<scriptname>.cmd <projectname>
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_92_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Enables a quick start mode. This parameter can speed up system initialization by skipping certain checks.

```data
quickStart
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_87_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Enables a quick start mode. This parameter can speed up system initialization by skipping certain checks.

```data
quickStart
```

--------------------------------

### Perform Unattended WinCC OA Setup

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/Installation-32

This command initiates an unattended installation of WinCC OA using the setup executable with the /passive flag. It specifies which components to install or exclude, such as the base installation, video, help files, and special functions. The /passive option ensures minimal user interaction during the setup process.

```command line
WinCC_OA_3.20_Setup_x64.exe /passive INSTALLBASE=1 INSTALLVIDEO=0 INSTALLHELPDE=1 INSTALLHELPEN=1 INSTALLHELPRU=1
            INSTALLSPECIALFUNCTIONS=1
```

--------------------------------

### Start WinCC OA Simulation Manager

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Treiber_Simulator/Treiber_Simulator-02

This command shows how to start the WinCC OA simulation manager from the console, specifying the path to the simulation file. The '-t' option indicates the simulation file to be used. Ensure the project path is correctly set.

```bash
-t C:/<proj_path>/Sim.txt
```

```bash
-t C:/WinCC_OA_Proj_projects/proj_new/Sim.txt
```

--------------------------------

### Initialize Node.js Project and Install Dependencies

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/NodeJS/topics/nodejs_javascript_module_2

This command installs the necessary Node.js modules for your project, as defined in the package.json file. It is a crucial step after copying project templates to ensure all dependencies are met.

```bash
npm install
```

--------------------------------

### Checking WinCC OA API Environment

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started

This command verifies if the API_ROOT, compiler, and CMake are correctly set up for building WinCC OA projects on Windows.

```shell
%API_ROOT%\checkApiEnv
```

--------------------------------

### Create Project Scripts (Linux)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started_2

Command to create a new WinCC OA project on Linux using a specified template script. Replace `<scriptname>` with the desired script (e.g., newWCCILManager) and `<projectname>` with your project's name.

```bash
$API_ROOT/new<scriptname>.sh <projectname>
```

--------------------------------

### Set Environment Variable API_ROOT (Bash/Bourne-Shell)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started_2

Exports the API_ROOT environment variable in Bash or Bourne Shell to the WinCC OA API installation path. This allows the system to locate and use the API tools.

```bash
export API_ROOT=/opt/WinCC_OA/3.20/api
```

--------------------------------

### Start Remote WinCC OA UI Process

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/FAQ/topics/faq_misc_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

This shows how to start a remote WinCC OA UI process using the command line with the `-proj` option. It also includes an example for starting a remote UI with a local license, useful when a dongle with a Para license is connected to the remote machine. This method automatically establishes a connection to the server, regardless of the redundant server status.

```CMD
WCCOAui –proj [project name]
WCCOAui –localLicense –m para -proj [project name]
```

--------------------------------

### WinCC OA Desktop UI Installation Package Naming Convention

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Desktop_UI/desktop_ui_requirements

This example shows the required naming convention for WinCC OA Desktop UI installation packages when using HTTP server distribution. The structure includes the operating system, version with patch level, and architecture, with specific examples for Windows, Debian, and RHEL/CentOS.

```bash
<operating system architecture>/WinCC_OA_<Version with Patch Level>_Desktop_UI_<architecture>.<package file ending>
```

```bash
Windows : windows-64/WinCC_OA_<version with patch>_Desktop_UI_x64.exe (e.g. WinCC_OA_Desktop_UI_3.20.0_x64.exe)
```

```bash
Debian : linux-debian-x86_64/WinCC_OA- <version with patch> -DesktopUI-debian.x86_64.zip
```

```bash
RHEL/CentOS : linux-rhel-x86_64/WinCC_OA- <version with patch> -DesktopUI-rhel.x86_64.zip
```

--------------------------------

### Creating WinCC OA Projects from Templates

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started

These commands create new developer projects for various WinCC OA components using template scripts. The `<projectname>` should be replaced with the desired project name.

```cmd
%API_ROOT%\new<scriptname>.cmd <projectname>
```

```bash
$API_ROOT/new<scriptname>.sh <projectname>
```

--------------------------------

### Starting DNP3 Driver Manager

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Treiber_DNP3/dnp3_example

This command starts the DNP3 driver manager with a specified driver number. It's important that the WCCILsim simulator is not running when this command is executed.

```bash
WCCOAdnp3 -num 1

```

--------------------------------

### Start Manager in Specified Language

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Manageroptionen/ManagerOptionen-20

Starts a manager in a defined language. For multilingual projects, it can start with a different project language. Example starts extended UI in English.

```bash
WCCOAui -extend -lang en_US.utf8
```

--------------------------------

### Oracle DB Setup Path Configuration

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/RDB/RDB-21_2

Example configurations for directory paths used in the RDB_config.sql file for Oracle database setup. These paths must be manually created.

```sql
define path_dbfile = 'D:\\app\\oracle\\oradata\\DBSYNC1\\datafile\' 
define path_tempdbfile = 'D:\\app\\oracle\\oradata\\DBSYNC1\\datafile\' 
define path_oraclebin = 'D:\\app\\oracle\\product\\19.3.0.0\\db1\\bin\' 
define path_backup = 'C:\\WINCCOABackup\' 
define path_alert = 'D:\\app\\oracle\\oradata\\DBSYNC1\\datafile\' 
define path_event = 'D:\\app\\oracle\\oradata\\DBSYNC1\\datafile\' 
define path_asm_bin = 'D:\\app\\oracle\\product\\19.3.0.0\\db1\\bin\' 
```

--------------------------------

### Install WinCC OA TypeScript Definitions

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/NodeJS/topics/nodejs_typescript_module

Installs the necessary type definitions for the WinCC OA manager, which are required by the TypeScript compiler. This command is executed from the module's directory.

```bash
npm install --save-dev <path-to-installation>/javascript/@types/winccoa-manager
```

--------------------------------

### Get Scheduler Time Range Start - WinCC OA Script

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Control_Grafik/getRangeStart

This script retrieves the starting time of a scheduler time range using the getRangeStart function. It then prints the duration in seconds since the start of the day using the period() function. The example also shows how to get the end time and emphasizes using period(t) for accurate time calculations.

```WinCC OA Script
main()
{
  time t = shape.getRangeStart(0);
  DebugN("seconds since start: "+period(t));
  //and
  time t = shape.getRangeEnd(0);
  DebugN("seconds since end: "+period(t));
  //Use ONLY period(t) and NOT t.hour(), t+"", ... because only period(t) returns the correct value!
}
```

--------------------------------

### Install WinCC OA Service (WCCILpmon)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/service_configuration

Command to install the WinCC OA Process Monitoring (WCCILpmon) service. This command registers WCCILpmon with the Windows service manager, setting its start mode to 'Automatic'. It requires administrator privileges to execute. The '-set' option specifies the path to the project's configuration file that the Pmon will start at reboot. The trailing '1' ensures the project starts automatically.

```shell
WCCILpmon -user NetworkService -install -set<proj_path>\config\config 1
```

--------------------------------

### Start WinCC OA GEDI Module

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Native_GEDI/Referenz_Native_GEDI

This command initiates the WinCC OA User Interface (WCCOAui) with the graphics editor (GEDI) module. Ensure WinCC OA is installed and accessible via the command line.

```bash
WCCOAui -m gedi
```

--------------------------------

### Install and Configure HTTP Server and Connect Resource

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/ControlE_R/httpServer

Installs the HTTP server and registers a CTRL callback function to handle requests for a specific web resource. The callback function returns an HTML string to be sent to the client.

```CTRL
main()
{
  httpServer(); // installs the HTTP server
  httpConnect("example", "/firstExample");
}
string example()
{
  return "<html><head><title>First
  Example</title></head>"
  "<body>This is my first HTML
  example</body></html>";
}
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_98_hl=ui%2Cclient

Enables a quick start mode. This parameter can speed up system initialization by skipping certain checks.

```data
quickStart
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_77_hl=ui

Enables a quick start mode. This parameter can speed up system initialization by skipping certain checks.

```data
quickStart
```

--------------------------------

### Starting WinCC OA UI with Options

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/Installation-12

Demonstrates the basic syntax for starting the WinCC OA UI with the '-extend' option, which is necessary if no module parameter is specified. It also shows how to include user credentials and other options.

```bash
WCCOAui -extend [...]
```

--------------------------------

### Linux Shell Script for Oracle DB Setup

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/RDB/RDB-22

This is an example of a Linux shell script command used to initiate the Oracle database setup for WinCC OA. It specifies an alternative configuration file name, 'RDB_config_Test.sql', for the installation process.

```sh
unix_install.sh _Test
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_85_hl=ui

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Configuring Build with CMake

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started

This demonstrates how to use CMake to generate build files for your project. The `-G` option specifies the build system generator, and other flags can be used for specific IDEs and architectures.

```cmake
cmake .. -G <generator>
```

```cmake
cmake -G "Visual Studio 16 2019" -A "x64" -T "v142" ..
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_74

Enables a quick start mode. This parameter can speed up system initialization by skipping certain checks.

```data
quickStart
```

--------------------------------

### Windows Batch File for Oracle DB Setup

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/RDB/RDB-22

This is an example of a Windows batch file command used to initiate the Oracle database setup for WinCC OA. It specifies an alternative configuration file name, 'RDB_config_Test.sql', for the installation process.

```bat
win_install.bat _Test
```

--------------------------------

### httpServer() Installation and Activation

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/ControlE_R/httpServer

Installs and activates an HTTP server with options for authentication and port configuration.

```APIDOC
## POST /websites/winccoa_winccoa_en_us/httpServer

### Description
Installs and activates an HTTP server. This function allows configuration of authentication, HTTP port, and HTTPS port.

### Method
POST

### Endpoint
`/websites/winccoa_winccoa_en_us/httpServer`

### Parameters
#### Query Parameters
- **authRequired** (boolean) - Optional - Defines whether the HTTP server requires authentication. `TRUE` for authentication necessary, `FALSE` for no authentication. Default: `TRUE`. If authentication is required, a token is always sent back by the server.
- **authMethod** (string) - Optional - Defines the used authentication mode. Possible values: `"Basic"`, `"Basic realm = myRealm"`, `"Negotiate"` (Windows), `"NTLM"` (Windows). **Note:** Only one authentication parameter can be used.
- **authMethods** (dyn_string) - Optional - Defines the used authentication modes. **Note:** Only one authentication parameter can be used.
- **portNr** (unsigned) - Optional - Defines the port number for incoming HTTP queries. Default: `80`. If `0` is specified, no HTTP port will be opened.
- **SecurePortNr** (unsigned) - Optional - Defines the port number for HTTPS communication. Default: `443`. If `0`, HTTPS is disabled. For HTTPS, both `portNr` and `SecurePortNr` must be specified.

### Request Example
```json
{
  "authRequired": false,
  "portNr": 8080,
  "SecurePortNr": 8443
}
```

### Response
#### Success Response (0)
Returns `0` on success.

#### Error Response (-1)
Returns `-1` on failure. Errors are OS-dependent, commonly a port number is already in use.

#### Response Example
```json
{
  "returnValue": 0
}
```
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### WinCC OA Remote UI Configuration File Example

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/Installation-13_hl=ui

This snippet shows an example configuration file for a remote WinCC OA project. It includes essential settings like the WinCC OA installation path, project paths (both remote and local), version, language, and server hostnames for data and event managers. It also demonstrates how to use IP addresses and the `noReverseLookup` setting.

```ini
[general]
pvss_path = "C:/Siemens/Automation/ WinCC_OA/<version>/"
#Remote project path
proj_path = "//eiwrk117/Testproj_de_en"
#Local installation directory
proj_path = "C:/WinCC_OA_Proj/Remote_project"
#Local project path
proj_version = "<version>"
langs = "en_US.iso88591"
event = "Eiwrk117"
#Computer name of the server
data = "Eiwrk117"
#Computer name of the server
pmonPort = 5001
```

```ini
data = "192.168.0.2"
```

```ini
noReverseLookup = 1
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_81_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### ASCII Manager Command Line Structure Examples

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Manager_ASCII/Manager_ASCII_2

Provides examples of the four possible command-line structures for the ASCII Manager, illustrating options for filtering, outputting, inputting, setting, and getting data.

```bash
WCCOAascii [-filter TDAOPH] [-filterDp Name*;] [-filterDpType Typ] [-localTime] [-outputVersion version] [-langList list] | -out filename
```

```bash
WCCOAascii [-wait] [-inactivateAlert] [-localTime] [-yes] | -in filename
```

```bash
WCCOAascii [-localTime] | -set dpname value
```

```bash
WCCOAascii [-localTime] | -get dpname
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_72_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Specify WinCC OA Setup Language via Command Line

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/Installation

This snippet demonstrates how to explicitly set the language for the WinCC OA setup wizard using a command-line argument. This overrides the default language selection based on system locale settings.

```batch
WinCC_OA_3.20_Setup_x64.exe /lang en
```

--------------------------------

### Display Command Line Options

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/Silent_Setup

This command displays a summary of all available command-line options for the WinCC OA setup executable, allowing users to understand and utilize various installation parameters.

```bash
WinCC_OA_3.20_Setup_x64.exe /?
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_67_hl=ui%2Cclient

Enables a quick start mode. This parameter can speed up system initialization by skipping certain checks.

```data
quickStart
```

--------------------------------

### Set Environment Variable API_ROOT (C-Shell)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started_2

Sets the API_ROOT environment variable in C-Shell to the installation directory of the WinCC OA API. This is necessary for executing API-related commands.

```csh
setenv API_ROOT /opt/WinCC_OA/3.20/api
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_85_hl=ui

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Open Visual Studio Solution

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started_2

Command to open the generated Visual Studio solution file (`.sln`) for a WinCC OA project. This allows the project to be built and managed within the Visual Studio IDE.

```batch
devenv <projectname>.sln
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_97_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_92_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_86

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Start PostgreSQL 16 Server

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/NGA/topics/nga_postgre_db_postgre_dbms_winccoa_db_upgrade

Starts the PostgreSQL 16 server, either as a Windows service or manually using pg_ctl. Ensure the -D switch points to the correct PGDATA directory. The '-w' flag for the Windows manual start waits for the server to come online.

```shell
Start the 'postgresql-x64-16' service in Windows Services.
```

```shell
"C:\Program Files\PostgreSQL\16\bin\pg_ctl.exe" start -D <new PGDATA directory for PostgreSQL® 16> -w -U postgres
```

```shell
/usr/pgsql-16/bin/pg_ctl -D <new PGDATA directory for PostgreSQL® 16> start
```

--------------------------------

### Manage Grafana Service on Linux

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/NGA/topics/influxDB_grafana/nga_influxdb_garafana_req_install_2

These commands manage the Grafana server service on Linux systems. They include enabling the service to start on boot and starting the service. Status checking is also provided.

```bash
sudo systemctl enable Grafana-server.service ( Grafana service to restart at boot)
sudo systemctl start Grafana-server (start the Grafana service)
sudo systemctl status Grafana-server (Check the status of service)
```

--------------------------------

### Building WinCC OA Projects

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started

This shows different methods to build your WinCC OA project after CMake configuration. Depending on the generator used, you can build using the IDE's build command, 'make', or a generator-independent CMake command.

```shell
devenv <projectname>.sln
```

```make
make
```

```shell
cmake --build . --config RelWithDebInfo
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_72_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_90_hl=ui%2Cclient

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Setting Environment Variable for WinCC OA API

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started

This section demonstrates how to set the API_ROOT environment variable on different operating systems. This variable is crucial for locating the API installation directory.

```cmd
set API_ROOT=C:\Siemens\Automation\WinCC_OA\3.20\api
```

```csh
setenv API_ROOT /opt/WinCC_OA/3.20/api
```

```bash
export API_ROOT=/opt/WinCC_OA/3.20/api
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_68_hl=ui

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Manage Grafana Service on Linux

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/NGA/topics/influxDB_grafana/nga_influxdb_garafana_req_install

This snippet shows essential systemctl commands for managing the Grafana server service on Linux. It includes enabling the service to start on boot and starting the service manually, along with a command to check its status.

```bash
sudo systemctl enable Grafana-server.service ( Grafana service to restart at boot)
sudo systemctl start Grafana-server (start the Grafana service)

sudo systemctl status Grafana-server (Check the status of service)
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Set Environment Variable API_ROOT (Windows cmd)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started_2

Sets the API_ROOT environment variable in Windows Command Prompt to the installation directory of the WinCC OA API. This is a prerequisite for using API scripts.

```batch
set API_ROOT=C:\Siemens\Automation\WinCC_OA\3.20\api
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_70_hl=ui

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### CMake Configuration for Visual Studio

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started_2

Specific CMake command to configure a project for Visual Studio 2019 (v16) with a 64-bit architecture and v142 toolset. This ensures compatibility with the selected Visual Studio version and compiler.

```bash
cmake -G "Visual Studio 16 2019" -A "x64" -T "v142" ..
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_81_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_87_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Start HTTP Server with CTRL Script

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Desktop_UI/desktop_ui_requirements

This snippet demonstrates how to start a WinCC OA HTTP Server using a CTRL script. It involves adding a new CTRL manager to the project and specifying the 'webclient_http.ctl' script as a parameter. Default ports and considerations for Linux non-root users are mentioned.

```bash
Add a new CTRL manager to your project, add "webclient_http.ctl" as parameter to it and start the manager.
```

--------------------------------

### Get Node Icon Path with cns_getNodeIcon

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/CNS_Ctrl/cns_getNodeIcon_2

This function retrieves the icon path for a given node ID. It requires the node's ID and a variable to store the resulting path. The path is relative to the pictures folder in the installation or project directory. This example demonstrates its usage within a main function.

```C/C++
main()
{
  DebugN(cns_getNodeTypeIcon("myNode"));
}
```

--------------------------------

### Install WinCC OA Pmon Service with Specific User Account

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/Installation-16

Installs the WCCILpmon as a Windows service, allowing it to run under a specified user account. This is crucial for managing permissions and ensuring the service operates correctly. The '-install' option registers the service with an 'Automatic' start type.

```shell
WCCILpmon -user NetworkService -install
WCCILpmon -user LocalService -install
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_94_hl=ui

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Execute Silent WinCC OA Setup

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/Silent_Setup

This command performs a silent installation of WinCC OA, suppressing the user interface. It allows for customization through various installation parameters like disabling video features or enabling specific help languages.

```bash
WinCC_OA_3.20_Setup_x64.exe /quiet INSTALLBASE=1 INSTALLVIDEO=0 INSTALLHELPDE=1
            INSTALLHELPEN=1 INSTALLHELPRU=1 INSTALLSPECIALFUNCTIONS=1
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_97_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Get Data Types using dpTypes in Excel VBA

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/COM/com_excel_example

Retrieves a list of available data types within the WinCC OA system using a specified pattern (e.g., '*') via the dpTypes method. It then populates an Excel worksheet with the data types, excluding those starting with an underscore.

```VBA
'Example dpTypes()
Private Sub dpTypes(ws As Worksheet)
Dim sPattern As String
Dim asDpType() As String
Dim rg As Range
Dim n As Long
 sPattern = "*"
 Call moComMan.dpTypes(sPattern, asDpType)

 Set rg = ws.Range("A14")
 rg.Value = "Beispiel dpTypes()"
 For n = 1 To UBound(asDpType)
 If Left(asDpType(n), 1) <> "_" Then
 Set rg = rg.Offset(1, 0)
 rg.Value = asDpType(n)
 End If
 Next n
End Sub

```

--------------------------------

### Verify Setup Package Integrity with SHA256 (Windows)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/install_prep

This command-line utility on Windows is used to generate a SHA256 hash for a given file. This hash can then be compared against the provided signature to ensure the integrity and authenticity of the downloaded WinCC OA setup package.

```shell
certUtil -hashfile <Filename.exe> sha256
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_86

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_76

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Verify Setup Package Integrity with SHA256 (Linux)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/install_prep

This command-line utility on Linux is used to generate a SHA256 hash for a given file. This hash can then be compared against the provided signature to ensure the integrity and authenticity of the downloaded WinCC OA setup package.

```shell
sha256sum <Filename.zip>
```

--------------------------------

### BACnet Driver Configuration - Network Setup (INI)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Treiber_BACnet/bacnet_configfile

This snippet shows an example of configuring the BACnet driver's network settings in the config file. It specifies the connection type, IP address, subnet mask, UDP port, and BBMD details. The 'net' entry is mandatory for the driver to start.

```INI
[bacnet]
net = 1 "IP" "" "" 47808 "" 0 120
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_77_hl=ui

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Build Project with Make

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started_2

Command to build the project when using the 'Unix Makefiles' CMake generator. This command is executed within the build directory.

```makefile
make
```

--------------------------------

### Suppress Reboot During Silent Setup

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Installation/Silent_Setup

This command-line option suppresses the automatic system reboot that might be required after an unattended installation of WinCC OA, ensuring the setup completes without interrupting the user's workflow.

```bash
SUPPRESSREBOOT=1
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_68_hl=ui

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_70

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_70_hl=ui

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_59

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### HTTP Server with Dyn_mixed Response and Status Code (WinCC OA CTRL)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/ControlE_R/httpConnect_2

Installs the HTTP server and connects a resource to a CTRL function returning a dyn_mixed. This example demonstrates returning plain text and a custom HTTP status code (404 Not Found). It includes error checking for the httpServer installation.

```CTRL
#uses "CtrlHTTP"
main()
{
  int i;
  i = httpServer();
/* installs the HTTP Server */
  string t = "text/plain";
/* Content Type */
  httpConnect("example", "/Example", t);
  DebugN("HTTP Server installed",i,"Format",t);

/* check if the function httpServer was executed correctly */
  dyn_errClass err;
  err = getLastError();
/* check possible errors */
  if(dynlen(err) > 0)
  {
    errorDialog(err);
    throwError(err);
  }
  else
  {
    DebugN("OK");
//No errors
  }
}
dyn_mixed example()
{
  dyn_mixed n;
  dynAppend(n,"This is a test");
//first field
  dynAppend (n, "Status: 404 Not found");
//header
  return n;
}
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_90_hl=ui%2Cclient

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Start PostgreSQL Server with Systemd (Systemd)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/NGA/topics/nga_postgre_db_maintenance_db_admin_managed

This command starts the PostgreSQL server using `systemctl`, typically used on Linux systems with systemd as the init system. This is an alternative to `pg_ctl start` for default PostgreSQL installations.

```bash
systemctl start postgresql
```

--------------------------------

### Start Remote WinCC OA UI Process (CMD-Line)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/FAQ/topics/faq_misc

This command line example shows how to start a remote WinCC OA UI process. It utilizes the `-proj` option to specify the project name, allowing the UI to connect to the server's Data and Event Managers. This method ensures automatic connection establishment, even with redundant servers.

```CMD
WCCOAui –proj [project name]
```

--------------------------------

### Build Project with CMake (Generator-Independent)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started_2

A generator-independent command to build the project using CMake. This command is useful as it works regardless of the chosen CMake generator. It specifically builds the 'RelWithDebInfo' configuration.

```bash
cmake --build . --config RelWithDebInfo
```

--------------------------------

### CMake Project Configuration

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/API/topics/api_getting_started_2

Command to generate build files for a project using CMake. The `..` indicates the project source directory. Replace `<generator>` with your preferred build system generator (e.g., "Visual Studio 16 2019").

```bash
cmake .. -G <generator>
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_71

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_59

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Starting the WinCC OA IEC Driver

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Treiber_IEC/iec_example

Command to start the WinCC OA IEC driver. This command initiates the driver process for a specified driver number. It's important that the WCCILsim simulator is not running when starting the driver.

```bash
WCCOAiec - num 1

```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_58_hl=ui%2Cclient

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Starting WCCOAui with Specific Panel (Windows)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Pmon_Consolepanel/Pmon_Consolepanel-23

This Windows shortcut example demonstrates how to launch the WCCOAui (User Interface Manager) with a specific project and panel. Additional optional parameters can be appended.

```Batch
_<wincc_oa_path>\bin\WCCOAui.exe -proj <projName> -p <panelName>_ [ + additional optional parameters ]
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_94_hl=ui

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Example: Get and Set Data Point Value in WinCCOAProj

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Manager_ASCII/Manager_ASCII-12_2

Demonstrates how to retrieve and then set a value for a data point element named 'ExampleDP_Arg1.' within the 'WinCCOAProj' project. The get command shows the original value, and the set command updates it.

```bash
# Display the original value
WCCOAascii -proj WinCCOAProj –get ExampleDP_Arg1. -log +stderr

# Set the original value to 10
WCCOAascii -proj WinCCOAProj –set ExampleDP_Arg1. 10
```

--------------------------------

### WinCC OA Manager Command Line Setup

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Authentication/Serverside_auth_managers/topics/serversideauthman_example

This snippet shows how to add Control Managers (CTRL) and a UI manager to the WinCC OA console. It includes options for specifying manager numbers, control scripts, and user authentication with certificates.

```Shell
CTRL -num 2 webclient_http.ctl
UI -m gedi -ssa
CTRL -num 3 script1.ctl -user para:
CTRL -num 4 script2.ctl -user para: //The option does not work since the wrong certificate is available, no //certificate for the user para but for the user "revoked"
CTRL -num 5 script3.ctl -user para: //The option does not work since the wrong certificate is available, no //certificate for the user para, but for the user "norole".
CTRL -num 6 script1.ctl -user operator: //The option does not work since this is the wrong user
//not the user para but the user "operator"
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_71

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Get Stream Info

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/video_oa/datenpunkttypen/Video_dp_request_cmd_rec_and_playb

Retrieves the start and end times of the recording for a specific camera stream.

```APIDOC
## GET /api/streams/getinfo

### Description
Retrieves the start and end timestamps of the recorded segment for a given camera stream.

### Method
GET

### Endpoint
/api/streams/getinfo

### Parameters
#### Query Parameters
- **cmd** (string) - Required - Must be 'getstreaminfo'
- **streamIndex** (integer) - Optional - Unique identifier for the camera stream whose information is to be queried.

### Request Example
```json
{
  "cmd": "getstreaminfo",
  "streamIndex": 1
}
```

### Response
#### Success Response (200)
- **begintime** (string) - The start timestamp of the recording (Format: TS.ms).
- **endtime** (string) - The end timestamp of the recording (Format: TS.ms).

#### Response Example
```json
{
  "begintime": "1698384000000",
  "endtime": "1698387600000"
}
```
```

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_74

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_9_hl=ui

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Starting WCCOAui with Specific Panel (Linux)

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Pmon_Consolepanel/Pmon_Consolepanel-23

This Linux shortcut example shows how to launch the WCCOAui (User Interface Manager) with a specific project and panel. Additional optional parameters can be appended.

```Shell
_<wincc_oa_path>/bin/WCCOAui -proj <projName> -p <panelName>_ [ + additional optional parameters ]
```

--------------------------------

### WCCOAtoolMedia Input File Structure Example

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/Datenbank/Datenbank-10

Provides an example of the structure for the WCCOAtoolMedia input file. The first four sections (COMMAND, DEVICE, FILE SYSTEM, COMPRESSION) are mandatory, followed by an optional FILE LIST for backup/restore operations.

```plaintext
COMMAND
DEVICE
FILE SYSTEM
COMPRESSION
[FILE LIST]
```

--------------------------------

### Configure data quickStart

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_7_hl=product%2Cinformation%2Cfollow%2Cint%2Csee

Enables a quick start mode for data processing. This can speed up system initialization by skipping certain checks.

--------------------------------

### Configure HTTP Server UI Arguments

Source: https://www.winccoa.com/documentation/WinCCOA/latest/en_US/cfg_doku/all_config_entries_76

Specifies the start parameters for the Ultralight Client 2.0. These arguments are passed to the UI Manager, similar to console startup, and can include language and server information for accessing project files.

```config
[httpServer]
uiArguments = -p vision/login.pnl -centered -iconBar -menuBar
```
Tokens:
Raw