Jump to main content
WinCC OA Documentation
WinCC OA Documentation
LANG
  • Version Information
  • Concepts
  • Deployment
  • Security
  • Engineering
  • Data Management
  • Business Logic / Control
  • Data Visualization
  • Southbound Interfaces
  • Northbound Interfaces
  • Web Connectivity / Network Interfaces
  • User Management
  • Availability
  • Reporting
  • Addons
  • Reference Tables
  • Videos & Tutorials
  • eLearning
  • Documentation
  • Support & Services
  • Disclaimer
  • SIMATIC WinCC OA World
  1. Home
  2. Web Connectivity / Network Interfaces

    Data exchange, APIs and web technologies

  3. Python Manager

    The Python Manager enables you to write WinCC OA managers in Python.

  4. WinCC OA Python API

    The Python API for WinCC OA provides access to the WinCC OA runtime system from Python scripts. It enables reading and writing datapoints, subscribing to value changes, executing queries, and integrating with the WinCC OA logging system.

  5. Guide

    In-depth explanations of the Python API’s core concepts.

  • 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.

    • Manager Service API (MSA) – High-Level Overview

      The Manager Service API (MSA) is the backbone for seamless, protocol-independent communication and logic reuse between WinCC OA managers, supporting modern distributed and web-integrated SCADA architectures.

    • COM

      COM - Microsoft Interface 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, 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.

    • Python Manager

      The Python Manager enables you to write WinCC OA managers in Python.

      • WinCC OA Python API

        The Python API for WinCC OA provides access to the WinCC OA runtime system from Python scripts. It enables reading and writing datapoints, subscribing to value changes, executing queries, and integrating with the WinCC OA logging system.

        • Getting Started

          This guide walks you through running your first Python script inside a WinCC OA project. The script is registered as a WinCC OA manager and is started, stopped and monitored by the process monitor (PMON) — just like a CTRL or ECMAScript manager.

        • Installation

          Detailed installation instructions for the WinCC OA Python API. For a quick start, see Getting Started.

        • Development Environment

          This page describes how to develop a Python application for WinCC OA on a workstation, keep it under source control, and verify it on a build node that has no WinCC OA installation. For running a finished script inside a project, see Getting Started.

        • Troubleshooting

          Common problems when running a Python manager, and how to resolve them.

        • Guide

          In-depth explanations of the Python API’s core concepts.

          • Data Access Patterns

            Reading, writing and observing datapoint values follows four patterns. Which one to use is a decision about confirmation and timing, not about the value itself. Historical values are a topic of their own and are covered at the end of the page.

          • Data Types

            WinCC OA has its own type system. The Python API maps between Python native types and WinCC OA types automatically where possible.

          • Error Handling

            Errors are reported as exceptions. A call that returns has succeeded, a call that fails raises. There is no return code to inspect and no equivalent of the CTRL function getLastError() that has to be queried after every statement.

          • Logging

            The Python API does not define a log API of its own. Messages are written with the standard logging module of Python, and the manager forwards them to the WinCC OA log system.

          • Manager Lifecycle

            The Manager class is the entry point for all interactions with WinCC OA. It manages the connection to the runtime system, the event loop, and graceful shutdown.

          • CTRL Interoperation

            A Python manager can run CTRL code. This gives access to the CTRL function set and to the script libraries that already exist in a project, without having to port them.

          • Manager Service API (MSA)

            The Manager Service API (MSA) lets managers call each other. One manager offers a service, another manager calls its methods through a stub. MSA works across all manager programming languages, so a Python manager can call a service written in CTRL, C++, C# or TypeScript, and vice versa.

          • Security

            This page collects the security topics that are specific to writing and running Python code in WinCC OA. It is an orientation, not a complete treatment. The WinCC OA Security Guideline is the authoritative document for securing a project. Most of the mechanisms described here belong to the project configuration rather than to the Python code.

        • API Reference

          This page contains auto-generated API reference documentation 1.

    • SIMATIC Unified AR (Augmented Reality)

      SIMATIC Unified AR is an industrial Augmented Reality app that allows to display and operate HMI screens (WinCC Unified / WinCC V8) and web applications (WinCC OA Dashboard) in real production environments.

    • webserver.js

      webserver.js is a Node.js-based web server that provides a modern, extensible backend for full-stack web applications in WinCC OA.

    • 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.

    • 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 [restRporting] enabled.

    • 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.

  • 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

Guide

In-depth explanations of the Python API’s core concepts.

  • Manager Lifecycle
  • Data Access Patterns
  • Data Types
  • Logging
  • Error Handling
  • CTRL Interoperation
  • Manager Service API (MSA)
  • Security
  • Data Access Patterns
    Reading, writing and observing datapoint values follows four patterns. Which one to use is a decision about confirmation and timing, not about the value itself. Historical values are a topic of their own and are covered at the end of the page.
  • Data Types
    WinCC OA has its own type system. The Python API maps between Python native types and WinCC OA types automatically where possible.
  • Error Handling
    Errors are reported as exceptions. A call that returns has succeeded, a call that fails raises. There is no return code to inspect and no equivalent of the CTRL function getLastError() that has to be queried after every statement.
  • Logging
    The Python API does not define a log API of its own. Messages are written with the standard logging module of Python, and the manager forwards them to the WinCC OA log system.
  • Manager Lifecycle
    The Manager class is the entry point for all interactions with WinCC OA. It manages the connection to the runtime system, the event loop, and graceful shutdown.
  • CTRL Interoperation
    A Python manager can run CTRL code. This gives access to the CTRL function set and to the script libraries that already exist in a project, without having to port them.
  • Manager Service API (MSA)
    The Manager Service API (MSA) lets managers call each other. One manager offers a service, another manager calls its methods through a stub. MSA works across all manager programming languages, so a Python manager can call a service written in CTRL, C++, C# or TypeScript, and vice versa.
  • Security
    This page collects the security topics that are specific to writing and running Python code in WinCC OA. It is an orientation, not a complete treatment. The WinCC OA Security Guideline is the authoritative document for securing a project. Most of the mechanisms described here belong to the project configuration rather than to the Python code.
Related information
  • Data Access Patterns
    Reading, writing and observing datapoint values follows four patterns. Which one to use is a decision about confirmation and timing, not about the value itself. Historical values are a topic of their own and are covered at the end of the page.
  • Data Types
    WinCC OA has its own type system. The Python API maps between Python native types and WinCC OA types automatically where possible.
  • Error Handling
    Errors are reported as exceptions. A call that returns has succeeded, a call that fails raises. There is no return code to inspect and no equivalent of the CTRL function getLastError() that has to be queried after every statement.
  • Logging
    The Python API does not define a log API of its own. Messages are written with the standard logging module of Python, and the manager forwards them to the WinCC OA log system.
  • Manager Lifecycle
    The Manager class is the entry point for all interactions with WinCC OA. It manages the connection to the runtime system, the event loop, and graceful shutdown.
  • CTRL Interoperation
    A Python manager can run CTRL code. This gives access to the CTRL function set and to the script libraries that already exist in a project, without having to port them.
  • Manager Service API (MSA)
    The Manager Service API (MSA) lets managers call each other. One manager offers a service, another manager calls its methods through a stub. MSA works across all manager programming languages, so a Python manager can call a service written in CTRL, C++, C# or TypeScript, and vice versa.
  • Security
    This page collects the security topics that are specific to writing and running Python code in WinCC OA. It is an orientation, not a complete treatment. The WinCC OA Security Guideline is the authoritative document for securing a project. Most of the mechanisms described here belong to the project configuration rather than to the Python code.

SIMATIC WinCC Open Architecture Version 3.21.7 - © ETM professional control GmbH - | | | - Privacy Policy - Cookie Policy - Terms of use - Whistleblowing - Imprint