Home
Web Connectivity / Network Interfaces
Data exchange, APIs and web technologies
HTTP Server
The HTTP Server integrates Internet technologies directly into WinCC OA . Implemented as an add-on for the Control Manager, possible applications are many and diverse. The HTTP Server can be used as a web server for static HTML pages including download facility or to generate dynamic HTML pages.
HTTP Server Control Functions
html_ref()
This function loads a reference into an HTML reference. The parameters will be replaced.

Version Information
Release Notes, Update information, Certifications and Frequently Asked Questions.
Concepts
Your first step into modern and powerful process visualization.
Deployment
Topics, you need to know, before using WinCC OA.
Security
Go beyond the norm in cybersecurity.
Engineering
Powerful tools for easy or complex engineering tasks.
Data Management
Classify, structure and archive your data.
Business Logic / Control
Endless possibilities in data processing for your projects.
Data Visualization
User interfaces, Trends and Reports for every purpose and device.
Southbound Interfaces
The process connection to the actual machines/sensors.
Northbound Interfaces
Your portal to the cloud or supervising systems.
Web Connectivity / Network Interfaces
Data exchange, APIs and web technologies
- APIs
  An overview of the APIs (Application Programming Interface) available in WinCC OA.
- COM in WinCC OA
  COM stands for Component Object Model, a specification for developing modular software components which can be used by each COM compatible application. COM components can be easily integrated in such applications and can even be removed from an application at run time. COM components can be programmed in various different programming languages although C++ is used mostly. The specifications OLE, ActiveX and DirectX are based on the COM technology.
- Prometheus Interface
  The Prometheus interface (also referred to as Prometheus client) serves as a bridge between WinCC OA and Prometheus. It facilitates the retrieval, processing, and exposure of data from the WinCC OA system to a Prometheus-compatible format. This allows Prometheus to monitor and alert based on the data fetched from the WinCC OA system.
- SIMATIC PLC Discovery
  In increasingly dynamic automation environments and the merging of IT with OT, the SIMATIC PLC Discovery can help with the connection of newly added S7/S7+ devices by showing you all the devices in the network
- WinCC OA JavaScript Manager for Node.js
  The WinCC OA JavaScript Manager for Node.js is a manager that allows for the integration of the TypeScript/JavaScript runtime environment Node.js® into WinCC OA.
- SIMATIC Unified AR (Augmented Reality)
  SIMATIC Unified AR is an industrial Augmented Reality app that allows to display and operate HMI screens (WinCC Unified) and web applications (WinCC OA Dashboard) in real production environments.
- HTTP Server
  The HTTP Server integrates Internet technologies directly into WinCC OA . Implemented as an add-on for the Control Manager, possible applications are many and diverse. The HTTP Server can be used as a web server for static HTML pages including download facility or to generate dynamic HTML pages.
  - HTTP Server Requirements and Installation
  - HTTPS (SSL Connections)
  - Root Certificate & the Trusted Certification Authorities for Browsers
  - Standard WinCC OA HTML pages
  - HTTP base configuration
  - WinCC OA tag (interpreter string)
  - WinCC OA HTML references
  - Calling HTML references
  - SQL query in the HTTP Server
  - Working with standard WinCC OA HTML pages
  - Creating custom pages
  - HTTP Server Control Functions
    - html_ref()
      This function loads a reference into an HTML reference. The parameters will be replaced.
    - httpAccessLog()
      Creates an httpAccess.log file in the log directory and writes a log line for each HTTP request into the file.
    - httpCloseWebSocket()
      The function closes web sockets.
    - httpConnect()
      Registers a CTRL function as a Web resource
    - httpDisconnect()
      Remove a registered Web-Resource
    - httpGetAllHeaders()
      The function returns a mapping of all HTTP headers.
    - httpGetContent()
      This function extracts the content of the currently processing HTTP-Request.
    - httpGetHeader()
      Returns the value of the header (== key) of the last HTTP message.
    - httpGetLanguage()
      The function checks the stated client connection and returns a matching language ID. The function httpGetLanguageId() can be used to keep the same functionality but have a OaLanguage enum value returned.
    - httpGetLanguageId()
      The function checks the stated client connection and returns a matching OaLanguage enum value. This function provides the same functionality as httpGetLanguage(), but uses the new OaLanguage enum as return value.
    - httpGetMethod()
      The function returns the HTTP method of the last HTTP message.
    - httpGetPort()
      Returns the port and connection used for the HTTP request.
    - httpGetQuery()
      Returns the HTTP query elements as key/value pairs
    - httpGetURI()
      Returns the last from the Client (index) requested URI from the HTTP server.
    - httpMakeParamString()
      Returns a string from the passed arguments that represents the query part of a URL.
    - httpOnConnectionClose()
      The function starts the specified callBack function when the HTTP connection is closed.
    - httpParseDate()
      Allows parsing an RFC-2616 conform date string, e.g. from header "If-Modified-Since".
    - httpReadWebSocket()
      The function reads web sockets.
    - httpSaveFilesFromUpload()
      The function returns the HTTP content of a Blob variable that was received from an HTTP client via an HTML form. The function copies the content of this blob variable (a file) into a directory.
    - httpServer()
      Installs and activates an HTTP server.
    - httpSetMaxAge()
      Defines the time in seconds how long files should be cached by the client.
    - httpSetMaxContentLength()
      Sets the maximum length of a POST request.
    - httpSetMethodHandler()
      The function can be used to redirect an HTTP method to a user-defined CTRL callback function.
    - httpSetPermission()
      The function httpSetPemission() allows to define more fine grained user permissions for a specific URL used with the HTTP Server.
    - httpSetSecondaryAuthSuccess()
      The function is used to check for secondary authentification and implement a login delay.
    - httpSetUlcUserName()
      Sets the userName that will be used for the ULC_UX/ulc_ux_basics.html.
    - httpWriteWebSocket()
      The function writes web sockets.
- XML-RPC
  XML-RPC (Extensible Markup Language Remote Procedure Call) allows software on different operating systems to make procedure calls over the internet. XML-RPC uses HTTP for the transport and XML for the encoding. It sends the procedure call to a remote server through HTTP. The call is an XML document and it receives the response as XML.
- REST Reporting API
  The REST Reporting API is integrated into the Standard web server and can be activated via the config entry enabled in the [restReporting] section.
- Distributed systems
  Distributed systems in WinCC OA allow to connect two or more autonomous WinCC OA systems via a network.
- Dist-Management
  Configuring and maintaining a distributed system in WinCC OA requires a high amount of engineering effort due to a high number of settings and configuration steps that must be applied on several systems. The Dist-Management reduces the engineering effort and simplifies the necessary settings.
- XMPP
  XMPP (formerly Jabber) is mostly used in chat (instant messaging) applications and allows near real time communication between two or more parties. It can, e.g., be used to push information from a WinCC_OA project server to one or more persons, even allowing the recipient to send a confirmation back to the server.
User Management
All about authorization, authentication and login-customization.
Availability
How to get your system uptime to the maximum.
Reporting
Create state of the art project reports without limits.
Addons
Useful tools and enhancements for special demands.
Reference Tables
Detailed and extensive content for special project adaptation.
Videos & Tutorials
Explore the capabilities of WinCC OA with our carefully selected collection of video tutorials and guides.
WinCC OA Documentation
Basic information about terms and functions within the documentation.
Disclaimer
A brief clarification of liability exclusions or legal notices.

html_ref()

This function loads a reference into an HTML reference. The parameters will be replaced.

Synopsis

void html_ref(string &html, string sFilename, dyn_string asDollar, int x, int y)

Parameters


Parameter	Description
&html	The returned HTML site.
sFilenanme	Name of the HTML site to be loaded, for example, "refs/examples/valueRef.html "
asDollar	The $ parameters as dyn_string, for example, makeDynString("$DPE:ExampleDP_Result.", "$Text:Ref_Result")
x	The x position of the reference. This parameter will be transferred as a $x to the reference.
y	The y Position of the reference. This parameter will be transferred as a $x to the reference.

Return value

None

Error

Description

This function loads a reference into a HTML reference. The parameters will be replaced. It is also possible to referencein references.

Furthermore, each reference contains the following information:

$User: logged in WinCC OA user (for example, for authorization control).

For instance, pPermission = getUserPermission(5, getUserId($User));
$Ip: TCP-IP address of the -Adresse des Teilnehmers.
$LangId: WinCC OA language ID (necessary to select a text from the message catalogs) for example, sErrorText = getCatStr("http", "errFileLoad", http_getLangId($Ip));

For nesting references (that is, ref. in ref.), these three parameters pass trough and are available anywhere.

Example

In the following example, the CTRL function html_ref() reads the value of the data point ExampleDP_Result and writes it to the text field "Ref_Result".

<%={string sHtml; html_ref(sHtml,

refs/examples/valueRef.html",

makeDynString("$DPE:ExampleDP_Result.",$Text:Ref_Result"),

$x, 80);return(sHtml);}%>

Assignment

CTRL PlugIn

Availability

CTRL