Special Functions
- Audit Trail panel
- Authentication via Kerberos, basics
- Common Name Service (CNS)
- COM in WinCC OA, basics
- OLE DB Provider
- CtrlExtension, basics
- CTRL OA Unit
- DBLogger, basics
- Input Recording
- Generic Dialog Framework
- HTTP Server
  - 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.
- DP Identification
- Insights Hub Connector
- Message Compression
- Node-RED
- 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.
- Panel topology/Group alert facility
- PM Agent
- Prometheus Interface
- Redundant network connections
- Redundancy, basics
- XML Reporting
- Reporting with Panels (Silent print)
- Recipes, basics
- REST Reporting API
- Scheduler, basics
- Security
- System Use Notification
- System Overview
- Alive mechanism of manager connections
- Basics on Encryption
- Distributed systems, basics
- Maintenance package, basics
- Wizard Framework
- XML panel format, basics
- XML-RPC, Basics
- XMPP Basics

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