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.
- Introduction to CTRL
  An introduction to the product's own programming language Control(CTRL).
- Control Classes
  The overview of classes available in Control.
- Types of Control Functions
  An overview of the types of functions distinguished within Control.
- Control graphics
- CONTROL Functions
  - Functions A
  - Functions B
  - Functions C
  - Functions D
  - Functions E
  - Functions F
  - Functions G
  - Functions H
    - hasEvent()
      This function checks if an object defines an event.
    - hasMethod()
      The function returns TRUE when the specified method exists.
    - helpViewerClose()
      The function closes the Help Viewer.
    - helpViewerIsOpen()
      The function confirms if the Help Viewer is open.
    - helpViewerOpen()
      The function opens the Help Viewer.
    - helpViewerReload()
      The function reloads the Help Viewer.
    - HOOK_aes_acknowledgeTableFunction()
      The system executes the function when you acknowledge an alert in the alert screen. Implement the function in a CONTROL library.
    - HOOK_ep_acknowledgeTableFunction()
      The system executes the function when you acknowledge a table (when you use the simple configuration). Implement the function in a CONTROL library.
    - HOOK_isAckable()
      The system executes the function when you acknowledge alarms. Implement the function in a CONTROL library.
    - hotKeyDialog()
      The function opens a window that allows you to select a hotkey for a shape.
    - hour()
      Returns the hour portion (0 to 23) of a time t.
    - 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.
  - Functions I
  - Functions J
  - Functions K
  - Functions L
  - Functions M
  - Functions N
  - Functions O
  - Functions P
  - Functions Q
  - Functions R
  - Functions S
  - Functions T
  - Functions U
  - Functions V
  - Functions W
  - Functions X
  - Functions Y
  - Functions Z
- CtrlExtension
  The CtrlExtension allows the addition of custom C++ code.
- CTRL Debugger
  You can use the CTRL debugger to debug the Control programming language. The debugger can be used via its own panel, which also enables the monitoring and setting of variable values during the execution of a script.
- SQL in CONTROL
  The database functions enable you to quickly carry out value queries on data points and elements.
- 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.
- API Manager
  The WinCC OA API (Application Programming Interface) offers a number of functions adding special Managers to this process control system.
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
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.
Documentation
Basic information about terms and functions within the documentation.
Support & Services
An experienced team of support agents, consultants and trainers are ready to facilitate active partnerships with our customers, so they can profit from our comprehensive service.
Disclaimer
A brief clarification of liability exclusions or legal notices.

helpViewerReload()

The function reloads the Help Viewer.

Synopsis

int helpViewerReload();

Parameters


Parameter	Description
-	-

Details

Return Value

0, if the function was executed successfully
-1,if no documentation is available on the system and could therefore not be opened.

Assignment

Help Viewer (OA Assistant)

Availability

UI, CTRL