UnifiedRT enUS en-US
UnifiedRT enUS en-US
Options 3
SIMATIC HMI
User administration in
Runtime 4
WinCC Unified
WinCC Unified Runtime
Certificate Manager 5
Tag Simulator 7
Online documentation
05/2021
Online documentation
Legal information
Warning notice system
This manual contains notices you have to observe in order to ensure your personal safety, as well as to prevent damage
to property. The notices referring to your personal safety are highlighted in the manual by a safety alert symbol, notices
referring only to property damage have no safety alert symbol. These notices shown below are graded according to
the degree of danger.
DANGER
indicates that death or severe personal injury will result if proper precautions are not taken.
WARNING
indicates that death or severe personal injury may result if proper precautions are not taken.
CAUTION
indicates that minor personal injury can result if proper precautions are not taken.
NOTICE
indicates that property damage can result if proper precautions are not taken.
If more than one degree of danger is present, the warning notice representing the highest degree of danger will be
used. A notice warning of injury to persons with a safety alert symbol may also include a warning relating to property
damage.
Qualified Personnel
The product/system described in this documentation may be operated only by personnel qualified for the specific
task in accordance with the relevant documentation, in particular its warning notices and safety instructions.
Qualified personnel are those who, based on their training and experience, are capable of identifying risks and
avoiding potential hazards when working with these products/systems.
Proper use of Siemens products
Note the following:
WARNING
Siemens products may only be used for the applications described in the catalog and in the relevant technical
documentation. If products and components from other manufacturers are used, these must be recommended or
approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance
are required to ensure that the products operate safely and without any problems. The permissible ambient
conditions must be complied with. The information in the relevant documentation must be observed.
Trademarks
All names identified by ® are registered trademarks of Siemens AG. The remaining trademarks in this publication may
be trademarks whose use by third parties for their own purposes could violate the rights of the owner.
Disclaimer of Liability
We have reviewed the contents of this publication to ensure consistency with the hardware and software described.
Since variance cannot be precluded entirely, we cannot guarantee full consistency. However, the information in this
publication is reviewed regularly and any necessary corrections are included in subsequent editions.
Security information
Siemens provides products and solutions with industrial security functions that support the
secure operation of plants, systems, machines and networks.
In order to protect plants, systems, machines and networks against cyber threats, it is necessary
to implement – and continuously maintain – a holistic, state-of-the-art industrial security
concept. Siemens’ products and solutions only form one element of such a concept.
Customer is responsible to prevent unauthorized access to its plants, systems, machines and
networks. Systems, machines and components should only be connected to the enterprise
network or the internet if and to the extent necessary and with appropriate security measures
(e.g. use of firewalls and network segmentation) in place.
Additionally, Siemens’ guidance on appropriate security measures should be taken into account.
For more information about industrial security, please visit
http://www.siemens.com/industrialsecurity
Siemens’ products and solutions undergo continuous development to make them more secure.
Siemens strongly recommends to apply product updates as soon as available and to always use
the latest product versions. Use of product versions that are no longer supported, and failure to
apply latest updates may increase customer’s exposure to cyber threats.
To stay informed about product updates, subscribe to the Siemens Industrial Security RSS Feed
under
http://www.siemens.com/industrialsecurity
Network settings
The following table shows the network ports that are used by WinCC Unified for internal and
external communication. These ports must not be used for any other purpose.
The setup configures the ports for the firewall to ensure smooth operation.
WinCC Unified
Name Port number Transport protocol
ILScs Manager 20008 TCP
UMC 20009 TCP
ILPmon Manager 4999 TCP
ILEvent Manager 1235 TCP
ILDist Manager 4777 TCP
ILDataManager 1234 TCP
5001
WinCC Unified
Node Processes 3103 TCP
443
8888
Graphics Runtime 1339 TCP
1345
License server 1366 TCP
Screen debugger 9222 TCP
Job debugger 9224 TCP
Purposes
The above data is required for the following purposes:
• Access protection and security measures (e. g. Login, IP address)
• Process synchronization and integrity (e. g. time zone information, IP addresses)
• Archiving system for traceability and verification of processes (e. g. access timestamps)
• Alarm system for traceability and availability (for example, e-mail notification)
The storage of data is appropriate and limited to what is necessary, as it is essential to identify
the authorized operators and process events.
Data configuration
The customer can configure the data collected via the product as follows:
• Display data in process pictures
• Data output in form of reports, e. g. for printing or display as electronic file
• Data collection and evaluation in form of graphics, e. g. for KPI analysis
Deletion policy
The product does not provide an automatic deletion of the above data.
If necessary, these can be deleted manually if desired. To do this, refer to the product
documentation or contact customer support.
Securing of data
The above data will not be stored anonymously or pseudonymized, because the purpose of
access and event identification cannot be achieved otherwise.
For WinCC Unified PC-based, the above data is secured by appropriate technical measures:
• Encryption of log data
• Storing the process data in access-protected SQL databases
The user must ensure the access protection as part of their process configuration.
You can find information about securing data on the WinCC Unified Comfort Panel in the
operating instructions for the Comfort Panel.
Introduction
Specific requirements for the operating system and software configuration must be met for the
installation.
Note
Windows computer name
Retain the Windows computer name after the installation.
The following characters are not permitted for the computer name:
• .,;:!?"'^´`~_
• -+=/\¦@*#$%&§°
• ()[]{}<>
• Space
Follow these recommendations when assigning the Windows computer name:
• Uppercase only
• The first character must be a letter.
• The first 12 characters of the computer name must be unique.
Hardware Requirement
Processor type Intel Core i3
RAM 4 GB
Free hard disk space 10 GB, 8 GB CF
Virtualization
The following virtualization systems were tested:
• VMware vSphere Hypervisor (ESXi) 6.7 (or higher)
• VMware Workstation 12.5.5 and VMware Workstation 15.5.0 (or higher)
• VMware Player 12.5.5 and VMware Player 15.5.0 (or higher)
• Microsoft Hyper-V Server 2019
Requirement
The performance data of the virtual computers must meet the minimum requirements of WinCC
clients.
Note
Number of supported clients and connections
Desktop operating systems support a maximum of 5 clients. In server operating systems, more
than 5 clients can connect to the server.
Windows limits the number of incoming connections on desktop operating systems to 20. This
limits the number of possible accesses to Runtime.
Compatible browsers
For more information on the use of browsers, see section Internet browsers for WinCC Unified PC
(Page 26).
Ports
When a Windows firewall is used, the installation routine of WinCC Unified Runtime sets up the
following ports:
• HTTPS: 443
• TIA administrator: 8888
If your system uses a different firewall solution, make sure the ports are set up accordingly.
Security programs
The following security programs are approved for Runtime Unified:
Principle
Care must be taken to ensure that the use of the antivirus software does not impair the process
operation of a plant.
Rules for antivirus software (virus scanning clients)
• Integrated firewall of the virus scanner
In WinCC Unified Runtime, the local Windows firewall used is configured with SIMATIC
Security Control. Do not install or enable the integrated firewall of the antivirus software.
• Manual scan
Do not perform a manual scan in Runtime. Perform disk on regular intervals on all plant PCs,
for example, during the maintenance interval.
• Automatic scan
For automatic scan it is sufficient to scan the incoming data traffic.
Note
If you are using an anti-virus scanner, make sure that the computer has sufficient system
resources.
Requirement
• You have administrator privileges on your computer.
• All running programs are closed.
Procedure
1. Place the installation medium in the respective drive.
2. Start the Setup.
3. Select the required installation language.
4. Select the required product configuration.
5. Read and accept all the license conditions and safety information.
6. Accept the changes in the security settings.
7. Check the selected installation settings.
8. Start the installation.
9. After selecting the components, make the system settings for operation of Unified Runtime.
These are described in the section Configuring Runtime system settings (Page 16).
You can amend or change the settings at a later time by calling the "WinCC Unified
Configuration" tool.
10. Reboot the PC to complete the installation.
Note
Using the Openness SDK
You will find the Openness SDK in the "Support\Openness" folder on the installation medium.
Unpack the file "Siemens.Unified.Openness_SDK_<version number>.zip" to your local computer.
A WinCC Unified installation is not necessary to use the Openness SDK.
Introduction
You have two options for removing:
• Removing selected components via the Control Panel
• Removing the product using the installation data medium
Note
Some components are not automatically removed by the uninstall routine of the software
package as these are used for other purposes. ALM, for example, is used for the administration
of the license keys of several products of Siemens AG.
Requirement
• You have completed the component selection in the setup and are now in the step for
configuration of the Runtime system settings.
Procedure
Follow the setup instructions and configure the following settings:
• The Web UI certificate
• User management
• The log settings for the storage location of log databases and the maximum storage limit of
the SQL server
• Reporting settings
• Password-protected download
You navigate between the various steps with "Back" and "Next".
To skip a step or maintain the pre-selected inputs, select the option "Keep the existing
configuration" and click "Next".
Result
The installation automatically creates a desktop shortcut for "WinCC Unified Configuration". You
can amend or change the settings at a later time by manually starting "WinCC Unified
Configuration".
Requirement
• The program package is installed.
Procedure
1. Start "WinCC Unified Configuration" manually using the desktop shortcut that was created
during the installation.
The same settings are available in "WinCC Unified Configuration" as during the installation.
– The Web UI certificate
– User management
– The log settings for the storage location of log databases and the maximum storage limit
of the SQL server
– Reporting settings
– Password-protected download
2. If required, change the interface language of WinCC Unified Configuration. To do so, select
the desired language from the list.
3. Follow the setup instructions and configure the required settings.
4. You navigate between the various steps with "Back" and "Next".
To skip a step or maintain the inputs select during the installation, select the option "Keep the
existing configuration" and click "Next".
Result
After you have completed the settings, the system automatically performs the configuration.
You will receive an overview of the implemented configuration.
NOTICE
Security risk due to self-signed web server certificate
Using a self-signed certificate, e.g. for test purposes, is possible but not recommended for the
operation of the system for security reasons.
Web clients must install this certificate in the web browser. The installation of self-signed
certificates is not supported by all web browsers. Depending on the web browser, it is possible
to define exceptions.
For more detailed information, refer to the operating instructions of the web browser.
See also
Handling certificates (Page 23)
Note
This step is only available in the following situations:
• A UMC server or its agent is installed on the HMI device.
• Or the runtime installation has been started via the TIA Portal engineering DVD.
If this is not the case, Runtime uses the user configuration downloaded from the TIA Portal. User
data is read from the local or central user management according to the project configuration.
In the "User management" step, configure the user management configuration that Runtime is
to use. Possible settings:
• Use the user management configuration downloaded from the TIA Portal.
Runtime uses the local user management.
• Use the configuration from the Runtime system settings
The user data is always centrally located on a UMC server. The server or its agent must be
installed on the HMI device.
When a project with local user management is loaded in Runtime, the user management
connects to the UMC server configured here.
Note
Select this option only if you cannot access the computer from the network using the full
computer name.
When you have entered your settings and the system has terminated the configuration, Runtime
uses the user management configuration downloaded from the TIA Portal.
Note
Automatic generation of the identity provider address
By default, the identity provider address is automatically generated based on the UMC server
address.
When you have entered your settings and the system has terminated the configuration, Runtime
uses the UMC server configured here.
See also
Activating user management (Page 282)
Introduction
In this step you configure the settings for generating reports.
You have the following options:
• Unified PC: Select the local main storage location for storing reports in the file system.
Note
Permanently configured local main storage location for Unified Comfort Panel
The "Reports" folder on the SD card inserted in the panel is specified as the local main storage
location for Panels: media/simatic/X51/Reports
You cannot select or create another folder.
Specify the local main storage location for reports (Unified PC)
Select a local directory.
To save the generated reports, users can create subdirectories in Runtime in the "Reports"
control.
Note
Deviating PDF results possible
A PDF report created by LibreOffice may differ in content or layout from a PDF report created
with Excel. Such deviations are possible if general Excel functions that LibreOffice does not
support are used in the report template, for example, special fonts or chart types.
2. When Excel is creating the PDFs: Specify the user name and password of the Windows user
under whose name the PDF creation is running.
During the Runtime installation, an appropriate user account is created.
Do not use a user that already exists in Windows user management.
Adhere to Windows policies for user passwords.
Note
Checking the security settings of the user management
Clarify with your administrator whether the security settings of the Windows user
management prevent the new user created on your device during the Runtime installation
from being permanently available.
If required, modify the settings or select LibreOffice as the application for PDF creation.
3. When LibreOffice creates the PDFs: Select the LibreOffice installation directory.
Introduction
To use WinCC Runtime Unified, transfer a license key to the Runtime PC.
When you transfer a license, the associated license key is removed from the storage location.
Note
A license key cannot be copied. The copy protection employed prevents the license keys from
being copied.
Data backup
Transfer the license keys from the PC when backing up data on the PC and when creating a
backup during device replacement.
You use the Automation License Manager to save license keys for PC-based HMI devices at the
storage area of the license key.
NOTICE
Destruction of license keys on PCs
Transfer all license keys to a storage location in the following cases:
• Before you format the hard disk
• Before you compress the hard disk
• Before you restore the hard disk
• Starting an optimization program that moves fixed blocks
• Installing a new operating system
Read the description of Automation License Manager. Observe all warnings and notices.
The location of the license keys is capable of storing multiple licenses when the
Automation License Manager is used on PC-based HMI devices. This capability means you can
store multiple licenses of the same type at one location. Save all license keys of the HMI device
to the same storage location.
You transferred the license key to the HMI device with a time zone setting based on a full hour.
Then, also transfer the license key from the HMI device with a time zone setting based on a full
hour.
This behavior does not apply to the trial license.
Defective license
A license is defective in the following cases:
• If the license key is no longer accessible at the storage area.
• If the license key disappears during its transfer to the destination drive.
Note
Resetting of the system status to an earlier time causes all licenses to become defective.
You can use the Automation License Manager to repair the defective licenses. Use the "Restore"
function or the "Restore Wizard" of the Automation License Manager for this purpose. Contact
Customer Support in order to restore the license.
Note
The runtime software can also be operated without errors if the license is missing or defective.
The system alerts you with an alarm at brief intervals that you are working in non-licensed mode.
Introduction
Communication between web clients (browser) and Runtime (web server) is encrypted. The
communication partners authenticate themselves with a certificate. The web server certificate
must be known to the web client browser as trusted.
You determine which certificate you are using when installing Runtime on the web server or at
a later time in the "WinCC Unified Configuration" tool.
NOTICE
Security risk due to self-signed web server certificate
Using a self-signed certificate, e.g. for test purposes, is possible but not recommended for
the operation of the system for security reasons.
Web clients must install this certificate in the web browser. The installation of self-signed
certificates is not supported by all web browsers. Depending on the web browser, it is
possible to define exceptions.
For more detailed information, refer to the operating instructions of the web browser.
Contents
Information that could no longer be included in the online help and important information
about product properties.
Browser recommendation
In view of the performance and support of the Runtime standard elements, Google Chrome has
proven to be the preferred browser. Its memory requirements are slightly higher than those of
the other browsers.
Note
Operating system and browser version
For Runtime operation via Android or iOS, always use the latest operating system.
Use the latest browser version.
Note
Performance differences in different versions of individual browsers
The browser versions can differ from each other, which can result in different behavior regarding
the memory requirements and speed.
Note
Suitability for continuous operation
MS Edge and Mozilla Firefox have proven to be problematic in continuous operation.
Restrictions to the various functions can also occur, such as the availability of the before and
after buttons in the controls.
Browser recommendation
In view of the performance and support of the Runtime standard elements, Google Chrome has
proven to be the preferred browser. Its memory requirements are slightly higher than those of
the other browsers.
Note
Operating system and browser version
For Runtime operation via Android or iOS, always use the latest operating system.
Use the latest browser version.
Note
Performance differences in different versions of individual browsers
The browser versions can differ from each other, which can result in different behavior regarding
the memory requirements and speed.
Note
Suitability for continuous operation
MS Edge and Mozilla Firefox have proven to be problematic in continuous operation.
Restrictions to the various functions can also occur, such as the availability of the before and
after buttons in the controls.
Introduction
After you have downloaded a Runtime project to an HMI device and started Runtime, you display
Runtime in the browser.
Requirement
• The Runtime project is loaded.
• The project is executed in Runtime.
• The user management configuration of the project is active.
Procedure
1. In the browser, enter the IP address or the full computer name (fully qualified domain name)
of the PC on which Runtime is running, for example, "https://141.73.65.245/".
If Runtime is installed on the same PC as the browser, the "localhost" designation can also be
used.
2. If you are accessing the Runtime of the HMI device from this device for the first time and there
is no corresponding certificate, install the certificate in the browser. Then reload the page.
3. The start page of Runtime is displayed.
Note
If you experience display problems in the web client, completely delete the browser data
(history, form entries, etc.).
If WebES is installed on the device, the "WinCC Configuration" button also appears.
4. Select "WinCC Unified RT".
The login page is displayed.
After complete download of a project, an error can occur when you open the WinCC Unified
home page (SwacLogin).
You can find additional information at SwacLogin: Errors after complete download
(Page 38).
See also
Installing a certificate in the browser when accessing via web client (Unified PC) (Page 32)
NOTICE
Security risk from self-signed certificate
A self-signed certificate is not issued by a trusted certification authority.
If you use a self-signed certificate from an untrustworthy source, the data transfer is not
protected from attacks.
Before using self-signed certificates, check the source.
Depending on the firewall and network settings, the use of self-signed certificates may be
prohibited.
The installation of self-signed certificates is not supported by all web browsers. Depending on
the web browser, it is possible to define exceptions.
For more detailed information, refer to the operating instructions of the web browser.
2. Open the field with the error details and confirm that you want to open the web page.
3. On the WinCC Unified home page, select the field "Certificate Authority" and confirm "Open
file" in the download dialog.
The root certificate is downloaded to the pre-selected download directory.
4. Save the root certificate. To do this, click "Save file" in the Firefox dialog that follows.
5. Store the certificate in the Firefox certificate store. Proceed as follows:
– Open the "Settings" page of Firefox.
– Select "Privacy & Security". There you will find the "Certificates" area further down. Open
"Show certificates...".
– In the "Certificate Management" window, select the "Certification authorities" tab:
– Click "Import" and select the root certificate you saved in step 3.
– In the window that opens, select the option "This certificate can identify websites" and
confirm your selection.
– Click "Server" and remove the exception that was created by step 2.
3. Select "Install".
Error description
In "Chrome" and "MS Edge", the error is displayed with the following alarm:
After accepting the warning of a potential security risk, the page remains empty in Firefox. Only
the background screen is visible.
See also
Displaying runtime (Page 30)
Requirement
• You are logged in to Runtime.
• When you want to log out in the Runtime project, the system function "Logout" is
configured, for example, to the event "Click left mouse button".
Logging out in the Runtime project with the system function "Logout"
• Select the button at which the system function "Logout" is configured.
New data downloaded from the TIA Portal is applied during the next login.
2.6 Basics
Note
Displaying a start screen changed by reloading
A start screen was defined for a project, and the project was started in Runtime. If another start
screen is then defined in engineering and the project is loaded into the device again, the last
active screen is displayed in Runtime after the connection is established again.
After reloading the project, refresh the screen in Runtime. If your HMI device is a computer, use
the F5 key or the browser "Refresh" button to do this.
Screen navigation
Process visualization is generally split between multiple process screens, for example on the
basis of functional or technological aspects. Changing between process screens is referred to as
screen navigation.
Popup window
With corresponding configuration in the engineering system, clicking on a screen area opens a
popup window containing additional information on the screen area.
Example: A screen represents a pump with its valves. When you click on a valve, a popup window
opens with detailed information on the valve as well as input fields. You can check the state of
the valve in the pop-up window and edit using the input fields.
Predefined styles
The following predefined styles are available for the process screens of the HMI devices:
• Light style
• Dark style
• Expanded style
Note
Compact mode in light and dark style
If the following elements in light or dark style fall below specific dimensions, they are
automatically displayed in compact mode:
• Bar
• Slider
• Gauge
• Clock
2.6.2 Tags
Behavior of tags
Tags correspond to defined memory areas to which values are written and/or from which values
are read.
External tags correspond to the process values from the memory of an automation system.
Internal tags transport values within the HMI device. The internal tag values are only available
as long as Runtime is running.
The reading and writing of tag values is triggered by the controller or by the operator on the HMI
device. The update cycle is defined in the configuration.
Tags are output in Runtime in trends or tables.
Note
Values with a mantissa of up to 64 bits are correctly displayed by I/O fields.
2.6.3 Alarms
2.6.4 Logs
Data log
In Runtime, the data logging functions on the server as a log server. On the clients, the data
logging functions as a log client. Only the log server accesses the database and compiles and
logs the process data. The clients receive log data from the log server.
The log data is visualized in tabular or graphic format on all clients running tag logging in
Runtime. The data to be displayed always comes from the log server. All operations on the client
are transmitted to the server and the result of the processing is transferred back to the client.
Alarm log
Alarms in the project indicate fault states and operating states of a process. They are generally
triggered by the controller. Alarms are displayed on the HMI device in screens. All the data
associated with an alarm and configuration data are saved in an alarm log, for example, alarm
class, time stamp and alarm text. Each alarm class can be logged separately. Alarms are logged
either automatically or by operator intervention.
2.6.5 Contexts
Contexts allow you to view plant units according to a certain viewpoint, e.g. according to a
certain customer, product, job or shift.
Principle
Contexts always belong to a plant object. They are indicated as follows:
• User-defined contexts:
Using a program created with the ODK-API
• System-generated contexts:
For installed Performance Insight and Calendar option packages: Automatically in Runtime
Example: When a shift starts in Calendar, an archived context value is created with the shift
ID
A log entry is generated each time a context (e.g. "Product") is executed. The logged context
saves:
• The context value (e.g. "orange lemonade")
• Start time and end time of the execution time
• The quality code
Example
A press house produces juices for various beverage brands. Using contexts, employees can
display in runtime which alarms have occurred:
• During the production of a specific product (cloudy apple juice, clear apple juice, pear juice
etc.).
• For orders for a specific customer (Schmitt, Schulze, Meier).
• During a specific shift (early shift, late shift, night shift).
See also
Display context-dependent alarms of a plant object (Page 72)
Display context data of the plant objects in a trend control (Page 108)
Adding contexts (Page 191)
Definition
The on-screen keyboard is a virtual keyboard on the screen of an HMI device. The operator can
click the displayed keys with a mouse, touch pen or finger.
The on-screen keyboard provides keys for numeric entries or for entering alphanumeric
characters. The key labeling is based on the country setting is the Windows Control Panel. For
example, no German or French special characters are available on an English keyboard. The
arrangement of the letters is also different is some cases. If multiple keyboard layouts are
installed, you can switch the keyboard layout by clicking on the country ID on the on-screen
keyboard.
Definition
Various touch gestures are available for Runtime operation on mobile devices. Some touch
gestures have different effects in the process pictures than in the controls.
Note
No operation with three or more fingers.
Only use one or two fingers when operating with touch gestures.
If you use more than two fingers with touch gestures, this can cause incorrect operation.
In the case of multi-touch operation with several fingers, you only operate the respectively
configured objects.
Drag with one To scroll horizontally or vertically, drag the object with one finger in the desired di‐
finger rection.
Keep pressed To call the shortcut menu, press for longer than a second on the object or the link.
The function corresponds to a right-click.
Drag with To scroll vertically or horizontally in the table of the control, • Alarm control
two fingers drag in the control window with two fingers in the desired • Process control
direction.
• Ruler window
• System diagnos‐
tics view
• Parameter set con‐
trol
Drag with • Moves the ruler. • Trend control
one finger • Moves the x-axis or y-axis. • f(x) trend control
Requirement: The "Move trend area" or "Move axis area"
button is pressed or the control is zoomed in.
To select multiple rows, tap a row and drag your finger up or • Alarm control
down. • Process control
With corresponding configuration of the control: To select
• Ruler window
multiple cells.
• System diagnos‐
To adapt the column width, tap a column grid line and drag
your finger to the right or left. tics view
To change the order of the columns, tap a column header • Parameter set con‐
and drag your finger to another column header. trol
Double tap To edit a cell value, tap the cell twice. • Process control
Requirement: • Parameter set con‐
• Table view: The "Edit" button is pressed. trol
• Parameter set control: A parameter set is selected.
Swiping (hori‐ To quickly scroll left or right or up or down within the table of • Alarm control
zontally and the control, swipe in the corresponding direction. • Process control
vertically)
• Ruler window
• System diagnos‐
tics view
• Parameter set con‐
trol
Trigger event
Requirement
An event which is triggered by operating actions such as typing or clicking has been configured
for the object in the engineering.
Procedure
To trigger the event, proceed as follows:
• If the object does not have the focus, click a visible part of the object, e.g. its border.
• If the object already has the focus, the event is also triggered by clicking in the transparent
area.
2.7.5 Flashing
Flashing in Runtime
You can display the objects flashing in Runtime. Scripts can be used to switch flashing on and off
and influence the properties of the flashing.
Configure the flashing behavior of an object property in the engineering system for each color
setting of an object that supports flashing.
Note
The flashing in Runtime does not change the color value of the property.
2.8 Controls
Alarm system
Introduction
The alarm system allows you to display and record operating states and faults on the HMI device
that are present or occur in a plant.
6\VWHPGHILQHGDODUPV6 8VHUGHILQHGDODUPV
6GLDJQRVWLFVDODUPV 6\VWHPGLDJQRVWLFV
6,0$7,&66,027, DODUPV
21
$QDORJDODUPV
V\VWHP 1R &RQWUROOHU &RQWUROOHU
DODUPV FRQILJXUDWLRQ DODUPV 'LVFUHWHDODUPV DODUPV
LQ:LQ&&
8VHUDODUPV
The following figure shows the alarm system structure for communication with the SIMATIC
S7-1500 controllers:
6\VWHPGHILQHGDODUPV6 8VHUGHILQHGDODUPV
6\VWHPGLDJQRVWLFVDODUPV
$QDORJDODUPV
V\VWHP 1R &RQWUROOHU &RQWUROOHU
DODUPV FRQILJXUDWLRQ DODUPV 'LVFUHWHDODUPV DODUPV
LQ:LQ&&
8VHUDODUPV
Alarms
Overview
The following table shows the basic components of alarms:
Alarm Alarm Time of Date Alarm state Alarm text Priority Trigger Limit val‐
class number day tag ue
Alarm class
Alarm classes are, for example, "Alerts" or "Errors". The alarm class defines the following for an
alarm:
• State machine
• Appearance in Runtime (e.g. color)
• Logging
Note
Device dependency
Logging is not available for all HMI devices.
Alarm number
An alarm is identified by a unique alarm number. The alarm number is assigned by the system.
You can change the alarm number to a sequential alarm number, if necessary, to identify alarms
associated with your project.
Note
Time zones
All alarms are always synchronized in the utilized time zone.
Alarm state
An alarm has the events "Active", "Inactive", "Acknowledge". For each event, a new alarm is
output with the current status of the alarm.
Alarm text
The alarm text describes the cause of the alarm.
The alarm text can contain output fields for current values. Which values are output depends on
the runtime used. The value is retained at the time at which the alarm status changes.
If a text list is also assigned to a parameter, the alarm text shows the text list entry that
corresponds to the tag value.
Note
If no default value is assigned to the text list and the tag value is outside the defined value range
of the text list, the alarm text returns a string with the parameter ID and the text list.
Priority
Displays the priority of individual alarms.
Limit value
Analog alarms display limit violations. Depending on the configuration, WinCC outputs the
analog alarm as soon as the trigger tag exceeds or undershoots the configured limit value.
Alarm indicator
The alarm indicator is a graphic symbol that is displayed on the screen when an alarm of the
specified alarm class is active.
The alarm indicator can have one of two states:
• Flashing: At least one unacknowledged alarm is queued.
• Static: The alarms are acknowledged but at least one of them is not inactive yet. The
displayed number indicates the number of queued alarms.
Computer
Operator input alarms have the "Computer" column in the alarm summary. The computer name
is displayed for local alarms and the IP address for alarms from the web client.
Users
When an empty user name is passed to an alarm, it will display its formatting string instead of
the user name, for example, "@S2%s@".
Alarm types
Introduction
The alarm types are used for various purposes for monitoring the plant. The alarms of the
individual alarm types are configured and triggered in different ways.
User-defined alarms
• Analog alarms
– Analog alarms are used for limit monitoring and show limit violations in the active
process.
• Discrete alarms
– Discrete alarms are used for status monitoring and display a status in the active process.
System-defined alarms
• System-defined PLC alarms
– System-defined PLC alarms are used to monitor the PLC.
– Diagnostic interrupts (SIMATIC S7) and system errors (RSE) also belong to the category of
system-defined PLC alarms.
Note
Device dependency
System-defined PLC alarms are not available for all HMI devices.
• System alarms
– System alarms belong to the respective HMI device and are imported into the project.
– System alarms are used for monitoring the HMI device.
Alarm classes
Introduction
Many alarms occur in a plant; these are all of different importance. You can assign the alarms of
your project to alarm classes to clearly show the user which of the alarms are most important.
Description
The alarm class specifies the display of an alarm. The alarm class specifies if and how the user has
to acknowledge alarms of this alarm class.
Note
The choice of display modes for alarm classes depends on the options of your HMI device.
• "Safety Alerts"
The alarm class "Safety Alerts" contains alarms for fail-safe operation. Users do not
acknowledge alarms from this alarm class. Alarms of the alarm class "Safety Alerts" belong to
the system alarms.
Note
Device dependency
The alarm class "Safety Alerts" is not available for all HMI devices.
Alarm number
Note
When adapting alarm numbers, observe the inter-project uniqueness of the alarm number.
The alarm number of a system alarm has a higher priority than the number of a user-defined
alarm. When you use the alarm number of a system alarm for a user-defined alarm, you change
the alarm number of the user-defined alarm.
Alarm states
Introduction
An alarm assumes various alarm states in runtime. You analyze and report the process sequence
using the alarm states.
Note
Device dependency
Reporting and logging are not available for all HMI devices.
Description
Every alarm has an alarm state. The alarm states are made up of the following events:
• Active
The condition for triggering an alarm is fulfilled. The alarm is displayed, such as "Boiler
pressure too high".
• Inactive
The condition for triggering an alarm is no longer fulfilled. The alarm is no longer displayed
as the boiler was vented.
• Acknowledge
The user acknowledges the alarm.
Each occurrence of these states can be displayed and logged on the HMI device and a protocol
printed.
Note
The display text for the states of an alarm is language-specific and configuration-specific.
Introduction
The "Alarm control" object displays PLC alarms and HMI alarms that occur during the process in
a plant. Each alarm is displayed in a separate alarm line. The content of the alarm line depends
on the alarm blocks to be displayed.
The following figure shows an alarm control:
Note
An alarm appears in the alarm control with the date and time stamp crossed out in the following
situations:
• A deactivated alarm is enabled again.
• An alarm is reloaded after a power failure. This applies only to chronological alarming.
• The automation system is restarted. This applies only to chronological alarming.
List Description
Display active alarms Shows the pending alarms.
Display logged alarms Shows the logged alarms.
The display is not updated immediately when new incoming
alarms occur.
List Description
Update and display logged Shows the logged alarms.
alarms The display is updated immediately when new incoming
alarms occur.
The setting of whether the following alarms belong to the active alarms and to the defined
alarms is made in the engineering:
• Not suppressed
• Deactivated
• Suppressed by design
• Shelved alarms
You can change this setting in Runtime:
• For the active alarms with the "Display options setup" button
• For the defined alarms with the "Deactivated alarms setup" button
The maximum number of alarms that can be displayed in Runtime depends on the selected view:
See also
Alarm control overview (Page 64)
Alarm signaling Shows all alarms for which the alarm signaling equipment was
equipment configured. The alarm signaling equipment is a visual or acoustic
signal, such as a horn or warning light, that is displayed in addition
to the alarm control in the system.
First line The first of the currently active alarms is selected. This button is only
operable if the "Show recent" function is disabled.
Previous line The previous alarm with regard to the selected alarm is selected.
This button is only operable if the "Show recent" function is disa‐
bled.
Next line The next alarm with regard to the selected alarm is selected. This
button is only operable if the "Show recent" function is disabled.
Last line The last of the currently active alarms is selected. This button is only
operable if the "Show recent" function is disabled.
Skip to the next Selects the next alarm that requires acknowledgment, starting
alarm that re‐ from the currently selected alarm. This button is only operable if the
quires acknowl‐ "Show recent" function is disabled.
edgment
Previous page Navigates to the previous page.
Deactivate alarm Hides an alarm in the current alarm summary and in the alarm log
summaries.
Only available in the "Display defined alarms" summary.
Release alarm Releases an alarm selected in the "Disabled alarms" display.
Only available in the "Display defined alarms" summary.
Shelve alarm Shelves an alarm. It appears in the "Shelved alarms" display. You use
this feature, for example, to prevent that a deviation alarm affects
the efficiency of your system.
Unshelve alarm Revokes the shelving of an alarm selected in the "Shelved alarms"
display.
Time base setup Opens a dialog for setting the time zone for the time information
shown in alarms.
Selection display Opens a dialog for filtering alarms. Here you define your own filter
criteria or filter the alarms by criteria defined in the engineering
system.
Sorting setup Opens a dialog for setting custom sorting criteria for displayed
alarms.
Icon Meaning
Shows the status to the alarm servers:
No faulty connections
Shows the status to the alarm servers:
Faulty connections
Shows the status to the alarm servers:
All connections are faulty
With the corresponding configuration in engineering, the status bar shows the number of
alarms that are not acknowledged in runtime. The counter includes all connected servers, but no
filters.
When a context is selected, the status bar shows the values of the selected context.
Icon Meaning
Alarm is active
Alarm is active/inactive
Alarm is active/acknowledged
Icon Meaning
Alarm is active
Alarm is inactive
Alarm acknowledged
Note
Displayed alarms
The alarms that you see in the alarm control depend on which alarm summary you have selected
in the toolbar.
Sorting columns
This function can be configured and is only available in Runtime if it was enabled in engineering.
1. Click on a column header.
2. Click the same column header again to reverse the sorting order.
3. You cancel the sorting by clicking again.
Buttons Description
<PgUp> Selects the previous alarm.
<PgDn> Selects the next alarm.
<Ctrl+Up Ar‐ If multiple rows were selected, the first row of the selection is selected.
row>
or
<Home>
<Ctrl+Down If multiple rows were selected, the last row of the selection is selected.
Arrow>
or
<End>
<Ctrl+Left Ar‐ If multiple columns were selected, the first column of the selection is selected.
row>
<Ctrl+Right Ar‐ If multiple columns were selected, the last column of the selection is selected.
row>
<Tab> Selects the next operator control in the toolbar.
<Shift+Tab> Selects the previous operator control in the toolbar.
<ENTER> Runs the currently selected operator control.
<Shift+PgUp> Scrolls to the left column-by-column.
<Shift+PgDn> Scrolls to the right column-by-column.
Touch operation
Refer to the section On mobile devices (Page 49).
Alternative operation
Depending on the configuration, you can also operate the alarm control via the function keys.
Introduction
You use criteria to define the alarms you want to display in the alarm control.
The following settings are available in the "Selection" dialog:
Setting Description
"AND/OR" col‐ Adds additional criteria to the existing criteria with the Boolean operations AND or OR.
umn
"Criterion" col‐ Selection list with the available criteria.
umn Criteria correspond to the alarm blocks in the alarm control.
Setting Description
"Operator" col‐ Selection list with the available relational operators.
umn
"Setup" column Free text field
"Remove" but‐ Removes the selected filter criterion.
ton
"Up/down" but‐ Moves the selected filter criterion.
ton
"Filter" area Free text area for direct input and editing of filter criteria.
In the example below, only the alarms that contain the alarm text "Motor on" and whose priority
is less than or equal to 5 are displayed.
Requirement
The "Selection display" button is configured in the alarm control.
Procedure
To filter alarms in the alarm control, follow these steps:
1. Use the "Selection display" to open the "Selection" dialog.
2. In the "Criterion" column, open the selection list and select the entry "Alarm text".
3. In the "Operator" column, open the selection list and select the entry "Equal to".
4. In the free text field of the "Setup" column, enter the value "Motor on".
5. Select an AND logic operation from the selection list in the next row.
6. In the "Criterion" column, open the selection list and select the entry "Priority".
7. In the "Operator" column, open the selection list and select the entry "Less than or equal to".
8. Enter the value "5" in the free text field of the "Setting" column.
9. Confirm your entries with "Apply".
10.Close the "Selection" dialog.
For certain alarm blocks, such as the "date" and "time-of-day" system blocks, you specify the start
and end times or a search text in the "Selection" dialog. Your input must be in the format required
in the dialog.
Note
In multi-user systems, make sure that contents displayed in the "Specify selection" dialog on a
client have the same names on all servers.
When filtering by time, the start and stop values are not adjusted automatically when the time
base of the alarm control is changed.
Example: At the PC location with the time zone "UTC + 1h", the alarm control has the "Local time
zone" time base. You should filter by the time 10:00 to 11:00. Change the time base from "Local
time zone" to "UTC". If you want to display the same alarms, change the filter to 9:00 to 10:00 hrs.
Time-based filtering
During time-based filtering of the alarm control, always define two filter conditions linked via
"And". For these conditions, use the operands "Greater than", "Greater than or equal" and "Less
than or equal".
Do not use the operand "Equal to". When filtering, you specify the filter period down to the
millisecond, but internally the time stamp of alarms is stored precisely down to the nanosecond
and the missing information for nanoseconds is supplemented by 0. A search with "Equal to" will
therefore only find alarms whose time stamp has the nanosecond value 0.
Examples
You can use the following filter conditions to filter for alarms that were triggered between 12:00
and 12:01:
• Filter condition 1: "Tripping time", "Greater than or equal to", 12:00:00.000
• Filter condition 2: "And", "Tripping time", "Less than or equal to", 12:01:00.000
You can use the following filter conditions to filter for alarms that were triggered at 12:00:00.000
hrs:
• Filter condition 1: "Tripping time", "Greater than or equal to", 12:00:00.000
• Filter condition 2: "And", "Tripping time", "Less than or equal to", 12:00:00.001
See also
Display alarms for plant objects (Page 70)
Introduction
In the case of the corresponding configuration, the alarm control shows the alarms of the plant
objects that are configured in the plant hierarchy:
• Automatic display
When the HMI device is assigned to a plant hierarchy or a plant object, and a plant overview
and an alarm control are configured for the screen, the alarm control automatically shows the
alarms of the plant object selected in the plant overview.
• Manual display through filters
If no plant overview is configured in the screen, filter the alarm control to display alarms of
a plant object.
The alarm control offers the following options for plant object alarms:
• Display the hierarchy path of the alarm source
• Filter the alarm control by plant objects
• Display alarm log of a plant object
• Context-dependent display of plant object alarms
General requirements
• The plant hierarchy has been created and a device assigned in the engineering system.
• An alarm control with the column "Area" has been configured in the screen of the assigned
device.
• Runtime is active.
Additional requirements
• Alarms are available for a plant object from the plant hierarchy.
Procedure
1. In Runtime, click the "Selection display" button in the alarm control.
2. Select "Area" as the criterion in the "Alarm filter" dialog.
3. Click the cell of the "Setting" column
4. Click "...".
A tree of the plant hierarchy is displayed.
5. Select a plant object and confirm your selection.
The alarm control shows its setting according to the alarms of the selected plant object or its
lower-level plant objects. The "Area" column shows the complete path of the plant object.
Note
Display of the filter string for filters configured in engineering
The plant view is based on a type/instance architecture. When a filter has been configured in
engineering that filters the alarm view by plant objects, you will first see a filter string with
information from the type level in the "Filter" field of the "Alarm filter" dialog.
If you select an operand under "Operand" or a plant object under "Setting", the filter string
changes to the instance level and adopts the device ID.
Additional requirements
• The alarm log contains entries for a plant object from the plant hierarchy.
Procedure
1. In runtime, click on the "Display logged alarms" button.
The alarm control shows the logged alarms of the plant object.
See also
Filtering alarms (Page 68)
Plant overview (Page 121)
Requirement
• An HMI device has been configured.
• An alarm control is configured in the device screen.
• The plant hierarchy has been created and assigned to the HMI device.
• There are alarms for the plant object.
• Contexts and context entries are available for the plant object.
• The "Select context" button is configured in the alarm control.
Procedure
1. In the alarm control, click the "Select context" button.
The "Alarm context" dialog opens.
2. Click "..." and select the plant object whose data you want to display in the alarm control.
3. Select one of the contexts assigned to the plant object in the "Context" drop-down list.
A list of the entries logged for the context appears under "Logged context values".
4. Select an entry.
5. Click "OK".
The alarm control shows the alarms of the plant object that fall within the time period of the
selected entry. The status bar shows the values of the selected context.
Note
"AND" link with other filters
When a filter is defined for the alarm control, the filter condition and the context conditions are
linked via "AND".
When no alarms appear in the alarm control, check your filter settings by clicking "Selection
display".
See also
Contexts (Page 46)
Introduction
In runtime, you can sort the alarms in the alarm control by column header.
Requirement
• "Allow sorting" is enabled for the respective columns in the configuration of the alarm
control.
• The "Show recent" function is paused in the alarm control.
Procedure
To filter alarms in the alarm control by column, follow these steps:
1. Click the column header by which you want to sort the alarms first.
The number "1" is displayed with an arrow pointing upwards for ascending sort order or an
arrow pointing downwards for descending sort order.
2. Optional:
– To reverse the sort order for this column, click the column header again.
– To cancel the sorting for this column, click the column header a third time.
3. If you want to sort by several columns, click the column header in the required order.
Alternatively, click "Sorting setup" and configure the sorting in the "Sorting" dialog.
Introduction
When you deactivate an alarm, this alarm is not logged. You can lock single alarms, alarm classes
or alarm groups as required.
Note
Deactivated alarm:
Deactivated alarms are no longer deactivated after a restart of the WinCC Runtime. Only alarms
that are deactivated directly in the automation system via data blocks remain deactivated
(deactivated at source).
Deactivated alarm classes / alarm groups:
Alarm classes and alarm groups remain deactivated even after a restart of the WinCC Runtime.
Requirement
• The "Visibility" and "Allow operation" settings have been activated for the following buttons
in the engineering system:
– "Deactivate alarm"
– "Release alarm"
– "Display defined alarms"
• To activate:
The alarm summary "Display defined alarms" is configured so that deactivated alarms are
displayed.
Alternatively: If the "Visibility" and "Allow operator control" settings are enabled for the
"Deactivated alarms setup" button, you can change the alarm summary configuration in
runtime with this button.
• The user is authorized to deactivate and activate alarms.
Note
The "Deactivate alarms" and "Enable alarms" authorizations must be configured directly one
below the other. This is necessary because the authorization level used automatically for the
"Enable alarms" authorization is directly below the "Deactivate alarms" authorization.
Deactivating an alarm
1. In the alarm control, select the alarm summary "Display defined alarms".
2. Select the alarm.
3. Click the "Deactivate alarm" button.
The alarm is removed from the alarm summary.
Activating an alarm
1. In the alarm control, select the alarm summary "Display defined alarms".
2. Select the alarm.
3. Click the "Enable alarm" button.
Notes
• Deactivating or activating an alarm of an Alarm_8(P) via S7PMC, always deactivates or
activates all eight alarms of this block.
• An alarm that has been enabled again appears in the alarm control with the date stamp and
timestamp crossed out.
• When an alarm is enabled again, it is checked by the system and, if the cause still exists,
displayed again.
Introduction
You shelve an alarm for a specific period of time, for example, to prevent that a conformity error
alarm affects the efficiency of your system.
Shelving can be canceled at any time. To do so, you use the buttons "Shelve alarm" and "Unshelve
alarm" in the alarm control in runtime.
Requirement
• The "Visibility" and "Allow operation" settings have been activated for the following buttons
in the engineering system:
– "Shelve alarm"
– "Unshelve alarm"
– "Display defined alarms"
• To unshelve:
The alarm summary "Display defined alarms" is configured so that shelved alarms are
displayed.
Alternatively: If the "Visibility" and "Allow operator control" settings are enabled for the
"Deactivated alarms setup" button, you can change the alarm summary configuration in
runtime with this button.
• An alarm is displayed on the HMI device.
Procedure
To shelve an alarm, follow these steps:
1. In the alarm control, select the alarm summary "Display defined alarms".
2. Select the alarm.
3. Click the "Shelve alarm" button.
The alarm is shelved. Whether the alarm is visible in the alarm summaries for active alarms and
defined alarms depends on the settings of this alarm summary.
Shelved alarms are still available and logged in the system.
Unshelve an alarm
To unshelve an alarm, follow these steps:
1. In the alarm control, select the alarm summary "Display defined alarms".
2. Select the alarm.
3. Click the "Unshelve alarm" button.
If the shelving has been canceled, the alarm is again visible in its last state.
2.8.2.11 Acknowledging
Acknowledgment model
Overview
The state machine is defined for an alarm class. Alarms that are assigned to this alarm class are
acknowledged based on this state machine. The following state machines are used in WinCC:
• Alarm without acknowledgment
This alarm becomes active and inactive without having to be acknowledged. There is no
visible response from the system.
• Alarm with a single acknowledgment
This alarm must be acknowledged as soon as the event that triggers the alarm occurs. The
alarm remains pending until it is acknowledged.
Note
If the "Show recent" button is pressed, the most recent alarm is always shown first. Group
acknowledgment is only executed for the visible and selected alarms.
Acknowledging alarms
The number of alarms to be acknowledged is indicated by a counter at the "Single
acknowledgment" button or, if the alarm control was configured accordingly in engineering, by
the status bar.
Introduction
You can acknowledge alarms in runtime according to your project configuration settings. You
acknowledge alarms as follows:
• In the alarm control with the buttons "Single acknowledgment" and "Group
acknowledgment", and for alarms with dual-mode acknowledgment also with the button
"Single confirm".
• With customized buttons
When an operator authorization is configured for the operator controls, the alarms can only be
acknowledged by authorized users.
Acknowledgment variants
You acknowledge individual alarms or multiple alarms together in runtime. The following
options are possible:
• Single acknowledgment
Acknowledgment of an alarm using the "Single acknowledgment" button of the alarm
control.
• Group acknowledgment
Acknowledgment of all pending, visible alarms that require acknowledgment in the alarm
control using the "Group acknowledgment" button in the alarm control.
• Dual-mode acknowledgment
When an alarm requires dual-mode acknowledgment, you acknowledge the activation and
deactivation of the alarm or you acknowledge the alarm and reset it with the "Single
confirm" button in the alarm control. The alarm status changes from "Active/Acknowledged"
to "Inactive".
Procedure
To acknowledge an alarm, follow these steps:
• Read the alarm texts of the pending alarm and perform corrective measures, if necessary.
• Select the alarm.
• Click "Single acknowledgment" in the alarm control.
Result
The alarm status is set to "Acknowledged". When the trigger condition for an alarm no longer
applies, the alarm status is set to "Inactive" and no longer displayed on the HMI device.
Procedure
For group acknowledgment of alarms, follow these steps:
1. Read the alarm texts of the pending alarms and perform corrective actions, if necessary.
2. Click the "Single confirm" button in the alarm control.
Result
All pending alarms with the following properties have been acknowledged:
• Requires acknowledgment
• Does not require single acknowledgment
• Visible
Logging basics
Introduction
An alarm log is used to document the alarms of the project. Alarm logs are created by the system.
If an error or limit violation occurs, for example, an alarm is output in runtime. Each alarm event
of an alarm is logged, such as the status change of the alarm from "Alarm active" to "Alarm
acknowledged".
You can store the alarm events in a log database and/or log them to hardcopy as an alarm report.
You can output the alarms stored in the database in runtime, for example, in an alarm control.
The logged alarms are stored in a circular log that consists of multiple single segments.
Note
The time stamp of a logged alarm is always specified in standard UTC format (Universal Time
Coordinated).
Because the alarm configuration is language-specific, the logs contain a configuration data table
for each language configured.
Introduction
When you want to access the data of an archived alarm log, connect the log backup to the
project. You can configure an automatic connection or connect the alarm log to the project via
a script. The logged alarms are displayed in the alarm control.
If you no longer want to access the backup of a log segment, disconnect the log backup from the
project.
Requirement
The relevant backup files in "*. ldf" and "*.mdf" format are stored locally.
Example
You have configured the time range so that only the alarms of the past 24 hours are displayed.
When you connect to a log backup containing alarms that are older than 24 hours, these alarms
are not included in the alarm control.
Introduction
The alarm control not only displays current alarms but also logged alarms.
Requirements
• All logged data that is to be displayed must be stored locally on the logging server. The SQL
server does not allow access to backup files held elsewhere, such as another computer on the
network.
• The buttons "Show logged alarms" and "Show and update logged alarms" are configured in
the alarm control.
Procedure
To display logged alarms, follow these steps:
1. In the alarm control, click the "Show logged alarms" button to display logged and current
alarms. Only logged alarms are displayed.
2. In the alarm control, click the "Show and update logged alarms" button to display logged and
current alarms. Any new incoming alarms are updated immediately in the control.
Introduction
The alarm statistics represent statistical calculations of logged alarms.
You can use a button in the alarm control to export the alarm statistics to an Excel file.
Note
Filter
A filter set in the alarm control is not effective in the alarm statistics.
Note
Display options
Display options selected via the "Display options setup" button in the alarm control are not
effective in the alarm statistics.
Requirement
• Alarms are logged.
• For the following button of the alarm control, the "Visibility" and "Allow operator control" are
enabled in the engineering system:
Alarm statistics
Procedure
To display the alarm statistics in Runtime, proceed as follows:
1. Click the "Alarm statistics" button in the alarm control.
Result
The alarms to be displayed in the alarm statistics are specified in the engineering system.
Depending on the engineering system, the following columns are displayed:
Column Description
Number Configured number of the alarm.
Frequency Frequency of an alarm. The system counts the number of occurrences of
an alarm with "active" status in the log. If the alarm number is not found,
this alarm number is not included in the statistics.
Sum active active Total display time of an alarm in seconds. The time period between the
alarm states "active" and "active" is calculated.
Sum active inactive Total display time of an alarm in seconds. The time period between the
alarm states "active" and "inactive" is calculated.
Sum active acknowledged Total display time of an alarm in seconds. The time period between the
alarm states "active" and "acknowledged" is calculated.
Average active active Average display time of an alarm in seconds. The time period between
the alarm states "active" and "active" is calculated.
Average active inactive Average display time of an alarm in seconds. The time period between
the alarm states "active" and "inactive" is calculated.
Average active acknowledged Average display time of an alarm in seconds. The time period between
the alarm states "active" and "acknowledged" is calculated.
The calculation of the time of acknowledgment includes the "acknowledged" alarm state. This
"acknowledged" alarm state includes the acknowledgment by the controller.
Note
For the calculation, alarms in the "acknowledged" and "inactive" states are only used if a suitable
alarm with "active" state is found in the result set beforehand.
If an alarm from the controller is pending and Runtime is disabled and enabled several times, the
alarm is entered into the log several times with the state "active". The alarm will also be included
multiple times in the evaluation.
Introduction
Using the statistics setup, you can change the settings for calculating the alarm statistics. The
following settings are available:
Setting Description
Time range start • Now
The current time is displayed as the start time of the calculation.
• Fixed
The start time of the calculation can be changed as required.
Start time Start time for the calculation. If the "Now" option is selected under "Start
time range", the start time cannot be changed.
Time range base Unit of time for the calculation. The following settings are available:
• Undefined
The default time unit "Minute" is used with this setting.
• Millisecond
• Second
• Minute
• Hour
• Day
• Month
• Year
Time range factor The time range factor depends on the "Time range base" setting. For
example, if the number 4 is set for the time range factor and "Minutes" is
set for the time range base, all alarms that are logged within this period
will be evaluated.
Requirement
• Alarms are located in the alarm log.
• For the following button of the alarm control, the "Visibility" and "Allow operator control" are
enabled in the engineering system:
Statistics setup
Procedure
To display the statistics setup in Runtime, follow these steps:
1. Click the "Statistics setup" button in the alarm control.
Setup opens.
2. Change the settings as required.
3. Click "OK".
Result
The calculation of the alarm statistics is displayed according to the changed settings.
Overview
With WinCC you can output tag values in the HMI screen with different screen objects and
change them.
• The I/O field is used for the input and output of process values.
• Bars are used for graphic display of the process values in form of a scale.
• Sliders are used for the input and output of process values within a defined range.
• The gauge is used to display the process values in form of an analog gauge.
In runtime you can also output tag values as table or as trend. You can use either process values
or logged values as source for the tag values.
• Use a trend for the graphic display of tag values. Trends allows you to display the change in
motor temperature, for example.
• Use a table to compare tag values. In the table you can, for example, compare fill levels of
supply tanks.
Displayed values
When configuring the trend control, specify which tag values are to be displayed.
• "Online": The trend is continued with current individual values from the PLC.
• "Log": In runtime, the trend control displays the values of a tag from a data log. The trend
shows the logged values in a particular window in time. The operator can move the time
window in runtime to view the desired information from the log.
Introduction
You can continue the update of the data contained in the control with the "Start/Stop" buttons.
Some buttons stop the update automatically, e.g. "Define statistics area"
The appearance of the button indicates whether the update is stopped or not:
The update has been stopped. To continue the update, click on the button.
The update has been started. To stop the update, click on the button
Introduction
You can generate an analysis of the process data for the Runtime data in the trend or process
control. You can display the evaluated data in the trend companion.
Overview
Use the following buttons to create statistics of runtime data:
"Start/stop"
"Statistics area"
Requirement
• A trend control or process control is configured.
• A trend companion is configured and connected to the trend or process control.
• Runtime is activated.
Requirement:
The "Statistics area window" display mode is activated in the trend companion.
To display data in the statistics area window of the trend companion, proceed as follows:
1. In the trend control or process control, click "Stop".
The updated display is stopped, the process data continues being logged.
2. If you wish to evaluate data outside the displayed time range:
– Click "Select time range".
The "Time - Selection" dialog opens.
– Enter the required time range.
The data for the defined time range is displayed.
Note
For additional statistical analysis of process data and logging of results, you can write the scripts
yourself.
Introduction
Scroll through the displayed data of a log using the buttons in the toolbar of a trend or process
control. If key combinations are configured, you can also use these for scrolling.
The buttons for browsing in logs are available only if data is supplied through logging tags.
The logged values of a tag are displayed within a time range in the trend or process control.
Overview
Use the following buttons to display logged values:
"Last record"
Requirement
• Time range is configured.
"Line 1"2 Selected line Shows the number of the selected line.
"Column 2" 2
Selected column Shows the number of the selected column.
"23.02.2010" Date Shows the system date.
"23:59:59" Time Shows the system time.
Time base Shows the time base used in the display of times.
1
: If you double-click on the "Connection status" icon, the "Status of the data connections" window opens.
The following properties of each data connection are listed in the window:
• Name
• Status
• Tag name
2
: Only in the process control
Exporting values
Requirement
• The "Export" button is configured in the control.
Procedure
1. Optional: For the export of a trend control, check the time format for the time axis
configured in the control.
The time axis of the export file takes on the time format configured in the control.
2. Click "Export" in the control.
3. Enter the name of the target file.
4. For the trend companion and process control: Choose whether all values are exported or just
the values selected in the control.
5. Optional: Using "Select format", determine which separator and which character set the
target file uses.
Note
Displaying Asian languages correctly in MS Excel
If Runtime is running in an Asian language, select the character set "UTF-8".
Function
The trend companion displays values or statistics from a control. The content of the trend
companion is specified during its configuration.
Display mode
Three different display modes are available in the trend companion.
• Ruler window
The ruler window shows the coordinate values of the trends on a ruler or values of a selected
line in the table.
• Statistics area window
The statistics area window shows the values of the low limit and high limit of the trends
between two rulers or the selected area in the table. You can only connect the statistics area
view to the trend control or the process control.
• Statistics window
The statistics window displays the statistical evaluation of the trends. Among other things,
the statistics include:
– Minimum
– Maximum
– Average
– Standard deviation
– Integral
All windows can also display additional information on the connected trends or columns, such
as time stamps.
Note
With version V16, the "Trend companion" control is supported only for Unified PC. If you use the
control under Unified Comfort Panel, an error message of the compiler is returned. Existing
projects under Unified Comfort Panel in which the control is configured must delete the control
before compilation to version V16.
With the "Trend companion", you display evaluated data and statistics of a control in a table.
Ruler window Displays a ruler that shows the coordinates of the intersection point
with a trend in the trend companion.
Requirement: The trend companion is configured with "Ruler win‐
dow" display mode.
Print Starts the printout of the values shown in the table.
Previous record Shows the trend direction of the previous time range.
Start/stop Stops and starts the trend update. The values are buffered and up‐
dated as soon as you start the trend update again.
Next record Shows the trend direction of the next time range.
Last record Shows the trend direction up to the last logged value.
Requirement: The values come from a process value log.
Zoom value axis Zooms in or out of the value axis in the trend control.
+/-
Zoom area Zooms in on the section of the trend control. You define the section
by dragging with the mouse.
Use the "Original view" button to return to the original view.
Zoom +/- Enlarges or reduces the view in the trend window.
Original view Returns to the original view from the zoomed display.
Select time range Opens a dialog in which you configure the time range.
Select trends Opens a dialog in which you set the visibility and sorting of trends.
Select data con‐ Opens a dialog in which you select the data source:
nection • Process value log
• Tag
• Recipe (only function trend control)
Statistics area Enables you to define a time range for which statistical values are
determined. Vertical lines which you use to set the time range are
displayed in the trend window.
Statistical analysis Opens a statistics window to display the minimum, maximum, aver‐
age, and standard deviation for the selected time range and the
selected trend.
Print Starts printing the trends shown in the trend window.
Zoom area Zooms in on the section of the trend control. You define the section
by dragging with the mouse.
Use the "Original view" button to return to the original view.
Zoom X axis plus Zooms into or out of the time axis in the trend control.
minus Left-click: Zoom in
<Shift + Left-click>: Zoom out
Use the "Original view" button to return to the original view.
Ruler Displays a ruler that shows the coordinates of the intersection point
with a trend in the trend companion.
Requirement: The trend companion is configured with "Ruler win‐
dow" display mode.
Move trend area You can move the trends in the trend window along the X axis and the
Y axis using the button.
Move axes area You can move the trends in the trend window along the value axis
using the button.
Select time range Opens a dialog in which you configure the time range.
Select data con‐ Opens a dialog in which you select the data source:
nection • Process value log
• Tag
• Recipe
Print Click this button to print the trend shown in the trend window. The
print job used during printing is defined in the configuration dialog in
the "General" tab.
Export data This button is used for exporting all or the selected runtime data to a
csv file.
Value aggregation
Introduction
If the number of process values or archive values to be displayed for the selected time range in
a trend control is larger than the number of pixels available for the trend, they will be aggregated.
Which values are aggregated to a trend value depends on the loading time of the trend control.
For this reason, screen changes can result in a change of the trend line.
Avoid aggregation
To avoid that values are aggregated, select a shorter time range or enlarge the width of the trend
control.
Example
• Pixels available for the trend: 600
• Measuring interval of the tag set as the data source: 10 times per s
• Time range: 10 minutes,
i.e. in the selected time range, 6000 values are measured or logged. When drawing the trend,
10 values are aggregated to each trend value.
The trend displays different values depending on the loading time. The following graphics
illustrate how the last two aggregated trend values change when the loading time is 11:00:0019
instead of 11:00:0024.
• Loading time 11:00:0019:
Introduction
In Runtime, you configure online and thus change the appearance of the trend control.
During the configuration of the trend control, it is specified whether online configurations are
retained or discarded during a screen change or after Runtime is ended.
Overview
Use the following buttons to configure the trend control in Runtime:
"Select data con‐ Opens a dialog in which you can set the source from which a con‐
nection" figured trend is supplied.
Possible sources are the tags or logging tags of an HMI device or
plant object and UDTs.
"Select trends" Opens a dialog in which you set the visibility and sorting of trends.
"Select time Opens a dialog in which you configure the time range.
range"
See also
Select data connection of a trend (Page 105)
Note
Scrolling in a zoomed in trend control
When the trend control is zoomed in, you can scroll using the mouse wheel:
• Move the mouse wheel to scroll up or down.
• Press <Shift> and move the mouse wheel to scroll to the left or right.
Introduction
Key functions can be used for zooming in on, zooming out of and returning to the original view
for trends, axes and various zoom areas of the trend window.
Overview
The following zoom functions are available in the trend window:
Requirement
• The trend control is open
• Buttons with zoom functions are configured
• Runtime is activated
Note
If you change the value area of a value axis on the "Value Axis" tab in the configuration dialog
while zooming, the visible zoom area is set to the new value area.
Sorting trends
If a trend area contains multiple trends, you can select the order of the trends.
You have the following options:
• Specify the top trend
• Specify the order of all trends
Requirement
The "Select trend" button is configured in the toolbar.
Procedure
1. Click "Select trend" in the toolbar.
2. Click on a trend.
3. Move the trend to the selected position using the buttons.
4. Repeat these steps for the other trends.
Requirement
The "Select trend" button is configured in the toolbar.
Procedure
1. Click "Select trend" in the toolbar.
2. Disable the trend option to hide a trend.
3. Enable the trend option to show a trend.
Introduction
The "Ruler" button is used to determine the coordinates of a point on the trend by means of a
ruler. You can zoom in on an area of the trend to make coordinate finding easier. If you display
the ruler in the trend control, you can move the ruler at any time.
If you click on the trend with the mouse, several trend parameters are shown in the tooltip for
the trend control.
Requirement
• A trend control is configured
• A trend companion is configured and connected with the trend control
Procedure
Proceed as follows to determine the coordinates of a point:
1. Click "Ruler" in the trend control.
The ruler is shown.
2. Move the ruler to the desired position with the mouse.
3. If you want to zoom in on an area, click on "Zoom area".
– Move the ruler to the desired position with the mouse.
– To return to the original view, click "Original view".
Result
In the ruler window of the trend companion, besides the X value/time stamp and the Y value, the
data that you have configured in the trend companion is shown in the columns.
In the trend companion, the indices "i" and "u" can be displayed in addition to the values:
• "i.": The displayed value is an interpolated value.
• "u.": The displayed value has an uncertain status:
– The start value after Runtime activation is unknown
– A substitute value is used
Note
You can also display the "uncertain" status of a value in the displayed trend curve. You
must activate the "Value with uncertain status" option on the "Trends" tab under "Limits".
Alternative procedure
Alternatively, you can also connect the trend companion to the process control. In the "ruler
window" display mode, the values of the selected row are displayed in the trend companion.
Requirement
• An HMI device has been configured.
• A trend control is configured in the screen of the device.
• To display logging tags: A data log has been configured.
• To display the tags of a plant object: The plant hierarchy has been created and assigned to the
HMI device.
• Runtime is active.
Procedure
1. Click on "Select data connection" in the toolbar of the trend control.
The "Selection of logs/tags" dialog opens.
2. Click "Trend:" and select a trend.
3. Click "Tag".
The "Browser view" dialog opens in which you specify how the selected trend is supplied with
data.
"Small icons"
"List"
"Details"
"CPM" Shows the plant hierarchy and the plant object tags.
"CPM logging tags " Shows the plant hierarchy and the logging tags of the plant ob‐
jects.
7. In the tree, select the object whose data you want to display in the trend control.
8. Select a tag as the data source.
9. Confirm your entries.
The values of the tags are displayed in the trend control. If the path belongs to a plant object, the
path of the plant object is also shown in the trend control.
Procedure
The following table shows the configuration options for the time range:
Field Description
Time axis Select the configured time axis for which you want to define a time range.
Time range Set the time range:
• If you want to define a fixed time interval, select the setting "Start to end time". Enter the date and time
for each.
• If you want to define a time period, select the setting "Time range". Define the date and time for the start
time. The length of the time interval to be displayed is determined by multiplying the "Factor" by the
"Unit of time".
• If you want to display a certain number of values, select the setting "Number of measuring points".
Define the date and time for the start time. Enter the desired number of measuring points in the input
field.
This section describes how to show context-dependent data of a plant object in the trend control.
The evaluation is relevant, for example, in connection with the WinCC Performance Insight in
order to analyze the effectiveness or the fault rate of the plant.
Requirement
• A trend control is configured in the screen of an HMI device.
• The plant hierarchy has been created and assigned to the HMI device.
• The data source of one of the trends in the trend control is a plant object.
• To display the logging tags of the plant object: A data log has been configured.
• Contexts are available for the plant object.
• The "Select context" button is configured for the trend control.
Procedure
1. In the trend control, click "Select context".
2. Select the plant object set as data source.
3. Select one of the contexts assigned to the plant object in the "Context" drop-down list.
A list of the entries logged for the context appears under "Logged context values".
4. Select an entry.
5. Click "OK".
Result
The time period of the selected entry is applied to the time axis of the trend area. The trend
represents the data that falls within the time period of the selected entry.
Note
Effect on other trend areas
If the plant object selected as data source has multiple interface tags and trends from other trend
areas of the trend control display these tags, their time axes are also updated accordingly.
See also
Select data connection of a trend (Page 105)
Contexts (Page 46)
"Select data connec‐ Opens the dialog for selecting the logs and tags of an 9
tion" HMI device, plant object or PLC that serve as data source
for this table view.
"Create archive val‐ Creates a table entry for a log value. 10
ue" Enter the log value manually. Its time stamp corresponds
to the time at which you added the table entry.
"Delete archive val‐ Deletes a logged value. 11
ue"
Introduction
In Runtime, you configure online and thus change the layout of the process control. The process
control configuration specifies whether online configurations are retained or discarded on a
screen change or after Runtime is ended.
Overview
The following buttons make online configuration possible in process control:
Field Description
Value column Choose the configured value column for which you want to change the data con‐
nection.
Data Source Define whether the selected value column is supplied with a logging tag or online
tag.
Tag name Select the tag name for the data connection.
Field Description
Time column Select the configured time column for which you want to define a time range.
Time range Set the time range:
• If you want to define a fixed time interval, select the setting "Start to end time". Enter
the date and time for each.
• If you want to define a time period, select the setting "Time range". Define the date
and time for the start time. The length of the time interval to be displayed is deter‐
mined by multiplying the "Factor" by the "Unit of time".
• If you want to display a certain number of values, select the setting "Number of
measuring points". Define the date and time for the start time. Enter the desired
number of measuring points in the input field.
Introduction
You change the values displayed in the process control manually using the "Edit" button.
Overview
The following buttons allow you to edit the table fields:
"Start/stop"
"Edit"
Requirement
• The process control is configured
• The "Edit" button is configured
• Runtime is activated
Procedure
Proceed as follows to edit a table field in Runtime:
1. Click "Stop" in a process control.
The updated display is stopped, the process data continues being logged.
2. Click "Edit".
3. Double click on the desired table field of a value column.
4. Enter the new value.
The changed value is logged.
5. To continue with the display of Runtime data in the process control, click on "Start".
Application
The "Screen window" object is used to display other screens of the project in the current screen.
To continuously update the content of a screen window, for example, the object must be
dynamized. User-defined menus and toolbars can be used to add specific buttons to the screen
window.
You can also use independent screen windows independently of the screen in question. With
appropriate hardware equipment and support by the operating system, you can also control
multiple monitors and map processes in a more comprehensive and differentiated manner.
Layout
The settings for the position, geometry, style and color of the object are made during
configuration.
In particular, the following properties are changed:
• Zoom factor: Defines the size of the embedded screen.
• Screen section: Defines the section of the embedded screen that is displayed in the screen
window. If the embedded screen is larger than the screen window, you configure scroll bars
for the screen window.
• Independent screen windows: Specified that the screen windows are displayed
independently from the screen in which they were configured.
Note
Cascading screen windows
Screen windows can also display screens which, in turn, contain screen windows. Up to 14
cascaded screen windows can be displayed.
Introduction
The "Browser" control is designed for the visualization of simple HTML pages. It allows creation
of centrally stored machine-specific descriptions, which are displayed from different HMI
devices.
You have access to the data of the local user management in Runtime via a browser.
Note
Switching the functionality of the web control as a file explorer, in the following ways, for
example, is not enabled in WinCC:
• Entry of a folder or drive, e.g. "\" or "C:", or
• Connection to an FTP server, for example, "ftp://"
One reason this function is not implemented is to prevent inadvertent changes to files, their
deletion or execution.
When configuring, ensure that the operator can only enter valid Internet addresses, for example,
by using symbolic I/O fields. Configure a password-protected input for service purposes.
Note
Page navigation in the web control
Whether you can navigate back and forth between the pages that you have viewed in the web
control depends on the browser and browser versions in which Runtime is running. If the
browser or browser versions do not support page navigation, the buttons in the web control are
disabled.
Displayed content
Remember the following notes when using the control:
• The "Browser" control only shows contents that are supported by the browser in which
Runtime is open.
• The control is implemented as IFrame. Pages with X-Frame option settings that prevent the
display in an IFrame are not displayed in the control.
• As compared to a standard browser, the "Browser" control has limited functionality:
– Navigation from the "Browser" control is not supported (top-level navigation).
– Calls of queries and dialogs (pop-ups and modal dialogs) are only supported if they were
activated in the file <Path for the WinCC Unified installation directory>WinCCUnified
\WebRH\public\content\custom\CustomSettings.json:
{"CustomSettings": {"HmiWebControl" : {"AllowPopups" :
true,"AllowModals" : true}}}
Note
Pop-ups and modal dialogs stop the update.
– Links to embedded files, for example, *.pdf or *.xls, are not supported.
– Queries and dialogs that are conducted during the access of, for example, protected
pages are not supported.
Use
In Runtime, the media player is used to play multimedia files via an https connection.
Layout
The settings for the position, style and color of the object are made during configuration.
In particular, the following properties are changed:
• Display operator controls: specifies the operator controls in Runtime.
• Show tracker: establishes, whether a slider is available for the operation.
Restrictions
Note
Play restrictions
• The web control security settings do not allow local files to be played.
• Playing multimedia files in the Runtime control system depends on factors such as the
installed operating system, the browser used and video and audio codecs installed on the
machine.
Examples:
– Internet Explorer does not play any video file with an embedded .wav audio file.
– Most browsers do not support .avi files.
• The browser determines which video formats are supported.
You can find an overview of the video formats supported by popular browsers here (https://
www.w3schools.com/html/html5_video.asp).
You can find a detailed overview of the browser version used or between browsers here
(https://html5test.com/compare/browser/index.html).
• iOS guidelines for the <video autoplay> element are available here (https://webkit.org/blog/
6784/new-video-policies-for-ios/).
Note
Requirements for video files
To play video files in the Windows Server 2008 R2 SP1 and 2012 R2, install the Microsoft feature
"Desktop Experience". You will find more detailed information on this topic on the Internet in the
Microsoft documentation.
Note
Data loss when copying the project
If you copy the project to another PC, keep the following in mind:
Files indicated in the WinCC Media Control are not copied along with the other files if they are
dynamically linked and no UNC path is specified. You have to load the files into the project again.
Layout
In Runtime, the diagnostic messages of the selected PLC are displayed in the "System diagnostics
control". The selected PLC can be changed using the buttons ④. Once Runtime has started, the
events of the PLC with the most serious error are displayed.
3 4 5 6 7
① Grid view
② Detail view
③ Update the view of the diagnostics event
④ Switch to the next or previous PLC
⑤ Navigation buttons for the grid view:
jump to the first line
jump to the previous line
jump to the next line
jump to the last line
⑥ Enable/disable detail view
⑦ Status text field
The diagnostic buffer displays the diagnostics events of a PLC in a grid view ①. The grid view
shows the last 200 diagnostics events of the PLC.
The first column shows the number of the entry.
The symbols in the second column indicate the event type of the PLC:
Device in operation
Maintenance required
Maintenance necessary
You can see the symbols of the incoming or outgoing status in the third column:
Incoming event
Outgoing event
The fourth column shows the date and time of the event. You can see the event message in the
last column.
Below the grid view, the detail view ② of the selected row from the grid view is displayed. You
can enable or disable the detail view with the button ⑥.
When the screen is loaded, the "System diagnostics control" shows the PLC with the most severe
error. If several PLCs are configured for system diagnostics, you can use the toolbar buttons ④ to
switch to the next or previous PLC.
To update the "System diagnostics control", select the toolbar button ③. For performance
reasons, no automatic update is performed.
At the bottom of the window, a status field ⑦ is displayed with the diagnostic status and the
name of the station/PLC.
Languages in runtime
The alarms are displayed in the RT language selected by the user in the screen logon dialog. The
Runtime language and the PLC language should be identical.
The PLC supports only three languages, which can be configured by the user in the engineering.
If the PLC language and the Runtime language are different, the event text is displayed as follows
according to the fallback mechanism:
• English US
• English UK
• the standard text "## text is missing ##"
Introduction
Note
With version V17, the "Plant overview" control is supported only for Unified PC. If you use the
control under Unified Comfort Panel, an error message of the compiler is returned. If the control
is configured for the Unified Comfort Panels, it must be deleted before the compile.
The "Plant overview" object shows you the configured plant hierarchy in Runtime. In the plant
overview, you can navigate through the system to the plant objects and see the plant at a glance.
With the corresponding configuration of the lower-level plant objects and the assigned HMI
device during the engineering, the plant overview also offers you the following options:
• Obtaining an overview of the plant objects for which alarms are available
• Displaying the alarms of a plant object
• Display of configured screens of a plant object.
1 Toolbar
2 Menu bar
3 Filter bar
4 Plant tree
5 Alarm icon
Alarms are available for the plant object or one of its lower-level plant objects.
The following buttons are available in the toolbar and in the filter bar:
Collapse all Recursively collapses all lower-level plant objects of the selected
plant object.
When configuring in the engineering system, you can hide the toolbar and menu bar.
Requirement
• The plant view has been created and assigned to an HMI device.
• The "Plant overview" object is configured in the screen of the assigned HMI device.
• Optional:
– The "Dynamic" navigation type is configured in the engineering system for the plant
overview.
– A root node is configured in the engineering system for the plant overview.
• Runtime is active.
Operation
• To see which lower-level objects a plant object displayed in the menu bar has at the next level,
click the arrow in the menu bar next to the plant object.
• To go from the menu bar to the overview, click on one of the plant objects shown in the menu
bar.
Dynamic navigation
If dynamic navigation is activated in the engineering system, specify the level from which the
plant tree is displayed.
The buttons of the toolbar and the filter bar relate to the displayed area.
• To select a plant object, click on the object in the menu bar or double-click on the object in
the plant tree.
The levels below the selected plant object are available.
• To navigate up one level, click on the up arrow next to the plant object.
Root node
You have the option of defining a root node in the engineering system.
If a root node is configured, the root node and all objects below the root node are available in the
plant overview.
See also
Display alarms for plant objects (Page 70)
Requirement
• The plant view has been created and assigned to a device.
• The "Plant overview" object is configured in the screen of the assigned device.
• The objects "Alarm control" and "Screen window" are configured in the screen of the assigned
device and configured as companion controls of the plant overview.
• Screens are configured at the plant objects.
• Runtime is active.
Display alarms
To display the alarms of a plant object, click on the alarm icon.
The alarm control shows the alarms of the plant object.
Note
The alarm icon only appears when an alarm has occurred at the respective plant object or one
of its lower-level objects. The alarm icon disappears again when the alarm is no longer present.
Note
"$POName$" is an expression with which the name of the plant object is resolved.
Introduction
Note
With version V16, the "Parameter set control" is supported only for Unified PC. If you use the
control under Unified Comfort Panel, an error message of the compiler is returned. Existing
projects under Unified Comfort Panel in which the control is configured must delete the control
before compilation to version V16.
Set up the machine for production in Runtime using parameter sets. The elements in a
parameter set are defined in engineering by defining its parameter set type.
In Runtime, the parameter sets are displayed in the parameter set control. In the control, you
manage the parameter sets and load a parameter set into the PLC to set up a machine for
production.
Example
A bakery generates the following parameter set types in the engineering system:
• Bread
• Bread rolls
• Cake
The elements of the parameter set types define the ingredients of these products. For example,
the parameter set type "Bread" has the following elements:
• Flour
• Salt
• Syrup
• Yeast
• Water
In Runtime, the bakery creates parameter sets for the "bread" parameter set type for the bread
types to be produced:
• White bread
• Wholewheat bread
• French bread
The quantities required for this type of bread are entered in the elements.
During production, an operator selects the parameter set to be produced next and writes it to the
PLC.
User interface
Note
Fixed parameter set type
The parameter set control in the engineering system can be configured so that you are only
offered the parameter sets of a certain parameter set type and cannot select any other parameter
set types.
Button Function
Create Creates a new parameter set.
Save as Opens the selection dialog for the storage path of the
selected parameter set.
Write to PLC Save the parameter set and writes it to the PLC.
Read from PLC Reads a Parameter set type or parameter set from the PLC.
Requirements
• Parameter set types were configured in the engineering system.
• The parameter set control is configured in the screen of the device that is active in Runtime.
3. Optional: Enter the name of the new parameter set in "Parameter set name".
The name must be unique for the parameter set type.
4. Optional: Enter the ID of the parameters set in "Number".
The number must be unique for the parameter set type.
5. The find the values of the parameters set by clicking in a table cell and modifying the value
predefined by the parameter set type.
6. Confirm.
The parameter set is created and saved.
Requirements
• Parameter set types were configured in the engineering system.
• The parameter set control is configured in the screen of the device that is active in Runtime.
• A parameter set was created in Runtime.
Procedure
1. In the parameter set control, select a parameter set type under "Parameter set type".
2. Select a parameter set in "Parameter set".
The parameter set table loads the columns and values defined for the parameter set.
3. The new parameter set is created.
4. Click in a table cell and enter a new value.
5. Click the "Save" button.
Requirements
• Parameter set types are configured in the engineering system.
• The parameter set control is configured in the screen of the device that is active in Runtime.
• Write to the PLC: Parameter sets are available in Runtime.
Result
• Unsaved data of the parameter set is saved.
• The parameter set is written to the PLC of the parameter set type.
Result
• The parameter set or the parameter set type and a parameter set are read in.
• The parameter table is updated.
• The parameter set that is created for the imported parameter set type has the default values
defined in the type.
Note
A parameter set cannot be read from the PLC if minimum and/or maximum values are defined
for a parameter set type element and the value in the parameter set to be transferred is outside
this range. A message is output.
Requirements
• Parameter set types are configured in the engineering system.
• The "Parameter set control" control is configured in the screen of the device that is active in
Runtime.
• For the export: Parameter sets are available in Runtime.
Import
1. Click "Import" in the parameter set control.
2. In the dialog "Import - Parameter set", select a TSV file with parameter sets.
3. To overwrite parameter sets in the parameter set control that have the same IDs as the
imported parameter sets, activate the "Overwrite" option.
Note
If you deactivate overwriting and if a parameter set with the same ID or the same parameter
set name exists in the parameter set control, the import of parameter sets is not possible.
Any added parameter sets whose IDs and parameter set names deviate from the existing
parameter sets are imported regardless of the "Overwrite" option.
4. Select "Check checksum" when importing a parameter data record that was exported with
the "Generate checksum" option.
5. Click "OK".
Result
• The parameter sets from the file is stored in the database.
• In selecting your parameter set type, you will be prompted to select under "Parameter set".
• If the currently loaded parameter set was part of the import, it will be updated accordingly
in the parameter set control.
Export
1. Select a parameter set type in the parameter set control.
2. Click the "Export" button.
3. In the dialog "Export - Parameter set", select a storage location for the file with parameter sets.
4. Set the formatting settings:
– Select the file format.
– Select the list separator.
– Select the decimal character.
– Select "Generate checksum" to export the parameter data record with a checksum.
Parameter data records with a checksum cannot be imported if they have been
manipulated in the meantime.
5. Click "OK".
Result
All parameters of the parameter set type are exported.
2.8.11 Reports
2.8.11.1 Basics
Reporting in Runtime
Note
Restriction for Unified Comfort Panel
Audit and contexts are not supported in V17 for Unified Comfort Panel. These options are not
available in a report template with a Unified Comfort Panel as data source. If you generate a
report on a Unified Comfort Panel whose report template uses these options, error entries are
generated in the "ErrorLog" worksheet of the report.
Introduction
With WinCC Unified Reporting, you can generate tabular production logs (reports) in Runtime for
the following project data:
• Logging tags and tags
• Log alarms
• Contexts:
– User-defined contexts:
These contexts are created and executed by a program created with the ODK API.
– System-generated contexts
When the Performance Insight and Calendar option packages are installed, these
contexts are executed by the system during Runtime.
• Audit trail of the Runtime device
• If Plant Intelligence options are installed, you can use the WinCC Unified Local Reporting
option to generate production logs for additional project data.
You can find more information in the Help for the respective Plant Intelligence option.
The production reports can be generated as XLSX file or PDF file and sent automatically as an e-
mail to a specified group of recipients. For example, you can generate an XLSX report that
outputs all alarms occurring in a production line. You then distribute or archive the report for
analysis purposes.
Functional scope
In the "Reports" control in Runtime, you configure report jobs that use the report templates
defined in the Excel add-in. To do so, Reporting offers the following functions in Runtime:
• Maintenance of the global e-mail settings (contact data and SMTP server configuration)
• Maintenance of job parameters, especially import and export of report templates
• Creating new report jobs and managing existing report jobs
• Overview of the generated reports
• Download or deletion of the reports
Basics of Reporting
Report templates
A report template is an Excel file (.xslx) that was created with the WinCC Unified Excel add-in. The
report template has access to the data of the data source with which the add-in is connected.
For each report template, you define which segments are contained in the reports using the
template and which data source items are evaluated by the segments.
After you have imported report templates into the "Reports" control in Runtime, you can select
them for configuring report jobs.
Data sources
The data source is the source from which you select data source items when you configure the
report template.
The following connection modes and data sources are available:
• Connection mode: Online
The data source is the project that is running on the Runtime server to which the add-in is
connected.
• Connection mode: Offline
Data source is a configuration file. You generate the configuration file by exporting the data
source items of the project to a file in the "Reports" control in Runtime. You can use this file
to create additional report templates without connecting to a runtime server.
Reports
A report (production report) is an XLSX file or PDF file that is generated when a report job is
executed in Runtime. The data source items from the Runtime project defined in the report
template are read during generation, and their data are imported into a table in the report.
Note
Note the Microsoft upgrade restrictions
If you have an Excel installation that cannot be upgraded to Build 16.0.6769 or higher (for
example, because Excel was installed using a single Office license), purchase a current Office
version or use Online Office.
See also
Version compatibility (Page 137)
Version compatibility
Introduction
When loading a Runtime project for which the "Reports" control has been configured, the
general rules for version compatibility of WinCC Unified apply.
The rules described here also apply for the interaction between add-in, data source, report
template and runtime version of the project in which reports are generated.
Note
Migration of report templates
The migration of the report template is not reversible. A report template migrated from V16 to
V17 can no longer be opened in a V16 add-in.
If migration is not desired, connect the add-in to a V16 data source before opening the report
template.
Note
Scope of functions of report templates
The functions available in the configuration of the report template in the add-in depend on the
version of the data source used by the add-in.
Introduction
The following workflow describes which works are required in the "Reports" control so that
reports (production records) are generated in Runtime.
The reports can be stored as file in the file system and sent as an attachment to an e-mail.
Alternatively, an e-mail without attachment can also be sent about the generation of the report.
In this way, employees from management and production can be informed about the
production situation promptly, regardless of their location.
You can send the e-mail using a secure SMTP server (authentication with user name and
password or via certificate) or an unsecured SMTP server, for example, an internal company mail
server.
Requirement
• In engineering, the necessary project data were configured for the HMI device for which
reports are to be created.
• The "Reports" control was placed on an HMI screen.
• The HMI device has been compiled, uploaded to the Runtime server and its project is being
executed.
• When using contexts: Contexts have been defined and executed in Runtime for the project.
Procedure
1. To send reports by e-mail, configure the global e-mail settings:
– When one of the servers requires a certificate for sending e-mails, upload the certificate.
– Create contacts for the e-mail receivers and e-mail senders.
– Create the required SMTP server configurations.
2. Configure job parameters for report templates, triggers and targets.
These job parameters will then be available to you for selection when configuring the report
jobs.
3. Configure report jobs.
Reports are generated in Runtime when the report jobs are executed.
4. (Optional) Perform report orders manually.
5. In the control, get an overview of which reports have been generated.
6. Download the reports, if necessary.
7. (Optional) To reuse the configuration of the "Reports" control, such as on a device in another
network, transfer the existing configuration from the control from one device to the control
of the other device.
See also
Setting global email settings (Page 143)
Configuring job parameters (Page 145)
Configuring report jobs (Page 152)
Running a report job manually (Page 155)
Downloading reports (Page 156)
Transferring the control configuration (Page 157)
Configuring report templates in the add-in (Page 161)
Note
Automatic data transfer
Changes in the "Reports" control are saved automatically.
Layout
You create and manage report jobs in the "Reports" control. You also have access to the reports
generated by the report jobs.
The control has the following structure:
X
Y
Z
[
]
1 Tab for the configuration and management of reports, report jobs, job parameters and global settings
2 Toolbar
The buttons you see depend on the tab.
3 Work area
On the "Reports", "Report jobs" and "Job parameters" tabs: List of elements available on the tab
On the "Global settings" tab: The settings
4 Options for selecting the elements
You can select elements individually or all at once.
5 Detail area
Shows the properties of the selected element.
6 Status bar
Tab
"Reports" tab
Here you can see which reports have been generated. You can use the toolbar to download or
delete reports.
The "Status" column shows Information:
• On the status of the generated report files (XLSX and PDF)
• On the status of the targets (File system and E-mail)
Overview of the status icons:
Status Description
Execution has been successfully completed.
Execution is in progress.
Toolbar
The following buttons are available in the toolbars of the tabs:
Icon Button
Delete Deletes the elements whose option is enabled in the work area.
Icon Button
Run In the "Report jobs" tab.
Manually creates a report for the report job whose option is enabled in the
work area.
Export • In the "Job parameters > Templates" tab:
To export report templates
• In the "Reports" tab:
To download reports to the client
Status bar
The button in the status bar displays general information sent by the reporting service, for
example on whether a report job has been executed.
If configured accordingly, an e-mail is sent automatically after a report job is executed. The e-
mail can include the report as an attachment.
Maintenance of the basic settings for sending e-mails is carried out in the "Global settings" tab:
• If necessary: The certificates that the e-mail sender uses to authenticate itself at the SMTP
servers.
• The contact information of the e-mail senders and e-mail receivers.
• The configuration of the SMTP server via which the e-mails are sent.
Upload certificates
Store the certificates of the SMTP servers that require authentication via certificate.
Requirement
• You have access to the storage location of a valid certificate file.
Procedure
1. In the "Reports" control, click on the "Global settings > Certificates" tab.
2. Click "Add new" in the toolbar.
Alternative: In the work area, click "Add new".
3. In the dialog that opens, select the certificate file.
4. Confirm your input.
5. Optional: Select the uploaded certificate in the work area and enter a comment on the
certificate in the detail area.
Result
The certificates uploaded here are available in the "Contacts" tab.
Maintaining contacts
Store the data of the e-mail senders and email recipients.
Procedure
To create a new contact, follow these steps:
1. In the "Reports" control, click on the "Global settings > Contacts" tab.
2. Click "Add new".
3. Enter the name of the contact.
4. Enter the e-mail address of the contact.
5. To use the contact as a sender for an SMTP server that requires authentication with a
certificate, select the appropriate certificate under "Certificate".
6. To use the contact as a sender for an SMTP server that requires authentication with a user
name and password, enter the password.
The e-mail address is used as the user name.
7. (Optional) Enter a comment relating to the contact.
Result
The contacts configured here are available:
• As the e-mail sender in the SMTP server configuration.
• As an e-mail recipient when configuring "target" job parameters with the target type e-mail
Requirement
Contacts that are suitable as senders have been entered in the "Global Settings > Contacts" tab.
Procedure
To create a new SMTP server configuration, follow these steps:
1. In the "Reports" control, click on the "Global settings > SMTP" tab.
2. Click "Add new".
3. Specify the following:
Field Description
"Name" Enter the name of the SMTP server configuration.
"Address" Enter the URL of the SMTP server.
Servers without authentication (e.g. company-
internal mail servers) and with authentication are
permitted.
Example: URL of a company mail
server: mail.<Company name>.com
"Port" Enter the port number of the SMTP server.
Default setting: 25
"Sender" In the list, select the contact that is used as the
sender for this SMTP server configuration.
All contacts maintained under "Contacts" are of‐
fered to you for selection. Select a sender that
meets the respective requirements of the server.
"Comment" (Optional) Enter a comment relating to the SMTP
server configuration.
Result
The servers configured here are available when configuring the "Target" job parameters with the
target type email.
The parameters configured here are available to you for selection when configuring the report
jobs in the "Report jobs" tab.
You define the remaining job parameters while configuring a report job in the "Report jobs" tab.
See also
Importing and exporting report templates (Page 146)
Deleting templates (Page 147)
Configure trigger (Page 147)
Add target with target type "E-mail" (Page 150)
Requirement
• The "Reports" control is placed on a screen of the project.
• The "Job parameters > Templates" tab is visible in the control.
• Import: You have access to the storage location of the report template.
• Export: Report templates have been imported into the control.
4. Optional: In the work area, select the imported report template in the work area and enter a
comment describing the template in the detail area.
Deleting templates
Requirement
• The "Reports" control is placed on a screen of the project.
• The "Job parameters > Templates" tab is visible in the control.
• Templates have been imported into the control.
Procedure
1. In the work area, select the options next to the templates you want to delete.
2. Click "Delete" in the toolbar.
Configure trigger
Introduction
In the "Job Parameters > Triggers" tab you configure which automatic triggers are available for
selection when configuring report jobs.
Report jobs with automatic triggers are executed if the report jobs on the "Report jobs" tab are
set to active and their trigger event occurs. Users can also start the execution manually.
Requirement
• The "Reports" control is placed on a screen of the project.
• The "Job parameters > Trigger" tab is visible in the control.
• To use the trigger type "Context trigger": Contexts are available in the project.
Add trigger
1. In the work area of the tab, click "Add new".
A new trigger is created and displayed in the detail area.
2. Assign a unique name to the trigger.
4. Depending on the selected trigger type, set the settings for the new trigger as described
below.
5. Optional: Enter a comment for the trigger.
6. Optional: To bind the execution of the report order to certain context values, you define a
condition:
Delete trigger
Select the option of the desired trigger in the work area of the "Job Parameters > Trigger" tab and
click "Delete" in the toolbar.
Edit trigger
1. Activate the option of the desired trigger in the work area of the tab.
2. In the detail area, edit the settings of the trigger.
Note
No change of the trigger type
The trigger type can only be set when adding the trigger.
Requirement
• The "Reports" control is placed on a screen of the project.
• The receivers of the e-mails are maintained as contacts in the "Global settings > Contacts" tab.
• An SMTP server, with which the e-mail is to be sent, has been configured in the "Global
settings > SMTP" tab.
Procedure
1. In the "Reports" control, click on the "Job parameters > Targets" tab.
2. In the work area of the tab, click "Add new".
3. Select "E-mail" as target type.
A new target is created and displayed in the detail area.
4. Assign a unique name to the target.
5. Select an SMTP server configuration.
6. Add the desired receivers and CC receivers:
– To do so, select a contact from the list "Add receiver" or "Add CC receiver".
– Add the contact by clicking "+".
7. Enter the e-mail subject.
To integrate the report name into the subject line, use the placeholder {ReportName}.
8. Enter the e-mail text.
To integrate the report name into the email text, use the placeholder {ReportName}.
9. (Optional) Enter a comment.
Result
The target configured here is available for selection when configuring report jobs.
An e-mail is sent after a report job is executed with this target. The e-mail can include the report
as attachment.
See also
Dynamic placeholder (Page 159)
Introduction
A reporting job with a target of the target type "File system" saves the reports to a file system.
You can select the following, pre-configured targets with the target type "File system" when
configuring a report job, but not edit or delete them in the control.
• Local project storage location: The "Reports" folder in the project directory.
• Local main storage location for reports:
In addition, you can add additional targets that save the reports to subfolders of the local main
storage location for reports.
Requirement
• The "Reports" control is placed on a screen of the project.
• Unified Comfort Panel: An SD card is inserted in the panel.
Procedure
1. In the "Reports" control, click on the "Job parameters > Targets" tab.
2. In the work area of the tab, click "Add new".
3. Select "File system" as target type.
A new target is created and displayed in the detail area.
Under "Destination path", you can see the path to the local main storage location for reports.
4. Assign a unique name to the target.
5. Under "Subfolder", enter the path to the subfolder in which the report is to be saved.
Use the following notation: <folder name> or <folder name>\<folder name>\...
Note
Relative path information
The path information is relative to the local main storage location for reports.
Result
The target is available for selection when configuring report jobs.
When a report job with this target is executed, the report generated by the report job is saved to
the file system. If the folder entered under "Target path" does not exist, it is created by the system.
Note
Change of the local main storage location for reports (Unified PC)
When you change the originally configured local main storage location for reports, the targets
are automatically adapted. New reports are stored relative to the new local main storage
location. The old folders are not deleted.
Introduction
A report job is a job for generating reports in Runtime. A new report is generated each time the
report job is performed.
The report jobs configured in the "Report jobs" tab are executed:
• Automatic
Report jobs that have a tag trigger, serial trigger or context trigger and are set to active on the
"Report jobs" tab are automatically executed when their trigger is triggered.
• Manual
Report jobs with a trigger of the "Manual" type must always be executed manually.
You can also run report jobs manually with triggers of the types "Tag trigger", "Serial trigger"
or "Context trigger" at any time.
The configuration of a report job controls the details of the generation.
Requirement
• The "Reports" control is configured on a screen of the project.
• The following job parameters were configured in the control:
– At least one template has been imported.
– To automatically execute a report job: Triggers are configured in the "Job parameters >
Trigger" tab.
Procedure
1. Select the "Report jobs" tab in the "Reports" control.
2. Select "Add new" In the work area or click "Add new" in the toolbar.
3. In the detail area, enter a name for the report job.
4. Select a report template.
5. Enter a report name.
The name will be used for all reports generated by the report job. To get unique names, use
placeholders. They are dynamically evaluated during the execution of the report job.
Example:
6. Under "Targets", you determine how the reports are to be made available to users. Follow
these steps:
– Click "Add target".
You see the targets configured in the tab "Job parameters > Targets".
– Select a target.
– Add the target by clicking "+".
The target is added to the table to define the target formats.
– Determine the formats in which the reports generated by the report job are provided for
the target. In the table, activate the options of the desired formats for each target.
Note
Sending e-mails without a report
If you deactivate both options for targets with "E-mail" target type, an email without
attachment is sent after the report job has been executed.
Note
PDF as target type for large reports
Generating PDFs with Excel is significantly slower than with LibreOffice. To generate large
PDF reports, it is therefore recommended that you install LibreOffice.
– To remove a target from the report job, click the "Remove" button in the table.
7. Under "Trigger", select which event triggers the execution of the report job:
– If the report job is only to be executed manually, select "Manual".
– If the report job is to be executed automatically, select one of the other triggers
configured under "Trigger".
Note
You can also execute the report job manually.
Result
The report job is saved automatically. When its trigger is triggered, a report is generated.
See also
Configure trigger (Page 147)
Dynamic placeholder (Page 159)
Add target with target type "E-mail" (Page 150)
Tips on design and layout (Page 211)
Requirement
• The "Reports" control is configured on a screen of the project.
• Report jobs have been configured in the control.
Procedure
1. Select the "Report jobs" tab in the "Reports" control.
2. To edit a report job, proceed as follows:
– Select the report job in the work area.
– In the detail area, edit the settings of the report job.
You have the same options as when creating a report job.
3. To delete report jobs, proceed as follows:
– In the work area, enable the options next to the report job.
– Click "Delete" in the toolbar.
Requirement
Report jobs have been configured in the "Reports" control.
Procedure
1. Select the "Report jobs" tab in the "Reports" control.
2. In the work area, enable the option next to the report job that you want to execute manually.
3. Click "Run" in the toolbar.
Result
The report is generated. You can download it in the "Reports" tab.
Requirement
• Report jobs with the target type "File system" have been configured and executed in the
"Reports" control.
Procedure
1. Select the "Reports" tab in the "Reports" control.
2. In the work area, select the option in the left column for each report that you want to
download.
3. Activate the desired target formats in the "Files" column.
Note
Generation status
You are only offered successfully generated formats.
In the "Status" column you can check whether the generation for a format has failed. For a
detailed status message click on the icon of a target format.
Result
The reports are downloaded into the download directory of the browser.
You can edit, distribute, or log the reports.
See also
Installation of the Reporting add-in (Page 162)
Requirement
• The "Reports" control is placed on a screen of the project.
• The Runtime project has data that can serve as data source elements in the reporting
template, such as alarms and logging tags.
Procedure
1. In the "Reports" control, click on the "Global settings > Configuration" tab.
2. Enter the name of the offline configuration file under "Offline-configuration".
3. Click "Export offline configuration".
Result
A JSON file with the data source elements of the Runtime project is created. The file is
downloaded to the download folder or a user-defined directory according to the device settings.
You can select the configuration file in the Reporting Excel add-in as data source for an offline
connection.
Scope
The transfer covers the following data:
• Global settings, without passwords and certificates
• Job parameters, including the report templates available in the control
• Report jobs
Reports are not transferred.
Requirement
• The "Reports" control is placed on a screen in the project running in Runtime.
• Export: Settings have been made, e.g. contacts maintained, report templates imported, and
report jobs created in the "Reports" control.
• Import: You have access to the ZIP file generated by the export on the device on which
Runtime is installed.
Export configuration
1. In the "Reports" control, select the "Global settings > Configuration" tab.
2. Enter the name of the export file under "Export/import configuration > Export".
3. Click "Export configuration".
The configuration is exported to a ZIP file and downloaded to the default download directory of
the device.
Import configuration
1. In the "Reports" control, select the "Global settings > Configuration" tab.
2. Click "Select import file" under "Export/import configuration".
3. Select the ZIP file in File Explorer and confirm your selection.
4. Runtime checks whether the control already contains configurations:
– No: The configuration is imported.
– Yes:
Select "OK" to import the configuration. The existing configuration is overwritten.
Select "Cancel" to cancel the import.
Note
The setting is lost through a screen change.
Note
Inconsistent report jobs are not executed.
The templates available in the "Reports" control are not validated.
Job parameters
The following values lead to errors and inconsistencies:
Examples:
Requirements
Note
Note the Microsoft upgrade restrictions
If you have an Excel installation that cannot be upgraded to Build 16.0.6769 or higher (for
example, because Excel was installed using a single Office license), purchase a current Office
version or use Online Office.
See also
Version compatibility (Page 137)
Note
Regular updates of operating system and MS Excel
The installation of the Reporting add-in on a computer requires that the operating system and
the local MS Excel installation are regularly updated.
If there are problems with the installation, check the version of the local MS Excel installation.
Lengthy maintenance intervals between the operating system and Excel can cause problems
during installation of the add-in.
Update the operating system and the Excel version if necessary.
To install the add-in with a local Excel installation, MS Excel with build 16.0.6769 or higher is
required.
Note
Note the Microsoft upgrade restrictions
If you have an Excel installation that cannot be upgraded to Build 16.0.6769 or higher (for
example, because Excel was installed using a single Office license), purchase a current Office
version or use Online Office.
Procedure
1. Install the Excel manifest on the computer.
2. Set up read access to the installation path of the Excel manifest.
3. Add the add-in to Excel.
See also
Installing the Excel manifest (Page 163)
Setting up read access to the Excel manifest (Page 163)
Adding the Reporting add-in in Excel (Page 164)
Procedure
1. In the installation package of WinCC Unified on "DVD_2", double-click the file "Support
\Reporting\SIMATIC_WinCC_Unified_Reporting_<Version number>.exe".
2. Select the target directory to which the underlying ZIP file is extracted and confirm your input.
The ZIP file is extracted and setup starts automatically.
Note
Start setup manually
To start the setup manually after the file was extracted, select the option "Extract the setup
files without being installed".
Start the setup later by running the "Setup.exe" file as administrator in the target directory.
See also
Installation of the Reporting add-in (Page 162)
Requirement
The Excel manifest is installed.
Procedure
Give the users that create templates with the Excel add-in read access to the installation path of
the Excel manifest: <target directory>\WinCCUnifiedReporting\Excelmanifest
Note
This step is also necessary if the user belongs to a group in the user management with general
read permission.
See also
Installing the Excel manifest (Page 163)
Installation of the Reporting add-in (Page 162)
Requirement
• The Excel manifest is installed on the PC.
• Read access to the installation path of the Excel manifest is set up.
• The following software is available on the computer:
– Local Excel
MS Excel (Build 16.0.6769 or higher)
Note
Regular updates of operating system and MS Excel
The installation of the Reporting add-in on a computer requires that the operating system
and the local MS Excel installation are regularly updated.
If there are problems with the installation, check the version of the local MS Excel
installation. Lengthy maintenance intervals between the operating system and Excel can
cause problems during installation of the add-in.
Update the operating system and the Excel version if necessary.
Note
Note the Microsoft upgrade restrictions
If you have an Excel installation that cannot be upgraded to Build 16.0.6769 or higher (for
example, because Excel was installed using a single Office license), purchase a current
Office version or use Online Office.
– Or Office online
Procedure
1. Open Microsoft Excel.
2. Open the "Trust Center" under "File" > "Options".
3. Click "Trust Center Settings".
4. Click "Catalogs of trusted add-ins".
6. Make sure that the check mark in the "Show in Menu" column is set.
7. End and restart Excel.
In the "Office Add-ins" dialog box, the Siemens add-in is displayed under "Shared folders".
9. Select the add-in and click "Add".
See also
Installing the Excel manifest (Page 163)
Setting up read access to the Excel manifest (Page 163)
Installation of the Reporting add-in (Page 162)
Login
A login dialog opens in the Excel add-in in the following cases:
• After start of Excel and the add-in
• When using an online connection: When the connection to the Runtime server must be re-
established.
Examples:
– Runtime has been reloaded.
– The security token has expired due to a timeout.
Requirement
• The add-in is installed.
• When using an online connection:
– A Runtime server is accessible.
– A Runtime project is running on the server.
Procedure
In order to use an online connection, log onto a Runtime server:
1. Under "Server", enter the name of the server on which the project that is to serve as data
source for the report template is running.
Use the same spelling as when the Runtime server certificate was created.
Note
If Runtime is installed on the same computer as the add-in, use of the name "localhost" is not
permitted.
2. Enter the user name and password of a user that is registered on the server in the Runtime
user management.
3. Click "Login".
In order to use an offline connection, click "Go offline".
Result
Online connection
The add-in is connected to the Runtime server and the options available there are loaded.
You can now create report templates.
Offline connection
Before you create report templates, set up the offline connection.
See also
Installation of the Reporting add-in (Page 162)
Setting up an offline connection (Page 171)
Requirements
• A Runtime server is accessible.
• A Runtime project is running on the server.
Procedure
1. In the "Data sources" group on the "WinCC Unified" tab, click on "Connections".
2. Click "Online" under "Connections" in the add-in.
3. Under "Server", enter the server name.
Use the same spelling as when the Runtime server certificate was created.
Note
If Runtime is installed on the same computer as the add-in, use of the name "localhost" is not
permitted.
4. Click "Load".
Result
• A server node is created.
• The add-in is connected to the Runtime server and its options are loaded.
Data source items of these options can be added to report templates. Their data can be read
in from Runtime to Excel.
Note
To check which options were loaded, click on the server node.
Options that are being used in the currently open report template but are not available on the
connected server have a red icon. You can remove the option:
• If no connection can be established or an incorrect server name has been entered, the add-
in will display a corresponding error message.
See also
Removing options (Page 169)
Removing options
Introduction
If you reuse report templates across servers, e.g. in order to adapt an existing template for
another project, it may be necessary to remove unavailable options from the connection
settings.
The procedure for this is presented using the Performance Insight option as an example.
Requirement
• The add-in was connected to a server on which the Performance Insight (PI) option is
installed.
• A report template that uses KPIs was created with the add-in.
• The add-in was then connected to a server without the Performance Insight option installed
for the purpose of adapting the template to the project running there.
Removing an option
1. In the "Data sources" group on the "WinCC Unified" tab, click on "Connections".
2. Under "Connections", click on "Online".
3. Select the server node.
You see the loaded options under the server node:
Available options
The following applies to data source items of these options:
• They can be added to the report template.
• Their data can be read in from Runtime to Excel in the add-in.
Unavailable options
In the example: Performance Insight
The following applies to data source items of these options:
• They cannot be added to the report template.
• If the report template already has a data source element of this option, its data
cannot be read in from Runtime to Excel.
Result
The option is removed from the connection settings.
Next, remove all data source items of this option from the report template.
Reloading an option
When the add-in is connected to a Runtime server, all options available on the server are loaded.
To reload an option that was deleted in the connection settings but is available on the server,
select the server node and click "Load".
Requirement
An offline configuration file was created in the "Reports" control in Runtime. The configuration
file is available on the device.
Procedure
1. In the "Data sources" group on the "WinCC Unified" tab, click on "Connections".
2. Under "Connections", click on "Offline".
3. Click "Open offline configuration".
4. Select the desired file in the window that opens and confirm your entries.
5. Click "Load".
6. Select the desired options.
7. Confirm your entries.
Result
• A server node is created. The node bears the name of the server on which the configuration
file is based.
• The configuration file, together with its options, is loaded into the add-in. The data of the
configuration file is available for configuring the report template.
Note
To check which options were loaded, click on the server node.
Options that are being used in the currently open report template but are not available in the
configuration file have a red icon. You can remove the option:
See also
Removing options (Page 172)
Exporting an offline configuration file (Page 157)
Removing options
Introduction
If you reuse report templates across servers, e.g. in order to adapt an existing template for
another project, it may be necessary to remove unavailable options from the connection
settings.
The procedure for this is presented using the Performance Insight option as an example.
Requirement
• The add-in was changed over to an offline connection whose configuration file does not
include Performance Insight.
• A report template was opened in the add-in whose configuration is based on a connection to
a Runtime server on which Performance Insight is installed.
Removing an option
1. In the "Data sources" group on the "WinCC Unified" tab, click on "Connections".
2. Under "Connections", click on "Offline".
3. Select the server node.
You see the loaded options under the server node:
Available options
The following applies to data source items of these options:
• They can be added to report templates.
• Their data can be read in from the configuration file to Excel.
Unavailable options
In the example: Performance Insight
The following applies to data source items of these options:
• They cannot be added to the report template.
• If the report template already has a data source element of this option, its data
cannot be read in from the configuration file to Excel.
Result
The option is removed from the connection settings.
Next, remove all data source items of this option from the report template.
Reloading an option
When a configuration file is loaded, all options available in the file are loaded.
To reload an option that was deleted in the connection settings but is available in the
configuration file, select the server node and click "Load".
Requirement
An online connection or offline connection has been established.
Procedure
To create a new report template, proceed as follows:
1. Open a new Excel file.
2. Add a segment.
You can choose between time series segments and single value segments.
3. Add data source items to the segment.
The exact procedure depends on the type of the data source item.
4. Optional: If you do not want a data source item to use the default configuration, determine its
configuration.
You have the following options:
– Select an existing configuration.
– Create a new configuration and select it.
– Define a local configuration.
5. Optional: To define additional segments, repeat steps 2 to 4.
6. Optional: When using an online connection, test the template by reading the runtime data
of selected segments or all segments.
See also
Setting up a data source (Page 168)
Requirement
• The "WinCC Unified" tab is visible in Excel.
Structure
If you click on "Segments" in the "Configuration" group, you see the following interface:
① Toolbar
② Work area
Toolbar buttons:
See also
The segment user interface (Page 177)
Definition
A report template consists of any number of segments. Each segment is a container to which you
can add any number of data source items. The segment reads the data from its data source items.
There are time series segments and single value segments.
Note
Data source items of the PI options
If PI options are installed, additional data source elements may be added. For more information
on this, refer to the PI Options help.
Note
Output additional information
For the data source items of the single value segment, you can set in the configurations of the
data source items whether the data table outputs additional information about the value.
Example of logging tags:
• Quality code and time stamp of the tag value
• Labels
Note
Data source items of the PI options
If PI options are installed, additional data source elements may be added. For more information
on this, refer to the PI Options help.
Structure
The interface for creating and editing segments has the following structure:
① Filter
Filters the list of segments by name.
② Button for creating a segment
③ List of segments
Each segment has buttons for reading in, editing and deleting the segment.
The following configuration is displayed for each segment:
• Segment name
• Number of data source items
• Insertion location of the segment in the Excel file
• Time span
• If context filters have been configured: The filter string
A click on the segment opens the area with the data source items.
Create segments
Requirement
• The "WinCC Unified" tab is visible in Excel.
• The data source is set up.
• To filter the time interval of the time series segment depending on the context: There are
contexts in the project that run on the connected Runtime server or are the basis of the
configuration file.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Click "New segment".
3. Select "New time series segment" or "New single value segment".
4. Enter a segment name. Note the Excel restrictions for naming tables (for example, do not use
blanks).
– Optional: Under "Legend table properties", you configure the contents that the legend
table of the segment is to display:
6. Optional: You can filter the time interval of the time series segment depending on the
context. You can define up to two filter conditions.
Follow these steps:
– Under "Context filter", click "+" or "Add new condition row".
The condition line is added.
– Click on "+" in the condition line.
– Under "Select context", select the root of the common plant model.
In the next row, you see the top level of the common plant model.
– Navigate through the common plant model to plant objects with contexts.
Plant objects and contexts can be recognized by the following icons:
Plant object
Context
– Select a context.
– Select an operator.
– Enter a value.
– Optional: Use "+" or "Add new condition row" to create a second condition and select
whether the two conditions are to be linked with a logical AND or OR.
7. Confirm your entries with "OK".
Result
The segment is created and added to the list of segments:
Next, add data source items to the segment. Your procedure depends on the type of the new
data source item.
Reference time
Use one of the following characters for the reference time:
• "*" - Now
• "t" (today) - Today at midnight
• "y" (yesterday) - Yesterday at midnight
• "1-31" - Specific day of the current month
Time interval
• "y" (year): +1y = plus 1 year
• "mo" (month): +1mo = plus 1 month
• "w" (week): +1w = plus 1 week
• "d" (day): +1d = plus 1 day
• "h" (hour): +1h = plus 1 hour
• "m" (minute): +1m = plus 1 minute
• "s" (second): +1s = plus 1 second
• "ms" (milliseconds): +250ms = plus 250 milliseconds
Examples
• *-1y: One year ago today
• t+8h: Today at 8:00 am
• y+8h: Yesterday at 8:00 am
See also
Tips on design and layout (Page 211)
Adding data source items (Page 185)
Working with configurations (Page 197)
Edit segments
Requirement
• The "WinCC Unified" tab is visible in Excel.
• A segment is available.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Click "Edit" next to a segment in the list of segments.
3. Edit the segment.
You can make the same settings as when creating the segment.
Delete segments
Requirement
• The "WinCC Unified" tab is visible in Excel.
• A segment is available.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Click "Delete" next to a segment in the list of segments.
3. Confirm your entries with "OK".
Introduction
The columns of the data table take over the order that the data source items have in the
segment. By default, this is the sequence in which the data source items were added to the
segment.
For time series segments, you can change the sequence of the data source items and thereby
specify a different column sequence in the data table.
Note
Changing the column sequence of alarm properties of an alarm data source item
The configuration of the alarm data source item also allows you to define the sequence in which
the columns of the alarm properties are inserted into the data table.
Requirement
• The "WinCC Unified" tab is visible in Excel.
• A time series segment has been created.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Click the time series segment in the list of segments.
The data source items of the segment are displayed.
3. Left-click a data source item and move it up or down using drag-and-drop operation.
Result
The order of data source items in the segment interface is changed.
The next time the Runtime data is read in, the columns of the data table have the same order as
the data source items.
See also
Create or edit configurations for an alarm (Page 198)
Requirement
• There are log alarms in the project that runs on the connected runtime server or is the basis
of the configuration file.
• The "Alarm" option is activated in the connection settings.
• The "WinCC Unified" tab is visible in Excel.
• A time series segment is available.
6. To undo your choice, select the "Alarm" entry under "Selected data source items" and click
"Delete".
7. Confirm with "OK".
Note
Displayed alarms
First, the data table shows all log alarms of the project. You filter the alarms using the
configuration of the data source item.
Result
The added data source item for alarms is displayed below the segment and inserted into the data
table.
If you do not want the data source item to use the default configuration, select a configuration.
See also
Create or edit configurations for an alarm (Page 198)
Select configuration (Page 207)
Working with configurations (Page 197)
Introduction
To output statistical calculations for log alarms in a report, add alarm statistics to a report
template. The following calculations are available:
• Frequency of an alarm
• Average display time per state machine
• Total display time per state machine
• Maximum display time per state machine
• Minimum display time per state machine
The alarm statistics add columns with statistical calculations and columns with general alarm
properties of the recorded alarms to the reports.
You can find more information about calculations in alarm statistics in the help for the alarm
control.
Requirement
• The "Alarm" option is activated in the connection settings.
• The "WinCC Unified" tab is visible in Excel.
• A time series segment is available.
Procedure
1. Click on "Segments" in the "Configuration" group.
The list with the segments already created is loaded.
2. Select a time series segment.
The segment is extended by the area for the data source items.
3. Click "+".
4. Select the "Alarm" option.
5. Under "Select alarms", select the "Alarm statistics" entry.
7. (Optional) To undo your selection, select the "Alarm statistics" entry under "Selected data
source items" and click "Delete".
8. Confirm with "OK".
Result
The added data source item for alarm statistics is displayed below the segment and inserted into
the data table.
First, the data table shows the contents configured in the standard configuration for alarm
statistics. To output other contents, select or create a configuration.
Requirement
• The project on which the connected Runtime server runs or the basis of the configuration file
has logging tags.
• The "Logging tag" option was selected while setting up of the connection.
• The "WinCC Unified" tab is visible in Excel.
• A single value segment or time series segment is available.
Procedure
1. Click on "Segments" in the "Configuration" group.
The list of segments is loaded.
2. Select a segment.
The segment is extended by the area for the data source items.
3. Click "+".
4. Select the "Logging tag" option.
5. Optional: To reduce the load time, filter which tags are loaded to the selection under "Add
filter".
The preset filters "*" return all logging tags of the project.
– "Tag name": Enter the name of the online tag whose logging tags you want to add.
– "Logging tag name": Enter the name of the logging tags you want to add.
Note that the entry is case-sensitive.
Note
Filter by partial string
You use the wildcard "*" to filter by partial strings.
For example:
• *T* returns all tags with a "T" in their name.
• *T returns all tags that end in "T".
• T* returns all tags that start with "T".
When filtering for structures, the separators must be part of the filter string.
For example: The following filters return the logging tags for all tags of the device
"HMI_RT_1":
• Filter for tag: "HMI_RT_1::*"
• Filter for logging tag: "*"
6. Click "Load".
The logging tags of the project are filtered and provided under "Select tags".
7. Optional: Further reduce the number of tags that are offered for selection by clicking next to
"Select logging tags" and entering another filter string.
The list of tags you are being offered is filtered while you type.
8. Select one or more tags under "Select logging tags".
The tags are added to the "Selected data source items" list.
Note
Change selection criteria
After you have added a tag, you can select a different option or a different filter and add
additional data source items.
For example: Output KPIs and logging tags in the same segment.
9. To remove one or more data source items from "Selected data source items", select them and
click "Delete".
10.Confirm with "OK".
The added logging tags are shown below the segment and added to the Excel table.
11.If you have added the logging tag to a single value segment:
– In the Excel worksheet, select the cell in which the logging tag is to be inserted.
– Click the "Select a cell" button on the data source item of the logging tag.
Alternatively, enter the name of the worksheet and the cell.
See also
Create or edit configurations for logging tags (Page 200)
Working with configurations (Page 197)
Adding tags
Requirement
• The project on which the connected Runtime server runs or the basis of the configuration file
has tags.
• The "Tag" option was enabled when the connection was set up.
• The "WinCC Unified" tab is visible in Excel.
• A single value segment is available.
Procedure
1. Click on "Segments" in the "Configuration" group.
The list of segments is loaded.
2. Select the single value segment.
The segment is extended by the area for the data source items.
3. Click "+".
4. Select the "Tag" option.
5. Optional: To reduce the load time, filter which tags are loaded to the selection under "Add
filter".
Under "Tag name", enter a filter, e.g. the name of the tag. Note that the entry is case-sensitive.
The default filter "*" returns all tags of the project.
Note
Filter by partial string
You use the wildcard "*" to filter by partial strings.
For example:
• *T* returns all tags with a "T" in their name.
• *T returns all tags that end in "T".
• T* returns all tags that start with "T".
When filtering for structures, the separators must be part of the filter string.
For example: The filter "HMI_RT_1::*" returns all tags of the device "HMI_RT_1".
6. Click "Load".
The tags of the project are filtered and provided under "Select tags".
You can recognize structs and arrays in the list by the following items:
7. Optional: Further reduce the number of tags that are offered for selection by clicking next to
"Select tags" and entering another filter string.
The list of tags you are being offered is filtered while you type.
8. Select which tags will be added to the segment. You have the following options:
Note
Automatic filtering when displaying the members or selection of all members
If you click the button to display the members of a struct or array or activate the option to
select their members, the struct or array is set as a filter:
• The list under "Select tags" only shows the struct or array.
• A second "Select tags" list is added below this, in which you can see all members of the
struct or array.
To see all available tags again, delete the filters.
Note
Change selection criteria
After you have added a tag, you can select a different option or a different filter and add
additional data source items.
9. To remove tags from the segment, click on the tags in "Selected data source items" and click
"Delete".
10.Confirm with "OK".
The added tags are added to the segment.
When the report template is updated in the add-in and when the report is generated in runtime,
the tag values are inserted into the data table.
See also
Creating or editing configurations for tags: (Page 201)
Working with configurations (Page 197)
Adding contexts
Introduction
To display in a report which contexts are to run during a certain time period, add only contexts
to a segment in the report template.
To display which process data has been accumulated during the runtimes of a context, add the
context and other data source items, such as logging tags or log alarms, to the segment.
Requirement
• There are contexts in the project that run on the connected Runtime server or are the basis
of the configuration file.
• The "Context" option is enabled in the connection settings.
• The "WinCC Unified" tab is visible in Excel.
• A time series segment is available.
5. Select a context:
– Under "Select context", select the root of the common plant model.
In the next row, you see the top level of the common plant model.
– Navigate through the common plant model to plant objects with contexts.
Plant objects and contexts can be recognized by the following icons:
Plant object
Context
Note
Change selection criteria
After you have added a context, you can select a different option and add additional data
source items.
For example: Context and logging tags in the same segment.
6. To remove one or more data source items from "Selected data source items", select them and
click "Delete".
7. Confirm with "OK".
Result
The selected contexts are displayed below the segment and inserted into the data table.
If you do not want a context to use the default configuration, select its configuration next.
Example
The following data source items were added to a segment:
• The "Product" context
Runtime of the context: 15:00:00 to 19:59:59 hours
The context was started with the "Orange lemonade" value.
• The "Logged_Rotation" logging tag
Logging cycle: 2s
• The "Logged_Temperature" logging tag
Logging cycle: 5s
• The user-defined "Unit" column
It contains the unit for "Logged temperatures".
Content of the data table after execution of the segment:
Lines 2 to Values were logged for "Logged_Rotation" and "Logged_Temperature", while the "Product" context ran with the
6 "Orange lemonade" value.
Line 8 A value was logged for "Logged_Rotation" while no context was running.
See also
Contexts (Page 46)
Introduction
User-defined columns supplement the data of the other data source items of a time series
segment with additional information:
• With a fixed string
The string appears in each cell of the column.
Example: Display measurement unit of the tag values in report
• With a formula
The formula is calculated during generation for each cell in the dynamic column.
Example: The sum of the tag values output in the report.
The configuration of the user-defined column controls which string or formula it uses.
Requirement
• The "User-defined column" option was enabled when the connection was set up.
• The "WinCC Unified" tab is visible in Excel.
• A time series segment is available.
Procedure
1. Click on "Segments" in the "Configuration" group.
The list of segments is loaded.
2. Select a segment.
The segment is extended by the area for the data source items.
3. Click "+".
4. Select the option "User-defined column".
5. Enter the name of the column under "name".
6. Click "Select" or press <ENTER>.
The column is included in the list "Selected data source items".
Note
Change selection criteria
After you have added a column, you can select a different option or a different filter and add
additional data source items.
See also
Creating and editing configurations for user-defined columns (Page 203)
Select configuration (Page 207)
Working with configurations (Page 197)
Add Audit
Introduction
To output the Runtime device Audit Trail in a report, add an Audit data source item to a report
template.
You can find more information about the Audit option in WinCC Unified in the TIA Portal help.
Requirement
• The Audit option was activated in the engineering for the Runtime device.
• The "Audit" option is activated in the connection settings of the Excel add-in.
• The "WinCC Unified" tab is visible in Excel.
• A time series segment is available.
Procedure
1. Click on "Segments" in the "Configuration" group.
The list with the segments already created is loaded.
2. Select a time series segment.
The segment is extended by the area for the data source items.
3. Click "+".
4. Select the "Audit" option.
5. Select the Audit Trail.
6. (Optional) To undo your selection, select the Audit Trail under "Selected data source items"
and click "Delete".
7. Confirm with "OK".
Result
The Audit data source item is displayed below the segment.
If an Audit Trail is configured for the data source, the Audit data is inserted into the report when
the Runtime data is read into Excel and when it is generated in Runtime:
• In the legend table: Identifier of the overall status of the Audit Trail for the queried time range
in the "Audit Status" field
Value Description
Green No manipulations of the Audit Trail were found in
the queried time range.
Red Manipulations of the Audit Trail were found in the
queried time range. Single or multiple entries
have been deleted, added or changed.
Requirement: The "Audit status" option is activated on the segment under "Header
properties".
Note
Overall status for check mode "None"
If the check mode "None" is set in the configuration of the audit data sources item, the "Audit
status" field is always green.
First, the data table shows the contents configured in the standard configuration for Audit. To
output other contents, select or create a configuration.
Requirement
• The "WinCC Unified" tab is visible in Excel.
• A segment with a data source item is available.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Expand a segment by clicking on it.
The area for adding and editing data source elements appears.
3. Move the mouse pointer over a data source element and click "Edit".
A local configuration of the data source element opens.
The local configuration adopts the values of the configuration that was originally set.
4. Enter the desired display name in "Display name".
The display name must be unique within the segment.
5. Confirm your entry with "OK".
Result
• The "Display name" column is displayed in the legend table.
The "Display name" column remains empty for data source elements without display name.
If the segment is configured accordingly, the "Name" column is also displayed.
• The display name is shown in the value table instead of the name.
Note
The display name is retained if you select a different configuration at the data source element
Requirement
• The "WinCC Unified" tab is visible in Excel.
• A segment with a data source element is available.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Expand a segment by clicking on it.
The area for adding and editing data source elements appears.
3. Move the mouse pointer over a data source element and click "Delete".
Basics of configuration
The configuration of a data source item defines the values of a data source element that are
displayed in a segment or how they are calculated and displayed.
There are specific configuration settings for each data-source-item type.
Data source items used in time series segments use a different configuration than data source
items used in single-value segments.
Requirement
• The "WinCC Unified" tab is visible in Excel.
Creating a configuration
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click "New Configuration > Logging alarm configuration".
4. Enter the name of the configuration under "Name".
5. To determine which alarm properties are displayed, activate the options for the desired
columns under "Columns".
To change the sequence of columns in the data table, move the mouse cursor to a row and
move it with the arrow buttons.
6. To filter which log alarms are displayed, define a filter query. The filter query can consist of up
to two conditions.
Follow these steps:
– Under "Filter query", click "+" or "Add new condition row".
– Select an alarm property, an operator, and enter a value.
– Optional: Use "+" or "Add new condition row" to create further conditions and select
whether the conditions are to be linked with a logical AND or OR.
7. Activate the option "Use system colors" so that the alarms are highlighted with the same
colors as in the alarm control.
8. Confirm your entries with "OK".
Editing a configuration
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
Requirement
• The "WinCC Unified" tab is visible in Excel.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click "New Configuration > Alarm statistics configuration".
4. Enter the name of the configuration under "Name".
5. To determine which statistical calculations and alarm properties are displayed, activate the
options for the desired columns under "Columns".
6. To filter which content is displayed in the alarm statistics, define a filter query. The filter query
can consist of up to two conditions.
Follow these steps:
– Under "Filter query", click "+" or "Add new condition row".
– Select an alarm property, an operator, and enter a value.
– Optional: Use "+" or "Add new condition row" to create further conditions and select
whether the conditions are to be linked with a logical AND or OR.
7. Activate the option "Use system colors" so that the alarms are highlighted with the same
colors as in the alarm control.
8. Confirm your entries with "OK".
Editing a configuration
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click a configuration for alarm statistics.
4. Edit the configuration settings. You have the same options as when creating the
configuration.
5. Confirm your entries with "OK".
The changes are applied the next time you read in the Runtime data.
Requirement
• The "WinCC Unified" tab is visible in Excel.
Creating a configuration
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click "New Configuration".
4. To create a configuration for logging tags in a time series segment, select the entry "Logging
tag configuration".
To create a configuration for logging tags in a single value segment, select the entry "Single
value configuration logging tag".
5. Set the settings for the configuration.
6. Confirm your entries with "OK".
Editing a configuration
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click a configuration for logging tags.
4. Edit the configuration settings.
5. Confirm your entries with "OK".
The changes are applied the next time you read in the Runtime data.
Setting Description
"Name" Enter the name of the configuration.
"Calculation mode" Select which data are to be written if there is no current value.
"Interval" Only for the calculation modes "Keep last value" and "Interpolate".
"Show quality code" Select whether the quality code is output with the value.
Setting Description
"Name" Enter the name of the configuration.
"Time stamp" Determine the date and time for which the value is read.
"Calculation mode" Determine which data is to be written if there is no current value.
"Show captions" Define whether a header is displayed in the columns for the time stamp,
the data source item and the quality code.
"Show time stamp" Determine whether and where this information is displayed in the table.
"Show data source item" The information is always in relation to the value cell.
"Show quality code"
Requirement
• The "WinCC Unified" tab is visible in Excel.
Creating a configuration
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click "New Configuration> Tag single value configuration".
4. Set the settings for the configuration.
5. Confirm your entries with "OK".
Editing a configuration
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click a configuration for tags.
4. Edit the configuration settings.
5. Confirm your entries with "OK".
The changes are applied the next time you read in the Runtime data.
Setting Description
"Name" Enter the name of the configuration.
"Show captions" Select whether a header is displayed in the columns for the time stamp,
the data source item and the quality code.
"Show time stamp" Select whether the time stamp is output with the value.
"Show data source item" Select whether the quality code is output with the value.
"Show quality code" Select whether the quality code is output with the value.
Requirement
• The "WinCC Unified" tab is visible in Excel.
Core statement
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click "New Configuration".
4. Select the entry "Configuration context".
5. Under "Columns" you select which columns are inserted in the data table for contexts.
6. To change the order of the columns, move the mouse pointer to the row of a column and
move it using the arrow buttons.
7. Confirm your entries with "OK".
Edit configuration
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click a configuration for contexts.
4. Edit the configuration settings.
5. Confirm your entries with "OK".
The changes are applied the next time you read in the Runtime data.
Requirement
• The "WinCC Unified" tab is visible in Excel.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click "New Configuration > User-defined column configuration".
4. Enter the name of the configuration under "Name".
5. Under "Formula", select one of the following options:
– Enter a fixed string.
The string is transferred into each cell of the column.
– Enter an Excel formula.
The formula is copied into each cell of the user-defined column and adapted to the
respective row.
To prevent a part of the formula from being adjusted, place the character "$" in front of
it.
Example
Note
No validity check
The formula is not tested for correctness during either input or dynamic adaptation.
Introduction
Check mode
The check mode of the configuration of an audit data source item determines
• whether an integrity check is performed when the runtime data is read, and what is checked.
You can output the overall result of the check in the table header row in the "Audit status"
field.
• Which audit data records are provided in the data table.
Possible check modes:
"None" Provides the data for all audit data records that fall within the requested time range. No
integrity check is performed.
Default setting
"Check only" Checks all audit data records that fall within the requested time range without providing their
data.
It is tested whether data records have been manipulated, deleted or added.
"Check entries" Checks the audit data records that fall within the requested time range and that have not been
deleted from the audit trail or subsequently added, and provides their data.
It is checked whether data records have been manipulated.
"Check all" Checks all audit data records that fall within the requested time range and provides their data.
It is tested whether data records were manipulated, deleted from the audit trail or subse‐
quently added.
Filter type
An Audit data record consists of two entries: One for user expectation and one for system
response. User expectation and system response may differ. In addition, there are cases in which
one of the two entries is missing.
The filter type controls which data records and which entries are inserted into the data table.
Possible filter types:
Filter type User expectation equals sys‐ User expectation does not Data record entry for user
tem response equal system response expectation or system re‐
sponse is missing
"Show all data in detail" Both data record entries are inserted. The existing data record entry
"Show data and conformity The data record entry with Both data record entries are is inserted.
errors" the user expectation is inser‐ inserted.
ted.
"Show only data with con‐ No data record entry inserted.
formity errors"
Requirement
• The "WinCC Unified" tab is visible in Excel.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click "New Configuration > Audit configuration".
4. Enter the name of the configuration under "Name".
5. Select a check mode:
6. Determine which audit attributes are displayed. To do this, activate the options for the
desired columns under "Columns".
7. Specify a filter type.
Preset value: "Show data and conformity errors"
8. (Optional) To further filter the inserted content, define a filter query.
The filter query can consist of up to two conditions. Follow these steps:
– Under "Filter query", click "+" or "Add new condition row".
– Select an Audit attribute, an operator and enter the value of the attribute.
– Optional: Use "+" or "Add new condition row" to create further conditions and select
whether the conditions are to be linked with a logical AND or OR.
9. Confirm your entries with "OK".
Editing a configuration
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Click a configuration for Audit.
4. Edit the configuration settings. You have the same options as when creating the
configuration.
5. Confirm your entries with "OK".
The changes are applied the next time you read in the Runtime data.
Data record Tag name Modified by Old value New value Description
ID
1A Mo‐ User1 0 10 An operator changes the speed of a motor in
tor1_Speed an I/O field of an HMI screen.
1B Mo‐ System 0 10 User expectation and system response are
tor1_Speed identical.
Data record Tag name Modified by Old value New value Description
ID
2A ValvePercen‐ User1 0 100 An operator opens a valve using a slider on
tile an HMI screen.
The valve has a physical blockage and cannot
be opened. Therefore, no data record entry
for the system response is generated.
3A ValvePercen‐ User1 0 99 A physical blockage has been removed and
tile the operator repeats the entry. The valve re‐
3B ValvePercen‐ System 0 49 acts, but cannot be fully opened.
tile User expectation and system response differ.
4B Mo‐ System 0 20 An operator changed the speed of another
tor2_Speed motor. The resulting data record was manip‐
ulated and the user expectation entry was
deleted.
There is only one entry for the system re‐
sponse.
The following table shows which data record entries are inserted into the data table depending
on the filter type selected when generating the report:
Select configuration
Requirement
• The "WinCC Unified" tab is visible in Excel.
• A segment with a data source item is available.
• There is a user-defined configuration for the type of the data source item.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Select the segment.
The segment is extended by the area for the data source items.
3. Select the desired configuration from a data source item in the drop-down list.
4. Click "OK".
Result
The changes are applied the next time you read in the runtime data.
Requirement
• The "WinCC Unified" tab is visible in Excel.
• A segment with a data source item is available.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Select the segment.
The segment is extended by the area for the data source items.
3. Move the mouse over a data source item and click "Edit".
You create a local configuration that first adopts the values of the original configuration.
4. Enter a name for the local configuration.
5. Change the desired settings.
6. Confirm your entries with "OK".
Result
The changes are applied the next time you read in the runtime data.
See also
Defining the display name of a data source element (Page 196)
Delete configuration
Requirement
A configuration is available.
Procedure
1. Click on "Segments" in the "Configuration" group.
2. Click "Data source item configuration".
3. Move the mouse to a configuration.
Note
Default configurations cannot be deleted
You can edit default configurations but not delete them.
4. Click "Delete".
Result
• The configuration is deleted.
• Data source items with this configuration obtain a local configuration with the same settings.
Note
Reading in Runtime data in Excel is used for testing. It is not intended for mass retrieval of data,
as is the case when report jobs are executed in Runtime.
Requirement
An online connection is established.
Result
The segment or segments are run. The Runtime data of your data source items are read into
Excel.
Note
Controlling the column width and row height
When the automatic adjustment of the column width and row height is disabled in the segment
properties, the text read in may be truncated or the formula results are replaced with "#"
characters.
Check the column widths and row heights and adjust them manually, if required, or select
automatic adjustment.
Note
Removing Runtime data from report template
Remove the Runtime data from the report template before you save the report template and
make it available for uploading to Runtime.
To do this, click the "Delete Runtime data" button in the toolbar of the Excel add-in.
The following calculation modes are available for tags of a single value segment:
Procedure
To zoom in or out of the display in the add-in, press <CTRL> and move the mouse wheel.
Note
Deviating PDF results
A PDF report created by LibreOffice can deviate in content or layout from a PDF report generated
with Excel, for example, if the report template uses common Excel features that LibreOffice does
not support, such as special fonts or chart types.
Arranging segments
Always place the segments of a report template side by side or each in their own worksheet.
Because the data tables of the segments grow dynamically, tables can overlap when segments
are placed one below the other. This causes an error of the OfficeExtension.Error type.
Set up page
Use "File > Print > Set up page" to define details for printing the report, for example:
• Alignment of the report (portrait format or landscape format)
• Scaling, for example, to print all columns on one page
• Inserting a user-defined header or footer
The print settings set in the report template are applied in Runtime when a report job is executed
for PDF generation.
2.9 Elements
The following elements are available depending on the configured access rights:
List box Used for display and selection of multiple list entries.
Radio button Used for display and selection of various options of which only one can be
selected.
Switch Used for toggling between two predefined states.
Slider Used for monitoring and changing process values within a defined range
and adjusts them. By adjusting the slider, you intervene in the process and
correct the displayed process value.
Clock Used for display of date and time.
Gauge Represents numerical values in the form of an analog gauge. For example,
it can be seen at a glance whether the boiler pressure is in the normal range.
2.9.2.1 Bar
Application
The tags are displayed graphically with the "Bar" object. The bar graph can be labeled with a
value scale.
Layout
The settings for the position, geometry, style, colors and fonts of the object are made during
configuration.
In particular, the following properties are changed:
• Color transition: Specifies the change in color display when limit values are exceeded.
• Limit marking: Displays the configured limit value as an arrow.
• Bar segments: Defines the gradations on the bar scale.
• Scale gradation: Defines the position of the zero point on a bar scale.
If the object falls below a certain size in the light or dark style, it is automatically displayed in
compact mode.
Color transition
The display of the color change is specified during configuration.
2.9.2.2 IO field
Application
The "I/O field" object is used to enter and display process values.
Layout
The settings for the position, geometry, style, color and fonts of the object are made during
configuration.
In particular, the following properties are changed:
• Mode: Specifies the response of the object in Runtime.
• Display format: Specifies the display format in the I/O field for input and output of values.
• Hidden input: Specifies whether the input value is displayed normally or encrypted during
input.
Note
Reports
In reports, I/O fields only output data. "Output" mode is preset. Properties for configuring
input are not available, e.g. "hidden input".
Mode
The behavior of the I/O field is specified during configuration.
Mode Description
"Input/output" Values can be input and output in the I/O field.
"Output" The I/O field is used for the output of values only.
Layout
The "display format" for the input and output of values is specified during configuration.
Layout
"Binary" Input and output of values in binary form
"Date" Input and output of date information. The format depends on the language setting
on the HMI device.
"Date/time" Input and output of date and time information. The format depends on the lan‐
guage setting on the HMI device.
"Decimal" Input and output of values in decimal form
"Hexadecimal" Input and output of values in hexadecimal form
"Time" Input and output of times. The format depends on the language setting on the HMI
device.
"Character string" Input and output of character strings.
Hidden input
In Runtime the input can be displayed normally or encrypted, for example for hidden input of a
password. A "*" is displayed for every character during hidden input. The data format of the value
entered cannot be recognized.
Limits
During configuration, colors can be specified for the values that exceed or fall below limits.
When there is a limit violation, the background color of the I/O field changes according to the
configuration, even if the I/O field is in input mode.
A limit range can also be defined for the input in the I/O field for the configuration.
If you enter a numeric value outside this limit, it is not applied; for example, 80 with a limit of 78.
In this case, a system alarm is generated on the HMI device if an alarm window is configured. The
original value is displayed again.
Application
You use the "Checkbox" object to select multiple options. Checkboxes can be activated by default
so that the user changes the default values only as required. Multiple options can be selected if
the corresponding properties are dynamized.
Layout
The settings for the position, geometry, style, color and fonts of the object are made during
configuration.
In particular, the following properties are changed:
• Number of the checkboxes: Defines the number of options.
• Selection of the checkboxes: Defines which options are displayed as activated by default.
Application
You use the "List box" object to present and select multiple list entries. List entries are selected
by default so that the default setting can be changed only when necessary. If the list box is larger
than the selection rectangle, WinCC automatically adds a scroll bar to the right margin.
Layout
The settings for the position, geometry, style, color and fonts of the object are made during
configuration.
In particular, the following properties are changed:
• Number of entries: Defines the number of list entries.
• Selection of entries: Defines which entry is displayed as activated by default.
Application
You use the "Option button" object for selection of various options. Options are selected by
default so that the default setting can be changed only when necessary. Only one option can be
selected if the corresponding property is dynamized.
Layout
The settings for the position, geometry, style, color and fonts of the object are made during
configuration.
In particular, the following properties are changed:
• Number of fields
• Selection of the fields: Specifies which fields are displayed as activated.
2.9.2.6 Switch
Application
With the "Switch" object you switch between two predefined states. The current state of the
"Switch" object is visualized with either a label or a graphic.
Layout
The settings for the position, geometry, style, color and fonts of the object are made during
configuration.
In particular, the following property is changed:
• Type: Defines the graphic representation of the object.
Type
The display of the switch is specified during configuration.
Type Description
"Switch" The two states of the "Switch" are displayed in the form of a switch. The position
of the switch indicates the current state. The switch is switched by moving it.
"Switch with text" The switch is shown as a button. The current state is visualized with a label. The
switch is switched by clicking the button.
"Switch with graphic" The switch is shown as a button. The current state is visualized with a graphic.
The switch is switched by clicking the button.
2.9.2.7 Button
Use
With the "Button" object, you execute a configured function.
Layout
The settings for the position, geometry, style, color and font of the object are made during
configuration.
In particular, the following properties are changed:
• Mode: Defines the graphic representation of the object.
• Text / Graphic: Defines whether the Graphic view is static or dynamic.
• Define hotkey: Defines a key, or shortcut that the operator can use to actuate the button.
Note
You can only define a hotkey for HMI devices with keys.
Mode
The display of the button is specified during configuration.
Mode Description
"Invisible" The button is not visible.
"Text" The button is displayed with text. This text explains the function of the button.
"Graphic" The button is displayed with a graphic. This graphic represents the function of
the button.
"Graphic or text" The button is displayed with text or graphics.
If the graphic cannot be displayed, the corresponding text is displayed.
"Graphic and text" The button is displayed with text and graphic.
Text / Graphic
Depending on the "Mode" property, the display can be specified as a static or dynamic display.
The display is specified during configuration.
You can, for example, select the following options for the "Graphic" or "Text" type.
Hotkey
A key or key combination that the operator can use to actuate the button can be defined during
configuration.
2.9.2.8 Slider
Use
Process values are monitored and adapted within a defined range with the "Slider" object. The
monitored range is visualized in the form of a slider. By adjusting the slider, you intervene in the
process and correct the displayed process value.
Layout
The settings for the position, geometry, style, color and fonts of the object are made during
configuration.
In particular, the following properties are changed:
• Maximum Value and Minimum Value: Specifies the top and bottom values of the scale.
• Display current value: Specifies whether the current position of the controller appears below
the slider.
• Display of bars: The sliders above and below the bar can be hidden.
If the object falls below a certain size in the light or dark style, it is automatically displayed in
compact mode.
Limits/ranges
You can represent limits and ranges in different colors. The colors are defined during
configuration.
Note
If the "Show ranges from tag" option is selected, up to five ranges can be displayed in a slider. The
values of the ranges are specified using a process tag. The values for the ranges are defined with
a process tag that is connected to the screen object.
The option "Show ranges from tag" is available for Comfort Panels, KTP Mobile Panels and RT
Advanced.
2.9.2.9 Clock
Application
The "Clock" object displays the date and time.
By default, the "Clock" object displays the date and time of the client.
If the "Process value" property of the clock is connected to a DateTime tag, the clock uses the tag
value as a start value and continues counting. When the tag value is changed the time is
synchronized and continues counting from the new value.
Note
Static display of a date-time value
If the image is supposed to display a static time of day, link a tag of the type DateTime with an I/O
field.
Layout
The settings for the position, geometry, style, color and fonts of the object are made during
configuration.
In particular, the following properties are adapted:
• Analog display: Specifies whether the clock is shown as an analog clock or digital clock.
• Display clock dial: Specifies whether hour marks of the analog clock will be displayed.
• Width and length of hands: Specifies the width and length of the hands.
If the object falls below a certain size in the light or dark style, it is automatically displayed in
compact mode.
2.9.2.10 Gauge
Use
The "Gauge" object shows numeric values in the form of an analog gauge. For example, it can
be seen at a glance whether the boiler pressure is in the normal range.
Note
The gauge is for display only and cannot be controlled by the operator.
Layout
The settings for the position, geometry, style, color and fonts of the object are made during
configuration.
In particular, the following properties are changed:
• Display peak value pointer: Specifies whether the actual measurement range is indicated
with a slave pointer.
• Maximum Value and Minimum Value: Specifies the top and bottom values of the scale.
• Start value of the danger range and start value of the warning range: Specifies the scale value
from which the danger range and the warning range start.
• Display normal range: Specifies whether the normal range is shown in color on the scale.
• Color of individual ranges: Different operating modes, such as normal range, warning range
and danger range, are shown in different colors so that the operator can distinguish them
easily.
If the object falls below a certain size in the light or dark style, it is automatically displayed in
compact mode.
Note
The use of many differently sized "Gauge" objects can reduce the performance in Runtime. With
"Gauge", avoid minimally different heights and widths, for example, 48 pixels, 49 pixels, 51
pixels, etc. Use the same sizes instead.
Note
If the "Show ranges from tag" option is selected, up to five ranges can be displayed in the gauge.
The values of the ranges are specified using a process tag. The values for the ranges are defined
with a process tag that is connected to the screen object.
The option "Show ranges from tag" is available for Comfort Panels, KTP Mobile Panels and RT
Advanced.
• Text box
• Graphic view
Note
If no default value is assigned to the text list and the tag value is outside the defined value range
of the text list, the last valid process value displayed by the text box is output.
Example
Runtime shows a screen with an overview graphic for a pump and its valves.
Behavior in Runtime
When you click on a valve in the overview graphic in the screen, a popup window opens. In the
popup window, you can check the state of the valve and edit the valve using the input fields.
Overview
With SIMATIC Runtime Manager, you obtain an overview of which projects are running on the
WinCC Unified Runtime server. You can start or stop the projects manually. Detailed information
about the projects is displayed, e.g. status and type.
Runtime settings
Under "Settings of SIMATIC Runtime Manager", you have the following options:
• Start OPC UA Export
For additional information, refer to the "Runtime - Open Platform Communications (OPC)"
manual.
• Set Script Debugger
Activate the option button for a Screen Debugger or Scheduler Debugger and enter the port.
Operation
1. Start SIMATIC Runtime Manager.
2. In the project list, select a project for the operation.
Icon Function
Starts a stopped project.
TraceViewer
The log files can be viewed with the Trace Viewer. It is located in the installation directory of
WinCC Unified under "WinCCUnified\bin". To open the Trace Viewer start the file
"RTILtraceViewer.exe".
Introduction
For example, you can use a debugger to test whether correct values are being transferred to tags
and whether abort conditions are being correctly implemented. Check the following in the
debugger:
• Source code of functions
• Function sequence
• Values
Note
Your code is displayed in the debugger but is write-protected.
Basic procedure
To find an error, check the script with the debugger.
The following options are available for your support:
• Setting breakpoints
• Step-by-step execution
• Viewing values parallel to execution of the script
You do not edit the code of your scripts directly in the debugger. When you find an error, follow
these steps:
1. Correct the error in the engineering system.
2. Compile the changed code.
3. Load the runtime.
4. Update the debugger.
Note
A client corresponds to a tab in Google Chrome in which the runtime is open. When you have
opened runtime in multiple tabs, multiple clients are used. The client opened first is given the
number 1. Numbering is reset when the runtime is restarted.
On the start page of the debugger for jobs you can see the context "JobsExecution".
① Navigation area
② Code display area
③ Console
④ Debugging area
Navigation area
In the navigation area, the available contents for the screen shown in runtime are displayed in
groups. The available groups vary depending on the use of scripts and functions.
Debugging area
The debugging area offers the following relevant options for WinCC Unified:
• Toolbar: Control for executing the script
• "Watch": Display of values
• "Callstack": Display of the current call stack
• "Scope": Available local values ("Local"), functions ("Module") and global values ("Global"),
• "Breakpoints": List of set breakpoints
Requirement
• SIMATIC Runtime Manager is installed.
• The logged-on user has administrator rights.
Note
The debugger is only available locally.
Remote access from the debugger to other devices is not possible.
Procedure
The debugger is disabled by default.
Note
The debugger should be deactivated in production operation, as using the debugger can
endanger system stability and security. Actions can accumulate if the debugger is, for example,
at a breakpoint for a long time or the screen is not refreshed.
Note
Start the runtime after enabling the debugger.
Requirement
• Google Chrome (as of version 70) is installed.
• A project is opened in runtime.
• The debugger was activated in SIMATIC Runtime Manager.
Note
The debugger is only available locally.
Remote access from the debugger to other devices is not possible.
Procedure
1. In a new tab, call up the URL chrome://inspect in Google Chrome.
The homepage of the Chrome DevTools is loaded in the tab.
2. Click "Devices".
3. Select the "Discover network targets" check box.
4. Click "Configure".
5. In the "Target discovery settings" dialog box, enter one of the following strings:
– 127.0.0.1:<Port number>
– localhost:<Port number>
Use the port number for the Script Debugger entered in SIMATIC Runtime Manager.
6. Press Enter.
7. Click "Done".
8. Under "Remote Target", click "inspect" for the desired target.
The DevTools open in a separate window with the selected target.
9. In the DevTools, select "Sources".
The debugger is displayed.
10.Click "Toggle screencast".
11.In the navigation area under "Page", select the desired script module.
Requirement
• Runtime has started.
• The debugger has been started.
• The group you want to debug is selected.
Pause script
To pause the execution of a script, you have 2 options:
• To pause the script immediately, click the "Pause script execution" button while the script
is being executed.
• Set a breakpoint in the desired line.
The script pauses when a breakpoint is reached.
To pause a script at a breakpoint that is configured to an event, follow these steps:
1. Set a breakpoint in the script.
2. Trip the respective event in runtime.
The script pauses at the breakpoint.
Setting breakpoints
You have several options to set a breakpoint in a line of the script:
• Click on the line number.
• Right-click the line number and select "Add Breakpoint".
All set breakpoints are displayed in the debugging area under "Breakpoints".
Deleting breakpoints
You have several options to delete a breakpoint:
• Click on the breakpoint in the code display area.
• Open the shortcut menu of the breakpoint in the code display area and select
"Remove breakpoint".
• Open the shortcut menu in the debugging area under "Breakpoints" and select
"Remove breakpoint"..
To delete breakpoints, the shortcut menu offers the following additional options in the
debugging area under "Breakpoints":
• Delete all breakpoints ("Remove all breakpoints")
• Delete all breakpoints except the selected breakpoint ("Remove other breakpoints")
Introduction
The following options are available to execute your script step-by-step:
• Execute script to the next breakpoint
• Force execution of a script
• Execute script to the next function call
• Jump into a function
• Jump out of a function
• Execute script up to a selected line
• Pause at Exceptions
• Use call stack
Requirement
• The group you want to debug is selected.
• The script pauses at a breakpoint.
Note
You can only jump into functions that you have defined yourself.
Note
You can only jump out of a function that you have defined yourself.
Pause at Exceptions
• To pause the script at Exceptions, click on the "Pause on exceptions" button in the
debugging area.
Note
You can only jump into functions that you have defined yourself.
Introduction
To identify errors in your script efficiently, have current values displayed while the script is being
executed. This way you can view properties of objects or parameters of functions, for example.
You can find additional information on objects and their properties under "WinCC Unified Object
Model".
Requirements
• The group you want to debug is selected.
• The script pauses at a breakpoint.
Procedure
You view values by moving the mouse over the label in the code display area.
You also have the following options to view values:
• In the debugging area under "Scope"
• In the debugging area under "Watch"
• In the console
"Scope" area
All local values ("Local"), functions ("Module") and global values ("Global") that are defined at this
time are displayed in the "Scope" area.
The values cannot be edited.
"Watch" area
In the "Watch" area, you view how values change in the course of a script.
Console
The values available at the current time can be called in the console.
• You show or hide the console with <Esc>.
Call the current values in the console as follows:
1. Enter the name of a local or global value in the console.
2. Press <Enter>.
Overview
The Plant Intelligence options offer optional enhancements to the WinCC Unified Basic System.
These can be combined freely in line with your requirements.
The options allow you to plan production processes and analyze and optimize the overall
effectiveness of your plant. In addition, you can design flexible production processes and
coordinate complex and interlinked production processes.
Note
The Plant Intelligence options are successively released as add-on packages. To use the Plant
Intelligence options, you require the relevant software packages and licenses.
You can find information on the licenses in the TIA Portal installation instructions in the section
"Licensing of WinCC Unified options".
Requirements
Please note the following requirements for using the options:
• SIMATIC WinCC Runtime Unified V17 is installed.
• STEP7 Professional V17 is installed.
• Plant Intelligence option, including license, is installed.
• The plant hierarchy is configured.
• License for the respective option is available.
• The configuration engineer has WinCC experience.
4.2.1 Logon
To manage the local users on a Unified PC, you require the "User management" function right.
Configure a user with the required rights in the engineering system and load the user into
Runtime. Log in to the user management.
Procedure
To log on to user management in Runtime, follow these steps:
1. In the browser, enter the IP address or the fully qualified name (name and domain) of the PC
on which Runtime is installed. If Runtime is installed on the same PC as the browser, the
"localhost" designation can also be used.
The start page of Runtime is displayed.
2. Click on the "User management" button. The "User login" dialog is displayed.
Note
Users with the "User management" function right have access to all functions.
Users without the "User management" function right can change their password under "User
profile".
Menu
The following options are available to you under the symbols in the menu:
• "Home"
This takes you to the start page of the user management.
• "Users"
You can create new users or manage the existing users.
• "User profile"
You can change your password and switch the language.
• "Logoff"
You will be logged out directly and can log in again.
4.2.3 Users
Open the "UMC user" tab via the "Users" tab. Here you create new users and edit the properties
and roles of the users.
Adding users
The buttons are used to manage the users:
• "Add user" – you create a new user.
• "Details" – you open a dialog in which you can change the password and status of the user
and assign or remove roles.
You can select "Edit" or "Delete" in the line for each user:
• "Edit" – you change the password, the full name or the comment.
• "Delete" – you remove a user.
4.2.4 Password
You can change your password via the "User profile" link.
Users with the "User management" function right can change their password via "User profile"
in the menu.
Logging out
To log out in Runtime, proceed as follows:
1. Close all open pages.
2. Select "Logout" from the menu. Your session is terminated.
Newly loaded data from the TIA Portal will not be applied until the next time you log in.
Using certificates
Communication within the plant must be protected to secure plants, systems and networks
against cyber threats. Between WinCC Unified devices, this is ensured by using encrypted
communication protocols. Each communication partner is assigned a unique certificate, which
is used for authentication and encryption.
Note
No support for certificates from external certification authorities
To issue certificates for Unified Runtime via a certification authority, the use of the Certificate
Manager is necessary.
Additional information on the use of certificates can be found in the "Runtime Readme" help
under Handling certificates (Page 23).
Functions of the Certficate Manager:
• Create a root certificate for the plant (Certificate Authority - CA)
• Central creation of certificates for WinCC Unified devices in the network
• Creation of the certificates for the following WinCC Unified components:
– WinCC Unified Runtime (Webserver (IIS))
– WinCC Unified OPC UA Server
– WinCC Unified OPC UA Exporter
– WinCC Unified OPC UA client
– WinCC Unified Collaboration
– WinCC Unified Audit
• Encrypted export of certificates for manual distribution to WinCC Unified devices
• Import and installation of the configured certificates on a WinCC Unified device
• Encrypted export and import of the root certificate including keys and all device certificates
for data backup and restore.
Required certificates
For WinCC Unified devices, certificates should be configured for the following applications:
• If a device has a web server (IIS) to enable access to WinCC Unified via web pages, a "web
server" certificate is required.
• If WinCC devices are to exchange data with each other (WinCC Unified Collaboration), an "RT
collaboration" certificate is required on all participating devices.
Note
Renewal of the Runtime Collaboration certificate after upgrading to V17
After a Runtime Collaboration device was upgraded to V17, its Runtime Collaboration
certificate must be renewed.
• If the OPC UA server is used on a device, a device-specific certificate is required for the OPC UA
server and the OPC UA Exporter.
Alternatively, you can use the self-signed default certificates generated for the OPC UA server
and OPC UA exporter.
• If a device is to communicate with an OPC UA server, an OPC UA client certificate is required.
• All above-stated certificates are issued by a common Certification Authority (CA) to simplify
the trust relationship between the communication partners.
• An empty CRL file (Certificate Revocation List) is automatically generated for the root
certificate of the certification authority.
• The root certificate of the certification authority is classified as trusted on each device for each
application.
• When accessing WinCC Unified Runtime via websites, the root certificate must be configured
as trustworthy once in the web browser.
Example
• In the example shown, two WinCC Unified PC devices and a panel are operated.
• The PC devices provide web pages for the visualization of the runtime and therefore require
a "WebServer certificate".
• A PC device (192.168.0.100) operates an OPC UA server. The "WinCC Unified OPC UA Server"
and "WinCC OPC UA Exporter" certificates are therefore required.
• Runtime data should be exchanged between a panel (192.168.0.30) and a PC
(192.168.0.40). Accordingly, both devices require an "RT collaboration certificate".
• The root certificate is installed and classified as trustworthy on all devices.
• When accessing the Runtime web pages from external devices via a browser, the root
certificate must be installed in the browser's certificate store. The WinCC Runtime home page
provides a corresponding download link.
Additional information on the use of certificates can be found in the "Runtime Readme" help
under Handling certificates (Page 23).
6RIWZDUH&HUWLILFDWHV 6RIWZDUH&HUWLILFDWHV
&HUWLILFDWH$XWKRULW\ &$ &HUWLILFDWH$XWKRULW\ &$
57FROODERUDWLRQFHUWLILFDWH :LQ&&5XQWLPH8QLILHG
:HEVHUYHUFHUWLILFDWH
57FROODERUDWLRQFHUWLILFDWH
6RIWZDUH&HUWLILFDWHV
&HUWLILFDWH$XWKRULW\ &$
:LQ&&5XQWLPH8QLILHG
:HEVHUYHUFHUWLILFDWH
23&8$6HUYHU
:LQ&&8QLILHG23&8$6HUYHU
:LQ&&8QLILHG23&8$([SRUWHU
:LQ&&23&8$([SRUWHU
The root certificate and its key are stored on the device and used to generate the device
certificates. An empty CRL file (Certificate Revocation List) is created under the root certificate.
Note
If the "WinCC Certificate Manager" is restarted on this device, the root certificate and the device
certificates generated with it are loaded automatically.
Note
Distribution of the root certificate
Exporting and installing a certificate configuration with Certificate Manager includes the root
certificate and its CRL file. In addition, you can export the root certificate and CRL file individually
with the Certificate Manager and install them on a Unified PC with the SIMATIC Runtime
Manager.
Adding devices
1. Right-click the root certificate and select "Add device ...".
2. In the "New device" dialog, enter the complete computer name (fully qualified domain name)
and/or the IP address of the device.
The specification of the IP address is sufficient for panel devices.
For devices with dynamic IP addresses, enter only the host name.
Note
Permitted names
Either the host name or the "Fully qualified domain name" can be used as the name. The
name is inserted in the certificates created for the device and used for validation. Within a
domain, the "Fully qualified domain name" must be used to avoid validation errors when
accessing the web pages.
The use of the name "localhost" is not permitted and is automatically replaced by the
Certificate Manager with the name of the local device.
Adding certificates
1. Right-click on a device and select "Add <Certificate type> ..."
2. Enter the properties of the certificate in the dialog.
If necessary, select a different key length and runtime for the certificate.
Note
Runtime
For web certificates, the runtime is limited to a maximum of 27 months. Longer runtimes are
not accepted by some browsers.
Note
The "Fully qualified domain name" must be used for web server certificates.
See also
Distributing and installing certificates on PC devices (Page 255)
Distributing and installing certificates on HMI panels (Page 258)
Exporting root certificate and CRL file (Page 259)
Introduction
To distribute the configured certificates to the corresponding devices, the certificates must be
exported to a secure storage file. This file must be transferred manually to the respective device
and imported there. The procedures differ for PC devices and panel devices.
2. In the "Export all" dialog, assign a password and select "Export for installation ..." (default
setting).
3. Click on "Export" and select the storage location and file name.
The data is stored encrypted with the specified password.
4. Copy the export file to the device to be installed.
5. Open the WinCC Certificate Manager on the device to be installed.
6. Double-click "Open configuration ...".
7. Select the exported file and enter the password.
8. You see the entire configuration for all devices, but you can only install a certificate for the
local device.
Note
Restrictions
The certificates of the other devices can only be displayed, the configuration cannot be
changed.
The configuration display is used to install the certificates on the device. Exiting the
Certificate Manager also closes the configuration.
9. To install certificates for the local device, the following options are available:
– To install all available certificates, right-click the device and select "Install all
certificates ...".
– To install a single certificate of the device, right click on the certificate and select "Install ..."
in the menu.
Perform steps 4 to 9 on the other PC devices on which you want to install certificates.
Result
• The certificates are installed in the certificate store defined for the respective application.
• The public root certificate of the certification authority is trusted in each certificate store.
• The CRL file of the root certificate is installed in the designated certificate store.
• If a web certificate is installed, it is automatically linked to the WinCC Unified website. The
web certificate replaces any certificate selected during the runtime installation.
The web page will then be restarted to enforce the use of the new certificate. Any connected
web browsers are disconnected and must log on again.
Note
New certificates for the OPC UA server only become effective after a restart of the WinCC Unified
Runtime.
See also
Exporting root certificate and CRL file (Page 259)
2. Assign a password. Optionally, you can adapt the iteration count for the encryption. Confirm
with "Export".
Introduction
The root certificate and the associated CRL file can be exported individually in the Certificate
Manager, for example, to establish trust between a Unified device and its external
communication partners or to update an expired CRL file.
After exporting, distribute the files:
• To install files on a Unified PC, use SIMATIC Runtime Manager.
• To install files on a Unified Comfort Panel, use the "Certificates" > "Import" function in the
Control Panel of the device under "Security".
• To distribute files to external communication partners, proceed as described in the user help
for the device.
Note
Exporting the root certificate and CRL file of a Unified PC
To export the root certificate installed on a Unified PC and its CRL file, you can use the "SIMATIC
Runtime Manager" tool as an alternative. You can find additional information here (Page 278).
5.7 Installing a root certificate in the browser for access via web client
(Unified PC)
2. Open the field with the error details and confirm that you want to open the web page.
3. On the WinCC Unified home page, select the field "Certificate Authority" and confirm "Open
file" in the download dialog.
4. Save the root certificate. To do this, click "Save file" in the Firefox dialog that follows.
5. Store the certificate in the Firefox certificate store. Proceed as follows:
– Open the "Settings" page of Firefox.
– Select "Privacy & Security". There you will find the "Certificates" area further down. Open
"Show certificates...".
– In the "Certificate Management" window, select the "Certification authorities" tab:
– Click "Import" and select the root certificate you saved in step 3.
– In the window that opens, select the option "This certificate can identify websites" and
confirm your selection.
– Click "Server" and remove the exception that was created by step 2.
3. Select "Install".
Procedure
1. Right-click the certificate and select "Recreate...".
The "New <Certificate type> certificate" dialog opens. The entries of the old certificate are
downloaded into the dialog.
2. Change the desired properties.
3. Click "Confirm".
Result
A new certificate is created. Export the certificate and install it on the target device.
Introduction
The SIMATIC Runtime Manager offers the following options for WinCC Unified PC:
• Use the project list to get an overview of the projects loaded into the Runtime and their
properties.
See The Runtime Manager user interface (Page 270).
• Manually start and stop a project loaded into the Runtime.
See Starting the project (Page 272).
• Define a project that is started automatically when the HMI device starts up.
See Selecting an autostart project (Page 275).
• Restore log segments in Runtime and delete restored segments.
See Restoring and deleting log segments (Page 275).
• Load a project from an external storage medium into Runtime.
See Adding a project (Page 273).
• Make the following settings:
– Enter the password that is used by the Runtime Manager for secure communication with
Runtime.
See Setting security settings (Page 277).
– Activate automatic adaptation of the HMI screens to the window size of the browser in
which the Runtime project is displayed (autoscale).
See Setting general settings (Page 277).
– Export the tags of the project running in Runtime into an XML file via the OPC UA server.
See Exporting tags via the OPC UA server (Page 284).
– Activate the user management of the project running in Runtime.
See Activating user management (Page 282).
– Manage and distribute certificates of external communication partners and manage and
distribute the root certificate of the Unified PC.
See Managing certificates (Page 278).
– Configure and activate the Runtime script debugger (screen debugger and scheduler
debugger).
See Setting the Runtime Script Debugger settings (Page 285).
Requirement
WinCC Unified Runtime for PC is installed on the device.
Procedure
Double-click the desktop link created during the installation of WinCC Unified Runtime.
Alternatively, start the Runtime Manager from a file explorer by double-clicking the following
file: "<Path to the Unified installation directory>\bin\SIMATICRuntimeManager.exe"
For example C:\Program Files\Siemens\Automation\WinCCUnified\bin
\SIMATICRuntimeManager.exe
Note
Starting the Runtime Manager as administrator
Some settings under "Settings" require the Runtime Manager to be started as administrator.
Right-click on the .exe and select "Run as administrator".
Note
User interface language
Runtime Manager starts with the language configured in the general settings. You can change
the interface language. See also Setting general settings (Page 277).
Structure
The Runtime Manager has the following structure:
Toolbar
The toolbar has the following buttons:
Icon Function
Loads a project from an external storage medium into the Runtime.
Deletes from the Runtime the project selected in the project list.
The project folder and the log folders are deleted.
Updates the project list.
Requirement
A project is loaded into Runtime that is not in the "Running" status.
4. Enable the options "Reset logging data" and/or "Reset Runtime data" in the "Start project
options" dialog.
5. Click "Start".
Result
• The project is started.
Note
Activating user management
The login to the Runtime project requires that its user management is active in Runtime.
After starting a project manually, you have to activate its user management manually.
• If the "Reset logging data" option was enabled, the following data is deleted when Runtime
is started:
– Logging tags
– Log alarms
– Logged context values
• If the "Reset Runtime data" option was enabled, the following data originating from the last
runtime of the project is deleted when Runtime is started:
– The last values of internal, persistent tags
– The last alarm states
– The persistent attributes of the alarm system
– The persistent attributes for the last logging cycle of the logging tags.
See also
Activating user management (Page 282)
Requirement
• The external storage medium with the Runtime project is connected to the computer.
• The Runtime Manager is open.
• To download a project for which only the changes to the project have been downloaded to
the external storage medium, the following additional requirements must be met:
– The project that is to receive the changes is executed on the HMI device.
– The Runtime ID of the executed project and the project on the external storage medium
match.
Procedure
1. In the toolbar, click "Add project from offline transmission".
The "Add projects" dialog box opens.
2. Under "Select project log", click "...".
A selection dialog opens.
3. Select the compressed ZIP folder of the Runtime project on the storage medium.
4. Click "Open".
Under "Project information" you can see details of the selected project.
5. If the project was downloaded completely to the external storage medium, you can start it
in Runtime after the download.
Follow these steps:
– Under "Options", select the "Start Runtime with project" option.
– Define whether project data is reset on startup.
To start the project in a state that existed when the project was first started, activate the
options "Reset logging data" or "Reset Runtime data".
Disable these options to start the project in a state that existed before the last project stop.
For more information on which data is reset with these options, see section Starting the
project (Page 272).
6. To overwrite the Runtime UMC data with UMC data from the project, select the "Overwrite
UMC data with the context of the offline loading" option under "Options".
7. Confirm with "Add project".
Result
• The project is downloaded to Runtime and appears in the project list.
• When "Start Runtime with project" is activated: The running project is stopped and the
downloaded project is started. Depending on your settings, the Runtime data and log data
of the project is reset and the Runtime UMC data is overwritten by the UMC data from the
project.
Note
When you load a project from an external storage medium, the SIMATIC Runtime Manager
extracts the repository to a temporary folder on the target system. The transfer to Runtime takes
place from this folder, which is then deleted again.
Requirements
• At least one project is loaded into Runtime.
• The Runtime Manager is open.
Procedure
In the project list for the desired project, select the option in the "Autostart" column.
Note
Restrictions
• You can only select one project for autostart at a time.
• The project must not have the "SIMULATION" project type.
Result
The project is started automatically when the device on which the Runtime is installed is started.
Note
Database type for backups
Backups can only be created if the Microsoft SQL database type is used.
You can find more information on logs in the help of the TIA Portal.
Requirement
• At least one backup of a tag or alarm log is available.
• A project is loaded into Runtime and is in the "Running" status.
• The Runtime Manager is open.
Requirement
The Runtime uses secure communication.
Note
Enabling secure communication
Secure communication for Runtime can be enabled as follows:
• During the installation of the Runtime, in the step "Secure Download";
Or after the installation in the application "WinCC Unified Configuration".
• In the Engineering System, if encrypted transmission is configured in the Runtime settings of
a device and the option "Allow initial password transfer via unencrypted download" is
activated when downloading the device to Runtime.
After the first, unencrypted transmission, the Runtime switches to secure communication.
Note
If Runtime does not use secure communication, the password entered here is ignored during
communication with Runtime.
Activate Autoscale
Proceed as follows to automatically adapt the size of HMI screens to the window size of the
browser in which a Runtime project is open:
1. Click the button in the toolbar.
2. Select the "General" tab.
3. Under "Autoscale", select the "Fit screen to window" check box.
4. Restart the currently running project or start another project that is loaded into the Runtime.
When users zoom in or out of the browser window, the HMI screens automatically adapt. Users
always see the entire screen.
Introduction
The "Certificates" tab provides you with the following options:
• Manage the trusted certificates of the external communication partners of the Unified HMI
device (certificates, root certificates, and CRL files).
• Export the certificates of the external communication partners to distribute them to other
Unified HMI devices (certificates, root certificates, and CRL files).
• Export the root certificate of the Unified HMI device and its CRL file (= Certificate Revocation
List) to distribute them to external communication partners.
Note
Alternative method
Export the root certificate and the CRL file of the Unified HMI device using the "WinCC Unified
Certificate Manager" tool. You can find additional information here (Page 259).
• Import the root certificate of the Unified HMI device and its CRL file separately from the
remaining certificate configuration.
The root certificate is installed by the import.
Note
Alternative method
Install the root certificate and the CRL file of the Unified HMI device together with the
remaining certificates configured for the device using the "WinCC Unified Certificate
Manager" tool. You can find additional information here (Page 255).
Note
Importing and exporting CRL files
The root certificate of the Unified HMI device and its CRL file must be imported separately.
When you export the root certificate of a CRL file, the CRL file is also exported. If required, you can
export the CRL file separately.
Structure
Requirement
• The Runtime Manager is open.
• The certificates and CRL files to be imported are located in a folder to which the HMI device
has access.
Managing certificates
1. Click the button in the toolbar.
2. Select the "Certificates" tab.
3. You can perform the following actions:
Action Procedure
Import and trust 1. Click "Import new certificate or Certificate Revocation List
(CRL)."
Action Procedure
Import 1. Click "Import new certificate or Certificate Revocation List
(CRL)."
2. Select the location of the CRL file, e.g. an external data storage
medium, and select the file.
3. Confirm your input.
The file is imported and copied to the "trusted" folder on the HMI
device.
Delete Right-click on a CRL file and select "Delete".
The file is deleted from the "trusted" folder on the HMI device.
Export 1. Right-click on the CRL file and select "Export".
2. Select the file format.
3. Select the target folder, for example, an external data storage
medium.
4. Confirm your input.
The CRL file is copied to the target folder.
Distribute the files to the desired devices. To do this, proceed as
described in the application help of the device.
See also
Functions of the Certificate Manager (Page 251)
Introduction
Several projects can be loaded on one Unified PC. The configuration of their user management
may differ. For a successful login to a project in Runtime, the project must be running in Runtime
and the appropriate user management must be active.
In the "User administration" tab, activate the appropriate user administration. For a project with
central user management, you can also adapt the connection settings to the UMC server, e.g. to
add missing settings in the TIA Portal or to use different settings.
Requirement
• In the Runtime system settings, it has been specified that Runtime uses the user
management configuration downloaded from the TIA Portal.
• At least one user has been configured with an HMI function right for the user management
active in Runtime.
• At least one user has been configured with an HMI function right for the user management
that you want to activate.
• The Runtime Manager is open.
• A project is running in Runtime, and:
– The active user management does not match the user management configured for the
project.
– For projects with central user management: The connection settings configured in the TIA
Portal for the project are incomplete, or you want to use different settings.
Procedure
1. Click the button in the toolbar.
2. Select the "User management" tab.
3. Under "Select configuration", in the "From" list, select the project whose user management
configuration you want to activate in Runtime.
Default setting after starting the Runtime Manager: The project running in Runtime
4. Confirm the confirmation prompt.
The "Operating mode" area shows the operating mode of the user management of the
selected project. The displayed options are read-only.
5. If the project selected under "From" uses local user management, click "Load user
management".
User management is activated in Runtime:
– The user data pre-configured in the TIA Portal for the project is loaded into the local user
management.
– Runtime uses the local user management.
– The "Status" field shows the status of the user management.
NOTICE
Possible data loss
The user data configured in the TIA Portal overwrites the user data added or changed on the
HMI device in the local user management. Data loss can occur.
6. If the project selected under "From" uses central user management, proceed as follows:
– Add missing or incorrect information about the connection settings.
By default, the identity provider address is automatically generated based on the UMC
server address.
To enter the address of the identity provider manually, deactivate the option "Generate
the address of the identity provider automatically".
To set all fields to empty, click "Reset configuration".
– Click "Connect to server".
The system will notify you if the configured server ID and the server ID reported during the
connection attempt are different from each other. To continue with the ID reported
online, click "Yes"; to continue with the configured server ID, click "No".
User management is activated in Runtime:
– A connection to the UMC server is established using the connection settings from the
Runtime Manager.
– Runtime uses the UMC server for user management.
– If you later select the project under "From", the connection settings you entered are
loaded.
See also
Enabling the debugger (Page 232)
Requirement
• Runtime and command line program are installed on the same device.
• For starting/stopping projects: Projects have been loaded into Runtime.
Procedure
1. Start the command line program.
2. Enter the command line call. Separate the individual elements of the call with spaces.
– Enter the path to the SIMATIC Runtime Manager.exe:
"<Runtime installation directory>\bin> start /wait SIMATICRuntimeManager.exe"
Example: C:\Program Files\Siemens\Automation\WinCCUnified\bin> start /wait
SIMATICRuntimeManager.exe
– Enter the options with which the command line program calls the Runtime Manager.
The last option must be "-c".
Option Description
-s Option for starting the Runtime Manager in silent mode.
Without this option, the UI of the Runtime Manager is started when the
command line call is processed.
-u Option to enable help messages that assist you in operating the Runtime
Manager via the command line program.
-sim Only use this option if you call the option "-c" with the
command projectstate, start, stop or remove.
-quiet Option for calling the Runtime Manager without output.
-o Option for diverting the output into an Output.txt file that is stored parallel
to SIMATICRuntimeManager.exe.
You can redirect the output to another folder. The Unified Administrator
must have write access to the folder.
Example:
-o “C:\Program Files\Siemens\Automation\WinCCUnified
\bin\MyOutput.txt"
If an error occurs during the write and -quiet is not set, the error indication
appears on the console.
-keepUmc Optional
Only in combination with the fulldownload command
Set the option to keep the Runtime UMC data.
-overwriteUmc Optional
Only in combination with the fulldownload command
Set this option to replace the UMC data of the Runtime with the UMC data
from the project.
-c Option for inputting the commands that are transmitted to the Runtime
Manager.
– After the option "-c", enter the command that the Runtime Manager should run and the
argument that is transmitted to the command:
Result
• The command is executed.
• A return code with description is output in the console.
List of possible return codes:
Examples
• Call a list of all projects loaded into Runtime:
– Input: C:\Program Files\Siemens\Automation\WinCCUnified\bin>
start /wait SIMATICRuntimeManager.exe -s -c projectlist [ALL]
– Example output:
[1]
Project name: T1
Device name: T1
Project type: REAL
Project ID: 0B527D12-6BBD-4F2F-BEB9-23E3C37A8932
Autostart: 0
[2]
Project name: T2
Device name: T2
Project type: REAL
Project ID: 29DCBA1D-C615-4560-AFB4-94EB9565682C
Autostart: 0
[3]
Project name: T3
Device name: T3
Project type: REAL
Project ID: 96FE68D0-5337-4072-A96C-F7C1D7525CAF
Autostart: 0
• Call the project running in Runtime:
Input:
C:\Program Files\Siemens\Automation\WinCCUnified\bin> start /wait
SIMATiCRuntimeManager.exe -s -c projectlist RUNNING
• Query project status:
Input:
C:\Program Files\Siemens\Automation\WinCCUnified\bin> start /wait
SIMATICRuntimeManager.exe -s -c projectstate 96FE68D0-5337-4072-
A96C-F7C1D7525CAF
• Start a project:
Input:
C:\Program Files\Siemens\Automation\WinCCUnified\bin> start /wait
SIMATICRuntimeManager.exe -s -c start 96FE68D0-5337-4072-A96C-
F7C1D7525CAF
• Stop a project:
Input:
C:\Program Files\Siemens\Automation\WinCCUnified\bin> start /wait
SIMATICRuntimeManager.exe -s -c stop 96FE68D0-5337-4072-A96C-
F7C1D7525CAF
• Remove a project from Runtime:
Input:
C:\Program Files\Siemens\Automation\WinCCUnified\bin> start /wait
SIMATICRuntimeManager.exe -s -c remove 96FE68D0-5337-4072-A96C-
F7C1D7525CAF
See also
Enabling the debugger (Page 232)
Brief description
The following general conditions apply for the simulator:
Tag types Process tags, internal tags and structure tags can be simulated.
You can find unsupported tag types under "Inserting tags in the "Tag simula‐
tion" editor (Page 298)".
Quantity structure A maximum of 300 tags can be simulated at the same time.
However, you can configure and save more tags in the simulator.
Update cycle The update time for tag values is one second.
Specify a multiple of a second using the "Cycle" parameter.
Online configuration Configuration changes of the simulation are immediately visible in Runtime.
WARNING
Effects on connected controls
Simulated tag values can be transferred to connected controllers.
When the WinCC project is connected to a controller, WinCC writes the simulated process values
to the automation system.
This can lead to a reaction of the connected process I/Os.
Disconnect hardware
Before using the simulator, ensure that
• No hardware is connected, if possible.
• The connected hardware represents no danger even when values are extreme.
Recommendation
Simulate the process values without process connection.
Application examples
Typical fields of applications for the Simulator:
• Testing the configuration without connected process I/Os
• Testing of the configuration with connected process I/Os, but without running process
You can simulate process tags both with and without connected process I/Os.
See also
Inserting tags in the "Tag simulation" editor (Page 298)
Procedure
To configure and activate the simulation, use the "Tags simulation" simulator. The simulator
opens in a separate window.
Start the simulator via the Windows user interface. Select one of the following options:
• In the Windows program group "Siemens Automation", select the entry "WinCC Unified Tag
Simulator".
• Search via the taskbar for "WinCC Unified Tag Simulator" and start the simulator.
The "Tags Simulation" simulator is opened. No simulation is started.
Data area
To set the same property for multiple tags, work in the data area and use, for example, the
automatic continuation ("Drag Down").
The data area additionally contains the simulation values and runtime values of the tags.
"Simulation" menu
The menu bar contains the entry "Simulation".
When the WinCC project is in RUN in Runtime, the entries "Start" and "Stop" are active. This allows
you to start and stop the configured simulation.
Tag properties
You edit the properties in the data area or in the properties window.
Column Description
Value set Value transferred by the simulator.
"User input" function
• If Runtime is activated, enter the required value in the field.
• To display the slider, click the displayed button:
Current value Current tag value in runtime
Time stamp Current time stamp of the tag value in runtime
Quality set Quality code set by the simulator.
Select the quality code from the drop-down list.
Default setting:
• 0x60: Uncertain; Simulated value
Quality code Current quality code of the tag in runtime
Tag status Current tag status in runtime
See also
Inserting tags in the "Tag simulation" editor (Page 298)
Configuring functions for the simulation (Page 300)
WARNING
Effects on connected controls
Simulated tag values can be transferred to connected controllers.
When the WinCC project is connected to a controller, WinCC writes the simulated process values
to the automation system.
This can lead to a reaction of the connected process I/Os.
Disconnect hardware
Before using the simulator, ensure that
• No hardware is connected, if possible.
• The connected hardware represents no danger even when values are extreme.
Recommendation
Simulate the process values without process connection.
Requirement
In runtime, a project of the project type REAL or SIMULATION is in RUN.
Procedure
1. Open the WinCC Unified Tag Simulator.
2. Insert the required tags.
To open the tag selection dialog, click the displayed button in the "Tag name" column:
Other possible procedures:
– "Inserting tags in the "Tag simulation" editor (Page 298)"
3. Select the function for the simulation.
5. To change the update cycle, enter a number > 1 in the "Cycle" field.
An update cycle of 1 second is the basis. To change the simulated value, every 5 seconds, for
example, enter "5".
6. If necessary, select the quality code in the "Quality set" column.
The selected quality code is also set each time a simulated tag value is written.
7. Activate the simulation of the required tags in the "Active" column.
You can simulate a maximum of 300 tags simultaneously, even if more tags are configured
in the simulator.
8. Save the simulation using the menu command "File > Save as".
This allows you to reuse the projected simulation later, for example, to test a changed
configuration.
9. Start the simulation using the menu command "Simulation > Start".
– The simulated values are displayed in the "Value set" column.
– The actual values of the tags are displayed in the "Current value" column.
– The respective, actual quality code is displayed in the "Quality Code" column.
10.To use the "User input" function to change the simulated value for tags, click the "..." button
in the "Value set" column and then select a value with the slider.
11.To stop the simulation, select the menu command "Simulation > Stop".
The simulation is also ended when you stop the runtime project.
See also
Inserting tags in the "Tag simulation" editor (Page 298)
Inserting tags
You have the following options for inserting tags in the WinCC Unified Tag Simulator:
• Enter tag name
• Applying tags from the list for tag selection
Supported tags
The following tags can be simulated:
• Process tags
• Internal tags
• Structure tags
• Structure tag elements
Restrictions
Simulation of the following tag types is not supported:
• Raw data tag
• Text reference
• Date/time
Tag name
The tag or structure tag is searched for and added in the tag management.
Adding a tag
In the detail area, you define which tags are part of the simulation. You have the following
options to add a tag:
• In the "Tag name" column, double-click in the cell with the following icon:
Then enter the tag name in the field. Make sure that the name is case-sensitive.
• In the "Tag name" field, click on the arrow button and select a tag from the list.
If a row that is already filled is selected in the data area, this tag is overwritten during pasting.
To add more tags, click the next empty line in the data area.
Delete tag
To delete a tag, click the respective row number in the data area. The line is highlighted.
Select "Delete" from the shortcut menu or press the <Del> key.
The tag is deleted, without further prompt, from the list of tags to be simulated.
Sine function
Periodic, non-linear function:
Parameters Description
Amplitude Value range
Offset Zero point for the value range
Oscillation period Duration of period in seconds
Oscillation
Simulation of jumps of a setpoint:
Parameters Description
Overshoots Maximum deviation from the rated value
Rated value Value around which the oscillations are occurring
Parameters Description
Oscillation period Time interval of the oscillation in seconds.
The oscillation restarts after the specified time have elapsed.
Damping Reduction of amplitude within the oscillation period
Random values
Randomly generated values:
Parameters Description
Random minimum value Smallest possible value
Random maximum value Greatest possible value
Increment
Up counter which restarts at the minimum value when it reaches the maximum value:
Parameters Description
Initial value Increment Minimum value
The start value is applied at runtime start.
End value Increment Maximum value
Step Increment Value increase, e.g. in increments of 10
Decrement
Down counter; restarts the maximum value after having reached the minimum value:
Parameters Description
Initial value Decrement Maximum value
The start value is applied at runtime start.
End value Decrement Minimum value
Step Decrement Value reduction, e.g. in decrements of 10
User input
Enter in the "Value set" table field or use the slider:
Parameters Description
Slider minimum value Lowest value that can be entered or selected with the slider
Slider initial value Value at runtime start
Slider maximum value Highest value that can be entered or selected with the slider.
Slider
1. To open the slider in runtime, click in the "Value set" field in the table area.
2. Click the displayed button:
Text tags
In addition to numbers, you can also set letters as start value for text tags.
The slider is not displayed. The "Minimum value" and "Maximum value" fields are inactive.
Script
VBScript function with the return value that is written to the WinCC tag:
Restrictions
• Tags whose name starts with the prefix "@" cannot be addressed in scripts via the simulator.
• You cannot deactivate a tag with the "Script" simulation function as long as the simulation is
active in runtime.
• If the script cannot be processed in the current cycle, it is not called up again until of next
update cycle after processing has been completed.
To deactivate the tag simulation and correct the script, stop the simulation using the menu
item "Simulation > Stop".
Transfer parameters
The VBS function must have a transfer parameter.
An object with the following properties is transferred to the script during the execution:
1) In the simulator you can only create procedures of the "Sub" type. The value to be set is written in the
"Value" parameter.
The "Function" type is only supported in the project modules or standard modules. In this case, the return
value is written to the tag.
'VBS378
Sub Tag_Simulation_01 (Byval Item)
MyCalculatedValue = Item.Counter
' do your own calculation
' ...
' write the calculated value to be set by WinCC Unified Tag Simulator
Item.Value = MyCalculatedValue
Item.QualityCode = 72
End Sub
You use the trace function via the HMIruntime object. The text is displayed in the diagnostic
window of the simulator.
Tags object
'VBS379
Sub SimulatedTag_address_02 (Byval Item)
Dim group
Set group = Tags.CreateTagSet
' add tags "Simulation_x" to the collection
group.Add "Simulation_3"
group.Add "Simulation_4"
' set the values of the tags
group("Simulation_3").Value = Item.Counter
group("Simulation_4").Value = Item.Counter +1
' write the values to the DataManager
group.Write
End Sub
SmartTags object
'VBS380
SmartTags("Simulation_5") = 7
Target directory:
• When you started the simulator via the Windows user interface while a project is in RUN in
Runtime, the simulation file is saved to the following directory:
<Path to the active RT project>\Simulation
Note
Overwriting the simulation file by full download
Simulation files saved in the project directory are overwritten by a full download.
• When you started the simulator without a project being in RUN in Runtime, the document
directory of the user is recommended as a storage location. Select a different directory, if
necessary.