Home
Business Logic / Control
Endless possibilities in data processing for your projects.
Types of Control Functions
An overview of the types of functions distinguished within Control.
User Administration Functions

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.
  - 32/64 bit Functions
  - Administration of Managers, Modules and Panels - Functions
  - Alert Handling Functions
    These functions are associated with datapoints and respond to alerts and changes to alerts.
  - AlertService Functions
    These functions provide alarm shelving, suppression, and out-of-service capabilities via the AlertServiceClient class.
  - Blob Functions
  - Communication functions
  - Connection Functions
    Connection functions can be used to establish connections to alerts, datapoints and system events.
  - Crypthographic Functions
  - Database Functions
  - Datapoint Functions
  - Error Functions
  - File Functions
    File functions allow you to import, export, open, close, and manipulate files within the application. This topic describes how to use file functions and important considerations for cross-platform compatibility.
  - Graphics Functions
  - Help Viewer Functions
    Available Functions for the Help Viewer.
  - HTTP Functions
  - Input Event Recorder Functions
  - Licensing Functions
  - Mapping Functions
  - Mathematical Functions
  - MindSphere Connector Functions
  - Miscellaneous Functions
  - Multilingual Functionality
  - Project administration Functions
  - Query Functions
  - Redu/Dist Functions
  - Selection and Configuration Dialogs - Functions
  - Semaphore Functions
  - String Functions
  - Subscription-based Licensing Functions
    CONTROL functions for querying information from subscription-based licenses.
  - System Tray
  - Time Functions
  - Threads Functions
  - User Administration Functions
    - afterLogin()
      After successful login displays the required panel.
    - checkPassword()
      Checks the assignment of a password to the user id.
    - convManIdToInt()
      Returns an integer that corresponds to the ManagerIdentifier.
    - convManIntToName()
      Converts an integer, which corresponds to the manager identifier, to manager name.
    - getManIdFromInt()
      Converts manager ID into manager type and manager number.
    - getOSDomainName()
      The function returns the domain name under Windows and Linux, regardless which user is currently logged in.
    - getUserId()
      Returns the associated ID for the specified user name.
    - getUserName()
      Returns the associated user name for a specified ID.
    - setUserId()
      Sets the current user ID to the specified value.
    - getUserPermission()
      Checks authorizations.
    - setUserNamePVSS() - deprecated
      Use the function UserManagementBaseType::UserAdmin/Classes/UserManagementBaseType/Methods/setFullName.htmlinstead!
    - uss_getGenericSetting()
      Reads all user or user group settings without hierarchy.
    - uss_getMyUsergroup()
      Returns the user group with the lowest position ID.
    - uss_getSpecificSetting()
      Reads a specific user(group) setting without hierarchy.
    - uss_getSpecificUserSetting()
      Reads a specific user setting with hierarchy.
    - uss_getUserSettings()
      Reads all user settings with hierarchy.
    - getCurrentDomainName()
    - getDomainOSUser()
      The function returns the domain, the user name, the full name, the description and the groups of the Windows user logged in.
    - getOSUser()
      The function returns the user name, the full name, the OS ID, the domain and the comment of the current user.
    - getOSGroupID()
      Returns the operating system ID of a specific user group.
    - getOSGroupInfo()
      Returns the attributes of a domain group.
    - getOSGroupName()
      Returns the group name for an OS specific ID.
    - getOSGroups()
      Returns an array containing the attributes of all groups of a domain (no local groups).
    - getOSGroupUsers()
      Returns all users of a group.
    - getOSUserGroups()
      Returns an array containing the attributes of all groups a user is member of.
    - getOSUserID()
      Returns the operating system ID of a specific user.
    - getOSUserInfo()
      Returns the attributes for a user "userName".
    - getOSUserName()
      Returns the user name for an OS specific ID.
    - getUserPermissionForArea()
      The function getUserPermissionForArea() gets the user permission for an area.
    - getWindowsEvents()
      The function returns the Windows events. The events under Windows are split into three different log types.
    - setUserNameSSO()
      Sets the name of a WinCC OA user for SSO.
    - usr_deleteSetting()
      Deletes a user setting from the configuration management.
    - verifyOSUser()
      The function returns TRUE (in the &result parameter) if the user with the defined user name exists, the account of the user is not locked or disabled and the specified password is correct. The default user is the current operating system user.
    - wss_getGenericSetting()
      Reads all workstation settings without hierarchy.
    - wss_getSpecificSetting()
      Reads a specific workstation setting without hierarchy.
    - wss_getSpecificWorkstationSetting()
      Reads a specific workstation setting with hierarchy.
    - wss_getWorkstationSettings()
      Reads all workstation settings with hierarchy.
    - UserManagement
    - UserManagementBaseType
    - UserManagementGroup
    - UserManagementUser
  - Vector / Dynamic arrays - Functions
  - Waiting Control Functions
  - Window Functions
    This chapter lists all functions used to control windows and panels, such as ChildPanelOn, LayerOn, LayerOff, PanelOff, RootPanelOn, SwitchLayer, ZoomModule, and related dialog and module operations.
  - XML Control Extension Functions
- Control Graphics
- CONTROL Functions
- 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 datapoints 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.
eLearning
Build Your Expertise Step by Step
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.
SIMATIC WinCC OA World
Explore the World of WinCC OA and Stay updated with the latest product news

User Administration Functions

These functions check the user, his identity and associated permissions. Users of WinCC OA can have features like a name, an identification number, a password and an entitlement code. These are managed by the process control system using the internal "_Users" datapoint. The following functions access element values of this datapoint.


afterLogin()
checkPassword()
convManIdToInt()
convManIntToName()
getManIdFromInt()
getOSDomainName()
getUserId()
getUserName()
setUserId()
getUserPermission()
setUserNamePVSS()
uss_getGenericSetting()
uss_getMyUsergroup()
uss_getSpecificSetting()
uss_getSpecificUserSetting()
uss_getUserSettings()
The following functions were implemented for the Windows user administration:
getCurrentDomainName()
getDomainOSUser()
getOSUser()
getOSGroupID()
getOSGroupInfo()
getOSGroupName()
getOSGroups()
getOSGroupUsers()
getOSUserGroups()
getOSUserID()
getOSUserInfo()
getOSUserName()
getUserPermissionForArea()
getWindowsEvents()
setUserNameSSO()
usr_deleteSetting()
verifyOSUser()
wss_getGenericSetting()
wss_getSpecificSetting()
wss_getSpecificWorkstationSetting()
wss_getWorkstationSettings()
The following user administration classes are available: UserManagement UserManagementBaseType UserManagementGroup UserManagementUser